GET v1/SalesReturn/{id}

This method gets a sales return including sales return line data

Request Information

URI Parameters

Name Description Type Additional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Sales return data from the Tradevine database

SalesReturn

Name Description Type
SalesReturnID

The unique internal identifier of each sales return in Tradevine e.g. 3451582911653885586

integer
OrganisationID

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

integer
CustomerID

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

integer
ReturnNumber

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

string
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
Status

The return status lookup value

integer
SalesOrderID

The internal identifier of the sales order this return was generated from and linked to

integer
OrderNumber

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

string
CustomerBillingAddressID

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

integer
Currency

The return currency lookup value

integer
ApplyTaxes

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

boolean
TotalsTaxInclusive

Whether totals include tax

boolean
TotalCost

The total cost value of the return (excluding tax)

decimal number
TotalCostExShipping

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

decimal number
GrossProfit

The total gross profit value of the return

decimal number
GrossProfitExShipping

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

decimal number
GrossMarginPercent

The total gross margin percent value of the return

decimal number
GrossMarginPercentExShipping

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

decimal number
AverageMarkupPercent

The average mark-up percent of the return

decimal number
AverageMarkupPercentExShipping

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

decimal number
SubTotal

The sub-total of the return (excluding taxes)

decimal number
SubTotalExShipping

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

decimal number
SubTotalApplicableTaxes

The sub total of all tax values for the return

decimal number
GrandTotal

The overall return total to be paid

decimal number
GrandTotalExShipping

The overall return total excluding shipping

decimal number
InternalNotes

Private notes associated with the return

string
ExternalNotes

Public notes associated with the return

string
CompletedDate

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

date
AccountingCreditNoteID

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

string
CreatedDate

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

date
CreatedBy

The internal Tradevine ID of the user that created the return

integer
ModifiedDate

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

date
ModifiedBy

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

integer
AccountingJournalID

If Xero is integrated, this is the ID of the manual journal created when the return was completed e.g. 1EC6091E-8B8F-4959-9B5C-D5CDCE659D6F

string
WarehouseID

Internal Tradevine ID of warehouse allocated for return

integer
WarehouseAddressID

integer
SubTotalIncTax

The sub-total of the return including deduction for any discount

decimal number
TotalDiscount

The total of the return discount

decimal number
DiscountTax

The tax applicable to the discount component

decimal number
SalesReturnLines

Collection of SalesReturnLine
WarehouseCode

Code for warehouse allocated for return

string
Customer

Customer
BillingAddress

Address
Labels

Collection of string

Response Formats

application/json

Sample:

Sample not available.