Name Description Type Additional information
SalesOrderID

The unique internal identifier of each sales order in Tradevine e.g. 34515829112475466365

integer

Optional

OrganisationID

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

integer

Optional

CustomerID

The unique internal identifier of each customer in Tradevine e.g. 34515829112467586585

integer

Optional

OrderNumber

The more user friendly identifier for the order (normally auto-generated using your auto-numbering settings) e.g. SO453

string

Optional

OrderOrigin

The origin lookup value

integer

Optional

CustomerOrderReference

The reference that the buyer for this sales order will have i.e. for Trade Me orders this will be the purchase ID e.g. P54645, for Shopify orders it will be the order number #1001

string

Optional

Status

The order status lookup value

integer

Optional

IsCompletedWithCancellations

Indicates if shipments were partially completed with no back-orders i.e. the full order quantity was not shipped

boolean

Optional

TradeMeOrganisationID

The internal identifier of this Trade Me account in Tradevine if this order came from Trade Me e.g. 345146044378132553

integer

Optional

ExternalListingID

The Trade Me listing ID if this order came from Trade Me e.g. 581641940

string

Optional

ExternalOfferID

The Trade Me fixed-price-offer ID if this order came from a Trade Me FPO e.g. 2434

string

Optional

ShopifyOrganisationID

The internal identifier of this Shopify account in Tradevine if this order came from Shopify e.g. 34514604434236363

integer

Optional

ShopifyOrderID

The internal order ID from Shopify if this order came from Shopify e.g. 654467

integer

Optional

ShopifyOrderNumber

The more user friendly identifier for the order in Shopify e.g. #1001

string

Optional

ShopifyOrderStatus

The status of the order in Shopify

string

Optional

CustomerBillingAddressID

The internal identifier of the customer's billing address in Tradevine e.g. 3451460547437456

integer

Optional

CustomerShippingAddressID

The internal identifier of the customer's shipping address in Tradevine e.g. 3451460547437456

integer

Optional

RecipientName

he name of the recipient of the shipment (could be different from the person who bought the item) e.g. Sam Jenkins

string

Optional

TermsOfTrade

The payment terms lookup value

integer

Optional

PaymentDueDate

The date/time (in UTC) that payment is due

date

Optional

IsPaymentReceived

Has payment been received for this order

boolean

Optional

PaymentDate

The date/time (in UTC) that payment was received

date

Optional

ManualApprovalNeeded

Is manual approval a pre-requisite for transitioning this order from Pending to Awaiting Shipment

boolean

Optional

IsManuallyApproved

Has the order been manually approved (only relevant if manual approval is needed)

boolean

Optional

PaymentType

The payment type lookup value

integer

Optional

PaymentReference

The optional reference made with the payment

string

Optional

ShipmentType

The shipment type lookup value

integer

Optional

RequestedShippingDate

The date/time (in UTC) that shipping is requested

date

Optional

Currency

The order currency lookup value

integer

Optional

ApplyTaxes

Whether tax is applicable for this order (defaulted according to seller tax-status and buyer billing address location)

boolean

Optional

TotalsTaxInclusive

Whether totals include tax

boolean

Optional

TotalCost

The total cost value of the order (excluding tax)

decimal number

Optional

TotalCostExShipping

The total cost value of the order minus costs for shipping (excluding tax)

decimal number

Optional

GrossProfit

The total gross profit value of the order

decimal number

Optional

GrossProfitExShipping

The total gross profit value of the order minus any p/l for shipping

decimal number

Optional

GrossMarginPercent

The total gross margin percent value of the order

decimal number

Optional

GrossMarginPercentExShipping

The total gross margin percent value of the order excluding shipping margin

decimal number

Optional

AverageMarkupPercent

The average mark-up percent of the order

decimal number

Optional

AverageMarkupPercentExShipping

The average mark-up percent of the order excluding shipping mark-up

decimal number

Optional

SubTotal

The sub-total of the order (excluding taxes)

decimal number

Optional

TotalDiscount

The total discount of the order (including or excluding tax depending on TotalsTaxInclusive value)

decimal number

Optional

SubTotalExShipping

The sub-total of the order (excluding taxes and shipping)

decimal number

Optional

SubTotalApplicableTaxes

The sub total of all tax values for the order

decimal number

Optional

GrandTotal

The overall order total to be paid

decimal number

Optional

GrandTotalExShipping

The overall order total excluding shipping

decimal number

Optional

InternalNotes

Private notes associated with the order

string

Optional

ExternalNotes

Public notes associated with the order - if this was from Trade Me the any message the buyer sends will be saved here

string

Optional

CompletedDate

The date/time (in UTC) that the order moved to the Completed status

date

Optional

AccountingInvoiceID

The internal Xero invoice identifier if integrated with Xero and an invoice has been sent through

string

Optional

AccountingPaymentID

The internal Xero payment identifier if integrated with Xero and the invoice has been paid

string

Optional

AccountingCreditNoteID

The internal Xero credit note identifier if integrated with Xero and the invoice has been credited

string

Optional

AccountingIsPaid

Whether the invoice has been paid according to Xero if integrated with Xero

boolean

Optional

AccountingIsVoided

Whether the invoice has been voided according to Xero if integrated with Xero

boolean

Optional

AccountingInvoiceDate

The date/time (in UTC) of the invoice according to Xero (Tradevine re-dates the invoice daily until payment is received)

date

Optional

TradeMePayNowCommissionTotal

If this order came from Trade Me and was a Pay Now listing then this is the commission payable to Trade Me

decimal number

Optional

IsChaserEmailsDisabled

Order level override for whether chaser emails are sent to the buyer if payment and/or delivery address is not received

boolean

Optional

CreatedDate

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

date

Optional

CreatedBy

The internal Tradevine ID of the user that created the order

integer

Optional

ModifiedDate

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

date

Optional

ModifiedBy

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

integer

Optional

ExternalPurchaseID

integer

Optional

WarehouseID

integer

Optional

WarehouseCode

string

Optional

ExternalClientData

A field for API clients to store any data relevant to them e.g. JSON. Tradevine will not modify this data but merely pass it through. Max 500 chars.

string

Optional

SuccessFees

Total success fees if this sales order was a result of a Trade Me sale

decimal number

Optional

PaymentFees

Total payment fees if this sales order was a result of a Trade Me sale i.e. Ping or Afterpay commission

decimal number

Optional

Customer

Customer

Optional

BillingAddress

Address

Optional

ShippingAddress

Address

Optional

PackLists

Collection of PackList

Optional

SalesOrderLines

Collection of SalesOrderLine

Optional

Labels

Collection of string

Optional