Name Description Type Additional information
ProductID

The unique internal identifier of each product in Tradevine e.g. 3451582911247567682

integer

Optional

OrganisationID

The internal identifier of this organisation in Tradevine e.g. 3451460443781171981

integer

Optional

Code

The product code e.g. PR432

string

Optional

Name

The product name e.g. ABE Chemical Fire Extinguisher

string

Optional

Description

The long description of the product

string

Optional

AlternateCode

The alternate product code if used e.g. ACME_CHEM_9860

string

Optional

EnableInventory

Whether this product is inventory-tracked or not i.e. true or false

boolean

Optional

UnitOfMeasure

The unit of measure the product is sold in e.g. each, box or crate

string

Optional

Barcode

The product barcode or GTIN or ISBN

string

Optional

ManufacturerCode

The manufacturer's code for the product

string

Optional

Brand

The brand name of the product e.g. Sony

string

Optional

InternalNotes

Internal (private) notes

string

Optional

ExternalNotes

External (public) notes

string

Optional

ProductCategoryID

The internal Tradevine product category identifier

integer

Optional

Weight

The product weight (either gram or ounce - depending on measurement system defined in the organisation settings)

decimal number

Optional

Length

The product length (either millimetre or inch - depending on measurement system defined in the organisation settings)

decimal number

Optional

Width

The product width (either millimetre or inch - depending on measurement system defined in the organisation settings)

decimal number

Optional

Height

The product height (either millimetre or inch - depending on measurement system defined in the organisation settings)

decimal number

Optional

Currency

The product currency lookup value

integer

Optional

TaxClassID

The internal Tradevine identifier for the tax type of this organisation. This is used as the product's default tax type/rate

integer

Optional

TaxCode

The tax type description for this tax type for this organisation e.g. GST. This is used as the product's default tax type/rate

string

Optional

QuantityInStock

The current Stock on Hand (SOH) value for this product if it is inventory tracked e.g. 10 if I physically hold 10 at the moment

decimal number

Optional

QuantityAvailableToSell

The current Available To Sell value for this product - this is the SOH minus any allocations for sales orders, open listings, open FPOs etc.

decimal number

Optional

QuantityAvailableToShip

The current Available To Ship value for this product - this is the SOH minus any allocations for printed shipments not yet confirmed

decimal number

Optional

CostPrice

This is the cost price (excluding tax) for the product. For an inventory-tracked product this will be the weighted average cost of all transactions. For non-inventory tracked products this will be whatever cost-price is configured against the product

decimal number

Optional

SellPriceIncTax

This is the default selling price (excluding tax) for the product

decimal number

Optional

SellPriceExTax

This is the default selling price (including tax) for the product

decimal number

Optional

MinimumStockQuantity

For inventory-tracked products, this is the ATS level that will trigger re-order alerts

decimal number

Optional

OverrideSalesGLAccountCode

For products that are not inventory-tracked and where Xero integration is on, this is the general ledger account code that will be used for sales i.e. accounts receivable invoices

string

Optional

OverrideSalesGLAccountName

For products that are not inventory-tracked and where Xero integration is on, this is the general ledger account name that will be used for sales i.e. accounts receivable invoices

string

Optional

OverridePurchaseGLAccountCode

For products that are not inventory-tracked and where Xero integration is on, this is the general ledger account code that will be used for purchases i.e. accounts payable invoices

string

Optional

OverridePurchaseGLAccountName

For products that are not inventory-tracked and where Xero integration is on, this is the general ledger account name that will be used for purchases i.e. accounts payable invoices

string

Optional

PhotoIdentifier

This field is used in product CSV import file to link products to photo names that will be subsequently uploaded (via file or downloaded from Trade Me or an external web-site) e.g. 'FireEx1.jpg;FireExt2.jpg'

string

Optional

IsManualOrderApprovalNeeded

This is a product level flag which indicates that sales orders that contain this product should require manual approval before transitioning from Pending to Awaiting Shipment

boolean

Optional

IsBoM

This is a product level flag which says if this product if a Bill Of Materials (BoM) container products

boolean

Optional

IsBoMComponent

This is a product level flag which says if this product if a component of one or more Bill Of Materials (BoM) container products

boolean

Optional

IsBoMWeightAutocalculated

This is a product level flag which can be set on BoM products and have its weight calculated based on its components and auto-updated whenever the weight of any components change

boolean

Optional

IsArchived

This is a product level flag which determines if it appears by default in your products list (archived products also don't auto-list in Trade Me or appear in Shopify)

boolean

Optional

CreatedDate

The date and time (in UTC) that the product was created

date

Optional

CreatedBy

The internal Tradevine ID of the user that created the product

integer

Optional

ModifiedDate

The date and time (in UTC) that the product was last modified

date

Optional

ModifiedBy

The internal Tradevine ID of the user that last modified the product

integer

Optional

QuantityAvailableForShipmentAllocation

The level of free inventory available for creating new shipments

decimal number

Optional

QuantityReorderBalance

The value of stock incoming and outgoing that gets compared to the ReorderPoint to trigger new purchases

decimal number

Optional

TradeMeListings

The level of inventory currently on open Trade Me listings

decimal number

Optional

TradeMeOffers

The level of inventory currently on open Trade Me FPOs

decimal number

Optional

SoftAllocated

The level of inventory currently on all open sales orders

decimal number

Optional

MediumAllocated

The level of inventory currently on non-pending sales orders

decimal number

Optional

HardAllocated

The level of inventory currently on printed shipments

decimal number

Optional

SoftPurchase

The level of inventory currently on all open purchase orders (draft included)

decimal number

Optional

HardPurchase

The level of inventory currently on all open, confirmed purchase orders

decimal number

Optional

BoMSoftAllocated

The level of inventory currently on any sales orders containing BoM products that contain this product as a component

decimal number

Optional

BoMTradeMeListings

The level of inventory currently on any Trade Me listings for BoM products that contain this product as a component

decimal number

Optional

BoMTradeMeOffers

The level of inventory currently on any Trade Me FPOs for BoM products that contain this product as a component

decimal number

Optional

Photos

The list of photos of the product

Collection of Photo

Optional

PerWarehouseInventory

The list of inventory records for each warehouse of the product

Collection of PerWarehouseInventory

Optional

ProductSuppliers

The list of remote product details for each supplier of the product

Collection of ProductSupplier

Optional

BoMComponents

The list of BoM components that make up this BoM parent if IsBoM is true

Collection of ProductBoMComponent

Optional

Labels

The list of labels applied to the product

Collection of string

Optional