| Name | Description | Type | Additional information |
|---|---|---|---|
| PackListID |
The unique internal identifier of the shipment in Tradevine e.g. 3451582911567846854 |
integer |
Optional |
| OrganisationID |
he internal identifier of this organisation in Tradevine e.g. 3451460443781171981 |
integer |
Optional |
| SalesOrderID |
The unique internal identifier of each sales order in Tradevine e.g. 34515829112475466365 |
integer |
Optional |
| Status |
The shipment's status lookup value |
integer |
Optional |
| PackListNumber |
The more user friendly identifier for the shipment (normally auto-generated using your auto-numbering settings) e.g. SO453/1 |
string |
Optional |
| ShipmentType |
The shipment's shipment type lookup value |
integer |
Optional |
| CustomerShippingAddressID | integer |
Optional |
|
| RequestedShippingDate |
The date/time (in UTC) that the shipment was requested to be shipped |
date |
Optional |
| ShippedDate |
The date/time (in UTC) that the shipment was confirmed i.e. shipped |
date |
Optional |
| Courier |
The shipment's courier lookup value |
integer |
Optional |
| TrackingReference |
The optional external courier tracking reference |
string |
Optional |
| TrackingReference2 |
The optional second external courier tracking reference |
string |
Optional |
| DeliveryNotes |
Any notes to be saved against the shipment |
string |
Optional |
| PrintedDate |
The date/time (in UTC) that the pick-list document for this shipment was printed |
date |
Optional |
| IsInvoiceEmailed |
Whether this shipment had its PDF invoice emailed to the buyer |
boolean |
Optional |
| IsInvoicePrinted |
Whether this shipment had its PDF invoice printed for packing into the shipment to the buyer |
boolean |
Optional |
| IsPackSlipEmailed |
Whether this shipment had its PDF pack-slip emailed to the buyer |
boolean |
Optional |
| IsPackSlipPrinted |
Whether this shipment had its PDF packing-slip printed for packing into the shipment to the buyer |
boolean |
Optional |
| AccountingJournalID |
If Xero is integrated, this is the ID of the manual journal created when the shipment was confirmed e.g. 1EC6091E-8B8F-4959-9B5C-D5CDCE659D6F |
string |
Optional |
| CreatedDate |
The date and time (in UTC) that the shipment was created |
date |
Optional |
| CreatedBy |
The internal Tradevine ID of the user that created the shipment |
integer |
Optional |
| ModifiedDate |
The date and time (in UTC) that the shipment was last modified |
date |
Optional |
| ModifiedBy |
The internal Tradevine ID of the user that last modified the shipment |
integer |
Optional |
| WarehouseID |
Internal Tradevine ID of warehouse allocated for shipment |
integer |
Optional |
| CourierCompanyName |
The name of the courier company when the Courier field is 70028 (User Supplied). |
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 |
| PackListItems |
The individual items that are part of this pack list |
Collection of PackListItem |
Optional |
| QueueInventorySummaryUpdates |
For some products like BoMs or BoM components, these updates can take a few seconds so this option queues them to be done asynchronously |
boolean |
Optional |
| ConfirmOptions |
The confirmation options for this shipment |
ConfirmOptions |
Optional |
| WarehouseCode |
Code for warehouse allocated for shipment |
string |
Optional |