The following objects are available when using Deposco as a source in Celigo Data Integration (DI).
Primary key: All Deposco DI endpoints use a resource-specific self.id as the primary key. Identity is modeled through a flattened self object (Deposco's EntityRef), so self.id is the consistent key across resources.
Note
Deposco soft deletes records. Core business objects are cancelled or moved through lifecycle status transitions rather than physically removed, and remain retrievable via the API. Celigo syncs all data returned by the source as-is.
| Object | API endpoint | Available extract modes | Delta field |
|---|---|---|---|
| Billable transactions | Get a list of billable transactions | Full, Incremental | updatedAfter |
| Billing invoices | Get a list of billing invoices | Full, Incremental | updatedAfter |
| Billing profiles | Get a list of billing profiles | Full, Incremental | updatedAfter |
| Companies | Get a list of companies | Full, Incremental | updatedAfter |
| Containers | Get a list of containers | Full, Incremental | updatedAfter |
| Customer orders | Get a list of customer orders | Full, Incremental | updatedAfter |
| Cycle count tasks | Get a list of cycle count tasks | Full, Incremental | createdAfter |
| Facilities | Get a list of facilities | Full, Incremental | updatedAfter |
| Inventory | Get a list of inventory items | Full | — |
| Kits | Get a list of kit headers | Full, Incremental | updatedAfter |
| Locations | Get a list of locations | Full, Incremental | updatedAfter |
| Price lists | Get a list of price lists | Full, Incremental | updatedAfter |
| Receipts | Get a list of receipts | Full, Incremental | updatedAfter |
| Replenishment tasks | Get a list of replenishment tasks | Full, Incremental | updatedAfter |
| Trips | Get a list of trips | Full, Incremental | updatedAfter |
| Work orders | Get a list of work orders | Full, Incremental | updatedAfter |
| Customer returns | Get a list of customer returns | Full, Incremental | updatedAfter |
| Inbound shipments | Get a list of inbound shipments | Full, Incremental | updatedAfter |
| Inbound transfer orders | Get a list of inbound transfer orders | Full, Incremental | updatedAfter |
| Items | Get a list of items | Full, Incremental | updatedAfter |
| Outbound shipments | Get a list of outbound shipments | Full, Incremental | updatedAfter |
| Outbound transfer orders | Get a list of outbound transfer orders | Full, Incremental | updatedAfter |
| Purchase orders | Get a list of purchase orders | Full, Incremental | updatedAfter |
| Sales orders | Get a list of sales orders | Full, Incremental | updatedAfter |
| Trading partners | Get a list of trading partners | Full, Incremental | updatedAfter |
| Vendor returns | Get a list of vendor returns | Full, Incremental | updatedAfter |
| Zones | Get a list of zones | Full, Incremental | updatedAfter |
Response schemas
Click an object below to view its response fields and delta configuration.
Billable transactions — Get a list of billable transactions
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
status |
string |
description |
string |
billingProfile |
object |
billingProfile.id |
number |
billingProfile.businessKey |
object |
billingProfile.href |
string |
billingConfig |
object |
billingConfig.id |
number |
billingConfig.businessKey |
object |
billingConfig.href |
string |
transactionType |
string |
transactionSource |
string |
transactionNumber |
string |
facility |
object |
facility.id |
number |
facility.businessKey |
object |
facility.href |
string |
location |
object |
location.id |
number |
location.businessKey |
object |
location.href |
string |
containerNumber |
string |
orderHeader |
object |
orderHeader.id |
number |
orderHeader.businessKey |
object |
orderHeader.href |
string |
item |
object |
item.id |
number |
item.businessKey |
object |
item.href |
string |
itemAttributes |
object |
itemAttributes.lotNumber |
string |
itemAttributes.serialNumber |
string |
itemAttributes.bornOnDate |
string |
itemAttributes.expirationDate |
string |
quantity |
number |
totalPrice |
number |
totalCost |
number |
currencyCode |
string |
effectiveDate |
string |
associatedUser |
object |
associatedUser.id |
number |
associatedUser.businessKey |
object |
associatedUser.href |
string |
customAttribute1 |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Billing invoices — Get a list of billing invoices
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
status |
string |
description |
string |
billingProfile |
object |
billingProfile.id |
number |
billingProfile.businessKey |
object |
billingProfile.href |
string |
facility |
object |
facility.id |
number |
facility.businessKey |
object |
facility.href |
string |
currencyCode |
string |
invoiceDate |
string |
dueDate |
string |
totalAmount |
number |
taxAmount |
number |
invoiceLines |
objectarray |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Billing profiles — Get a list of billing profiles
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
name |
string |
templateProfile |
object |
templateProfile.id |
number |
templateProfile.businessKey |
object |
templateProfile.href |
string |
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
billingProfile |
object |
billingProfile.id |
number |
billingProfile.businessKey |
object |
billingProfile.href |
string |
configType |
string |
active |
boolean |
description |
string |
facility |
object |
facility.id |
number |
facility.businessKey |
object |
facility.href |
string |
quantity |
number |
price |
number |
cost |
number |
percent |
number |
currencyCode |
string |
recurrenceFrequency |
string |
recurrenceInterval |
string |
transactionsGeneratedBy |
string |
transactionStatus |
string |
adHocRequiredField |
string |
customField1 |
number |
customField2 |
number |
customField3 |
number |
customField4 |
number |
customField5 |
number |
customField6 |
number |
customField7 |
number |
customField8 |
number |
customField9 |
number |
customField10 |
number |
customValue1 |
string |
customValue2 |
string |
customValue3 |
string |
customValue4 |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Companies — Get a list of companies
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
code |
string |
name |
string |
description |
string |
active |
boolean |
contact |
object |
contact.firstName |
string |
contact.lastName |
string |
contact.email |
string |
contact.phone |
string |
contact.fax |
string |
address |
object |
address.line1 |
string |
address.line2 |
string |
address.line3 |
string |
address.line4 |
string |
address.city |
string |
address.stateProvince |
string |
address.postalCode |
string |
address.country |
string |
website |
string |
industry |
string |
numberOfEmployees |
number |
annualRevenue |
number |
doingBusinessAs |
string |
naics |
string |
sic |
string |
locale |
string |
dateFormat |
string |
startDayOfWeek |
string |
timeZone |
string |
packingSlipLevel |
string |
packingSlipReport |
string |
useSAS70Compliance |
boolean |
ucceanCompanyNumber |
string |
ssccExpansionDigit |
number |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Containers — Get a list of containers
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
lpnNumber |
string |
number |
string |
type |
string |
secondaryType |
string |
cartonType |
object |
cartonType.id |
number |
cartonType.businessKey |
object |
cartonType.href |
string |
description |
string |
status |
string |
gtin |
string |
dimensions |
object |
dimensions.length |
object |
dimensions.length.measurement |
number |
dimensions.length.units |
string |
dimensions.width |
object |
dimensions.width.measurement |
number |
dimensions.width.units |
string |
dimensions.height |
object |
dimensions.height.measurement |
number |
dimensions.height.units |
string |
dimensions.volume |
object |
dimensions.volume.measurement |
number |
dimensions.volume.units |
string |
weight |
number |
weightUOM |
string |
activeZone |
object |
activeZone.id |
number |
activeZone.businessKey |
object |
activeZone.href |
string |
location |
object |
location.id |
number |
location.businessKey |
object |
location.href |
string |
cart |
object |
cart.id |
number |
cart.businessKey |
object |
cart.href |
string |
cartSlotNumber |
number |
copySourceLpnNumber |
string |
parent |
object |
parent.id |
number |
parent.businessKey |
object |
parent.href |
string |
masterLpnNumber |
string |
packageType |
string |
shipment |
object |
shipment.id |
number |
shipment.businessKey |
object |
shipment.href |
string |
trip |
object |
trip.id |
number |
trip.businessKey |
object |
trip.href |
string |
insuredValue |
number |
shippingCost |
number |
baseTrackingLink |
string |
trackingUrl |
string |
trackingNumber |
string |
trackingNumber2 |
string |
returnTrackingNumber |
string |
uspsConstructCode |
string |
orderHeaderSequence |
number |
orderHeaderSequenceTotal |
number |
pickWaveSequence |
number |
pickWaveSequenceTotal |
number |
sequence |
number |
sequenceTotal |
number |
printed |
boolean |
ssccLpnNumber |
string |
referenceNumber1 |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Customer orders — Get a list of customer orders
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
Note: Response fields for this object are not yet documented.
Cycle count tasks — Get a list of cycle count tasks
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | createdAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
facility |
object |
facility.id |
number |
facility.businessKey |
object |
facility.href |
string |
location |
object |
location.id |
number |
location.businessKey |
object |
location.href |
string |
item |
object |
item.id |
number |
item.businessKey |
object |
item.href |
string |
type |
string |
priority |
number |
status |
string |
assignedUser |
object |
assignedUser.id |
number |
assignedUser.businessKey |
object |
assignedUser.href |
string |
dueDate |
string |
finishedDate |
string |
createdDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
Facilities — Get a list of facilities
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
name |
string |
type |
string |
isVirtual |
boolean |
dbaName |
string |
description |
string |
phone |
string |
contact |
object |
contact.name |
string |
contact.phone |
string |
contact.email |
string |
contact.fax |
string |
address |
object |
address.line1 |
string |
address.line2 |
string |
address.city |
string |
address.stateProvince |
string |
address.postalCode |
string |
address.country |
string |
facilityUOMSystem |
string |
timeZone |
string |
enableCustomerPickup |
boolean |
enableShipToCustomer |
boolean |
latitude |
number |
longitude |
number |
squareFeet |
number |
fulfillmentFacility |
object |
fulfillmentFacility.id |
number |
fulfillmentFacility.businessKey |
object |
fulfillmentFacility.href |
string |
importReference |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Inventory — Get a list of inventory items
Response schema:
| Field | Type |
|---|---|
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
item |
object |
item.id |
number (Primary key) |
item.businessKey |
object |
item.href |
string |
facility |
object |
facility.id |
number |
facility.businessKey |
object |
facility.href |
string |
inventory |
object |
inventory.totalOnHandQuantity |
number |
inventory.availableQuantity |
number |
inventory.blockedQuantity |
number |
inventoryAttributes |
objectarray |
inventoryAttributes.serialNumber |
string |
inventoryAttributes.lotNumber |
string |
inventoryAttributes.expirationDate |
string |
inventoryAttributes.onHandQuantity |
number |
Kits — Get a list of kit headers
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
name |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
kitUsage |
string |
kitDetails |
object |
kitDetails.data |
objectarray |
kitDetails.data.self |
object |
kitDetails.data.self.id |
number |
kitDetails.data.self.businessKey |
object |
kitDetails.data.self.href |
string |
kitDetails.data.type |
string |
kitDetails.data.businessUnit |
object |
kitDetails.data.businessUnit.id |
number |
kitDetails.data.businessUnit.businessKey |
object |
kitDetails.data.businessUnit.href |
string |
kitDetails.data.kitHeader |
object |
kitDetails.data.kitHeader.id |
number |
kitDetails.data.kitHeader.businessKey |
object |
kitDetails.data.kitHeader.href |
string |
kitDetails.data.item |
object |
kitDetails.data.item.id |
number |
kitDetails.data.item.businessKey |
object |
kitDetails.data.item.href |
string |
kitDetails.data.pack |
object |
kitDetails.data.pack.id |
number |
kitDetails.data.pack.businessKey |
object |
kitDetails.data.pack.href |
string |
kitDetails.data.quantity |
number |
kitDetails.data.rank |
number |
kitDetails.data.customAttribute1 |
string |
kitDetails.data.customAttribute2 |
string |
kitDetails.data.customAttribute3 |
string |
kitDetails.data.createdDate |
string |
kitDetails.data.updatedDate |
string |
kitDetails.data.createdBy |
object |
kitDetails.data.createdBy.id |
number |
kitDetails.data.createdBy.businessKey |
object |
kitDetails.data.createdBy.href |
string |
kitDetails.data.updatedBy |
object |
kitDetails.data.updatedBy.id |
number |
kitDetails.data.updatedBy.businessKey |
object |
kitDetails.data.updatedBy.href |
string |
minWorkorderSize |
number |
maxWorkorderSize |
number |
leadTime |
number |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Locations — Get a list of locations
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
facility |
object |
facility.id |
number |
facility.businessKey |
object |
facility.href |
string |
zones |
object |
zones.data |
objectarray |
zones.data.id |
number |
zones.data.businessKey |
object |
zones.data.href |
string |
number |
string |
locator |
string |
name |
string |
description |
string |
type |
string |
storageType |
string |
status |
string |
dimensions |
object |
dimensions.length |
object |
dimensions.length.measurement |
number |
dimensions.length.units |
string |
dimensions.width |
object |
dimensions.width.measurement |
number |
dimensions.width.units |
string |
dimensions.height |
object |
dimensions.height.measurement |
number |
dimensions.height.units |
string |
dimensions.volume |
object |
dimensions.volume.measurement |
number |
dimensions.volume.units |
string |
pickable |
boolean |
reserved |
boolean |
lpnControlled |
boolean |
mixedItemThreshold |
string |
cycleCount |
boolean |
cycleCountFrequency |
number |
lastCountedDate |
string |
pickSequence |
number |
putawaySequence |
number |
useForKit |
boolean |
allocatedToBusinessUnit |
object |
allocatedToBusinessUnit.id |
number |
allocatedToBusinessUnit.businessKey |
object |
allocatedToBusinessUnit.href |
string |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
storageDetails |
object |
storageDetails.data |
objectarray |
storageDetails.data.self |
object |
storageDetails.data.self.id |
number |
storageDetails.data.self.businessKey |
object |
storageDetails.data.self.href |
string |
storageDetails.data.businessUnit |
object |
storageDetails.data.businessUnit.id |
number |
storageDetails.data.businessUnit.businessKey |
object |
storageDetails.data.businessUnit.href |
string |
storageDetails.data.location |
object |
storageDetails.data.location.id |
number |
storageDetails.data.location.businessKey |
object |
storageDetails.data.location.href |
string |
storageDetails.data.pack |
object |
storageDetails.data.pack.id |
number |
storageDetails.data.pack.businessKey |
object |
storageDetails.data.pack.href |
string |
storageDetails.data.type |
string |
storageDetails.data.minimum |
number |
storageDetails.data.maximum |
number |
storageDetails.data.minimumPick |
number |
storageDetails.data.maximumPick |
number |
storageDetails.data.opportunisticCountThreshold |
number |
storageDetails.data.createdBy |
object |
storageDetails.data.createdBy.id |
number |
storageDetails.data.createdBy.businessKey |
object |
storageDetails.data.createdBy.href |
string |
storageDetails.data.updatedBy |
object |
storageDetails.data.updatedBy.id |
number |
storageDetails.data.updatedBy.businessKey |
object |
storageDetails.data.updatedBy.href |
string |
storageDetails.data.createdDate |
string |
storageDetails.data.updatedDate |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Price lists — Get a list of price lists
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
code |
string |
name |
string |
description |
string |
active |
boolean |
currencyCode |
string |
priceListDetails |
object |
priceListDetails.data |
objectarray |
priceListDetails.data.self |
object |
priceListDetails.data.self.id |
number |
priceListDetails.data.self.businessKey |
object |
priceListDetails.data.self.href |
string |
priceListDetails.data.item |
object |
priceListDetails.data.item.id |
number |
priceListDetails.data.item.businessKey |
object |
priceListDetails.data.item.href |
string |
priceListDetails.data.pack |
object |
priceListDetails.data.pack.id |
number |
priceListDetails.data.pack.businessKey |
object |
priceListDetails.data.pack.href |
string |
priceListDetails.data.active |
boolean |
priceListDetails.data.fixedPrice |
number |
priceListDetails.data.salesPrice |
number |
priceListDetails.data.salesEffectiveStart |
string |
priceListDetails.data.salesEffectiveEnd |
string |
priceListDetails.data.createdDate |
string |
priceListDetails.data.updatedDate |
string |
priceListDetails.data.createdBy |
object |
priceListDetails.data.createdBy.id |
number |
priceListDetails.data.createdBy.businessKey |
object |
priceListDetails.data.createdBy.href |
string |
priceListDetails.data.updatedBy |
object |
priceListDetails.data.updatedBy.id |
number |
priceListDetails.data.updatedBy.businessKey |
object |
priceListDetails.data.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Receipts — Get a list of receipts
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
number |
string |
status |
string |
receivedItem |
object |
receivedItem.id |
number |
receivedItem.businessKey |
object |
receivedItem.href |
string |
receivedPack |
object |
receivedPack.id |
number |
receivedPack.businessKey |
object |
receivedPack.href |
string |
receivedPackQuantity |
number |
destinationLocation |
object |
destinationLocation.id |
number |
destinationLocation.businessKey |
object |
destinationLocation.href |
string |
container |
object |
container.id |
number |
container.businessKey |
object |
container.href |
string |
masterLpnNumber |
string |
unitPrice |
number |
lotNumber |
string |
serialNumber |
string |
bornOnDate |
string |
expirationDate |
string |
inventoryCondition |
string |
damaged |
boolean |
receivedDamagedPackQuantity |
number |
disposition |
string |
catchWeight |
number |
inventoryAttribute1 |
string |
inventoryAttribute2 |
string |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
importReference1 |
string |
importReference2 |
string |
exportReference1 |
string |
exportReference2 |
string |
otherReferenceNumber |
string |
orderLine |
object |
orderLine.id |
number |
orderLine.businessKey |
object |
orderLine.href |
string |
channels |
objectarray |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Replenishment tasks — Get a list of replenishment tasks
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
type |
string |
state |
string |
priority |
number |
item |
object |
item.id |
number |
item.businessKey |
object |
item.href |
string |
pack |
object |
pack.id |
number |
pack.businessKey |
object |
pack.href |
string |
orderLine |
object |
orderLine.id |
number |
orderLine.businessKey |
object |
orderLine.href |
string |
workorder |
object |
workorder.id |
number |
workorder.businessKey |
object |
workorder.href |
string |
sourceDetails |
object |
sourceDetails.locationOfTask |
object |
sourceDetails.locationOfTask.id |
number |
sourceDetails.locationOfTask.businessKey |
object |
sourceDetails.locationOfTask.href |
string |
sourceDetails.sourcePack |
object |
sourceDetails.sourcePack.id |
number |
sourceDetails.sourcePack.businessKey |
object |
sourceDetails.sourcePack.href |
string |
sourceDetails.quantityToPick |
number |
sourceDetails.quantityPicked |
number |
destinationDetails |
object |
destinationDetails.destinationLocation |
object |
destinationDetails.destinationLocation.id |
number |
destinationDetails.destinationLocation.businessKey |
object |
destinationDetails.destinationLocation.href |
string |
destinationDetails.quantityToReplenish |
number |
destinationDetails.quantityReplenished |
number |
stageLocation |
object |
stageLocation.id |
number |
stageLocation.businessKey |
object |
stageLocation.href |
string |
container |
object |
container.id |
number |
container.businessKey |
object |
container.href |
string |
startTaskTime |
string |
endTaskTime |
string |
assignedUser |
object |
assignedUser.id |
number |
assignedUser.businessKey |
object |
assignedUser.href |
string |
schedulerName |
string |
opportunisticCount |
boolean |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Trips — Get a list of trips
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
status |
string |
deliveryType |
string |
shipFromFacility |
object |
shipFromFacility.id |
number |
shipFromFacility.businessKey |
object |
shipFromFacility.href |
string |
shippingCarrier |
string |
accountNumber |
string |
licenseNumber |
string |
freightType |
string |
dockDoor |
object |
dockDoor.id |
number |
dockDoor.businessKey |
object |
dockDoor.href |
string |
driverName |
string |
departureTime |
string |
currentScheduledDeliveryDate |
string |
estimatedDeliveryDate |
string |
actualArrivalTime |
string |
carrierAlphaCode |
string |
freightClass |
string |
transportationMethodCode |
string |
bolNumber |
string |
equipmentDescriptionCode |
string |
carrierEquipmentNumber |
string |
sealNumber |
string |
route |
object |
route.id |
number |
route.businessKey |
object |
route.href |
string |
refNumber |
string |
shipments |
object |
shipments.data |
objectarray |
shipments.data.self |
object |
shipments.data.self.id |
number |
shipments.data.self.businessKey |
object |
shipments.data.self.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Work orders — Get a list of work orders
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
type |
string |
status |
string |
priority |
number |
description |
string |
kitHeader |
object |
kitHeader.id |
number |
kitHeader.businessKey |
object |
kitHeader.href |
string |
quantity |
number |
facility |
object |
facility.id |
number |
facility.businessKey |
object |
facility.href |
string |
zone |
object |
zone.id |
number |
zone.businessKey |
object |
zone.href |
string |
location |
object |
location.id |
number |
location.businessKey |
object |
location.href |
string |
pickWave |
object |
pickWave.id |
number |
pickWave.businessKey |
object |
pickWave.href |
string |
assignedToUser |
object |
assignedToUser.id |
number |
assignedToUser.businessKey |
object |
assignedToUser.href |
string |
startDate |
string |
endDate |
string |
dueDate |
string |
customAttribute1 |
string |
workorderDetails |
objectarray |
workorderDetails.self |
object |
workorderDetails.self.id |
number |
workorderDetails.self.businessKey |
object |
workorderDetails.self.href |
string |
workorderDetails.number |
string |
workorderDetails.workorder |
object |
workorderDetails.workorder.id |
number |
workorderDetails.workorder.businessKey |
object |
workorderDetails.workorder.href |
string |
workorderDetails.status |
string |
workorderDetails.builtQuantity |
number |
workorderDetails.startTime |
string |
workorderDetails.endTime |
string |
workorderDetails.createdDate |
string |
workorderDetails.updatedDate |
string |
workorderDetails.createdBy |
object |
workorderDetails.createdBy.id |
number |
workorderDetails.createdBy.businessKey |
object |
workorderDetails.createdBy.href |
string |
workorderDetails.updatedBy |
object |
workorderDetails.updatedBy.id |
number |
workorderDetails.updatedBy.businessKey |
object |
workorderDetails.updatedBy.href |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.schedulerTask |
object |
channels.schedulerTask.id |
number |
channels.schedulerTask.businessKey |
object |
channels.schedulerTask.href |
string |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Customer returns — Get a list of customer returns
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
orderPriority |
number |
orderSummary |
string |
orderSource |
string |
secondaryOrderSource |
string |
customerOrderNumber |
string |
relatedOrderNumber |
string |
partnerInvoiceNumber |
string |
consigneePartner |
object |
consigneePartner.id |
number |
consigneePartner.businessKey |
object |
consigneePartner.href |
string |
tradingPartnerSite |
object |
tradingPartnerSite.id |
number |
tradingPartnerSite.businessKey |
object |
tradingPartnerSite.href |
string |
shipToContact |
object |
shipToContact.attention |
string |
shipToContact.name |
string |
shipToContact.firstName |
string |
shipToContact.lastName |
string |
shipToContact.contactName |
string |
shipToContact.phone |
string |
shipToContact.email |
string |
shipToAddress |
object |
shipToAddress.line1 |
string |
shipToAddress.line2 |
string |
shipToAddress.line3 |
string |
shipToAddress.line4 |
string |
shipToAddress.city |
string |
shipToAddress.stateProvince |
string |
shipToAddress.postalCode |
string |
shipToAddress.country |
string |
billToContact |
object |
billToContact.name |
string |
billToContact.firstName |
string |
billToContact.lastName |
string |
billToContact.contactName |
string |
billToContact.attention |
string |
billToContact.phone |
string |
billToContact.email |
string |
billToAccountNumber |
string |
billToAddress |
object |
billToAddress.line1 |
string |
billToAddress.line2 |
string |
billToAddress.line3 |
string |
billToAddress.line4 |
string |
billToAddress.city |
string |
billToAddress.stateProvince |
string |
billToAddress.postalCode |
string |
billToAddress.country |
string |
shipFromContact |
object |
shipFromContact.name |
string |
shipFromContact.firstName |
string |
shipFromContact.lastName |
string |
shipFromContact.attention |
string |
shipFromContact.phone |
string |
shipFromContact.email |
string |
shipFromAddress |
object |
shipFromAddress.line1 |
string |
shipFromAddress.line2 |
string |
shipFromAddress.city |
string |
shipFromAddress.stateProvince |
string |
shipFromAddress.postalCode |
string |
shipFromAddress.country |
string |
placedDate |
string |
plannedArrivalDate |
string |
plannedReleaseDate |
string |
plannedShipDate |
string |
earliestShipDate |
string |
earliestDeliveryDate |
string |
cancelByArrivalDate |
string |
cancelByReleaseDate |
string |
cancelByShipDate |
string |
actualArrivalDate |
string |
actualReleaseDate |
string |
actualShipDate |
string |
priceList |
object |
priceList.id |
number |
priceList.businessKey |
object |
priceList.href |
string |
orderTotal |
number |
orderSubtotal |
number |
orderDiscountSubtotal |
number |
orderShippingTotal |
number |
orderShipTotal |
number |
taxable |
boolean |
orderTaxTotal |
number |
orderTaxableTotal |
number |
orderUntaxableTotal |
number |
shippingTaxTotal |
number |
shipVia |
string |
shipVendor |
string |
shipMethod |
string |
freightTermsType |
string |
freightBillToContact |
object |
freightBillToContact.name |
string |
freightBillToContact.firstName |
string |
freightBillToContact.lastName |
string |
freightBillToContact.attention |
string |
freightBillToContact.phone |
string |
freightBillToAccount |
string |
freightBillToAddress |
object |
freightBillToAddress.line1 |
string |
freightBillToAddress.line2 |
string |
freightBillToAddress.line3 |
string |
freightBillToAddress.line4 |
string |
freightBillToAddress.city |
string |
freightBillToAddress.stateProvince |
string |
freightBillToAddress.postalCode |
string |
freightBillToAddress.country |
string |
deliverToContact |
object |
deliverToContact.name |
string |
deliverToContact.attention |
string |
deliverToContact.phone |
string |
deliverToAddress |
object |
deliverToAddress.line1 |
string |
deliverToAddress.line2 |
string |
deliverToAddress.city |
string |
deliverToAddress.stateProvince |
string |
deliverToAddress.postalCode |
string |
deliverToAddress.country |
string |
weight |
object |
weight.weight |
number |
weight.units |
string |
returnRequired |
boolean |
returnShipVia |
string |
returnShipOption |
string |
deliveryConfirmation |
string |
insuranceRequired |
boolean |
homeDelivery |
boolean |
residential |
boolean |
saturdayDelivery |
boolean |
hubId |
string |
routingNumber |
string |
incotermsType |
string |
importType |
string |
importReference |
string |
exportReference |
string |
otherReferenceNumber2 |
string |
integrationSource |
object |
integrationSource.id |
number |
integrationSource.businessKey |
object |
integrationSource.href |
string |
sendASN |
string |
dropShip |
boolean |
pickWave |
object |
pickWave.id |
number |
pickWave.businessKey |
object |
pickWave.href |
string |
postReleaseState |
string |
entryName |
string |
entryPhone1 |
string |
saleConditionCode |
string |
seller |
string |
notificationCode1 |
string |
notificationCode2 |
string |
notificationCode3 |
string |
verbalConfirmationName |
string |
verbalConfirmationPhoneNumber |
string |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
customAttribute4 |
string |
customAttribute5 |
string |
customAttribute6 |
string |
customAttribute7 |
string |
customFields |
objectarray |
customFields.self |
object |
customFields.self.id |
number |
customFields.self.businessKey |
object |
customFields.self.href |
string |
customFields.name |
string |
customFields.value |
string |
customFields.type |
string |
customFields.item |
object |
customFields.item.id |
number |
customFields.item.businessKey |
object |
customFields.item.href |
string |
customFields.orderHeader |
object |
customFields.orderHeader.id |
number |
customFields.orderHeader.businessKey |
object |
customFields.orderHeader.href |
string |
customFields.orderLine |
object |
customFields.orderLine.id |
number |
customFields.orderLine.businessKey |
object |
customFields.orderLine.href |
string |
customFields.shipment |
object |
customFields.shipment.id |
number |
customFields.shipment.businessKey |
object |
customFields.shipment.href |
string |
customFields.createdDate |
string |
customFields.updatedDate |
string |
customFields.createdBy |
object |
customFields.createdBy.id |
number |
customFields.createdBy.businessKey |
object |
customFields.createdBy.href |
string |
customFields.updatedBy |
object |
customFields.updatedBy.id |
number |
customFields.updatedBy.businessKey |
object |
customFields.updatedBy.href |
string |
notes |
objectarray |
notes.self |
object |
notes.self.id |
number |
notes.self.businessKey |
object |
notes.self.href |
string |
notes.title |
string |
notes.body |
string |
notes.source |
string |
notes.priority |
string |
notes.orderHeader |
object |
notes.orderHeader.id |
number |
notes.orderHeader.businessKey |
object |
notes.orderHeader.href |
string |
notes.orderLine |
object |
notes.orderLine.id |
number |
notes.orderLine.businessKey |
object |
notes.orderLine.href |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.schedulerTask |
object |
channels.schedulerTask.id |
number |
channels.schedulerTask.businessKey |
object |
channels.schedulerTask.href |
string |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
type |
string |
orderStatus |
string |
shipToFacility |
object |
shipToFacility.id |
number |
shipToFacility.businessKey |
object |
shipToFacility.href |
string |
parentOrder |
object |
parentOrder.id |
number |
parentOrder.businessKey |
object |
parentOrder.href |
string |
coHeader |
object |
coHeader.id |
number |
coHeader.businessKey |
object |
coHeader.href |
string |
otherReferenceNumber |
string |
orderLines |
object |
orderLines.data |
objectarray |
orderLines.data.self |
object |
orderLines.data.self.id |
number |
orderLines.data.self.businessKey |
object |
orderLines.data.self.href |
string |
orderLines.data.businessUnit |
object |
orderLines.data.businessUnit.id |
number |
orderLines.data.businessUnit.businessKey |
object |
orderLines.data.businessUnit.href |
string |
orderLines.data.lineNumber |
string |
orderLines.data.customerLineNumber |
string |
orderLines.data.relatedOrderLine |
object |
orderLines.data.relatedOrderLine.id |
number |
orderLines.data.relatedOrderLine.businessKey |
object |
orderLines.data.relatedOrderLine.href |
string |
orderLines.data.sortOrder |
number |
orderLines.data.orderHeader |
object |
orderLines.data.orderHeader.id |
number |
orderLines.data.orderHeader.businessKey |
object |
orderLines.data.orderHeader.href |
string |
orderLines.data.item |
object |
orderLines.data.item.id |
number |
orderLines.data.item.businessKey |
object |
orderLines.data.item.href |
string |
orderLines.data.pack |
object |
orderLines.data.pack.id |
number |
orderLines.data.pack.businessKey |
object |
orderLines.data.pack.href |
string |
orderLines.data.description |
string |
orderLines.data.orderPackQuantity |
number |
orderLines.data.canceledPackQuantity |
number |
orderLines.data.lotNumber |
string |
orderLines.data.bornOnDate |
string |
orderLines.data.expirationDate |
string |
orderLines.data.productCode |
string |
orderLines.data.inventoryCondition |
string |
orderLines.data.inventoryAttribute1 |
string |
orderLines.data.inventoryAttribute2 |
string |
orderLines.data.plannedShipDate |
string |
orderLines.data.plannedArrivalDate |
string |
orderLines.data.unitPrice |
number |
orderLines.data.unitCost |
number |
orderLines.data.priceCode |
string |
orderLines.data.lineTotal |
number |
orderLines.data.taxable |
boolean |
orderLines.data.taxCost |
number |
orderLines.data.taxableTotal |
number |
orderLines.data.untaxableTotal |
number |
orderLines.data.extendedTotal |
number |
orderLines.data.discountAmount |
number |
orderLines.data.shippingAmount |
number |
orderLines.data.weight |
object |
orderLines.data.weight.weight |
number |
orderLines.data.weight.units |
string |
orderLines.data.importReference |
string |
orderLines.data.exportReference |
string |
orderLines.data.customAttribute1 |
string |
orderLines.data.customAttribute2 |
string |
orderLines.data.customAttribute3 |
string |
orderLines.data.customFields |
objectarray |
orderLines.data.customFields.self |
object |
orderLines.data.customFields.self.id |
number |
orderLines.data.customFields.self.businessKey |
object |
orderLines.data.customFields.self.href |
string |
orderLines.data.customFields.name |
string |
orderLines.data.customFields.value |
string |
orderLines.data.customFields.type |
string |
orderLines.data.customFields.item |
object |
orderLines.data.customFields.item.id |
number |
orderLines.data.customFields.item.businessKey |
object |
orderLines.data.customFields.item.href |
string |
orderLines.data.customFields.orderHeader |
object |
orderLines.data.customFields.orderHeader.id |
number |
orderLines.data.customFields.orderHeader.businessKey |
object |
orderLines.data.customFields.orderHeader.href |
string |
orderLines.data.customFields.orderLine |
object |
orderLines.data.customFields.orderLine.id |
number |
orderLines.data.customFields.orderLine.businessKey |
object |
orderLines.data.customFields.orderLine.href |
string |
orderLines.data.customFields.shipment |
object |
orderLines.data.customFields.shipment.id |
number |
orderLines.data.customFields.shipment.businessKey |
object |
orderLines.data.customFields.shipment.href |
string |
orderLines.data.customFields.createdDate |
string |
orderLines.data.customFields.updatedDate |
string |
orderLines.data.customFields.createdBy |
object |
orderLines.data.customFields.createdBy.id |
number |
orderLines.data.customFields.createdBy.businessKey |
object |
orderLines.data.customFields.createdBy.href |
string |
orderLines.data.customFields.updatedBy |
object |
orderLines.data.customFields.updatedBy.id |
number |
orderLines.data.customFields.updatedBy.businessKey |
object |
orderLines.data.customFields.updatedBy.href |
string |
orderLines.data.notes |
objectarray |
orderLines.data.notes.self |
object |
orderLines.data.notes.self.id |
number |
orderLines.data.notes.self.businessKey |
object |
orderLines.data.notes.self.href |
string |
orderLines.data.notes.title |
string |
orderLines.data.notes.body |
string |
orderLines.data.notes.source |
string |
orderLines.data.notes.priority |
string |
orderLines.data.notes.orderHeader |
object |
orderLines.data.notes.orderHeader.id |
number |
orderLines.data.notes.orderHeader.businessKey |
object |
orderLines.data.notes.orderHeader.href |
string |
orderLines.data.notes.orderLine |
object |
orderLines.data.notes.orderLine.id |
number |
orderLines.data.notes.orderLine.businessKey |
object |
orderLines.data.notes.orderLine.href |
string |
orderLines.data.channels |
objectarray |
orderLines.data.channels.self |
object |
orderLines.data.channels.self.id |
number |
orderLines.data.channels.self.businessKey |
object |
orderLines.data.channels.self.href |
string |
orderLines.data.channels.integration |
object |
orderLines.data.channels.integration.id |
number |
orderLines.data.channels.integration.businessKey |
object |
orderLines.data.channels.integration.href |
string |
orderLines.data.channels.schedulerTask |
object |
orderLines.data.channels.schedulerTask.id |
number |
orderLines.data.channels.schedulerTask.businessKey |
object |
orderLines.data.channels.schedulerTask.href |
string |
orderLines.data.channels.ref1 |
string |
orderLines.data.channels.ref2 |
string |
orderLines.data.channels.ref3 |
string |
orderLines.data.channels.ref4 |
string |
orderLines.data.channels.ref5 |
string |
orderLines.data.channels.secRef1 |
string |
orderLines.data.channels.secRef2 |
string |
orderLines.data.channels.secRef3 |
string |
orderLines.data.channels.secRef4 |
string |
orderLines.data.channels.secRef5 |
string |
orderLines.data.channels.createdDate |
string |
orderLines.data.channels.updatedDate |
string |
orderLines.data.channels.createdBy |
object |
orderLines.data.channels.createdBy.id |
number |
orderLines.data.channels.createdBy.businessKey |
object |
orderLines.data.channels.createdBy.href |
string |
orderLines.data.channels.updatedBy |
object |
orderLines.data.channels.updatedBy.id |
number |
orderLines.data.channels.updatedBy.businessKey |
object |
orderLines.data.channels.updatedBy.href |
string |
orderLines.data.createdDate |
string |
orderLines.data.updatedDate |
string |
orderLines.data.createdBy |
object |
orderLines.data.createdBy.id |
number |
orderLines.data.createdBy.businessKey |
object |
orderLines.data.createdBy.href |
string |
orderLines.data.updatedBy |
object |
orderLines.data.updatedBy.id |
number |
orderLines.data.updatedBy.businessKey |
object |
orderLines.data.updatedBy.href |
string |
orderLines.data.orderLineStatus |
string |
orderLines.data.shipToFacility |
object |
orderLines.data.shipToFacility.id |
number |
orderLines.data.shipToFacility.businessKey |
object |
orderLines.data.shipToFacility.href |
string |
orderLines.data.coLine |
object |
orderLines.data.coLine.id |
number |
orderLines.data.coLine.businessKey |
object |
orderLines.data.coLine.href |
string |
orderLines.data.receivedPackQuantity |
number |
orderLines.data.receivedDamagedPackQuantity |
number |
orderLine |
object |
orderLine.id |
number |
orderLine.businessKey |
object |
orderLine.href |
string |
canceledPackQuantity |
number |
lineNumber |
string |
customerLineNumber |
string |
relatedOrderLine |
object |
relatedOrderLine.id |
number |
relatedOrderLine.businessKey |
object |
relatedOrderLine.href |
string |
sortOrder |
number |
orderHeader |
object |
orderHeader.id |
number |
orderHeader.businessKey |
object |
orderHeader.href |
string |
item |
object |
item.id |
number |
item.businessKey |
object |
item.href |
string |
pack |
object |
pack.id |
number |
pack.businessKey |
object |
pack.href |
string |
description |
string |
orderPackQuantity |
number |
canceledPackQuantity |
number |
lotNumber |
string |
bornOnDate |
string |
expirationDate |
string |
productCode |
string |
inventoryCondition |
string |
inventoryAttribute1 |
string |
inventoryAttribute2 |
string |
unitPrice |
number |
unitCost |
number |
priceCode |
string |
lineTotal |
number |
taxCost |
number |
taxableTotal |
number |
untaxableTotal |
number |
extendedTotal |
number |
discountAmount |
number |
shippingAmount |
number |
orderLineStatus |
string |
coLine |
object |
coLine.id |
number |
coLine.businessKey |
object |
coLine.href |
string |
receivedPackQuantity |
number |
receivedDamagedPackQuantity |
number |
Inbound shipments — Get a list of inbound shipments
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
orderHeaders |
object |
orderHeaders.data |
objectarray |
orderHeaders.data.id |
number |
orderHeaders.data.businessKey |
object |
orderHeaders.data.href |
string |
shipVia |
string |
shipMethod |
string |
shipVendor |
string |
trackingNumber |
string |
trackingUrl |
string |
routingNumber |
string |
shipFromZone |
object |
shipFromZone.id |
number |
shipFromZone.businessKey |
object |
shipFromZone.href |
string |
consigneePartner |
object |
consigneePartner.id |
number |
consigneePartner.businessKey |
object |
consigneePartner.href |
string |
billToAccountNumber |
string |
billToPartner |
object |
billToPartner.id |
number |
billToPartner.businessKey |
object |
billToPartner.href |
string |
freightBillToPartner |
object |
freightBillToPartner.id |
number |
freightBillToPartner.businessKey |
object |
freightBillToPartner.href |
string |
freightBillToAccount |
string |
shipToFacility |
object |
shipToFacility.id |
number |
shipToFacility.businessKey |
object |
shipToFacility.href |
string |
shipFromFacility |
object |
shipFromFacility.id |
number |
shipFromFacility.businessKey |
object |
shipFromFacility.href |
string |
shipmentDates |
object |
shipmentDates.plannedShipDate |
string |
shipmentDates.plannedArrivalDate |
string |
shipmentDates.actualShipDate |
string |
shipmentDates.actualArrivalDate |
string |
shipmentDates.requestedDeliveryDate |
string |
totalWeight |
object |
totalWeight.value |
number |
totalWeight.units |
string |
chargeableWeight |
object |
chargeableWeight.value |
number |
chargeableWeight.units |
string |
totalCube |
object |
totalCube.measurement |
number |
totalCube.units |
string |
lpnNumber |
string |
containerType |
string |
totalPieces |
number |
totalPackages |
number |
fullCasePackages |
number |
splitCasePackages |
number |
fullCasePickComplete |
boolean |
splitCasePickComplete |
boolean |
driverPalletCountFlag |
boolean |
shippingCosts |
object |
shippingCosts.shippingCost |
number |
shippingCosts.extendedShippingCost |
number |
shippingCosts.taxCost |
number |
shippingCosts.insuranceRequired |
boolean |
shippingCosts.insuranceCost |
number |
shippingCosts.insuranceAmount |
number |
shippingCosts.handlingCost |
number |
shippingCosts.laborCost |
number |
shippingCosts.materialsCost |
number |
shippingCosts.rateZone |
string |
shippingCosts.publishedRate |
number |
shippingCosts.currencyCode |
string |
shippingCosts.freightTermsType |
string |
shippingCosts.feeTermsType |
string |
shippingCosts.customsDeclaredValue |
number |
shippingCosts.incotermsType |
string |
shippingCosts.dutyPaidByType |
string |
shippingCosts.dutyPaidByContactName |
string |
shippingCosts.dutyPaidByAccount |
string |
shippingCosts.dutyPaidByPostalCode |
string |
shippingCosts.dutyPaidByCountry |
string |
bolNumber |
string |
handlingInstructions |
string |
authorizationCode |
string |
trailerLoadedBy |
string |
shipperFreightCountFlag |
boolean |
driverPieceCountFlag |
boolean |
returns |
object |
returns.returnShipVia |
string |
returns.returnShipVendor |
string |
returns.returnShipMethod |
string |
returns.returnShipOption |
string |
residential |
boolean |
homeDelivery |
boolean |
saturdayDelivery |
boolean |
hubId |
string |
codAmount |
number |
shipMode |
string |
dropShip |
boolean |
complete |
boolean |
correct |
boolean |
onTime |
boolean |
custCheckFlag |
boolean |
masterFlag |
boolean |
shipFromFobFlag |
boolean |
shipToFobFlag |
boolean |
totalDistance |
number |
totalMiles |
number |
notificationCode1 |
string |
notificationCode2 |
string |
notificationCode3 |
string |
verbalConfirmationPhoneNumber |
string |
integrationSource |
object |
integrationSource.id |
number |
integrationSource.businessKey |
object |
integrationSource.href |
string |
integrationPoint |
object |
integrationPoint.id |
number |
integrationPoint.businessKey |
object |
integrationPoint.href |
string |
importReference |
string |
exportReference |
string |
otherReferenceNumber |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.schedulerTask |
object |
channels.schedulerTask.id |
number |
channels.schedulerTask.businessKey |
object |
channels.schedulerTask.href |
string |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
customFields |
objectarray |
customFields.self |
object |
customFields.self.id |
number |
customFields.self.businessKey |
object |
customFields.self.href |
string |
customFields.name |
string |
customFields.value |
string |
customFields.type |
string |
customFields.item |
object |
customFields.item.id |
number |
customFields.item.businessKey |
object |
customFields.item.href |
string |
customFields.orderHeader |
object |
customFields.orderHeader.id |
number |
customFields.orderHeader.businessKey |
object |
customFields.orderHeader.href |
string |
customFields.orderLine |
object |
customFields.orderLine.id |
number |
customFields.orderLine.businessKey |
object |
customFields.orderLine.href |
string |
customFields.shipment |
object |
customFields.shipment.id |
number |
customFields.shipment.businessKey |
object |
customFields.shipment.href |
string |
customFields.createdDate |
string |
customFields.updatedDate |
string |
customFields.createdBy |
object |
customFields.createdBy.id |
number |
customFields.createdBy.businessKey |
object |
customFields.createdBy.href |
string |
customFields.updatedBy |
object |
customFields.updatedBy.id |
number |
customFields.updatedBy.businessKey |
object |
customFields.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
type |
string |
status |
string |
shipToContact |
object |
shipToContact.name |
string |
shipToContact.contactName |
string |
shipToContact.attention |
string |
shipToContact.phone |
string |
shipToContact.email |
string |
shipToAddress |
object |
shipToAddress.line1 |
string |
shipToAddress.line2 |
string |
shipToAddress.line3 |
string |
shipToAddress.line4 |
string |
shipToAddress.city |
string |
shipToAddress.stateProvince |
string |
shipToAddress.postalCode |
string |
shipToAddress.country |
string |
shipFromContact |
object |
shipFromContact.attention |
string |
shipFromContact.phone |
string |
shipFromAddress |
object |
shipFromAddress.line1 |
string |
shipFromAddress.line2 |
string |
shipFromAddress.city |
string |
shipFromAddress.stateProvince |
string |
shipFromAddress.postalCode |
string |
shipFromAddress.country |
string |
billToContact |
object |
billToContact.name |
string |
billToContact.attention |
string |
billToContact.contactName |
string |
billToContact.phone |
string |
billToAddress |
object |
billToAddress.line1 |
string |
billToAddress.line2 |
string |
billToAddress.line3 |
string |
billToAddress.line4 |
string |
billToAddress.city |
string |
billToAddress.stateProvince |
string |
billToAddress.postalCode |
string |
billToAddress.country |
string |
freightBillToContact |
object |
freightBillToContact.name |
string |
freightBillToContact.attention |
string |
freightBillToContact.phone |
string |
freightBillToAddress |
object |
freightBillToAddress.line1 |
string |
freightBillToAddress.line2 |
string |
freightBillToAddress.line3 |
string |
freightBillToAddress.line4 |
string |
freightBillToAddress.city |
string |
freightBillToAddress.stateProvince |
string |
freightBillToAddress.postalCode |
string |
freightBillToAddress.country |
string |
deliverToContact |
object |
deliverToContact.name |
string |
deliverToContact.attention |
string |
deliverToContact.phone |
string |
deliverToAddress |
object |
deliverToAddress.line1 |
string |
deliverToAddress.line2 |
string |
deliverToAddress.city |
string |
deliverToAddress.stateProvince |
string |
deliverToAddress.postalCode |
string |
deliverToAddress.country |
string |
tradingPartner |
object |
tradingPartner.id |
number |
tradingPartner.businessKey |
object |
tradingPartner.href |
string |
shipmentLines |
object |
shipmentLines.data |
objectarray |
shipmentLines.data.self |
object |
shipmentLines.data.self.id |
number |
shipmentLines.data.self.businessKey |
object |
shipmentLines.data.self.href |
string |
shipmentLines.data.businessUnit |
object |
shipmentLines.data.businessUnit.id |
number |
shipmentLines.data.businessUnit.businessKey |
object |
shipmentLines.data.businessUnit.href |
string |
shipmentLines.data.shipment |
object |
shipmentLines.data.shipment.id |
number |
shipmentLines.data.shipment.businessKey |
object |
shipmentLines.data.shipment.href |
string |
shipmentLines.data.number |
string |
shipmentLines.data.orderLine |
object |
shipmentLines.data.orderLine.id |
number |
shipmentLines.data.orderLine.businessKey |
object |
shipmentLines.data.orderLine.href |
string |
shipmentLines.data.orderLineDetails |
object |
shipmentLines.data.orderLineDetails.customerLineNumber |
string |
shipmentLines.data.orderLineDetails.pack |
object |
shipmentLines.data.orderLineDetails.pack.id |
number |
shipmentLines.data.orderLineDetails.pack.businessKey |
object |
shipmentLines.data.orderLineDetails.pack.href |
string |
shipmentLines.data.orderLineDetails.packDetails |
object |
shipmentLines.data.orderLineDetails.packDetails.type |
string |
shipmentLines.data.item |
object |
shipmentLines.data.item.id |
number |
shipmentLines.data.item.businessKey |
object |
shipmentLines.data.item.href |
string |
shipmentLines.data.substitutedItem |
object |
shipmentLines.data.substitutedItem.id |
number |
shipmentLines.data.substitutedItem.businessKey |
object |
shipmentLines.data.substitutedItem.href |
string |
shipmentLines.data.pack |
object |
shipmentLines.data.pack.id |
number |
shipmentLines.data.pack.businessKey |
object |
shipmentLines.data.pack.href |
string |
shipmentLines.data.packDetails |
object |
shipmentLines.data.packDetails.type |
string |
shipmentLines.data.description |
string |
shipmentLines.data.orderPackQuantity |
number |
shipmentLines.data.shippedPackQuantity |
number |
shipmentLines.data.damagedPackQuantity |
number |
shipmentLines.data.shippedDamagedPackQuantity |
number |
shipmentLines.data.returnedPackQuantity |
number |
shipmentLines.data.canceledPackQuantity |
number |
shipmentLines.data.shortagePackQuantity |
number |
shipmentLines.data.pickedPackQuantity |
number |
shipmentLines.data.packageCount |
number |
shipmentLines.data.pieceCount |
number |
shipmentLines.data.totalWeight |
object |
shipmentLines.data.totalWeight.value |
number |
shipmentLines.data.totalWeight.units |
string |
shipmentLines.data.chargeableWeight |
object |
shipmentLines.data.chargeableWeight.value |
number |
shipmentLines.data.chargeableWeight.units |
string |
shipmentLines.data.lotNumber |
string |
shipmentLines.data.bornOnDate |
string |
shipmentLines.data.expirationDate |
string |
shipmentLines.data.inventoryCondition |
string |
shipmentLines.data.inventoryAttribute1 |
string |
shipmentLines.data.inventoryAttribute2 |
string |
shipmentLines.data.unitCost |
number |
shipmentLines.data.freightCost |
number |
shipmentLines.data.taxCost |
number |
shipmentLines.data.hazmatFlag |
boolean |
shipmentLines.data.externalLineNumber |
string |
shipmentLines.data.importReference |
string |
shipmentLines.data.exportReference |
string |
shipmentLines.data.invoiced |
boolean |
shipmentLines.data.createdDate |
string |
shipmentLines.data.updatedDate |
string |
shipmentLines.data.createdBy |
object |
shipmentLines.data.createdBy.id |
number |
shipmentLines.data.createdBy.businessKey |
object |
shipmentLines.data.createdBy.href |
string |
shipmentLines.data.updatedBy |
object |
shipmentLines.data.updatedBy.id |
number |
shipmentLines.data.updatedBy.businessKey |
object |
shipmentLines.data.updatedBy.href |
string |
shipmentLines.data.receivedPackQuantity |
number |
shippedContainers |
object |
shippedContainers.data |
objectarray |
shippedContainers.data.self |
object |
shippedContainers.data.self.id |
number |
shippedContainers.data.self.businessKey |
object |
shippedContainers.data.self.href |
string |
shippedContainers.data.businessUnit |
object |
shippedContainers.data.businessUnit.id |
number |
shippedContainers.data.businessUnit.businessKey |
object |
shippedContainers.data.businessUnit.href |
string |
shippedContainers.data.lpnNumber |
string |
shippedContainers.data.status |
string |
shippedContainers.data.description |
string |
shippedContainers.data.dimensions |
object |
shippedContainers.data.dimensions.length |
object |
shippedContainers.data.dimensions.length.measurement |
number |
shippedContainers.data.dimensions.length.units |
string |
shippedContainers.data.dimensions.width |
object |
shippedContainers.data.dimensions.width.measurement |
number |
shippedContainers.data.dimensions.width.units |
string |
shippedContainers.data.dimensions.height |
object |
shippedContainers.data.dimensions.height.measurement |
number |
shippedContainers.data.dimensions.height.units |
string |
shippedContainers.data.weight |
object |
shippedContainers.data.weight.value |
number |
shippedContainers.data.weight.units |
string |
shippedContainers.data.masterLPNNumber |
string |
shippedContainers.data.shipment |
object |
shippedContainers.data.shipment.id |
number |
shippedContainers.data.shipment.businessKey |
object |
shippedContainers.data.shipment.href |
string |
shippedContainers.data.trackingNumber |
string |
shippedContainers.data.packageType |
string |
shippedContainers.data.shippingCost |
number |
shippedContainers.data.insuredValue |
number |
shippedContainers.data.shippedContainerLines |
objectarray |
shippedContainers.data.shippedContainerLines.self |
object |
shippedContainers.data.shippedContainerLines.self.id |
number |
shippedContainers.data.shippedContainerLines.self.businessKey |
object |
shippedContainers.data.shippedContainerLines.self.href |
string |
shippedContainers.data.shippedContainerLines.handlingUnit |
object |
shippedContainers.data.shippedContainerLines.handlingUnit.id |
number |
shippedContainers.data.shippedContainerLines.handlingUnit.businessKey |
object |
shippedContainers.data.shippedContainerLines.handlingUnit.href |
string |
shippedContainers.data.shippedContainerLines.item |
object |
shippedContainers.data.shippedContainerLines.item.id |
number |
shippedContainers.data.shippedContainerLines.item.businessKey |
object |
shippedContainers.data.shippedContainerLines.item.href |
string |
shippedContainers.data.shippedContainerLines.pack |
object |
shippedContainers.data.shippedContainerLines.pack.id |
number |
shippedContainers.data.shippedContainerLines.pack.businessKey |
object |
shippedContainers.data.shippedContainerLines.pack.href |
string |
shippedContainers.data.shippedContainerLines.packDetails |
object |
shippedContainers.data.shippedContainerLines.packDetails.type |
string |
shippedContainers.data.shippedContainerLines.shipmentLine |
object |
shippedContainers.data.shippedContainerLines.shipmentLine.id |
number |
shippedContainers.data.shippedContainerLines.shipmentLine.businessKey |
object |
shippedContainers.data.shippedContainerLines.shipmentLine.href |
string |
shippedContainers.data.shippedContainerLines.containerLinePackQuantity |
number |
shippedContainers.data.shippedContainerLines.lotNumber |
string |
shippedContainers.data.shippedContainerLines.lineSerialNumbers |
objectarray |
shippedContainers.data.shippedContainerLines.lineSerialNumbers.serialNumber |
string |
shippedContainers.data.shippedContainerLines.bornOnDate |
string |
shippedContainers.data.shippedContainerLines.expirationDate |
string |
shippedContainers.data.shippedContainerLines.referenceNumber1 |
string |
shippedContainers.data.shippedContainerLines.inventoryCondition |
string |
shippedContainers.data.shippedContainerLines.inventoryAttribute1 |
string |
shippedContainers.data.shippedContainerLines.inventoryAttribute2 |
string |
shippedContainers.data.createdDate |
string |
shippedContainers.data.updatedDate |
string |
shippedContainers.data.createdBy |
object |
shippedContainers.data.createdBy.id |
number |
shippedContainers.data.createdBy.businessKey |
object |
shippedContainers.data.createdBy.href |
string |
shippedContainers.data.updatedBy |
object |
shippedContainers.data.updatedBy.id |
number |
shippedContainers.data.updatedBy.businessKey |
object |
shippedContainers.data.updatedBy.href |
string |
Inbound transfer orders — Get a list of inbound transfer orders
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
orderPriority |
number |
orderSummary |
string |
orderSource |
string |
secondaryOrderSource |
string |
customerOrderNumber |
string |
relatedOrderNumber |
string |
partnerInvoiceNumber |
string |
consigneePartner |
object |
consigneePartner.id |
number |
consigneePartner.businessKey |
object |
consigneePartner.href |
string |
tradingPartnerSite |
object |
tradingPartnerSite.id |
number |
tradingPartnerSite.businessKey |
object |
tradingPartnerSite.href |
string |
shipToContact |
object |
shipToContact.attention |
string |
shipToContact.name |
string |
shipToContact.firstName |
string |
shipToContact.lastName |
string |
shipToContact.contactName |
string |
shipToContact.phone |
string |
shipToContact.email |
string |
shipToAddress |
object |
shipToAddress.line1 |
string |
shipToAddress.line2 |
string |
shipToAddress.line3 |
string |
shipToAddress.line4 |
string |
shipToAddress.city |
string |
shipToAddress.stateProvince |
string |
shipToAddress.postalCode |
string |
shipToAddress.country |
string |
billToContact |
object |
billToContact.name |
string |
billToContact.firstName |
string |
billToContact.lastName |
string |
billToContact.contactName |
string |
billToContact.attention |
string |
billToContact.phone |
string |
billToContact.email |
string |
billToAccountNumber |
string |
billToAddress |
object |
billToAddress.line1 |
string |
billToAddress.line2 |
string |
billToAddress.line3 |
string |
billToAddress.line4 |
string |
billToAddress.city |
string |
billToAddress.stateProvince |
string |
billToAddress.postalCode |
string |
billToAddress.country |
string |
shipFromContact |
object |
shipFromContact.name |
string |
shipFromContact.firstName |
string |
shipFromContact.lastName |
string |
shipFromContact.attention |
string |
shipFromContact.phone |
string |
shipFromContact.email |
string |
shipFromAddress |
object |
shipFromAddress.line1 |
string |
shipFromAddress.line2 |
string |
shipFromAddress.city |
string |
shipFromAddress.stateProvince |
string |
shipFromAddress.postalCode |
string |
shipFromAddress.country |
string |
placedDate |
string |
plannedArrivalDate |
string |
plannedReleaseDate |
string |
plannedShipDate |
string |
earliestShipDate |
string |
earliestDeliveryDate |
string |
cancelByArrivalDate |
string |
cancelByReleaseDate |
string |
cancelByShipDate |
string |
actualArrivalDate |
string |
actualReleaseDate |
string |
actualShipDate |
string |
priceList |
object |
priceList.id |
number |
priceList.businessKey |
object |
priceList.href |
string |
orderTotal |
number |
orderSubtotal |
number |
orderDiscountSubtotal |
number |
orderShippingTotal |
number |
orderShipTotal |
number |
taxable |
boolean |
orderTaxTotal |
number |
orderTaxableTotal |
number |
orderUntaxableTotal |
number |
shippingTaxTotal |
number |
shipVia |
string |
shipVendor |
string |
shipMethod |
string |
freightTermsType |
string |
freightBillToContact |
object |
freightBillToContact.name |
string |
freightBillToContact.firstName |
string |
freightBillToContact.lastName |
string |
freightBillToContact.attention |
string |
freightBillToContact.phone |
string |
freightBillToAccount |
string |
freightBillToAddress |
object |
freightBillToAddress.line1 |
string |
freightBillToAddress.line2 |
string |
freightBillToAddress.line3 |
string |
freightBillToAddress.line4 |
string |
freightBillToAddress.city |
string |
freightBillToAddress.stateProvince |
string |
freightBillToAddress.postalCode |
string |
freightBillToAddress.country |
string |
deliverToContact |
object |
deliverToContact.name |
string |
deliverToContact.attention |
string |
deliverToContact.phone |
string |
deliverToAddress |
object |
deliverToAddress.line1 |
string |
deliverToAddress.line2 |
string |
deliverToAddress.city |
string |
deliverToAddress.stateProvince |
string |
deliverToAddress.postalCode |
string |
deliverToAddress.country |
string |
weight |
object |
weight.weight |
number |
weight.units |
string |
returnRequired |
boolean |
returnShipVia |
string |
returnShipOption |
string |
deliveryConfirmation |
string |
insuranceRequired |
boolean |
homeDelivery |
boolean |
residential |
boolean |
saturdayDelivery |
boolean |
hubId |
string |
routingNumber |
string |
incotermsType |
string |
importType |
string |
importReference |
string |
exportReference |
string |
otherReferenceNumber2 |
string |
integrationSource |
object |
integrationSource.id |
number |
integrationSource.businessKey |
object |
integrationSource.href |
string |
sendASN |
string |
dropShip |
boolean |
pickWave |
object |
pickWave.id |
number |
pickWave.businessKey |
object |
pickWave.href |
string |
postReleaseState |
string |
entryName |
string |
entryPhone1 |
string |
saleConditionCode |
string |
seller |
string |
notificationCode1 |
string |
notificationCode2 |
string |
notificationCode3 |
string |
verbalConfirmationName |
string |
verbalConfirmationPhoneNumber |
string |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
customAttribute4 |
string |
customAttribute5 |
string |
customAttribute6 |
string |
customAttribute7 |
string |
customFields |
objectarray |
customFields.self |
object |
customFields.self.id |
number |
customFields.self.businessKey |
object |
customFields.self.href |
string |
customFields.name |
string |
customFields.value |
string |
customFields.type |
string |
customFields.item |
object |
customFields.item.id |
number |
customFields.item.businessKey |
object |
customFields.item.href |
string |
customFields.orderHeader |
object |
customFields.orderHeader.id |
number |
customFields.orderHeader.businessKey |
object |
customFields.orderHeader.href |
string |
customFields.orderLine |
object |
customFields.orderLine.id |
number |
customFields.orderLine.businessKey |
object |
customFields.orderLine.href |
string |
customFields.shipment |
object |
customFields.shipment.id |
number |
customFields.shipment.businessKey |
object |
customFields.shipment.href |
string |
customFields.createdDate |
string |
customFields.updatedDate |
string |
customFields.createdBy |
object |
customFields.createdBy.id |
number |
customFields.createdBy.businessKey |
object |
customFields.createdBy.href |
string |
customFields.updatedBy |
object |
customFields.updatedBy.id |
number |
customFields.updatedBy.businessKey |
object |
customFields.updatedBy.href |
string |
notes |
objectarray |
notes.self |
object |
notes.self.id |
number |
notes.self.businessKey |
object |
notes.self.href |
string |
notes.title |
string |
notes.body |
string |
notes.source |
string |
notes.priority |
string |
notes.orderHeader |
object |
notes.orderHeader.id |
number |
notes.orderHeader.businessKey |
object |
notes.orderHeader.href |
string |
notes.orderLine |
object |
notes.orderLine.id |
number |
notes.orderLine.businessKey |
object |
notes.orderLine.href |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.schedulerTask |
object |
channels.schedulerTask.id |
number |
channels.schedulerTask.businessKey |
object |
channels.schedulerTask.href |
string |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
type |
string |
orderStatus |
string |
shipToFacility |
object |
shipToFacility.id |
number |
shipToFacility.businessKey |
object |
shipToFacility.href |
string |
shipFromFacility |
object |
shipFromFacility.id |
number |
shipFromFacility.businessKey |
object |
shipFromFacility.href |
string |
otherReferenceNumber |
string |
customerOrderHeaders |
objectarray |
customerOrderHeaders.id |
number |
customerOrderHeaders.businessKey |
object |
customerOrderHeaders.href |
string |
orderLines |
object |
orderLines.data |
objectarray |
orderLines.data.self |
object |
orderLines.data.self.id |
number |
orderLines.data.self.businessKey |
object |
orderLines.data.self.href |
string |
orderLines.data.businessUnit |
object |
orderLines.data.businessUnit.id |
number |
orderLines.data.businessUnit.businessKey |
object |
orderLines.data.businessUnit.href |
string |
orderLines.data.lineNumber |
string |
orderLines.data.customerLineNumber |
string |
orderLines.data.relatedOrderLine |
object |
orderLines.data.relatedOrderLine.id |
number |
orderLines.data.relatedOrderLine.businessKey |
object |
orderLines.data.relatedOrderLine.href |
string |
orderLines.data.sortOrder |
number |
orderLines.data.orderHeader |
object |
orderLines.data.orderHeader.id |
number |
orderLines.data.orderHeader.businessKey |
object |
orderLines.data.orderHeader.href |
string |
orderLines.data.item |
object |
orderLines.data.item.id |
number |
orderLines.data.item.businessKey |
object |
orderLines.data.item.href |
string |
orderLines.data.pack |
object |
orderLines.data.pack.id |
number |
orderLines.data.pack.businessKey |
object |
orderLines.data.pack.href |
string |
orderLines.data.description |
string |
orderLines.data.orderPackQuantity |
number |
orderLines.data.canceledPackQuantity |
number |
orderLines.data.lotNumber |
string |
orderLines.data.bornOnDate |
string |
orderLines.data.expirationDate |
string |
orderLines.data.productCode |
string |
orderLines.data.inventoryCondition |
string |
orderLines.data.inventoryAttribute1 |
string |
orderLines.data.inventoryAttribute2 |
string |
orderLines.data.plannedShipDate |
string |
orderLines.data.plannedArrivalDate |
string |
orderLines.data.unitPrice |
number |
orderLines.data.unitCost |
number |
orderLines.data.priceCode |
string |
orderLines.data.lineTotal |
number |
orderLines.data.taxable |
boolean |
orderLines.data.taxCost |
number |
orderLines.data.taxableTotal |
number |
orderLines.data.untaxableTotal |
number |
orderLines.data.extendedTotal |
number |
orderLines.data.discountAmount |
number |
orderLines.data.shippingAmount |
number |
orderLines.data.weight |
object |
orderLines.data.weight.weight |
number |
orderLines.data.weight.units |
string |
orderLines.data.importReference |
string |
orderLines.data.exportReference |
string |
orderLines.data.customAttribute1 |
string |
orderLines.data.customAttribute2 |
string |
orderLines.data.customAttribute3 |
string |
orderLines.data.customFields |
objectarray |
orderLines.data.customFields.self |
object |
orderLines.data.customFields.self.id |
number |
orderLines.data.customFields.self.businessKey |
object |
orderLines.data.customFields.self.href |
string |
orderLines.data.customFields.name |
string |
orderLines.data.customFields.value |
string |
orderLines.data.customFields.type |
string |
orderLines.data.customFields.item |
object |
orderLines.data.customFields.item.id |
number |
orderLines.data.customFields.item.businessKey |
object |
orderLines.data.customFields.item.href |
string |
orderLines.data.customFields.orderHeader |
object |
orderLines.data.customFields.orderHeader.id |
number |
orderLines.data.customFields.orderHeader.businessKey |
object |
orderLines.data.customFields.orderHeader.href |
string |
orderLines.data.customFields.orderLine |
object |
orderLines.data.customFields.orderLine.id |
number |
orderLines.data.customFields.orderLine.businessKey |
object |
orderLines.data.customFields.orderLine.href |
string |
orderLines.data.customFields.shipment |
object |
orderLines.data.customFields.shipment.id |
number |
orderLines.data.customFields.shipment.businessKey |
object |
orderLines.data.customFields.shipment.href |
string |
orderLines.data.customFields.createdDate |
string |
orderLines.data.customFields.updatedDate |
string |
orderLines.data.customFields.createdBy |
object |
orderLines.data.customFields.createdBy.id |
number |
orderLines.data.customFields.createdBy.businessKey |
object |
orderLines.data.customFields.createdBy.href |
string |
orderLines.data.customFields.updatedBy |
object |
orderLines.data.customFields.updatedBy.id |
number |
orderLines.data.customFields.updatedBy.businessKey |
object |
orderLines.data.customFields.updatedBy.href |
string |
orderLines.data.notes |
objectarray |
orderLines.data.notes.self |
object |
orderLines.data.notes.self.id |
number |
orderLines.data.notes.self.businessKey |
object |
orderLines.data.notes.self.href |
string |
orderLines.data.notes.title |
string |
orderLines.data.notes.body |
string |
orderLines.data.notes.source |
string |
orderLines.data.notes.priority |
string |
orderLines.data.notes.orderHeader |
object |
orderLines.data.notes.orderHeader.id |
number |
orderLines.data.notes.orderHeader.businessKey |
object |
orderLines.data.notes.orderHeader.href |
string |
orderLines.data.notes.orderLine |
object |
orderLines.data.notes.orderLine.id |
number |
orderLines.data.notes.orderLine.businessKey |
object |
orderLines.data.notes.orderLine.href |
string |
orderLines.data.channels |
objectarray |
orderLines.data.channels.self |
object |
orderLines.data.channels.self.id |
number |
orderLines.data.channels.self.businessKey |
object |
orderLines.data.channels.self.href |
string |
orderLines.data.channels.integration |
object |
orderLines.data.channels.integration.id |
number |
orderLines.data.channels.integration.businessKey |
object |
orderLines.data.channels.integration.href |
string |
orderLines.data.channels.schedulerTask |
object |
orderLines.data.channels.schedulerTask.id |
number |
orderLines.data.channels.schedulerTask.businessKey |
object |
orderLines.data.channels.schedulerTask.href |
string |
orderLines.data.channels.ref1 |
string |
orderLines.data.channels.ref2 |
string |
orderLines.data.channels.ref3 |
string |
orderLines.data.channels.ref4 |
string |
orderLines.data.channels.ref5 |
string |
orderLines.data.channels.secRef1 |
string |
orderLines.data.channels.secRef2 |
string |
orderLines.data.channels.secRef3 |
string |
orderLines.data.channels.secRef4 |
string |
orderLines.data.channels.secRef5 |
string |
orderLines.data.channels.createdDate |
string |
orderLines.data.channels.updatedDate |
string |
orderLines.data.channels.createdBy |
object |
orderLines.data.channels.createdBy.id |
number |
orderLines.data.channels.createdBy.businessKey |
object |
orderLines.data.channels.createdBy.href |
string |
orderLines.data.channels.updatedBy |
object |
orderLines.data.channels.updatedBy.id |
number |
orderLines.data.channels.updatedBy.businessKey |
object |
orderLines.data.channels.updatedBy.href |
string |
orderLines.data.createdDate |
string |
orderLines.data.updatedDate |
string |
orderLines.data.createdBy |
object |
orderLines.data.createdBy.id |
number |
orderLines.data.createdBy.businessKey |
object |
orderLines.data.createdBy.href |
string |
orderLines.data.updatedBy |
object |
orderLines.data.updatedBy.id |
number |
orderLines.data.updatedBy.businessKey |
object |
orderLines.data.updatedBy.href |
string |
orderLines.data.orderLineStatus |
string |
orderLines.data.shipToFacility |
object |
orderLines.data.shipToFacility.id |
number |
orderLines.data.shipToFacility.businessKey |
object |
orderLines.data.shipToFacility.href |
string |
orderLines.data.coLine |
object |
orderLines.data.coLine.id |
number |
orderLines.data.coLine.businessKey |
object |
orderLines.data.coLine.href |
string |
orderLines.data.inboundLPN |
string |
orderLines.data.masterInboundLPN |
string |
orderLines.data.receivedPackQuantity |
number |
orderLines.data.receivedDamagedPackQuantity |
number |
orderLines.data.receiptLines |
object |
orderLines.data.receiptLines.data |
objectarray |
orderLines.data.receiptLines.data.self |
object |
orderLines.data.receiptLines.data.self.id |
number |
orderLines.data.receiptLines.data.self.businessKey |
object |
orderLines.data.receiptLines.data.self.href |
string |
orderLines.data.receiptLines.data.number |
string |
orderLines.data.receiptLines.data.status |
string |
orderLines.data.receiptLines.data.receivedItem |
object |
orderLines.data.receiptLines.data.receivedItem.id |
number |
orderLines.data.receiptLines.data.receivedItem.businessKey |
object |
orderLines.data.receiptLines.data.receivedItem.href |
string |
orderLines.data.receiptLines.data.receivedPack |
object |
orderLines.data.receiptLines.data.receivedPack.id |
number |
orderLines.data.receiptLines.data.receivedPack.businessKey |
object |
orderLines.data.receiptLines.data.receivedPack.href |
string |
orderLines.data.receiptLines.data.receivedPackQuantity |
number |
orderLines.data.receiptLines.data.destinationLocation |
object |
orderLines.data.receiptLines.data.destinationLocation.id |
number |
orderLines.data.receiptLines.data.destinationLocation.businessKey |
object |
orderLines.data.receiptLines.data.destinationLocation.href |
string |
orderLines.data.receiptLines.data.container |
object |
orderLines.data.receiptLines.data.container.id |
number |
orderLines.data.receiptLines.data.container.businessKey |
object |
orderLines.data.receiptLines.data.container.href |
string |
orderLines.data.receiptLines.data.masterLpnNumber |
string |
orderLines.data.receiptLines.data.unitPrice |
number |
orderLines.data.receiptLines.data.lotNumber |
string |
orderLines.data.receiptLines.data.serialNumber |
string |
orderLines.data.receiptLines.data.bornOnDate |
string |
orderLines.data.receiptLines.data.expirationDate |
string |
orderLines.data.receiptLines.data.inventoryCondition |
string |
orderLines.data.receiptLines.data.damaged |
boolean |
orderLines.data.receiptLines.data.receivedDamagedPackQuantity |
number |
orderLines.data.receiptLines.data.disposition |
string |
orderLines.data.receiptLines.data.catchWeight |
number |
orderLines.data.receiptLines.data.inventoryAttribute1 |
string |
orderLines.data.receiptLines.data.inventoryAttribute2 |
string |
orderLines.data.receiptLines.data.customAttribute1 |
string |
orderLines.data.receiptLines.data.customAttribute2 |
string |
orderLines.data.receiptLines.data.customAttribute3 |
string |
orderLines.data.receiptLines.data.importReference1 |
string |
orderLines.data.receiptLines.data.importReference2 |
string |
orderLines.data.receiptLines.data.exportReference1 |
string |
orderLines.data.receiptLines.data.exportReference2 |
string |
orderLines.data.receiptLines.data.otherReferenceNumber |
string |
orderLines.data.receiptLines.data.orderLine |
object |
orderLines.data.receiptLines.data.orderLine.id |
number |
orderLines.data.receiptLines.data.orderLine.businessKey |
object |
orderLines.data.receiptLines.data.orderLine.href |
string |
orderLines.data.receiptLines.data.channels |
objectarray |
orderLines.data.receiptLines.data.channels.self |
object |
orderLines.data.receiptLines.data.channels.self.id |
number |
orderLines.data.receiptLines.data.channels.self.businessKey |
object |
orderLines.data.receiptLines.data.channels.self.href |
string |
orderLines.data.receiptLines.data.channels.integration |
object |
orderLines.data.receiptLines.data.channels.integration.id |
number |
orderLines.data.receiptLines.data.channels.integration.businessKey |
object |
orderLines.data.receiptLines.data.channels.integration.href |
string |
orderLines.data.receiptLines.data.channels.schedulerTask |
object |
orderLines.data.receiptLines.data.channels.schedulerTask.id |
number |
orderLines.data.receiptLines.data.channels.schedulerTask.businessKey |
object |
orderLines.data.receiptLines.data.channels.schedulerTask.href |
string |
orderLines.data.receiptLines.data.channels.ref1 |
string |
orderLines.data.receiptLines.data.channels.ref2 |
string |
orderLines.data.receiptLines.data.channels.ref3 |
string |
orderLines.data.receiptLines.data.channels.ref4 |
string |
orderLines.data.receiptLines.data.channels.ref5 |
string |
orderLines.data.receiptLines.data.channels.secRef1 |
string |
orderLines.data.receiptLines.data.channels.secRef2 |
string |
orderLines.data.receiptLines.data.channels.secRef3 |
string |
orderLines.data.receiptLines.data.channels.secRef4 |
string |
orderLines.data.receiptLines.data.channels.secRef5 |
string |
orderLines.data.receiptLines.data.channels.createdDate |
string |
orderLines.data.receiptLines.data.channels.updatedDate |
string |
orderLines.data.receiptLines.data.channels.createdBy |
object |
orderLines.data.receiptLines.data.channels.createdBy.id |
number |
orderLines.data.receiptLines.data.channels.createdBy.businessKey |
object |
orderLines.data.receiptLines.data.channels.createdBy.href |
string |
orderLines.data.receiptLines.data.channels.updatedBy |
object |
orderLines.data.receiptLines.data.channels.updatedBy.id |
number |
orderLines.data.receiptLines.data.channels.updatedBy.businessKey |
object |
orderLines.data.receiptLines.data.channels.updatedBy.href |
string |
orderLines.data.receiptLines.data.createdDate |
string |
orderLines.data.receiptLines.data.updatedDate |
string |
orderLines.data.receiptLines.data.createdBy |
object |
orderLines.data.receiptLines.data.createdBy.id |
number |
orderLines.data.receiptLines.data.createdBy.businessKey |
object |
orderLines.data.receiptLines.data.createdBy.href |
string |
orderLines.data.receiptLines.data.updatedBy |
object |
orderLines.data.receiptLines.data.updatedBy.id |
number |
orderLines.data.receiptLines.data.updatedBy.businessKey |
object |
orderLines.data.receiptLines.data.updatedBy.href |
string |
orderLine |
object |
orderLine.id |
number |
orderLine.businessKey |
object |
orderLine.href |
string |
canceledPackQuantity |
number |
lineNumber |
string |
customerLineNumber |
string |
relatedOrderLine |
object |
relatedOrderLine.id |
number |
relatedOrderLine.businessKey |
object |
relatedOrderLine.href |
string |
sortOrder |
number |
orderHeader |
object |
orderHeader.id |
number |
orderHeader.businessKey |
object |
orderHeader.href |
string |
item |
object |
item.id |
number |
item.businessKey |
object |
item.href |
string |
pack |
object |
pack.id |
number |
pack.businessKey |
object |
pack.href |
string |
description |
string |
orderPackQuantity |
number |
canceledPackQuantity |
number |
lotNumber |
string |
bornOnDate |
string |
expirationDate |
string |
productCode |
string |
inventoryCondition |
string |
inventoryAttribute1 |
string |
inventoryAttribute2 |
string |
unitPrice |
number |
unitCost |
number |
priceCode |
string |
lineTotal |
number |
taxCost |
number |
taxableTotal |
number |
untaxableTotal |
number |
extendedTotal |
number |
discountAmount |
number |
shippingAmount |
number |
orderLineStatus |
string |
coLine |
object |
coLine.id |
number |
coLine.businessKey |
object |
coLine.href |
string |
inboundLPN |
string |
masterInboundLPN |
string |
receivedPackQuantity |
number |
receivedDamagedPackQuantity |
number |
receiptLines |
object |
receiptLines.data |
objectarray |
receiptLines.data.self |
object |
receiptLines.data.self.id |
number |
receiptLines.data.self.businessKey |
object |
receiptLines.data.self.href |
string |
receiptLines.data.number |
string |
receiptLines.data.status |
string |
receiptLines.data.receivedItem |
object |
receiptLines.data.receivedItem.id |
number |
receiptLines.data.receivedItem.businessKey |
object |
receiptLines.data.receivedItem.href |
string |
receiptLines.data.receivedPack |
object |
receiptLines.data.receivedPack.id |
number |
receiptLines.data.receivedPack.businessKey |
object |
receiptLines.data.receivedPack.href |
string |
receiptLines.data.receivedPackQuantity |
number |
receiptLines.data.destinationLocation |
object |
receiptLines.data.destinationLocation.id |
number |
receiptLines.data.destinationLocation.businessKey |
object |
receiptLines.data.destinationLocation.href |
string |
receiptLines.data.container |
object |
receiptLines.data.container.id |
number |
receiptLines.data.container.businessKey |
object |
receiptLines.data.container.href |
string |
receiptLines.data.masterLpnNumber |
string |
receiptLines.data.unitPrice |
number |
receiptLines.data.lotNumber |
string |
receiptLines.data.serialNumber |
string |
receiptLines.data.bornOnDate |
string |
receiptLines.data.expirationDate |
string |
receiptLines.data.inventoryCondition |
string |
receiptLines.data.damaged |
boolean |
receiptLines.data.receivedDamagedPackQuantity |
number |
receiptLines.data.disposition |
string |
receiptLines.data.catchWeight |
number |
receiptLines.data.inventoryAttribute1 |
string |
receiptLines.data.inventoryAttribute2 |
string |
receiptLines.data.customAttribute1 |
string |
receiptLines.data.customAttribute2 |
string |
receiptLines.data.customAttribute3 |
string |
receiptLines.data.importReference1 |
string |
receiptLines.data.importReference2 |
string |
receiptLines.data.exportReference1 |
string |
receiptLines.data.exportReference2 |
string |
receiptLines.data.otherReferenceNumber |
string |
receiptLines.data.orderLine |
object |
receiptLines.data.orderLine.id |
number |
receiptLines.data.orderLine.businessKey |
object |
receiptLines.data.orderLine.href |
string |
receiptLines.data.channels |
objectarray |
receiptLines.data.channels.self |
object |
receiptLines.data.channels.self.id |
number |
receiptLines.data.channels.self.businessKey |
object |
receiptLines.data.channels.self.href |
string |
receiptLines.data.channels.integration |
object |
receiptLines.data.channels.integration.id |
number |
receiptLines.data.channels.integration.businessKey |
object |
receiptLines.data.channels.integration.href |
string |
receiptLines.data.channels.schedulerTask |
object |
receiptLines.data.channels.schedulerTask.id |
number |
receiptLines.data.channels.schedulerTask.businessKey |
object |
receiptLines.data.channels.schedulerTask.href |
string |
receiptLines.data.channels.ref1 |
string |
receiptLines.data.channels.ref2 |
string |
receiptLines.data.channels.ref3 |
string |
receiptLines.data.channels.ref4 |
string |
receiptLines.data.channels.ref5 |
string |
receiptLines.data.channels.secRef1 |
string |
receiptLines.data.channels.secRef2 |
string |
receiptLines.data.channels.secRef3 |
string |
receiptLines.data.channels.secRef4 |
string |
receiptLines.data.channels.secRef5 |
string |
receiptLines.data.channels.createdDate |
string |
receiptLines.data.channels.updatedDate |
string |
receiptLines.data.channels.createdBy |
object |
receiptLines.data.channels.createdBy.id |
number |
receiptLines.data.channels.createdBy.businessKey |
object |
receiptLines.data.channels.createdBy.href |
string |
receiptLines.data.channels.updatedBy |
object |
receiptLines.data.channels.updatedBy.id |
number |
receiptLines.data.channels.updatedBy.businessKey |
object |
receiptLines.data.channels.updatedBy.href |
string |
receiptLines.data.createdDate |
string |
receiptLines.data.updatedDate |
string |
receiptLines.data.createdBy |
object |
receiptLines.data.createdBy.id |
number |
receiptLines.data.createdBy.businessKey |
object |
receiptLines.data.createdBy.href |
string |
receiptLines.data.updatedBy |
object |
receiptLines.data.updatedBy.id |
number |
receiptLines.data.updatedBy.businessKey |
object |
receiptLines.data.updatedBy.href |
string |
Items — Get a list of items
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
name |
string |
packs |
objectarray |
packs.self |
object |
packs.self.id |
number |
packs.self.businessKey |
object |
packs.self.href |
string |
packs.businessUnit |
object |
packs.businessUnit.id |
number |
packs.businessUnit.businessKey |
object |
packs.businessUnit.href |
string |
packs.item |
object |
packs.item.id |
number |
packs.item.businessKey |
object |
packs.item.href |
string |
packs.type |
string |
packs.quantity |
number |
packs.key |
string |
packs.name |
string |
packs.newPackFlag |
boolean |
packs.dimensions |
object |
packs.dimensions.length |
object |
packs.dimensions.length.measurement |
number |
packs.dimensions.length.units |
string |
packs.dimensions.width |
object |
packs.dimensions.width.measurement |
number |
packs.dimensions.width.units |
string |
packs.dimensions.height |
object |
packs.dimensions.height.measurement |
number |
packs.dimensions.height.units |
string |
packs.dimensions.volume |
object |
packs.dimensions.volume.measurement |
number |
packs.dimensions.volume.units |
string |
packs.weight |
object |
packs.weight.weight |
number |
packs.weight.units |
string |
packs.cartonGroup |
string |
packs.preferredCartonType |
object |
packs.preferredCartonType.id |
number |
packs.preferredCartonType.businessKey |
object |
packs.preferredCartonType.href |
string |
packs.readyToShip |
boolean |
packs.lpnTrackingEnabled |
boolean |
packs.upcs |
object |
packs.upcs.data |
objectarray |
packs.upcs.data.self |
object |
packs.upcs.data.self.id |
number |
packs.upcs.data.self.businessKey |
object |
packs.upcs.data.self.href |
string |
packs.upcs.data.pack |
object |
packs.upcs.data.pack.id |
number |
packs.upcs.data.pack.businessKey |
object |
packs.upcs.data.pack.href |
string |
packs.upcs.data.value |
string |
packs.carrierSpecialServices |
objectarray |
packs.carrierSpecialServices.self |
object |
packs.carrierSpecialServices.self.id |
number |
packs.carrierSpecialServices.self.businessKey |
object |
packs.carrierSpecialServices.self.href |
string |
packs.carrierSpecialServices.shipVendor |
string |
packs.carrierSpecialServices.item |
object |
packs.carrierSpecialServices.item.id |
number |
packs.carrierSpecialServices.item.businessKey |
object |
packs.carrierSpecialServices.item.href |
string |
packs.carrierSpecialServices.pack |
object |
packs.carrierSpecialServices.pack.id |
number |
packs.carrierSpecialServices.pack.businessKey |
object |
packs.carrierSpecialServices.pack.href |
string |
packs.carrierSpecialServices.salesOrder |
object |
packs.carrierSpecialServices.salesOrder.id |
number |
packs.carrierSpecialServices.salesOrder.businessKey |
object |
packs.carrierSpecialServices.salesOrder.href |
string |
packs.carrierSpecialServices.orderLine |
object |
packs.carrierSpecialServices.orderLine.id |
number |
packs.carrierSpecialServices.orderLine.businessKey |
object |
packs.carrierSpecialServices.orderLine.href |
string |
packs.carrierSpecialServices.customerOrder |
object |
packs.carrierSpecialServices.customerOrder.id |
number |
packs.carrierSpecialServices.customerOrder.businessKey |
object |
packs.carrierSpecialServices.customerOrder.href |
string |
packs.carrierSpecialServices.customerOrderLine |
object |
packs.carrierSpecialServices.customerOrderLine.id |
number |
packs.carrierSpecialServices.customerOrderLine.businessKey |
object |
packs.carrierSpecialServices.customerOrderLine.href |
string |
packs.carrierSpecialServices.battery |
boolean |
packs.carrierSpecialServices.batteryMaterial |
string |
packs.carrierSpecialServices.batteryPacking |
string |
packs.carrierSpecialServices.batteryRegulation |
string |
packs.carrierSpecialServices.chemicalIdentifier |
string |
packs.carrierSpecialServices.commodityRegulations |
string |
packs.carrierSpecialServices.dangerousGoodsAmount |
number |
packs.carrierSpecialServices.dangerousGoodsUOM |
string |
packs.carrierSpecialServices.hazardClass |
number |
packs.carrierSpecialServices.extendedHazardClass |
string |
packs.carrierSpecialServices.hazardLabelDescription |
string |
packs.carrierSpecialServices.hazmatExceptedQuantity |
string |
packs.carrierSpecialServices.hazmatLimitedQuantity |
string |
packs.carrierSpecialServices.limitedQtyPackingInstructions |
string |
packs.carrierSpecialServices.packagingGroupType |
string |
packs.carrierSpecialServices.packagingType |
string |
packs.carrierSpecialServices.packingInstructions |
string |
packs.carrierSpecialServices.properShippingName |
string |
packs.carrierSpecialServices.regulationSet |
string |
packs.carrierSpecialServices.subRiskClass1 |
string |
packs.carrierSpecialServices.subRiskClass2 |
string |
packs.carrierSpecialServices.subRiskClass3 |
string |
packs.carrierSpecialServices.technicalName |
string |
packs.carrierSpecialServices.transportationMode |
string |
packs.carrierSpecialServices.unNumber |
string |
packs.carrierSpecialServices.shipsWithDryIce |
boolean |
packs.carrierSpecialServices.medicalUse |
boolean |
packs.carrierSpecialServices.alcohol |
boolean |
packs.carrierSpecialServices.holdAtLocation |
boolean |
packs.carrierSpecialServices.returnReceiptRequested |
boolean |
packs.carrierSpecialServices.saturdayDelivery |
boolean |
packs.carrierSpecialServices.liftgateDelivery |
boolean |
packs.carrierSpecialServices.appointmentDelivery |
boolean |
packs.carrierSpecialServices.accessible |
boolean |
packs.carrierSpecialServices.cargoAircraft |
boolean |
packs.carrierSpecialServices.exportComplianceStatement |
string |
packs.carrierSpecialServices.createdDate |
string |
packs.carrierSpecialServices.updatedDate |
string |
packs.carrierSpecialServices.createdBy |
object |
packs.carrierSpecialServices.createdBy.id |
number |
packs.carrierSpecialServices.createdBy.businessKey |
object |
packs.carrierSpecialServices.createdBy.href |
string |
packs.carrierSpecialServices.updatedBy |
object |
packs.carrierSpecialServices.updatedBy.id |
number |
packs.carrierSpecialServices.updatedBy.businessKey |
object |
packs.carrierSpecialServices.updatedBy.href |
string |
packs.createdDate |
string |
packs.updatedDate |
string |
packs.createdBy |
object |
packs.createdBy.id |
number |
packs.createdBy.businessKey |
object |
packs.createdBy.href |
string |
packs.updatedBy |
object |
packs.updatedBy.id |
number |
packs.updatedBy.businessKey |
object |
packs.updatedBy.href |
string |
upcs |
object |
upcs.data |
objectarray |
upcs.data.self |
object |
upcs.data.self.id |
number |
upcs.data.self.businessKey |
object |
upcs.data.self.href |
string |
upcs.data.item |
object |
upcs.data.item.id |
number |
upcs.data.item.businessKey |
object |
upcs.data.item.href |
string |
upcs.data.value |
string |
shortDescription |
string |
longDescription |
string |
itemType |
string |
intangibleItemFlag |
boolean |
externalImageUrl |
string |
productCategory |
object |
productCategory.id |
number |
productCategory.businessKey |
object |
productCategory.href |
string |
abcCategory |
string |
brandName |
string |
productCode |
string |
colorCode |
string |
colorName |
string |
size |
string |
styleName |
string |
styleNumber |
string |
hazmat |
boolean |
hazmatCode |
string |
inspectionRequired |
boolean |
unitPrice |
number |
purchaseCost |
number |
taxable |
boolean |
lotTrackingEnabled |
boolean |
serialTrackingEnabled |
boolean |
bornOnDateRequired |
boolean |
expirationDateRequired |
boolean |
serialCapturePoint |
string |
inventoryTrackingEnabled |
boolean |
shippable |
boolean |
salesEnabledFlag |
boolean |
cycleCount |
boolean |
cycleCountFrequency |
number |
receiveOverTolerance |
number |
reorderPoint |
number |
reorderQuantity |
number |
tradingPartner |
object |
tradingPartner.id |
number |
tradingPartner.businessKey |
object |
tradingPartner.href |
string |
itemVendors |
object |
itemVendors.data |
objectarray |
itemVendors.data.self |
object |
itemVendors.data.self.id |
number |
itemVendors.data.self.businessKey |
object |
itemVendors.data.self.href |
string |
itemVendors.data.item |
object |
itemVendors.data.item.id |
number |
itemVendors.data.item.businessKey |
object |
itemVendors.data.item.href |
string |
itemVendors.data.tradingPartner |
object |
itemVendors.data.tradingPartner.id |
number |
itemVendors.data.tradingPartner.businessKey |
object |
itemVendors.data.tradingPartner.href |
string |
itemVendors.data.itemSkuUpc |
string |
itemVendors.data.unitCost |
number |
itemVendors.data.shortDescription |
string |
itemVendors.data.longDescription |
string |
itemVendors.data.isPreferred |
boolean |
itemVendors.data.fulfillmentType |
string |
itemVendors.data.reorderPoint |
number |
itemVendors.data.reorderQuantity |
number |
itemVendors.data.quantity |
number |
itemVendors.data.importReference1 |
string |
itemVendors.data.importReference2 |
string |
itemVendors.data.exportReference1 |
string |
itemVendors.data.exportReference2 |
string |
itemVendors.data.createdDate |
string |
itemVendors.data.updatedDate |
string |
itemVendors.data.createdBy |
object |
itemVendors.data.createdBy.id |
number |
itemVendors.data.createdBy.businessKey |
object |
itemVendors.data.createdBy.href |
string |
itemVendors.data.updatedBy |
object |
itemVendors.data.updatedBy.id |
number |
itemVendors.data.updatedBy.businessKey |
object |
itemVendors.data.updatedBy.href |
string |
components |
objectarray |
components.self |
object |
components.self.id |
number |
components.self.businessKey |
object |
components.self.href |
string |
components.quantity |
number |
components.item |
object |
components.item.id |
number |
components.item.businessKey |
object |
components.item.href |
string |
components.subComponent |
object |
components.subComponent.id |
number |
components.subComponent.businessKey |
object |
components.subComponent.href |
string |
components.sequence |
number |
components.createdDate |
string |
components.updatedDate |
string |
components.createdBy |
object |
components.createdBy.id |
number |
components.createdBy.businessKey |
object |
components.createdBy.href |
string |
components.updatedBy |
object |
components.updatedBy.id |
number |
components.updatedBy.businessKey |
object |
components.updatedBy.href |
string |
kitOrderOnly |
boolean |
kitStockOnly |
boolean |
hsCodes |
object |
hsCodes.data |
objectarray |
hsCodes.data.self |
object |
hsCodes.data.self.id |
number |
hsCodes.data.self.businessKey |
object |
hsCodes.data.self.href |
string |
hsCodes.data.item |
object |
hsCodes.data.item.id |
number |
hsCodes.data.item.businessKey |
object |
hsCodes.data.item.href |
string |
hsCodes.data.productCategory |
object |
hsCodes.data.productCategory.id |
number |
hsCodes.data.productCategory.businessKey |
object |
hsCodes.data.productCategory.href |
string |
hsCodes.data.country |
object |
hsCodes.data.country.id |
number |
hsCodes.data.country.businessKey |
object |
hsCodes.data.country.href |
string |
hsCodes.data.code |
string |
hsCodes.data.createdDate |
string |
hsCodes.data.updatedDate |
string |
hsCodes.data.createdBy |
object |
hsCodes.data.createdBy.id |
number |
hsCodes.data.createdBy.businessKey |
object |
hsCodes.data.createdBy.href |
string |
hsCodes.data.updatedBy |
object |
hsCodes.data.updatedBy.id |
number |
hsCodes.data.updatedBy.businessKey |
object |
hsCodes.data.updatedBy.href |
string |
originCountry |
string |
classType |
string |
nmfcNumber |
string |
transportationClass |
string |
weight |
object |
weight.weight |
number |
weight.units |
string |
carrierSpecialServices |
objectarray |
carrierSpecialServices.self |
object |
carrierSpecialServices.self.id |
number |
carrierSpecialServices.self.businessKey |
object |
carrierSpecialServices.self.href |
string |
carrierSpecialServices.shipVendor |
string |
carrierSpecialServices.item |
object |
carrierSpecialServices.item.id |
number |
carrierSpecialServices.item.businessKey |
object |
carrierSpecialServices.item.href |
string |
carrierSpecialServices.pack |
object |
carrierSpecialServices.pack.id |
number |
carrierSpecialServices.pack.businessKey |
object |
carrierSpecialServices.pack.href |
string |
carrierSpecialServices.salesOrder |
object |
carrierSpecialServices.salesOrder.id |
number |
carrierSpecialServices.salesOrder.businessKey |
object |
carrierSpecialServices.salesOrder.href |
string |
carrierSpecialServices.orderLine |
object |
carrierSpecialServices.orderLine.id |
number |
carrierSpecialServices.orderLine.businessKey |
object |
carrierSpecialServices.orderLine.href |
string |
carrierSpecialServices.customerOrder |
object |
carrierSpecialServices.customerOrder.id |
number |
carrierSpecialServices.customerOrder.businessKey |
object |
carrierSpecialServices.customerOrder.href |
string |
carrierSpecialServices.customerOrderLine |
object |
carrierSpecialServices.customerOrderLine.id |
number |
carrierSpecialServices.customerOrderLine.businessKey |
object |
carrierSpecialServices.customerOrderLine.href |
string |
carrierSpecialServices.battery |
boolean |
carrierSpecialServices.batteryMaterial |
string |
carrierSpecialServices.batteryPacking |
string |
carrierSpecialServices.batteryRegulation |
string |
carrierSpecialServices.chemicalIdentifier |
string |
carrierSpecialServices.commodityRegulations |
string |
carrierSpecialServices.dangerousGoodsAmount |
number |
carrierSpecialServices.dangerousGoodsUOM |
string |
carrierSpecialServices.hazardClass |
number |
carrierSpecialServices.extendedHazardClass |
string |
carrierSpecialServices.hazardLabelDescription |
string |
carrierSpecialServices.hazmatExceptedQuantity |
string |
carrierSpecialServices.hazmatLimitedQuantity |
string |
carrierSpecialServices.limitedQtyPackingInstructions |
string |
carrierSpecialServices.packagingGroupType |
string |
carrierSpecialServices.packagingType |
string |
carrierSpecialServices.packingInstructions |
string |
carrierSpecialServices.properShippingName |
string |
carrierSpecialServices.regulationSet |
string |
carrierSpecialServices.subRiskClass1 |
string |
carrierSpecialServices.subRiskClass2 |
string |
carrierSpecialServices.subRiskClass3 |
string |
carrierSpecialServices.technicalName |
string |
carrierSpecialServices.transportationMode |
string |
carrierSpecialServices.unNumber |
string |
carrierSpecialServices.shipsWithDryIce |
boolean |
carrierSpecialServices.medicalUse |
boolean |
carrierSpecialServices.alcohol |
boolean |
carrierSpecialServices.holdAtLocation |
boolean |
carrierSpecialServices.returnReceiptRequested |
boolean |
carrierSpecialServices.saturdayDelivery |
boolean |
carrierSpecialServices.liftgateDelivery |
boolean |
carrierSpecialServices.appointmentDelivery |
boolean |
carrierSpecialServices.accessible |
boolean |
carrierSpecialServices.cargoAircraft |
boolean |
carrierSpecialServices.exportComplianceStatement |
string |
carrierSpecialServices.createdDate |
string |
carrierSpecialServices.updatedDate |
string |
carrierSpecialServices.createdBy |
object |
carrierSpecialServices.createdBy.id |
number |
carrierSpecialServices.createdBy.businessKey |
object |
carrierSpecialServices.createdBy.href |
string |
carrierSpecialServices.updatedBy |
object |
carrierSpecialServices.updatedBy.id |
number |
carrierSpecialServices.updatedBy.businessKey |
object |
carrierSpecialServices.updatedBy.href |
string |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
customAttribute4 |
string |
customAttribute5 |
string |
customFields |
objectarray |
customFields.self |
object |
customFields.self.id |
number |
customFields.self.businessKey |
object |
customFields.self.href |
string |
customFields.name |
string |
customFields.value |
string |
customFields.type |
string |
customFields.item |
object |
customFields.item.id |
number |
customFields.item.businessKey |
object |
customFields.item.href |
string |
customFields.orderHeader |
object |
customFields.orderHeader.id |
number |
customFields.orderHeader.businessKey |
object |
customFields.orderHeader.href |
string |
customFields.orderLine |
object |
customFields.orderLine.id |
number |
customFields.orderLine.businessKey |
object |
customFields.orderLine.href |
string |
customFields.shipment |
object |
customFields.shipment.id |
number |
customFields.shipment.businessKey |
object |
customFields.shipment.href |
string |
customFields.createdDate |
string |
customFields.updatedDate |
string |
customFields.createdBy |
object |
customFields.createdBy.id |
number |
customFields.createdBy.businessKey |
object |
customFields.createdBy.href |
string |
customFields.updatedBy |
object |
customFields.updatedBy.id |
number |
customFields.updatedBy.businessKey |
object |
customFields.updatedBy.href |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.item |
object |
channels.item.id |
number |
channels.item.businessKey |
object |
channels.item.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.listingStatus |
string |
channels.packQuantity |
number |
channels.description |
string |
channels.listingPrice |
number |
channels.itemCondition |
string |
channels.saleable |
boolean |
channels.syncInventory |
boolean |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
accountingType |
string |
defaultLedgerAccount |
string |
cogsAccount |
string |
planItems |
object |
planItems.data |
objectarray |
planItems.data.self |
object |
planItems.data.self.id |
number |
planItems.data.self.businessKey |
object |
planItems.data.self.href |
string |
planItems.data.businessUnit |
object |
planItems.data.businessUnit.id |
number |
planItems.data.businessUnit.businessKey |
object |
planItems.data.businessUnit.href |
string |
planItems.data.item |
object |
planItems.data.item.id |
number |
planItems.data.item.businessKey |
object |
planItems.data.item.href |
string |
planItems.data.facility |
object |
planItems.data.facility.id |
number |
planItems.data.facility.businessKey |
object |
planItems.data.facility.href |
string |
planItems.data.replenishmentMethod |
string |
planItems.data.serviceLevel |
number |
planItems.data.autoServiceLevel |
boolean |
planItems.data.calculatedServiceLevel |
number |
planItems.data.safetyStock |
number |
planItems.data.autoPreferredSafetyStock |
boolean |
planItems.data.calculatedSafetyStock |
number |
planItems.data.timePhasedSafetyStock |
number |
planItems.data.autoReorderLeadTime |
boolean |
planItems.data.autoOrderCycle |
boolean |
planItems.data.reorderPoint |
number |
planItems.data.autoReorderPoint |
boolean |
planItems.data.economicOrderQty |
number |
planItems.data.kitComponentOnly |
boolean |
planItems.data.newProductIntroduction |
boolean |
planItems.data.alternateSource |
object |
planItems.data.alternateSource.id |
number |
planItems.data.alternateSource.businessKey |
object |
planItems.data.alternateSource.href |
string |
planItems.data.alternateSourceFactor |
number |
planItems.data.baselineLevel |
number |
planItems.data.maxInventory |
number |
planItems.data.timePhasedMaxInventory |
string |
planItems.data.abcVelocityCode |
string |
planItems.data.inventoryHealth |
string |
planItems.data.projectedStockOutDays |
number |
planItems.data.daysOfSupply |
number |
planItems.data.minTransferQty |
number |
planItems.data.maxTransferQty |
number |
planItems.data.transferableQty |
number |
planItems.data.planItemSupplier |
objectarray |
planItems.data.planItemSupplier.self |
object |
planItems.data.planItemSupplier.self.id |
number |
planItems.data.planItemSupplier.self.businessKey |
object |
planItems.data.planItemSupplier.self.href |
string |
planItems.data.planItemSupplier.businessUnit |
object |
planItems.data.planItemSupplier.businessUnit.id |
number |
planItems.data.planItemSupplier.businessUnit.businessKey |
object |
planItems.data.planItemSupplier.businessUnit.href |
string |
planItems.data.planItemSupplier.planItem |
object |
planItems.data.planItemSupplier.planItem.id |
number |
planItems.data.planItemSupplier.planItem.businessKey |
object |
planItems.data.planItemSupplier.planItem.href |
string |
planItems.data.planItemSupplier.tradingPartner |
object |
planItems.data.planItemSupplier.tradingPartner.id |
number |
planItems.data.planItemSupplier.tradingPartner.businessKey |
object |
planItems.data.planItemSupplier.tradingPartner.href |
string |
planItems.data.planItemSupplier.preferred |
boolean |
planItems.data.planItemSupplier.parentFacility |
object |
planItems.data.planItemSupplier.parentFacility.id |
number |
planItems.data.planItemSupplier.parentFacility.businessKey |
object |
planItems.data.planItemSupplier.parentFacility.href |
string |
planItems.data.planItemSupplier.reorderLeadTime |
number |
planItems.data.planItemSupplier.calculatedReorderLeadTime |
number |
planItems.data.planItemSupplier.minVendorOrderQty |
number |
planItems.data.planItemSupplier.orderCycle |
number |
planItems.data.planItemSupplier.calculatedOrderCycle |
number |
planItems.data.planItemSupplier.preferredPack |
object |
planItems.data.planItemSupplier.preferredPack.id |
number |
planItems.data.planItemSupplier.preferredPack.businessKey |
object |
planItems.data.planItemSupplier.preferredPack.href |
string |
planItems.data.planItemSupplier.rounding |
number |
planItems.data.planItemSupplier.createdDate |
string |
planItems.data.planItemSupplier.updatedDate |
string |
planItems.data.planItemSupplier.createdBy |
object |
planItems.data.planItemSupplier.createdBy.id |
number |
planItems.data.planItemSupplier.createdBy.businessKey |
object |
planItems.data.planItemSupplier.createdBy.href |
string |
planItems.data.planItemSupplier.updatedBy |
object |
planItems.data.planItemSupplier.updatedBy.id |
number |
planItems.data.planItemSupplier.updatedBy.businessKey |
object |
planItems.data.planItemSupplier.updatedBy.href |
string |
planItems.data.createdDate |
string |
planItems.data.updatedDate |
string |
planItems.data.createdBy |
object |
planItems.data.createdBy.id |
number |
planItems.data.createdBy.businessKey |
object |
planItems.data.createdBy.href |
string |
planItems.data.updatedBy |
object |
planItems.data.updatedBy.id |
number |
planItems.data.updatedBy.businessKey |
object |
planItems.data.updatedBy.href |
string |
planItemRefs |
object |
planItemRefs.data |
objectarray |
planItemRefs.data.id |
number |
planItemRefs.data.businessKey |
object |
planItemRefs.data.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Outbound shipments — Get a list of outbound shipments
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
orderHeaders |
object |
orderHeaders.data |
objectarray |
orderHeaders.data.id |
number |
orderHeaders.data.businessKey |
object |
orderHeaders.data.href |
string |
shipVia |
string |
shipMethod |
string |
shipVendor |
string |
trackingNumber |
string |
trackingUrl |
string |
routingNumber |
string |
shipFromZone |
object |
shipFromZone.id |
number |
shipFromZone.businessKey |
object |
shipFromZone.href |
string |
consigneePartner |
object |
consigneePartner.id |
number |
consigneePartner.businessKey |
object |
consigneePartner.href |
string |
billToAccountNumber |
string |
billToPartner |
object |
billToPartner.id |
number |
billToPartner.businessKey |
object |
billToPartner.href |
string |
freightBillToPartner |
object |
freightBillToPartner.id |
number |
freightBillToPartner.businessKey |
object |
freightBillToPartner.href |
string |
freightBillToAccount |
string |
shipToFacility |
object |
shipToFacility.id |
number |
shipToFacility.businessKey |
object |
shipToFacility.href |
string |
shipFromFacility |
object |
shipFromFacility.id |
number |
shipFromFacility.businessKey |
object |
shipFromFacility.href |
string |
shipmentDates |
object |
shipmentDates.plannedShipDate |
string |
shipmentDates.plannedArrivalDate |
string |
shipmentDates.actualShipDate |
string |
shipmentDates.actualArrivalDate |
string |
shipmentDates.requestedDeliveryDate |
string |
totalWeight |
object |
totalWeight.value |
number |
totalWeight.units |
string |
chargeableWeight |
object |
chargeableWeight.value |
number |
chargeableWeight.units |
string |
totalCube |
object |
totalCube.measurement |
number |
totalCube.units |
string |
lpnNumber |
string |
containerType |
string |
totalPieces |
number |
totalPackages |
number |
fullCasePackages |
number |
splitCasePackages |
number |
fullCasePickComplete |
boolean |
splitCasePickComplete |
boolean |
driverPalletCountFlag |
boolean |
shippingCosts |
object |
shippingCosts.shippingCost |
number |
shippingCosts.extendedShippingCost |
number |
shippingCosts.taxCost |
number |
shippingCosts.insuranceRequired |
boolean |
shippingCosts.insuranceCost |
number |
shippingCosts.insuranceAmount |
number |
shippingCosts.handlingCost |
number |
shippingCosts.laborCost |
number |
shippingCosts.materialsCost |
number |
shippingCosts.rateZone |
string |
shippingCosts.publishedRate |
number |
shippingCosts.currencyCode |
string |
shippingCosts.freightTermsType |
string |
shippingCosts.feeTermsType |
string |
shippingCosts.customsDeclaredValue |
number |
shippingCosts.incotermsType |
string |
shippingCosts.dutyPaidByType |
string |
shippingCosts.dutyPaidByContactName |
string |
shippingCosts.dutyPaidByAccount |
string |
shippingCosts.dutyPaidByPostalCode |
string |
shippingCosts.dutyPaidByCountry |
string |
bolNumber |
string |
handlingInstructions |
string |
authorizationCode |
string |
trailerLoadedBy |
string |
shipperFreightCountFlag |
boolean |
driverPieceCountFlag |
boolean |
returns |
object |
returns.returnShipVia |
string |
returns.returnShipVendor |
string |
returns.returnShipMethod |
string |
returns.returnShipOption |
string |
residential |
boolean |
homeDelivery |
boolean |
saturdayDelivery |
boolean |
hubId |
string |
codAmount |
number |
shipMode |
string |
dropShip |
boolean |
complete |
boolean |
correct |
boolean |
onTime |
boolean |
custCheckFlag |
boolean |
masterFlag |
boolean |
shipFromFobFlag |
boolean |
shipToFobFlag |
boolean |
totalDistance |
number |
totalMiles |
number |
notificationCode1 |
string |
notificationCode2 |
string |
notificationCode3 |
string |
verbalConfirmationPhoneNumber |
string |
integrationSource |
object |
integrationSource.id |
number |
integrationSource.businessKey |
object |
integrationSource.href |
string |
integrationPoint |
object |
integrationPoint.id |
number |
integrationPoint.businessKey |
object |
integrationPoint.href |
string |
importReference |
string |
exportReference |
string |
otherReferenceNumber |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.schedulerTask |
object |
channels.schedulerTask.id |
number |
channels.schedulerTask.businessKey |
object |
channels.schedulerTask.href |
string |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
customFields |
objectarray |
customFields.self |
object |
customFields.self.id |
number |
customFields.self.businessKey |
object |
customFields.self.href |
string |
customFields.name |
string |
customFields.value |
string |
customFields.type |
string |
customFields.item |
object |
customFields.item.id |
number |
customFields.item.businessKey |
object |
customFields.item.href |
string |
customFields.orderHeader |
object |
customFields.orderHeader.id |
number |
customFields.orderHeader.businessKey |
object |
customFields.orderHeader.href |
string |
customFields.orderLine |
object |
customFields.orderLine.id |
number |
customFields.orderLine.businessKey |
object |
customFields.orderLine.href |
string |
customFields.shipment |
object |
customFields.shipment.id |
number |
customFields.shipment.businessKey |
object |
customFields.shipment.href |
string |
customFields.createdDate |
string |
customFields.updatedDate |
string |
customFields.createdBy |
object |
customFields.createdBy.id |
number |
customFields.createdBy.businessKey |
object |
customFields.createdBy.href |
string |
customFields.updatedBy |
object |
customFields.updatedBy.id |
number |
customFields.updatedBy.businessKey |
object |
customFields.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
type |
string |
status |
string |
shipToContact |
object |
shipToContact.name |
string |
shipToContact.contactName |
string |
shipToContact.attention |
string |
shipToContact.phone |
string |
shipToContact.email |
string |
shipToAddress |
object |
shipToAddress.line1 |
string |
shipToAddress.line2 |
string |
shipToAddress.line3 |
string |
shipToAddress.line4 |
string |
shipToAddress.city |
string |
shipToAddress.stateProvince |
string |
shipToAddress.postalCode |
string |
shipToAddress.country |
string |
shipFromContact |
object |
shipFromContact.attention |
string |
shipFromContact.phone |
string |
shipFromAddress |
object |
shipFromAddress.line1 |
string |
shipFromAddress.line2 |
string |
shipFromAddress.city |
string |
shipFromAddress.stateProvince |
string |
shipFromAddress.postalCode |
string |
shipFromAddress.country |
string |
billToContact |
object |
billToContact.name |
string |
billToContact.attention |
string |
billToContact.contactName |
string |
billToContact.phone |
string |
billToAddress |
object |
billToAddress.line1 |
string |
billToAddress.line2 |
string |
billToAddress.line3 |
string |
billToAddress.line4 |
string |
billToAddress.city |
string |
billToAddress.stateProvince |
string |
billToAddress.postalCode |
string |
billToAddress.country |
string |
freightBillToContact |
object |
freightBillToContact.name |
string |
freightBillToContact.attention |
string |
freightBillToContact.phone |
string |
freightBillToAddress |
object |
freightBillToAddress.line1 |
string |
freightBillToAddress.line2 |
string |
freightBillToAddress.line3 |
string |
freightBillToAddress.line4 |
string |
freightBillToAddress.city |
string |
freightBillToAddress.stateProvince |
string |
freightBillToAddress.postalCode |
string |
freightBillToAddress.country |
string |
deliverToContact |
object |
deliverToContact.name |
string |
deliverToContact.attention |
string |
deliverToContact.phone |
string |
deliverToAddress |
object |
deliverToAddress.line1 |
string |
deliverToAddress.line2 |
string |
deliverToAddress.city |
string |
deliverToAddress.stateProvince |
string |
deliverToAddress.postalCode |
string |
deliverToAddress.country |
string |
tradingPartner |
object |
tradingPartner.id |
number |
tradingPartner.businessKey |
object |
tradingPartner.href |
string |
shipmentLines |
object |
shipmentLines.data |
objectarray |
shipmentLines.data.self |
object |
shipmentLines.data.self.id |
number |
shipmentLines.data.self.businessKey |
object |
shipmentLines.data.self.href |
string |
shipmentLines.data.businessUnit |
object |
shipmentLines.data.businessUnit.id |
number |
shipmentLines.data.businessUnit.businessKey |
object |
shipmentLines.data.businessUnit.href |
string |
shipmentLines.data.shipment |
object |
shipmentLines.data.shipment.id |
number |
shipmentLines.data.shipment.businessKey |
object |
shipmentLines.data.shipment.href |
string |
shipmentLines.data.number |
string |
shipmentLines.data.orderLine |
object |
shipmentLines.data.orderLine.id |
number |
shipmentLines.data.orderLine.businessKey |
object |
shipmentLines.data.orderLine.href |
string |
shipmentLines.data.orderLineDetails |
object |
shipmentLines.data.orderLineDetails.customerLineNumber |
string |
shipmentLines.data.orderLineDetails.pack |
object |
shipmentLines.data.orderLineDetails.pack.id |
number |
shipmentLines.data.orderLineDetails.pack.businessKey |
object |
shipmentLines.data.orderLineDetails.pack.href |
string |
shipmentLines.data.orderLineDetails.packDetails |
object |
shipmentLines.data.orderLineDetails.packDetails.type |
string |
shipmentLines.data.item |
object |
shipmentLines.data.item.id |
number |
shipmentLines.data.item.businessKey |
object |
shipmentLines.data.item.href |
string |
shipmentLines.data.substitutedItem |
object |
shipmentLines.data.substitutedItem.id |
number |
shipmentLines.data.substitutedItem.businessKey |
object |
shipmentLines.data.substitutedItem.href |
string |
shipmentLines.data.pack |
object |
shipmentLines.data.pack.id |
number |
shipmentLines.data.pack.businessKey |
object |
shipmentLines.data.pack.href |
string |
shipmentLines.data.packDetails |
object |
shipmentLines.data.packDetails.type |
string |
shipmentLines.data.description |
string |
shipmentLines.data.orderPackQuantity |
number |
shipmentLines.data.shippedPackQuantity |
number |
shipmentLines.data.damagedPackQuantity |
number |
shipmentLines.data.shippedDamagedPackQuantity |
number |
shipmentLines.data.returnedPackQuantity |
number |
shipmentLines.data.canceledPackQuantity |
number |
shipmentLines.data.shortagePackQuantity |
number |
shipmentLines.data.pickedPackQuantity |
number |
shipmentLines.data.packageCount |
number |
shipmentLines.data.pieceCount |
number |
shipmentLines.data.totalWeight |
object |
shipmentLines.data.totalWeight.value |
number |
shipmentLines.data.totalWeight.units |
string |
shipmentLines.data.chargeableWeight |
object |
shipmentLines.data.chargeableWeight.value |
number |
shipmentLines.data.chargeableWeight.units |
string |
shipmentLines.data.lotNumber |
string |
shipmentLines.data.bornOnDate |
string |
shipmentLines.data.expirationDate |
string |
shipmentLines.data.inventoryCondition |
string |
shipmentLines.data.inventoryAttribute1 |
string |
shipmentLines.data.inventoryAttribute2 |
string |
shipmentLines.data.unitCost |
number |
shipmentLines.data.freightCost |
number |
shipmentLines.data.taxCost |
number |
shipmentLines.data.hazmatFlag |
boolean |
shipmentLines.data.externalLineNumber |
string |
shipmentLines.data.importReference |
string |
shipmentLines.data.exportReference |
string |
shipmentLines.data.invoiced |
boolean |
shipmentLines.data.createdDate |
string |
shipmentLines.data.updatedDate |
string |
shipmentLines.data.createdBy |
object |
shipmentLines.data.createdBy.id |
number |
shipmentLines.data.createdBy.businessKey |
object |
shipmentLines.data.createdBy.href |
string |
shipmentLines.data.updatedBy |
object |
shipmentLines.data.updatedBy.id |
number |
shipmentLines.data.updatedBy.businessKey |
object |
shipmentLines.data.updatedBy.href |
string |
shipmentLines.data.receivedPackQuantity |
number |
shippedContainers |
object |
shippedContainers.data |
objectarray |
shippedContainers.data.self |
object |
shippedContainers.data.self.id |
number |
shippedContainers.data.self.businessKey |
object |
shippedContainers.data.self.href |
string |
shippedContainers.data.businessUnit |
object |
shippedContainers.data.businessUnit.id |
number |
shippedContainers.data.businessUnit.businessKey |
object |
shippedContainers.data.businessUnit.href |
string |
shippedContainers.data.lpnNumber |
string |
shippedContainers.data.status |
string |
shippedContainers.data.description |
string |
shippedContainers.data.dimensions |
object |
shippedContainers.data.dimensions.length |
object |
shippedContainers.data.dimensions.length.measurement |
number |
shippedContainers.data.dimensions.length.units |
string |
shippedContainers.data.dimensions.width |
object |
shippedContainers.data.dimensions.width.measurement |
number |
shippedContainers.data.dimensions.width.units |
string |
shippedContainers.data.dimensions.height |
object |
shippedContainers.data.dimensions.height.measurement |
number |
shippedContainers.data.dimensions.height.units |
string |
shippedContainers.data.weight |
object |
shippedContainers.data.weight.value |
number |
shippedContainers.data.weight.units |
string |
shippedContainers.data.masterLPNNumber |
string |
shippedContainers.data.shipment |
object |
shippedContainers.data.shipment.id |
number |
shippedContainers.data.shipment.businessKey |
object |
shippedContainers.data.shipment.href |
string |
shippedContainers.data.trackingNumber |
string |
shippedContainers.data.packageType |
string |
shippedContainers.data.shippingCost |
number |
shippedContainers.data.insuredValue |
number |
shippedContainers.data.shippedContainerLines |
objectarray |
shippedContainers.data.shippedContainerLines.self |
object |
shippedContainers.data.shippedContainerLines.self.id |
number |
shippedContainers.data.shippedContainerLines.self.businessKey |
object |
shippedContainers.data.shippedContainerLines.self.href |
string |
shippedContainers.data.shippedContainerLines.handlingUnit |
object |
shippedContainers.data.shippedContainerLines.handlingUnit.id |
number |
shippedContainers.data.shippedContainerLines.handlingUnit.businessKey |
object |
shippedContainers.data.shippedContainerLines.handlingUnit.href |
string |
shippedContainers.data.shippedContainerLines.item |
object |
shippedContainers.data.shippedContainerLines.item.id |
number |
shippedContainers.data.shippedContainerLines.item.businessKey |
object |
shippedContainers.data.shippedContainerLines.item.href |
string |
shippedContainers.data.shippedContainerLines.pack |
object |
shippedContainers.data.shippedContainerLines.pack.id |
number |
shippedContainers.data.shippedContainerLines.pack.businessKey |
object |
shippedContainers.data.shippedContainerLines.pack.href |
string |
shippedContainers.data.shippedContainerLines.packDetails |
object |
shippedContainers.data.shippedContainerLines.packDetails.type |
string |
shippedContainers.data.shippedContainerLines.shipmentLine |
object |
shippedContainers.data.shippedContainerLines.shipmentLine.id |
number |
shippedContainers.data.shippedContainerLines.shipmentLine.businessKey |
object |
shippedContainers.data.shippedContainerLines.shipmentLine.href |
string |
shippedContainers.data.shippedContainerLines.containerLinePackQuantity |
number |
shippedContainers.data.shippedContainerLines.lotNumber |
string |
shippedContainers.data.shippedContainerLines.lineSerialNumbers |
objectarray |
shippedContainers.data.shippedContainerLines.lineSerialNumbers.serialNumber |
string |
shippedContainers.data.shippedContainerLines.bornOnDate |
string |
shippedContainers.data.shippedContainerLines.expirationDate |
string |
shippedContainers.data.shippedContainerLines.referenceNumber1 |
string |
shippedContainers.data.shippedContainerLines.inventoryCondition |
string |
shippedContainers.data.shippedContainerLines.inventoryAttribute1 |
string |
shippedContainers.data.shippedContainerLines.inventoryAttribute2 |
string |
shippedContainers.data.createdDate |
string |
shippedContainers.data.updatedDate |
string |
shippedContainers.data.createdBy |
object |
shippedContainers.data.createdBy.id |
number |
shippedContainers.data.createdBy.businessKey |
object |
shippedContainers.data.createdBy.href |
string |
shippedContainers.data.updatedBy |
object |
shippedContainers.data.updatedBy.id |
number |
shippedContainers.data.updatedBy.businessKey |
object |
shippedContainers.data.updatedBy.href |
string |
trip |
object |
trip.id |
number |
trip.businessKey |
object |
trip.href |
string |
Outbound transfer orders — Get a list of outbound transfer orders
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
orderPriority |
number |
orderSummary |
string |
orderSource |
string |
secondaryOrderSource |
string |
customerOrderNumber |
string |
relatedOrderNumber |
string |
partnerInvoiceNumber |
string |
consigneePartner |
object |
consigneePartner.id |
number |
consigneePartner.businessKey |
object |
consigneePartner.href |
string |
tradingPartnerSite |
object |
tradingPartnerSite.id |
number |
tradingPartnerSite.businessKey |
object |
tradingPartnerSite.href |
string |
shipToContact |
object |
shipToContact.attention |
string |
shipToContact.name |
string |
shipToContact.firstName |
string |
shipToContact.lastName |
string |
shipToContact.contactName |
string |
shipToContact.phone |
string |
shipToContact.email |
string |
shipToAddress |
object |
shipToAddress.line1 |
string |
shipToAddress.line2 |
string |
shipToAddress.line3 |
string |
shipToAddress.line4 |
string |
shipToAddress.city |
string |
shipToAddress.stateProvince |
string |
shipToAddress.postalCode |
string |
shipToAddress.country |
string |
billToContact |
object |
billToContact.name |
string |
billToContact.firstName |
string |
billToContact.lastName |
string |
billToContact.contactName |
string |
billToContact.attention |
string |
billToContact.phone |
string |
billToContact.email |
string |
billToAccountNumber |
string |
billToAddress |
object |
billToAddress.line1 |
string |
billToAddress.line2 |
string |
billToAddress.line3 |
string |
billToAddress.line4 |
string |
billToAddress.city |
string |
billToAddress.stateProvince |
string |
billToAddress.postalCode |
string |
billToAddress.country |
string |
shipFromContact |
object |
shipFromContact.name |
string |
shipFromContact.firstName |
string |
shipFromContact.lastName |
string |
shipFromContact.attention |
string |
shipFromContact.phone |
string |
shipFromContact.email |
string |
shipFromAddress |
object |
shipFromAddress.line1 |
string |
shipFromAddress.line2 |
string |
shipFromAddress.city |
string |
shipFromAddress.stateProvince |
string |
shipFromAddress.postalCode |
string |
shipFromAddress.country |
string |
placedDate |
string |
plannedArrivalDate |
string |
plannedReleaseDate |
string |
plannedShipDate |
string |
earliestShipDate |
string |
earliestDeliveryDate |
string |
cancelByArrivalDate |
string |
cancelByReleaseDate |
string |
cancelByShipDate |
string |
actualArrivalDate |
string |
actualReleaseDate |
string |
actualShipDate |
string |
priceList |
object |
priceList.id |
number |
priceList.businessKey |
object |
priceList.href |
string |
orderTotal |
number |
orderSubtotal |
number |
orderDiscountSubtotal |
number |
orderShippingTotal |
number |
orderShipTotal |
number |
taxable |
boolean |
orderTaxTotal |
number |
orderTaxableTotal |
number |
orderUntaxableTotal |
number |
shippingTaxTotal |
number |
shipVia |
string |
shipVendor |
string |
shipMethod |
string |
freightTermsType |
string |
freightBillToContact |
object |
freightBillToContact.name |
string |
freightBillToContact.firstName |
string |
freightBillToContact.lastName |
string |
freightBillToContact.attention |
string |
freightBillToContact.phone |
string |
freightBillToAccount |
string |
freightBillToAddress |
object |
freightBillToAddress.line1 |
string |
freightBillToAddress.line2 |
string |
freightBillToAddress.line3 |
string |
freightBillToAddress.line4 |
string |
freightBillToAddress.city |
string |
freightBillToAddress.stateProvince |
string |
freightBillToAddress.postalCode |
string |
freightBillToAddress.country |
string |
deliverToContact |
object |
deliverToContact.name |
string |
deliverToContact.attention |
string |
deliverToContact.phone |
string |
deliverToAddress |
object |
deliverToAddress.line1 |
string |
deliverToAddress.line2 |
string |
deliverToAddress.city |
string |
deliverToAddress.stateProvince |
string |
deliverToAddress.postalCode |
string |
deliverToAddress.country |
string |
weight |
object |
weight.weight |
number |
weight.units |
string |
returnRequired |
boolean |
returnShipVia |
string |
returnShipOption |
string |
deliveryConfirmation |
string |
insuranceRequired |
boolean |
homeDelivery |
boolean |
residential |
boolean |
saturdayDelivery |
boolean |
hubId |
string |
routingNumber |
string |
incotermsType |
string |
importType |
string |
importReference |
string |
exportReference |
string |
otherReferenceNumber2 |
string |
integrationSource |
object |
integrationSource.id |
number |
integrationSource.businessKey |
object |
integrationSource.href |
string |
sendASN |
string |
dropShip |
boolean |
pickWave |
object |
pickWave.id |
number |
pickWave.businessKey |
object |
pickWave.href |
string |
postReleaseState |
string |
entryName |
string |
entryPhone1 |
string |
saleConditionCode |
string |
seller |
string |
notificationCode1 |
string |
notificationCode2 |
string |
notificationCode3 |
string |
verbalConfirmationName |
string |
verbalConfirmationPhoneNumber |
string |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
customAttribute4 |
string |
customAttribute5 |
string |
customAttribute6 |
string |
customAttribute7 |
string |
customFields |
objectarray |
customFields.self |
object |
customFields.self.id |
number |
customFields.self.businessKey |
object |
customFields.self.href |
string |
customFields.name |
string |
customFields.value |
string |
customFields.type |
string |
customFields.item |
object |
customFields.item.id |
number |
customFields.item.businessKey |
object |
customFields.item.href |
string |
customFields.orderHeader |
object |
customFields.orderHeader.id |
number |
customFields.orderHeader.businessKey |
object |
customFields.orderHeader.href |
string |
customFields.orderLine |
object |
customFields.orderLine.id |
number |
customFields.orderLine.businessKey |
object |
customFields.orderLine.href |
string |
customFields.shipment |
object |
customFields.shipment.id |
number |
customFields.shipment.businessKey |
object |
customFields.shipment.href |
string |
customFields.createdDate |
string |
customFields.updatedDate |
string |
customFields.createdBy |
object |
customFields.createdBy.id |
number |
customFields.createdBy.businessKey |
object |
customFields.createdBy.href |
string |
customFields.updatedBy |
object |
customFields.updatedBy.id |
number |
customFields.updatedBy.businessKey |
object |
customFields.updatedBy.href |
string |
notes |
objectarray |
notes.self |
object |
notes.self.id |
number |
notes.self.businessKey |
object |
notes.self.href |
string |
notes.title |
string |
notes.body |
string |
notes.source |
string |
notes.priority |
string |
notes.orderHeader |
object |
notes.orderHeader.id |
number |
notes.orderHeader.businessKey |
object |
notes.orderHeader.href |
string |
notes.orderLine |
object |
notes.orderLine.id |
number |
notes.orderLine.businessKey |
object |
notes.orderLine.href |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.schedulerTask |
object |
channels.schedulerTask.id |
number |
channels.schedulerTask.businessKey |
object |
channels.schedulerTask.href |
string |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
type |
string |
orderStatus |
string |
shipToFacility |
object |
shipToFacility.id |
number |
shipToFacility.businessKey |
object |
shipToFacility.href |
string |
shipFromFacility |
object |
shipFromFacility.id |
number |
shipFromFacility.businessKey |
object |
shipFromFacility.href |
string |
otherReferenceNumber |
string |
dutyPaidBy |
string |
dutyPaidByType |
string |
dutyPaidByContactName |
string |
dutyPaidByAccount |
string |
dutyPaidByPostalCode |
string |
dutyPaidByCountry |
string |
directedToZone |
object |
directedToZone.id |
number |
directedToZone.businessKey |
object |
directedToZone.href |
string |
customerOrderHeaders |
objectarray |
customerOrderHeaders.id |
number |
customerOrderHeaders.businessKey |
object |
customerOrderHeaders.href |
string |
orderLines |
object |
orderLines.data |
objectarray |
orderLines.data.self |
object |
orderLines.data.self.id |
number |
orderLines.data.self.businessKey |
object |
orderLines.data.self.href |
string |
orderLines.data.businessUnit |
object |
orderLines.data.businessUnit.id |
number |
orderLines.data.businessUnit.businessKey |
object |
orderLines.data.businessUnit.href |
string |
orderLines.data.lineNumber |
string |
orderLines.data.customerLineNumber |
string |
orderLines.data.relatedOrderLine |
object |
orderLines.data.relatedOrderLine.id |
number |
orderLines.data.relatedOrderLine.businessKey |
object |
orderLines.data.relatedOrderLine.href |
string |
orderLines.data.sortOrder |
number |
orderLines.data.orderHeader |
object |
orderLines.data.orderHeader.id |
number |
orderLines.data.orderHeader.businessKey |
object |
orderLines.data.orderHeader.href |
string |
orderLines.data.item |
object |
orderLines.data.item.id |
number |
orderLines.data.item.businessKey |
object |
orderLines.data.item.href |
string |
orderLines.data.pack |
object |
orderLines.data.pack.id |
number |
orderLines.data.pack.businessKey |
object |
orderLines.data.pack.href |
string |
orderLines.data.description |
string |
orderLines.data.orderPackQuantity |
number |
orderLines.data.canceledPackQuantity |
number |
orderLines.data.lotNumber |
string |
orderLines.data.bornOnDate |
string |
orderLines.data.expirationDate |
string |
orderLines.data.productCode |
string |
orderLines.data.inventoryCondition |
string |
orderLines.data.inventoryAttribute1 |
string |
orderLines.data.inventoryAttribute2 |
string |
orderLines.data.plannedShipDate |
string |
orderLines.data.plannedArrivalDate |
string |
orderLines.data.unitPrice |
number |
orderLines.data.unitCost |
number |
orderLines.data.priceCode |
string |
orderLines.data.lineTotal |
number |
orderLines.data.taxable |
boolean |
orderLines.data.taxCost |
number |
orderLines.data.taxableTotal |
number |
orderLines.data.untaxableTotal |
number |
orderLines.data.extendedTotal |
number |
orderLines.data.discountAmount |
number |
orderLines.data.shippingAmount |
number |
orderLines.data.weight |
object |
orderLines.data.weight.weight |
number |
orderLines.data.weight.units |
string |
orderLines.data.importReference |
string |
orderLines.data.exportReference |
string |
orderLines.data.customAttribute1 |
string |
orderLines.data.customAttribute2 |
string |
orderLines.data.customAttribute3 |
string |
orderLines.data.customFields |
objectarray |
orderLines.data.customFields.self |
object |
orderLines.data.customFields.self.id |
number |
orderLines.data.customFields.self.businessKey |
object |
orderLines.data.customFields.self.href |
string |
orderLines.data.customFields.name |
string |
orderLines.data.customFields.value |
string |
orderLines.data.customFields.type |
string |
orderLines.data.customFields.item |
object |
orderLines.data.customFields.item.id |
number |
orderLines.data.customFields.item.businessKey |
object |
orderLines.data.customFields.item.href |
string |
orderLines.data.customFields.orderHeader |
object |
orderLines.data.customFields.orderHeader.id |
number |
orderLines.data.customFields.orderHeader.businessKey |
object |
orderLines.data.customFields.orderHeader.href |
string |
orderLines.data.customFields.orderLine |
object |
orderLines.data.customFields.orderLine.id |
number |
orderLines.data.customFields.orderLine.businessKey |
object |
orderLines.data.customFields.orderLine.href |
string |
orderLines.data.customFields.shipment |
object |
orderLines.data.customFields.shipment.id |
number |
orderLines.data.customFields.shipment.businessKey |
object |
orderLines.data.customFields.shipment.href |
string |
orderLines.data.customFields.createdDate |
string |
orderLines.data.customFields.updatedDate |
string |
orderLines.data.customFields.createdBy |
object |
orderLines.data.customFields.createdBy.id |
number |
orderLines.data.customFields.createdBy.businessKey |
object |
orderLines.data.customFields.createdBy.href |
string |
orderLines.data.customFields.updatedBy |
object |
orderLines.data.customFields.updatedBy.id |
number |
orderLines.data.customFields.updatedBy.businessKey |
object |
orderLines.data.customFields.updatedBy.href |
string |
orderLines.data.notes |
objectarray |
orderLines.data.notes.self |
object |
orderLines.data.notes.self.id |
number |
orderLines.data.notes.self.businessKey |
object |
orderLines.data.notes.self.href |
string |
orderLines.data.notes.title |
string |
orderLines.data.notes.body |
string |
orderLines.data.notes.source |
string |
orderLines.data.notes.priority |
string |
orderLines.data.notes.orderHeader |
object |
orderLines.data.notes.orderHeader.id |
number |
orderLines.data.notes.orderHeader.businessKey |
object |
orderLines.data.notes.orderHeader.href |
string |
orderLines.data.notes.orderLine |
object |
orderLines.data.notes.orderLine.id |
number |
orderLines.data.notes.orderLine.businessKey |
object |
orderLines.data.notes.orderLine.href |
string |
orderLines.data.channels |
objectarray |
orderLines.data.channels.self |
object |
orderLines.data.channels.self.id |
number |
orderLines.data.channels.self.businessKey |
object |
orderLines.data.channels.self.href |
string |
orderLines.data.channels.integration |
object |
orderLines.data.channels.integration.id |
number |
orderLines.data.channels.integration.businessKey |
object |
orderLines.data.channels.integration.href |
string |
orderLines.data.channels.schedulerTask |
object |
orderLines.data.channels.schedulerTask.id |
number |
orderLines.data.channels.schedulerTask.businessKey |
object |
orderLines.data.channels.schedulerTask.href |
string |
orderLines.data.channels.ref1 |
string |
orderLines.data.channels.ref2 |
string |
orderLines.data.channels.ref3 |
string |
orderLines.data.channels.ref4 |
string |
orderLines.data.channels.ref5 |
string |
orderLines.data.channels.secRef1 |
string |
orderLines.data.channels.secRef2 |
string |
orderLines.data.channels.secRef3 |
string |
orderLines.data.channels.secRef4 |
string |
orderLines.data.channels.secRef5 |
string |
orderLines.data.channels.createdDate |
string |
orderLines.data.channels.updatedDate |
string |
orderLines.data.channels.createdBy |
object |
orderLines.data.channels.createdBy.id |
number |
orderLines.data.channels.createdBy.businessKey |
object |
orderLines.data.channels.createdBy.href |
string |
orderLines.data.channels.updatedBy |
object |
orderLines.data.channels.updatedBy.id |
number |
orderLines.data.channels.updatedBy.businessKey |
object |
orderLines.data.channels.updatedBy.href |
string |
orderLines.data.createdDate |
string |
orderLines.data.updatedDate |
string |
orderLines.data.createdBy |
object |
orderLines.data.createdBy.id |
number |
orderLines.data.createdBy.businessKey |
object |
orderLines.data.createdBy.href |
string |
orderLines.data.updatedBy |
object |
orderLines.data.updatedBy.id |
number |
orderLines.data.updatedBy.businessKey |
object |
orderLines.data.updatedBy.href |
string |
orderLines.data.orderLineStatus |
string |
orderLines.data.shipFromFacility |
object |
orderLines.data.shipFromFacility.id |
number |
orderLines.data.shipFromFacility.businessKey |
object |
orderLines.data.shipFromFacility.href |
string |
orderLines.data.coLine |
object |
orderLines.data.coLine.id |
number |
orderLines.data.coLine.businessKey |
object |
orderLines.data.coLine.href |
string |
orderLines.data.allocatedQuantity |
number |
orderLines.data.unallocatedQuantity |
number |
orderLines.data.pickedPackQuantity |
number |
orderLines.data.shortagePackQuantity |
number |
orderLines.data.shippedPackQuantity |
number |
orderLines.data.preallocated |
boolean |
orderLines.data.isBackOrdered |
string |
orderLines.data.directedToZone |
object |
orderLines.data.directedToZone.id |
number |
orderLines.data.directedToZone.businessKey |
object |
orderLines.data.directedToZone.href |
string |
orderLines.data.allocateFromZone |
boolean |
orderLines.data.carrierSpecialServices |
objectarray |
orderLines.data.carrierSpecialServices.self |
object |
orderLines.data.carrierSpecialServices.self.id |
number |
orderLines.data.carrierSpecialServices.self.businessKey |
object |
orderLines.data.carrierSpecialServices.self.href |
string |
orderLines.data.carrierSpecialServices.shipVendor |
string |
orderLines.data.carrierSpecialServices.item |
object |
orderLines.data.carrierSpecialServices.item.id |
number |
orderLines.data.carrierSpecialServices.item.businessKey |
object |
orderLines.data.carrierSpecialServices.item.href |
string |
orderLines.data.carrierSpecialServices.pack |
object |
orderLines.data.carrierSpecialServices.pack.id |
number |
orderLines.data.carrierSpecialServices.pack.businessKey |
object |
orderLines.data.carrierSpecialServices.pack.href |
string |
orderLines.data.carrierSpecialServices.salesOrder |
object |
orderLines.data.carrierSpecialServices.salesOrder.id |
number |
orderLines.data.carrierSpecialServices.salesOrder.businessKey |
object |
orderLines.data.carrierSpecialServices.salesOrder.href |
string |
orderLines.data.carrierSpecialServices.orderLine |
object |
orderLines.data.carrierSpecialServices.orderLine.id |
number |
orderLines.data.carrierSpecialServices.orderLine.businessKey |
object |
orderLines.data.carrierSpecialServices.orderLine.href |
string |
orderLines.data.carrierSpecialServices.customerOrder |
object |
orderLines.data.carrierSpecialServices.customerOrder.id |
number |
orderLines.data.carrierSpecialServices.customerOrder.businessKey |
object |
orderLines.data.carrierSpecialServices.customerOrder.href |
string |
orderLines.data.carrierSpecialServices.customerOrderLine |
object |
orderLines.data.carrierSpecialServices.customerOrderLine.id |
number |
orderLines.data.carrierSpecialServices.customerOrderLine.businessKey |
object |
orderLines.data.carrierSpecialServices.customerOrderLine.href |
string |
orderLines.data.carrierSpecialServices.battery |
boolean |
orderLines.data.carrierSpecialServices.batteryMaterial |
string |
orderLines.data.carrierSpecialServices.batteryPacking |
string |
orderLines.data.carrierSpecialServices.batteryRegulation |
string |
orderLines.data.carrierSpecialServices.chemicalIdentifier |
string |
orderLines.data.carrierSpecialServices.commodityRegulations |
string |
orderLines.data.carrierSpecialServices.dangerousGoodsAmount |
number |
orderLines.data.carrierSpecialServices.dangerousGoodsUOM |
string |
orderLines.data.carrierSpecialServices.hazardClass |
number |
orderLines.data.carrierSpecialServices.extendedHazardClass |
string |
orderLines.data.carrierSpecialServices.hazardLabelDescription |
string |
orderLines.data.carrierSpecialServices.hazmatExceptedQuantity |
string |
orderLines.data.carrierSpecialServices.hazmatLimitedQuantity |
string |
orderLines.data.carrierSpecialServices.limitedQtyPackingInstructions |
string |
orderLines.data.carrierSpecialServices.packagingGroupType |
string |
orderLines.data.carrierSpecialServices.packagingType |
string |
orderLines.data.carrierSpecialServices.packingInstructions |
string |
orderLines.data.carrierSpecialServices.properShippingName |
string |
orderLines.data.carrierSpecialServices.regulationSet |
string |
orderLines.data.carrierSpecialServices.subRiskClass1 |
string |
orderLines.data.carrierSpecialServices.subRiskClass2 |
string |
orderLines.data.carrierSpecialServices.subRiskClass3 |
string |
orderLines.data.carrierSpecialServices.technicalName |
string |
orderLines.data.carrierSpecialServices.transportationMode |
string |
orderLines.data.carrierSpecialServices.unNumber |
string |
orderLines.data.carrierSpecialServices.shipsWithDryIce |
boolean |
orderLines.data.carrierSpecialServices.medicalUse |
boolean |
orderLines.data.carrierSpecialServices.alcohol |
boolean |
orderLines.data.carrierSpecialServices.holdAtLocation |
boolean |
orderLines.data.carrierSpecialServices.returnReceiptRequested |
boolean |
orderLines.data.carrierSpecialServices.saturdayDelivery |
boolean |
orderLines.data.carrierSpecialServices.liftgateDelivery |
boolean |
orderLines.data.carrierSpecialServices.appointmentDelivery |
boolean |
orderLines.data.carrierSpecialServices.accessible |
boolean |
orderLines.data.carrierSpecialServices.cargoAircraft |
boolean |
orderLines.data.carrierSpecialServices.exportComplianceStatement |
string |
orderLines.data.carrierSpecialServices.createdDate |
string |
orderLines.data.carrierSpecialServices.updatedDate |
string |
orderLines.data.carrierSpecialServices.createdBy |
object |
orderLines.data.carrierSpecialServices.createdBy.id |
number |
orderLines.data.carrierSpecialServices.createdBy.businessKey |
object |
orderLines.data.carrierSpecialServices.createdBy.href |
string |
orderLines.data.carrierSpecialServices.updatedBy |
object |
orderLines.data.carrierSpecialServices.updatedBy.id |
number |
orderLines.data.carrierSpecialServices.updatedBy.businessKey |
object |
orderLines.data.carrierSpecialServices.updatedBy.href |
string |
orderLine |
object |
orderLine.id |
number |
orderLine.businessKey |
object |
orderLine.href |
string |
canceledPackQuantity |
number |
carrierSpecialServices |
objectarray |
carrierSpecialServices.self |
object |
carrierSpecialServices.self.id |
number |
carrierSpecialServices.self.businessKey |
object |
carrierSpecialServices.self.href |
string |
carrierSpecialServices.shipVendor |
string |
carrierSpecialServices.item |
object |
carrierSpecialServices.item.id |
number |
carrierSpecialServices.item.businessKey |
object |
carrierSpecialServices.item.href |
string |
carrierSpecialServices.pack |
object |
carrierSpecialServices.pack.id |
number |
carrierSpecialServices.pack.businessKey |
object |
carrierSpecialServices.pack.href |
string |
carrierSpecialServices.salesOrder |
object |
carrierSpecialServices.salesOrder.id |
number |
carrierSpecialServices.salesOrder.businessKey |
object |
carrierSpecialServices.salesOrder.href |
string |
carrierSpecialServices.orderLine |
object |
carrierSpecialServices.orderLine.id |
number |
carrierSpecialServices.orderLine.businessKey |
object |
carrierSpecialServices.orderLine.href |
string |
carrierSpecialServices.customerOrder |
object |
carrierSpecialServices.customerOrder.id |
number |
carrierSpecialServices.customerOrder.businessKey |
object |
carrierSpecialServices.customerOrder.href |
string |
carrierSpecialServices.customerOrderLine |
object |
carrierSpecialServices.customerOrderLine.id |
number |
carrierSpecialServices.customerOrderLine.businessKey |
object |
carrierSpecialServices.customerOrderLine.href |
string |
carrierSpecialServices.battery |
boolean |
carrierSpecialServices.batteryMaterial |
string |
carrierSpecialServices.batteryPacking |
string |
carrierSpecialServices.batteryRegulation |
string |
carrierSpecialServices.chemicalIdentifier |
string |
carrierSpecialServices.commodityRegulations |
string |
carrierSpecialServices.dangerousGoodsAmount |
number |
carrierSpecialServices.dangerousGoodsUOM |
string |
carrierSpecialServices.hazardClass |
number |
carrierSpecialServices.extendedHazardClass |
string |
carrierSpecialServices.hazardLabelDescription |
string |
carrierSpecialServices.hazmatExceptedQuantity |
string |
carrierSpecialServices.hazmatLimitedQuantity |
string |
carrierSpecialServices.limitedQtyPackingInstructions |
string |
carrierSpecialServices.packagingGroupType |
string |
carrierSpecialServices.packagingType |
string |
carrierSpecialServices.packingInstructions |
string |
carrierSpecialServices.properShippingName |
string |
carrierSpecialServices.regulationSet |
string |
carrierSpecialServices.subRiskClass1 |
string |
carrierSpecialServices.subRiskClass2 |
string |
carrierSpecialServices.subRiskClass3 |
string |
carrierSpecialServices.technicalName |
string |
carrierSpecialServices.transportationMode |
string |
carrierSpecialServices.unNumber |
string |
carrierSpecialServices.shipsWithDryIce |
boolean |
carrierSpecialServices.medicalUse |
boolean |
carrierSpecialServices.alcohol |
boolean |
carrierSpecialServices.holdAtLocation |
boolean |
carrierSpecialServices.returnReceiptRequested |
boolean |
carrierSpecialServices.saturdayDelivery |
boolean |
carrierSpecialServices.liftgateDelivery |
boolean |
carrierSpecialServices.appointmentDelivery |
boolean |
carrierSpecialServices.accessible |
boolean |
carrierSpecialServices.cargoAircraft |
boolean |
carrierSpecialServices.exportComplianceStatement |
string |
carrierSpecialServices.createdDate |
string |
carrierSpecialServices.updatedDate |
string |
carrierSpecialServices.createdBy |
object |
carrierSpecialServices.createdBy.id |
number |
carrierSpecialServices.createdBy.businessKey |
object |
carrierSpecialServices.createdBy.href |
string |
carrierSpecialServices.updatedBy |
object |
carrierSpecialServices.updatedBy.id |
number |
carrierSpecialServices.updatedBy.businessKey |
object |
carrierSpecialServices.updatedBy.href |
string |
shipments |
object |
shipments.data |
objectarray |
shipments.data.id |
number |
shipments.data.businessKey |
object |
shipments.data.href |
string |
lineNumber |
string |
customerLineNumber |
string |
relatedOrderLine |
object |
relatedOrderLine.id |
number |
relatedOrderLine.businessKey |
object |
relatedOrderLine.href |
string |
sortOrder |
number |
orderHeader |
object |
orderHeader.id |
number |
orderHeader.businessKey |
object |
orderHeader.href |
string |
item |
object |
item.id |
number |
item.businessKey |
object |
item.href |
string |
pack |
object |
pack.id |
number |
pack.businessKey |
object |
pack.href |
string |
description |
string |
orderPackQuantity |
number |
canceledPackQuantity |
number |
lotNumber |
string |
bornOnDate |
string |
expirationDate |
string |
productCode |
string |
inventoryCondition |
string |
inventoryAttribute1 |
string |
inventoryAttribute2 |
string |
unitPrice |
number |
unitCost |
number |
priceCode |
string |
lineTotal |
number |
taxCost |
number |
taxableTotal |
number |
untaxableTotal |
number |
extendedTotal |
number |
discountAmount |
number |
shippingAmount |
number |
orderLineStatus |
string |
coLine |
object |
coLine.id |
number |
coLine.businessKey |
object |
coLine.href |
string |
allocatedQuantity |
number |
unallocatedQuantity |
number |
pickedPackQuantity |
number |
shortagePackQuantity |
number |
shippedPackQuantity |
number |
preallocated |
boolean |
isBackOrdered |
string |
allocateFromZone |
boolean |
Purchase orders — Get a list of purchase orders
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
orderPriority |
number |
orderSummary |
string |
orderSource |
string |
secondaryOrderSource |
string |
customerOrderNumber |
string |
relatedOrderNumber |
string |
partnerInvoiceNumber |
string |
consigneePartner |
object |
consigneePartner.id |
number |
consigneePartner.businessKey |
object |
consigneePartner.href |
string |
tradingPartnerSite |
object |
tradingPartnerSite.id |
number |
tradingPartnerSite.businessKey |
object |
tradingPartnerSite.href |
string |
shipToContact |
object |
shipToContact.attention |
string |
shipToContact.name |
string |
shipToContact.firstName |
string |
shipToContact.lastName |
string |
shipToContact.contactName |
string |
shipToContact.phone |
string |
shipToContact.email |
string |
shipToAddress |
object |
shipToAddress.line1 |
string |
shipToAddress.line2 |
string |
shipToAddress.line3 |
string |
shipToAddress.line4 |
string |
shipToAddress.city |
string |
shipToAddress.stateProvince |
string |
shipToAddress.postalCode |
string |
shipToAddress.country |
string |
billToContact |
object |
billToContact.name |
string |
billToContact.firstName |
string |
billToContact.lastName |
string |
billToContact.contactName |
string |
billToContact.attention |
string |
billToContact.phone |
string |
billToContact.email |
string |
billToAccountNumber |
string |
billToAddress |
object |
billToAddress.line1 |
string |
billToAddress.line2 |
string |
billToAddress.line3 |
string |
billToAddress.line4 |
string |
billToAddress.city |
string |
billToAddress.stateProvince |
string |
billToAddress.postalCode |
string |
billToAddress.country |
string |
shipFromContact |
object |
shipFromContact.name |
string |
shipFromContact.firstName |
string |
shipFromContact.lastName |
string |
shipFromContact.attention |
string |
shipFromContact.phone |
string |
shipFromContact.email |
string |
shipFromAddress |
object |
shipFromAddress.line1 |
string |
shipFromAddress.line2 |
string |
shipFromAddress.city |
string |
shipFromAddress.stateProvince |
string |
shipFromAddress.postalCode |
string |
shipFromAddress.country |
string |
placedDate |
string |
plannedArrivalDate |
string |
plannedReleaseDate |
string |
plannedShipDate |
string |
earliestShipDate |
string |
earliestDeliveryDate |
string |
cancelByArrivalDate |
string |
cancelByReleaseDate |
string |
cancelByShipDate |
string |
actualArrivalDate |
string |
actualReleaseDate |
string |
actualShipDate |
string |
priceList |
object |
priceList.id |
number |
priceList.businessKey |
object |
priceList.href |
string |
orderTotal |
number |
orderSubtotal |
number |
orderDiscountSubtotal |
number |
orderShippingTotal |
number |
orderShipTotal |
number |
taxable |
boolean |
orderTaxTotal |
number |
orderTaxableTotal |
number |
orderUntaxableTotal |
number |
shippingTaxTotal |
number |
shipVia |
string |
shipVendor |
string |
shipMethod |
string |
freightTermsType |
string |
freightBillToContact |
object |
freightBillToContact.name |
string |
freightBillToContact.firstName |
string |
freightBillToContact.lastName |
string |
freightBillToContact.attention |
string |
freightBillToContact.phone |
string |
freightBillToAccount |
string |
freightBillToAddress |
object |
freightBillToAddress.line1 |
string |
freightBillToAddress.line2 |
string |
freightBillToAddress.line3 |
string |
freightBillToAddress.line4 |
string |
freightBillToAddress.city |
string |
freightBillToAddress.stateProvince |
string |
freightBillToAddress.postalCode |
string |
freightBillToAddress.country |
string |
deliverToContact |
object |
deliverToContact.name |
string |
deliverToContact.attention |
string |
deliverToContact.phone |
string |
deliverToAddress |
object |
deliverToAddress.line1 |
string |
deliverToAddress.line2 |
string |
deliverToAddress.city |
string |
deliverToAddress.stateProvince |
string |
deliverToAddress.postalCode |
string |
deliverToAddress.country |
string |
weight |
object |
weight.weight |
number |
weight.units |
string |
returnRequired |
boolean |
returnShipVia |
string |
returnShipOption |
string |
deliveryConfirmation |
string |
insuranceRequired |
boolean |
homeDelivery |
boolean |
residential |
boolean |
saturdayDelivery |
boolean |
hubId |
string |
routingNumber |
string |
incotermsType |
string |
importType |
string |
importReference |
string |
exportReference |
string |
otherReferenceNumber2 |
string |
integrationSource |
object |
integrationSource.id |
number |
integrationSource.businessKey |
object |
integrationSource.href |
string |
sendASN |
string |
dropShip |
boolean |
pickWave |
object |
pickWave.id |
number |
pickWave.businessKey |
object |
pickWave.href |
string |
postReleaseState |
string |
entryName |
string |
entryPhone1 |
string |
saleConditionCode |
string |
seller |
string |
notificationCode1 |
string |
notificationCode2 |
string |
notificationCode3 |
string |
verbalConfirmationName |
string |
verbalConfirmationPhoneNumber |
string |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
customAttribute4 |
string |
customAttribute5 |
string |
customAttribute6 |
string |
customAttribute7 |
string |
customFields |
objectarray |
customFields.self |
object |
customFields.self.id |
number |
customFields.self.businessKey |
object |
customFields.self.href |
string |
customFields.name |
string |
customFields.value |
string |
customFields.type |
string |
customFields.item |
object |
customFields.item.id |
number |
customFields.item.businessKey |
object |
customFields.item.href |
string |
customFields.orderHeader |
object |
customFields.orderHeader.id |
number |
customFields.orderHeader.businessKey |
object |
customFields.orderHeader.href |
string |
customFields.orderLine |
object |
customFields.orderLine.id |
number |
customFields.orderLine.businessKey |
object |
customFields.orderLine.href |
string |
customFields.shipment |
object |
customFields.shipment.id |
number |
customFields.shipment.businessKey |
object |
customFields.shipment.href |
string |
customFields.createdDate |
string |
customFields.updatedDate |
string |
customFields.createdBy |
object |
customFields.createdBy.id |
number |
customFields.createdBy.businessKey |
object |
customFields.createdBy.href |
string |
customFields.updatedBy |
object |
customFields.updatedBy.id |
number |
customFields.updatedBy.businessKey |
object |
customFields.updatedBy.href |
string |
notes |
objectarray |
notes.self |
object |
notes.self.id |
number |
notes.self.businessKey |
object |
notes.self.href |
string |
notes.title |
string |
notes.body |
string |
notes.source |
string |
notes.priority |
string |
notes.orderHeader |
object |
notes.orderHeader.id |
number |
notes.orderHeader.businessKey |
object |
notes.orderHeader.href |
string |
notes.orderLine |
object |
notes.orderLine.id |
number |
notes.orderLine.businessKey |
object |
notes.orderLine.href |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.schedulerTask |
object |
channels.schedulerTask.id |
number |
channels.schedulerTask.businessKey |
object |
channels.schedulerTask.href |
string |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
type |
string |
orderStatus |
string |
shipToFacility |
object |
shipToFacility.id |
number |
shipToFacility.businessKey |
object |
shipToFacility.href |
string |
otherReferenceNumber |
string |
paymentTerms |
string |
currencyCode |
string |
contractNumber |
string |
ackReasonCode |
string |
invSegmentationPlan |
object |
invSegmentationPlan.id |
number |
invSegmentationPlan.businessKey |
object |
invSegmentationPlan.href |
string |
onTime |
boolean |
vendorCompliant |
boolean |
orderLines |
object |
orderLines.data |
objectarray |
orderLines.data.self |
object |
orderLines.data.self.id |
number |
orderLines.data.self.businessKey |
object |
orderLines.data.self.href |
string |
orderLines.data.businessUnit |
object |
orderLines.data.businessUnit.id |
number |
orderLines.data.businessUnit.businessKey |
object |
orderLines.data.businessUnit.href |
string |
orderLines.data.lineNumber |
string |
orderLines.data.customerLineNumber |
string |
orderLines.data.relatedOrderLine |
object |
orderLines.data.relatedOrderLine.id |
number |
orderLines.data.relatedOrderLine.businessKey |
object |
orderLines.data.relatedOrderLine.href |
string |
orderLines.data.sortOrder |
number |
orderLines.data.orderHeader |
object |
orderLines.data.orderHeader.id |
number |
orderLines.data.orderHeader.businessKey |
object |
orderLines.data.orderHeader.href |
string |
orderLines.data.item |
object |
orderLines.data.item.id |
number |
orderLines.data.item.businessKey |
object |
orderLines.data.item.href |
string |
orderLines.data.pack |
object |
orderLines.data.pack.id |
number |
orderLines.data.pack.businessKey |
object |
orderLines.data.pack.href |
string |
orderLines.data.description |
string |
orderLines.data.orderPackQuantity |
number |
orderLines.data.canceledPackQuantity |
number |
orderLines.data.lotNumber |
string |
orderLines.data.bornOnDate |
string |
orderLines.data.expirationDate |
string |
orderLines.data.productCode |
string |
orderLines.data.inventoryCondition |
string |
orderLines.data.inventoryAttribute1 |
string |
orderLines.data.inventoryAttribute2 |
string |
orderLines.data.plannedShipDate |
string |
orderLines.data.plannedArrivalDate |
string |
orderLines.data.unitPrice |
number |
orderLines.data.unitCost |
number |
orderLines.data.priceCode |
string |
orderLines.data.lineTotal |
number |
orderLines.data.taxable |
boolean |
orderLines.data.taxCost |
number |
orderLines.data.taxableTotal |
number |
orderLines.data.untaxableTotal |
number |
orderLines.data.extendedTotal |
number |
orderLines.data.discountAmount |
number |
orderLines.data.shippingAmount |
number |
orderLines.data.weight |
object |
orderLines.data.weight.weight |
number |
orderLines.data.weight.units |
string |
orderLines.data.importReference |
string |
orderLines.data.exportReference |
string |
orderLines.data.customAttribute1 |
string |
orderLines.data.customAttribute2 |
string |
orderLines.data.customAttribute3 |
string |
orderLines.data.customFields |
objectarray |
orderLines.data.customFields.self |
object |
orderLines.data.customFields.self.id |
number |
orderLines.data.customFields.self.businessKey |
object |
orderLines.data.customFields.self.href |
string |
orderLines.data.customFields.name |
string |
orderLines.data.customFields.value |
string |
orderLines.data.customFields.type |
string |
orderLines.data.customFields.item |
object |
orderLines.data.customFields.item.id |
number |
orderLines.data.customFields.item.businessKey |
object |
orderLines.data.customFields.item.href |
string |
orderLines.data.customFields.orderHeader |
object |
orderLines.data.customFields.orderHeader.id |
number |
orderLines.data.customFields.orderHeader.businessKey |
object |
orderLines.data.customFields.orderHeader.href |
string |
orderLines.data.customFields.orderLine |
object |
orderLines.data.customFields.orderLine.id |
number |
orderLines.data.customFields.orderLine.businessKey |
object |
orderLines.data.customFields.orderLine.href |
string |
orderLines.data.customFields.shipment |
object |
orderLines.data.customFields.shipment.id |
number |
orderLines.data.customFields.shipment.businessKey |
object |
orderLines.data.customFields.shipment.href |
string |
orderLines.data.customFields.createdDate |
string |
orderLines.data.customFields.updatedDate |
string |
orderLines.data.customFields.createdBy |
object |
orderLines.data.customFields.createdBy.id |
number |
orderLines.data.customFields.createdBy.businessKey |
object |
orderLines.data.customFields.createdBy.href |
string |
orderLines.data.customFields.updatedBy |
object |
orderLines.data.customFields.updatedBy.id |
number |
orderLines.data.customFields.updatedBy.businessKey |
object |
orderLines.data.customFields.updatedBy.href |
string |
orderLines.data.notes |
objectarray |
orderLines.data.notes.self |
object |
orderLines.data.notes.self.id |
number |
orderLines.data.notes.self.businessKey |
object |
orderLines.data.notes.self.href |
string |
orderLines.data.notes.title |
string |
orderLines.data.notes.body |
string |
orderLines.data.notes.source |
string |
orderLines.data.notes.priority |
string |
orderLines.data.notes.orderHeader |
object |
orderLines.data.notes.orderHeader.id |
number |
orderLines.data.notes.orderHeader.businessKey |
object |
orderLines.data.notes.orderHeader.href |
string |
orderLines.data.notes.orderLine |
object |
orderLines.data.notes.orderLine.id |
number |
orderLines.data.notes.orderLine.businessKey |
object |
orderLines.data.notes.orderLine.href |
string |
orderLines.data.channels |
objectarray |
orderLines.data.channels.self |
object |
orderLines.data.channels.self.id |
number |
orderLines.data.channels.self.businessKey |
object |
orderLines.data.channels.self.href |
string |
orderLines.data.channels.integration |
object |
orderLines.data.channels.integration.id |
number |
orderLines.data.channels.integration.businessKey |
object |
orderLines.data.channels.integration.href |
string |
orderLines.data.channels.schedulerTask |
object |
orderLines.data.channels.schedulerTask.id |
number |
orderLines.data.channels.schedulerTask.businessKey |
object |
orderLines.data.channels.schedulerTask.href |
string |
orderLines.data.channels.ref1 |
string |
orderLines.data.channels.ref2 |
string |
orderLines.data.channels.ref3 |
string |
orderLines.data.channels.ref4 |
string |
orderLines.data.channels.ref5 |
string |
orderLines.data.channels.secRef1 |
string |
orderLines.data.channels.secRef2 |
string |
orderLines.data.channels.secRef3 |
string |
orderLines.data.channels.secRef4 |
string |
orderLines.data.channels.secRef5 |
string |
orderLines.data.channels.createdDate |
string |
orderLines.data.channels.updatedDate |
string |
orderLines.data.channels.createdBy |
object |
orderLines.data.channels.createdBy.id |
number |
orderLines.data.channels.createdBy.businessKey |
object |
orderLines.data.channels.createdBy.href |
string |
orderLines.data.channels.updatedBy |
object |
orderLines.data.channels.updatedBy.id |
number |
orderLines.data.channels.updatedBy.businessKey |
object |
orderLines.data.channels.updatedBy.href |
string |
orderLines.data.createdDate |
string |
orderLines.data.updatedDate |
string |
orderLines.data.createdBy |
object |
orderLines.data.createdBy.id |
number |
orderLines.data.createdBy.businessKey |
object |
orderLines.data.createdBy.href |
string |
orderLines.data.updatedBy |
object |
orderLines.data.updatedBy.id |
number |
orderLines.data.updatedBy.businessKey |
object |
orderLines.data.updatedBy.href |
string |
orderLines.data.orderLineStatus |
string |
orderLines.data.shipToFacility |
object |
orderLines.data.shipToFacility.id |
number |
orderLines.data.shipToFacility.businessKey |
object |
orderLines.data.shipToFacility.href |
string |
orderLines.data.inboundLPN |
string |
orderLines.data.masterInboundLPN |
string |
orderLines.data.receivedPackQuantity |
number |
orderLines.data.receivedDamagedPackQuantity |
number |
orderLines.data.returnedPackQuantity |
number |
orderLines.data.invoice |
string |
orderLine |
object |
orderLine.id |
number |
orderLine.businessKey |
object |
orderLine.href |
string |
canceledPackQuantity |
number |
shipments |
object |
shipments.data |
objectarray |
shipments.data.id |
number |
shipments.data.businessKey |
object |
shipments.data.href |
string |
lineNumber |
string |
customerLineNumber |
string |
relatedOrderLine |
object |
relatedOrderLine.id |
number |
relatedOrderLine.businessKey |
object |
relatedOrderLine.href |
string |
sortOrder |
number |
orderHeader |
object |
orderHeader.id |
number |
orderHeader.businessKey |
object |
orderHeader.href |
string |
item |
object |
item.id |
number |
item.businessKey |
object |
item.href |
string |
pack |
object |
pack.id |
number |
pack.businessKey |
object |
pack.href |
string |
description |
string |
orderPackQuantity |
number |
canceledPackQuantity |
number |
lotNumber |
string |
bornOnDate |
string |
expirationDate |
string |
productCode |
string |
inventoryCondition |
string |
inventoryAttribute1 |
string |
inventoryAttribute2 |
string |
unitPrice |
number |
unitCost |
number |
priceCode |
string |
lineTotal |
number |
taxCost |
number |
taxableTotal |
number |
untaxableTotal |
number |
extendedTotal |
number |
discountAmount |
number |
shippingAmount |
number |
orderLineStatus |
string |
inboundLPN |
string |
masterInboundLPN |
string |
receivedPackQuantity |
number |
receivedDamagedPackQuantity |
number |
returnedPackQuantity |
number |
invoice |
string |
Sales orders — Get a list of sales orders
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
orderPriority |
number |
orderSummary |
string |
orderSource |
string |
secondaryOrderSource |
string |
customerOrderNumber |
string |
relatedOrderNumber |
string |
partnerInvoiceNumber |
string |
consigneePartner |
object |
consigneePartner.id |
number |
consigneePartner.businessKey |
object |
consigneePartner.href |
string |
tradingPartnerSite |
object |
tradingPartnerSite.id |
number |
tradingPartnerSite.businessKey |
object |
tradingPartnerSite.href |
string |
shipToContact |
object |
shipToContact.attention |
string |
shipToContact.name |
string |
shipToContact.firstName |
string |
shipToContact.lastName |
string |
shipToContact.contactName |
string |
shipToContact.phone |
string |
shipToContact.email |
string |
shipToAddress |
object |
shipToAddress.line1 |
string |
shipToAddress.line2 |
string |
shipToAddress.line3 |
string |
shipToAddress.line4 |
string |
shipToAddress.city |
string |
shipToAddress.stateProvince |
string |
shipToAddress.postalCode |
string |
shipToAddress.country |
string |
billToContact |
object |
billToContact.name |
string |
billToContact.firstName |
string |
billToContact.lastName |
string |
billToContact.contactName |
string |
billToContact.attention |
string |
billToContact.phone |
string |
billToContact.email |
string |
billToAccountNumber |
string |
billToAddress |
object |
billToAddress.line1 |
string |
billToAddress.line2 |
string |
billToAddress.line3 |
string |
billToAddress.line4 |
string |
billToAddress.city |
string |
billToAddress.stateProvince |
string |
billToAddress.postalCode |
string |
billToAddress.country |
string |
shipFromContact |
object |
shipFromContact.name |
string |
shipFromContact.firstName |
string |
shipFromContact.lastName |
string |
shipFromContact.attention |
string |
shipFromContact.phone |
string |
shipFromContact.email |
string |
shipFromAddress |
object |
shipFromAddress.line1 |
string |
shipFromAddress.line2 |
string |
shipFromAddress.city |
string |
shipFromAddress.stateProvince |
string |
shipFromAddress.postalCode |
string |
shipFromAddress.country |
string |
placedDate |
string |
plannedArrivalDate |
string |
plannedReleaseDate |
string |
plannedShipDate |
string |
earliestShipDate |
string |
earliestDeliveryDate |
string |
cancelByArrivalDate |
string |
cancelByReleaseDate |
string |
cancelByShipDate |
string |
actualArrivalDate |
string |
actualReleaseDate |
string |
actualShipDate |
string |
priceList |
object |
priceList.id |
number |
priceList.businessKey |
object |
priceList.href |
string |
orderTotal |
number |
orderSubtotal |
number |
orderDiscountSubtotal |
number |
orderShippingTotal |
number |
orderShipTotal |
number |
taxable |
boolean |
orderTaxTotal |
number |
orderTaxableTotal |
number |
orderUntaxableTotal |
number |
shippingTaxTotal |
number |
shipVia |
string |
shipVendor |
string |
shipMethod |
string |
freightTermsType |
string |
freightBillToContact |
object |
freightBillToContact.name |
string |
freightBillToContact.firstName |
string |
freightBillToContact.lastName |
string |
freightBillToContact.attention |
string |
freightBillToContact.phone |
string |
freightBillToAccount |
string |
freightBillToAddress |
object |
freightBillToAddress.line1 |
string |
freightBillToAddress.line2 |
string |
freightBillToAddress.line3 |
string |
freightBillToAddress.line4 |
string |
freightBillToAddress.city |
string |
freightBillToAddress.stateProvince |
string |
freightBillToAddress.postalCode |
string |
freightBillToAddress.country |
string |
deliverToContact |
object |
deliverToContact.name |
string |
deliverToContact.attention |
string |
deliverToContact.phone |
string |
deliverToAddress |
object |
deliverToAddress.line1 |
string |
deliverToAddress.line2 |
string |
deliverToAddress.city |
string |
deliverToAddress.stateProvince |
string |
deliverToAddress.postalCode |
string |
deliverToAddress.country |
string |
weight |
object |
weight.weight |
number |
weight.units |
string |
returnRequired |
boolean |
returnShipVia |
string |
returnShipOption |
string |
deliveryConfirmation |
string |
insuranceRequired |
boolean |
homeDelivery |
boolean |
residential |
boolean |
saturdayDelivery |
boolean |
hubId |
string |
routingNumber |
string |
incotermsType |
string |
importType |
string |
importReference |
string |
exportReference |
string |
otherReferenceNumber2 |
string |
integrationSource |
object |
integrationSource.id |
number |
integrationSource.businessKey |
object |
integrationSource.href |
string |
sendASN |
string |
dropShip |
boolean |
pickWave |
object |
pickWave.id |
number |
pickWave.businessKey |
object |
pickWave.href |
string |
postReleaseState |
string |
entryName |
string |
entryPhone1 |
string |
saleConditionCode |
string |
seller |
string |
notificationCode1 |
string |
notificationCode2 |
string |
notificationCode3 |
string |
verbalConfirmationName |
string |
verbalConfirmationPhoneNumber |
string |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
customAttribute4 |
string |
customAttribute5 |
string |
customAttribute6 |
string |
customAttribute7 |
string |
customFields |
objectarray |
customFields.self |
object |
customFields.self.id |
number |
customFields.self.businessKey |
object |
customFields.self.href |
string |
customFields.name |
string |
customFields.value |
string |
customFields.type |
string |
customFields.item |
object |
customFields.item.id |
number |
customFields.item.businessKey |
object |
customFields.item.href |
string |
customFields.orderHeader |
object |
customFields.orderHeader.id |
number |
customFields.orderHeader.businessKey |
object |
customFields.orderHeader.href |
string |
customFields.orderLine |
object |
customFields.orderLine.id |
number |
customFields.orderLine.businessKey |
object |
customFields.orderLine.href |
string |
customFields.shipment |
object |
customFields.shipment.id |
number |
customFields.shipment.businessKey |
object |
customFields.shipment.href |
string |
customFields.createdDate |
string |
customFields.updatedDate |
string |
customFields.createdBy |
object |
customFields.createdBy.id |
number |
customFields.createdBy.businessKey |
object |
customFields.createdBy.href |
string |
customFields.updatedBy |
object |
customFields.updatedBy.id |
number |
customFields.updatedBy.businessKey |
object |
customFields.updatedBy.href |
string |
notes |
objectarray |
notes.self |
object |
notes.self.id |
number |
notes.self.businessKey |
object |
notes.self.href |
string |
notes.title |
string |
notes.body |
string |
notes.source |
string |
notes.priority |
string |
notes.orderHeader |
object |
notes.orderHeader.id |
number |
notes.orderHeader.businessKey |
object |
notes.orderHeader.href |
string |
notes.orderLine |
object |
notes.orderLine.id |
number |
notes.orderLine.businessKey |
object |
notes.orderLine.href |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.schedulerTask |
object |
channels.schedulerTask.id |
number |
channels.schedulerTask.businessKey |
object |
channels.schedulerTask.href |
string |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
type |
string |
orderStatus |
string |
shipFromFacility |
object |
shipFromFacility.id |
number |
shipFromFacility.businessKey |
object |
shipFromFacility.href |
string |
otherReferenceNumber |
string |
dutyPaidBy |
string |
dutyPaidByType |
string |
dutyPaidByContactName |
string |
dutyPaidByAccount |
string |
dutyPaidByPostalCode |
string |
dutyPaidByCountry |
string |
directedToZone |
object |
directedToZone.id |
number |
directedToZone.businessKey |
object |
directedToZone.href |
string |
customerOrderHeaders |
objectarray |
customerOrderHeaders.id |
number |
customerOrderHeaders.businessKey |
object |
customerOrderHeaders.href |
string |
orderLines |
object |
orderLines.data |
objectarray |
orderLines.data.self |
object |
orderLines.data.self.id |
number |
orderLines.data.self.businessKey |
object |
orderLines.data.self.href |
string |
orderLines.data.businessUnit |
object |
orderLines.data.businessUnit.id |
number |
orderLines.data.businessUnit.businessKey |
object |
orderLines.data.businessUnit.href |
string |
orderLines.data.lineNumber |
string |
orderLines.data.customerLineNumber |
string |
orderLines.data.relatedOrderLine |
object |
orderLines.data.relatedOrderLine.id |
number |
orderLines.data.relatedOrderLine.businessKey |
object |
orderLines.data.relatedOrderLine.href |
string |
orderLines.data.sortOrder |
number |
orderLines.data.orderHeader |
object |
orderLines.data.orderHeader.id |
number |
orderLines.data.orderHeader.businessKey |
object |
orderLines.data.orderHeader.href |
string |
orderLines.data.item |
object |
orderLines.data.item.id |
number |
orderLines.data.item.businessKey |
object |
orderLines.data.item.href |
string |
orderLines.data.pack |
object |
orderLines.data.pack.id |
number |
orderLines.data.pack.businessKey |
object |
orderLines.data.pack.href |
string |
orderLines.data.description |
string |
orderLines.data.orderPackQuantity |
number |
orderLines.data.canceledPackQuantity |
number |
orderLines.data.lotNumber |
string |
orderLines.data.bornOnDate |
string |
orderLines.data.expirationDate |
string |
orderLines.data.productCode |
string |
orderLines.data.inventoryCondition |
string |
orderLines.data.inventoryAttribute1 |
string |
orderLines.data.inventoryAttribute2 |
string |
orderLines.data.plannedShipDate |
string |
orderLines.data.plannedArrivalDate |
string |
orderLines.data.unitPrice |
number |
orderLines.data.unitCost |
number |
orderLines.data.priceCode |
string |
orderLines.data.lineTotal |
number |
orderLines.data.taxable |
boolean |
orderLines.data.taxCost |
number |
orderLines.data.taxableTotal |
number |
orderLines.data.untaxableTotal |
number |
orderLines.data.extendedTotal |
number |
orderLines.data.discountAmount |
number |
orderLines.data.shippingAmount |
number |
orderLines.data.weight |
object |
orderLines.data.weight.weight |
number |
orderLines.data.weight.units |
string |
orderLines.data.importReference |
string |
orderLines.data.exportReference |
string |
orderLines.data.customAttribute1 |
string |
orderLines.data.customAttribute2 |
string |
orderLines.data.customAttribute3 |
string |
orderLines.data.customFields |
objectarray |
orderLines.data.customFields.self |
object |
orderLines.data.customFields.self.id |
number |
orderLines.data.customFields.self.businessKey |
object |
orderLines.data.customFields.self.href |
string |
orderLines.data.customFields.name |
string |
orderLines.data.customFields.value |
string |
orderLines.data.customFields.type |
string |
orderLines.data.customFields.item |
object |
orderLines.data.customFields.item.id |
number |
orderLines.data.customFields.item.businessKey |
object |
orderLines.data.customFields.item.href |
string |
orderLines.data.customFields.orderHeader |
object |
orderLines.data.customFields.orderHeader.id |
number |
orderLines.data.customFields.orderHeader.businessKey |
object |
orderLines.data.customFields.orderHeader.href |
string |
orderLines.data.customFields.orderLine |
object |
orderLines.data.customFields.orderLine.id |
number |
orderLines.data.customFields.orderLine.businessKey |
object |
orderLines.data.customFields.orderLine.href |
string |
orderLines.data.customFields.shipment |
object |
orderLines.data.customFields.shipment.id |
number |
orderLines.data.customFields.shipment.businessKey |
object |
orderLines.data.customFields.shipment.href |
string |
orderLines.data.customFields.createdDate |
string |
orderLines.data.customFields.updatedDate |
string |
orderLines.data.customFields.createdBy |
object |
orderLines.data.customFields.createdBy.id |
number |
orderLines.data.customFields.createdBy.businessKey |
object |
orderLines.data.customFields.createdBy.href |
string |
orderLines.data.customFields.updatedBy |
object |
orderLines.data.customFields.updatedBy.id |
number |
orderLines.data.customFields.updatedBy.businessKey |
object |
orderLines.data.customFields.updatedBy.href |
string |
orderLines.data.notes |
objectarray |
orderLines.data.notes.self |
object |
orderLines.data.notes.self.id |
number |
orderLines.data.notes.self.businessKey |
object |
orderLines.data.notes.self.href |
string |
orderLines.data.notes.title |
string |
orderLines.data.notes.body |
string |
orderLines.data.notes.source |
string |
orderLines.data.notes.priority |
string |
orderLines.data.notes.orderHeader |
object |
orderLines.data.notes.orderHeader.id |
number |
orderLines.data.notes.orderHeader.businessKey |
object |
orderLines.data.notes.orderHeader.href |
string |
orderLines.data.notes.orderLine |
object |
orderLines.data.notes.orderLine.id |
number |
orderLines.data.notes.orderLine.businessKey |
object |
orderLines.data.notes.orderLine.href |
string |
orderLines.data.channels |
objectarray |
orderLines.data.channels.self |
object |
orderLines.data.channels.self.id |
number |
orderLines.data.channels.self.businessKey |
object |
orderLines.data.channels.self.href |
string |
orderLines.data.channels.integration |
object |
orderLines.data.channels.integration.id |
number |
orderLines.data.channels.integration.businessKey |
object |
orderLines.data.channels.integration.href |
string |
orderLines.data.channels.schedulerTask |
object |
orderLines.data.channels.schedulerTask.id |
number |
orderLines.data.channels.schedulerTask.businessKey |
object |
orderLines.data.channels.schedulerTask.href |
string |
orderLines.data.channels.ref1 |
string |
orderLines.data.channels.ref2 |
string |
orderLines.data.channels.ref3 |
string |
orderLines.data.channels.ref4 |
string |
orderLines.data.channels.ref5 |
string |
orderLines.data.channels.secRef1 |
string |
orderLines.data.channels.secRef2 |
string |
orderLines.data.channels.secRef3 |
string |
orderLines.data.channels.secRef4 |
string |
orderLines.data.channels.secRef5 |
string |
orderLines.data.channels.createdDate |
string |
orderLines.data.channels.updatedDate |
string |
orderLines.data.channels.createdBy |
object |
orderLines.data.channels.createdBy.id |
number |
orderLines.data.channels.createdBy.businessKey |
object |
orderLines.data.channels.createdBy.href |
string |
orderLines.data.channels.updatedBy |
object |
orderLines.data.channels.updatedBy.id |
number |
orderLines.data.channels.updatedBy.businessKey |
object |
orderLines.data.channels.updatedBy.href |
string |
orderLines.data.createdDate |
string |
orderLines.data.updatedDate |
string |
orderLines.data.createdBy |
object |
orderLines.data.createdBy.id |
number |
orderLines.data.createdBy.businessKey |
object |
orderLines.data.createdBy.href |
string |
orderLines.data.updatedBy |
object |
orderLines.data.updatedBy.id |
number |
orderLines.data.updatedBy.businessKey |
object |
orderLines.data.updatedBy.href |
string |
orderLines.data.orderLineStatus |
string |
orderLines.data.shipFromFacility |
object |
orderLines.data.shipFromFacility.id |
number |
orderLines.data.shipFromFacility.businessKey |
object |
orderLines.data.shipFromFacility.href |
string |
orderLines.data.coLine |
object |
orderLines.data.coLine.id |
number |
orderLines.data.coLine.businessKey |
object |
orderLines.data.coLine.href |
string |
orderLines.data.allocatedQuantity |
number |
orderLines.data.unallocatedQuantity |
number |
orderLines.data.pickedPackQuantity |
number |
orderLines.data.shortagePackQuantity |
number |
orderLines.data.shippedPackQuantity |
number |
orderLines.data.returnedPackQuantity |
number |
orderLines.data.preallocated |
boolean |
orderLines.data.isBackOrdered |
string |
orderLines.data.platinumLineNo |
number |
orderLines.data.directedToZone |
object |
orderLines.data.directedToZone.id |
number |
orderLines.data.directedToZone.businessKey |
object |
orderLines.data.directedToZone.href |
string |
orderLines.data.allocateFromZone |
boolean |
orderLines.data.carrierSpecialServices |
objectarray |
orderLines.data.carrierSpecialServices.self |
object |
orderLines.data.carrierSpecialServices.self.id |
number |
orderLines.data.carrierSpecialServices.self.businessKey |
object |
orderLines.data.carrierSpecialServices.self.href |
string |
orderLines.data.carrierSpecialServices.shipVendor |
string |
orderLines.data.carrierSpecialServices.item |
object |
orderLines.data.carrierSpecialServices.item.id |
number |
orderLines.data.carrierSpecialServices.item.businessKey |
object |
orderLines.data.carrierSpecialServices.item.href |
string |
orderLines.data.carrierSpecialServices.pack |
object |
orderLines.data.carrierSpecialServices.pack.id |
number |
orderLines.data.carrierSpecialServices.pack.businessKey |
object |
orderLines.data.carrierSpecialServices.pack.href |
string |
orderLines.data.carrierSpecialServices.salesOrder |
object |
orderLines.data.carrierSpecialServices.salesOrder.id |
number |
orderLines.data.carrierSpecialServices.salesOrder.businessKey |
object |
orderLines.data.carrierSpecialServices.salesOrder.href |
string |
orderLines.data.carrierSpecialServices.orderLine |
object |
orderLines.data.carrierSpecialServices.orderLine.id |
number |
orderLines.data.carrierSpecialServices.orderLine.businessKey |
object |
orderLines.data.carrierSpecialServices.orderLine.href |
string |
orderLines.data.carrierSpecialServices.customerOrder |
object |
orderLines.data.carrierSpecialServices.customerOrder.id |
number |
orderLines.data.carrierSpecialServices.customerOrder.businessKey |
object |
orderLines.data.carrierSpecialServices.customerOrder.href |
string |
orderLines.data.carrierSpecialServices.customerOrderLine |
object |
orderLines.data.carrierSpecialServices.customerOrderLine.id |
number |
orderLines.data.carrierSpecialServices.customerOrderLine.businessKey |
object |
orderLines.data.carrierSpecialServices.customerOrderLine.href |
string |
orderLines.data.carrierSpecialServices.battery |
boolean |
orderLines.data.carrierSpecialServices.batteryMaterial |
string |
orderLines.data.carrierSpecialServices.batteryPacking |
string |
orderLines.data.carrierSpecialServices.batteryRegulation |
string |
orderLines.data.carrierSpecialServices.chemicalIdentifier |
string |
orderLines.data.carrierSpecialServices.commodityRegulations |
string |
orderLines.data.carrierSpecialServices.dangerousGoodsAmount |
number |
orderLines.data.carrierSpecialServices.dangerousGoodsUOM |
string |
orderLines.data.carrierSpecialServices.hazardClass |
number |
orderLines.data.carrierSpecialServices.extendedHazardClass |
string |
orderLines.data.carrierSpecialServices.hazardLabelDescription |
string |
orderLines.data.carrierSpecialServices.hazmatExceptedQuantity |
string |
orderLines.data.carrierSpecialServices.hazmatLimitedQuantity |
string |
orderLines.data.carrierSpecialServices.limitedQtyPackingInstructions |
string |
orderLines.data.carrierSpecialServices.packagingGroupType |
string |
orderLines.data.carrierSpecialServices.packagingType |
string |
orderLines.data.carrierSpecialServices.packingInstructions |
string |
orderLines.data.carrierSpecialServices.properShippingName |
string |
orderLines.data.carrierSpecialServices.regulationSet |
string |
orderLines.data.carrierSpecialServices.subRiskClass1 |
string |
orderLines.data.carrierSpecialServices.subRiskClass2 |
string |
orderLines.data.carrierSpecialServices.subRiskClass3 |
string |
orderLines.data.carrierSpecialServices.technicalName |
string |
orderLines.data.carrierSpecialServices.transportationMode |
string |
orderLines.data.carrierSpecialServices.unNumber |
string |
orderLines.data.carrierSpecialServices.shipsWithDryIce |
boolean |
orderLines.data.carrierSpecialServices.medicalUse |
boolean |
orderLines.data.carrierSpecialServices.alcohol |
boolean |
orderLines.data.carrierSpecialServices.holdAtLocation |
boolean |
orderLines.data.carrierSpecialServices.returnReceiptRequested |
boolean |
orderLines.data.carrierSpecialServices.saturdayDelivery |
boolean |
orderLines.data.carrierSpecialServices.liftgateDelivery |
boolean |
orderLines.data.carrierSpecialServices.appointmentDelivery |
boolean |
orderLines.data.carrierSpecialServices.accessible |
boolean |
orderLines.data.carrierSpecialServices.cargoAircraft |
boolean |
orderLines.data.carrierSpecialServices.exportComplianceStatement |
string |
orderLines.data.carrierSpecialServices.createdDate |
string |
orderLines.data.carrierSpecialServices.updatedDate |
string |
orderLines.data.carrierSpecialServices.createdBy |
object |
orderLines.data.carrierSpecialServices.createdBy.id |
number |
orderLines.data.carrierSpecialServices.createdBy.businessKey |
object |
orderLines.data.carrierSpecialServices.createdBy.href |
string |
orderLines.data.carrierSpecialServices.updatedBy |
object |
orderLines.data.carrierSpecialServices.updatedBy.id |
number |
orderLines.data.carrierSpecialServices.updatedBy.businessKey |
object |
orderLines.data.carrierSpecialServices.updatedBy.href |
string |
orderLine |
object |
orderLine.id |
number |
orderLine.businessKey |
object |
orderLine.href |
string |
canceledPackQuantity |
number |
carrierSpecialServices |
objectarray |
carrierSpecialServices.self |
object |
carrierSpecialServices.self.id |
number |
carrierSpecialServices.self.businessKey |
object |
carrierSpecialServices.self.href |
string |
carrierSpecialServices.shipVendor |
string |
carrierSpecialServices.item |
object |
carrierSpecialServices.item.id |
number |
carrierSpecialServices.item.businessKey |
object |
carrierSpecialServices.item.href |
string |
carrierSpecialServices.pack |
object |
carrierSpecialServices.pack.id |
number |
carrierSpecialServices.pack.businessKey |
object |
carrierSpecialServices.pack.href |
string |
carrierSpecialServices.salesOrder |
object |
carrierSpecialServices.salesOrder.id |
number |
carrierSpecialServices.salesOrder.businessKey |
object |
carrierSpecialServices.salesOrder.href |
string |
carrierSpecialServices.orderLine |
object |
carrierSpecialServices.orderLine.id |
number |
carrierSpecialServices.orderLine.businessKey |
object |
carrierSpecialServices.orderLine.href |
string |
carrierSpecialServices.customerOrder |
object |
carrierSpecialServices.customerOrder.id |
number |
carrierSpecialServices.customerOrder.businessKey |
object |
carrierSpecialServices.customerOrder.href |
string |
carrierSpecialServices.customerOrderLine |
object |
carrierSpecialServices.customerOrderLine.id |
number |
carrierSpecialServices.customerOrderLine.businessKey |
object |
carrierSpecialServices.customerOrderLine.href |
string |
carrierSpecialServices.battery |
boolean |
carrierSpecialServices.batteryMaterial |
string |
carrierSpecialServices.batteryPacking |
string |
carrierSpecialServices.batteryRegulation |
string |
carrierSpecialServices.chemicalIdentifier |
string |
carrierSpecialServices.commodityRegulations |
string |
carrierSpecialServices.dangerousGoodsAmount |
number |
carrierSpecialServices.dangerousGoodsUOM |
string |
carrierSpecialServices.hazardClass |
number |
carrierSpecialServices.extendedHazardClass |
string |
carrierSpecialServices.hazardLabelDescription |
string |
carrierSpecialServices.hazmatExceptedQuantity |
string |
carrierSpecialServices.hazmatLimitedQuantity |
string |
carrierSpecialServices.limitedQtyPackingInstructions |
string |
carrierSpecialServices.packagingGroupType |
string |
carrierSpecialServices.packagingType |
string |
carrierSpecialServices.packingInstructions |
string |
carrierSpecialServices.properShippingName |
string |
carrierSpecialServices.regulationSet |
string |
carrierSpecialServices.subRiskClass1 |
string |
carrierSpecialServices.subRiskClass2 |
string |
carrierSpecialServices.subRiskClass3 |
string |
carrierSpecialServices.technicalName |
string |
carrierSpecialServices.transportationMode |
string |
carrierSpecialServices.unNumber |
string |
carrierSpecialServices.shipsWithDryIce |
boolean |
carrierSpecialServices.medicalUse |
boolean |
carrierSpecialServices.alcohol |
boolean |
carrierSpecialServices.holdAtLocation |
boolean |
carrierSpecialServices.returnReceiptRequested |
boolean |
carrierSpecialServices.saturdayDelivery |
boolean |
carrierSpecialServices.liftgateDelivery |
boolean |
carrierSpecialServices.appointmentDelivery |
boolean |
carrierSpecialServices.accessible |
boolean |
carrierSpecialServices.cargoAircraft |
boolean |
carrierSpecialServices.exportComplianceStatement |
string |
carrierSpecialServices.createdDate |
string |
carrierSpecialServices.updatedDate |
string |
carrierSpecialServices.createdBy |
object |
carrierSpecialServices.createdBy.id |
number |
carrierSpecialServices.createdBy.businessKey |
object |
carrierSpecialServices.createdBy.href |
string |
carrierSpecialServices.updatedBy |
object |
carrierSpecialServices.updatedBy.id |
number |
carrierSpecialServices.updatedBy.businessKey |
object |
carrierSpecialServices.updatedBy.href |
string |
shipments |
object |
shipments.data |
objectarray |
shipments.data.id |
number |
shipments.data.businessKey |
object |
shipments.data.href |
string |
lineNumber |
string |
customerLineNumber |
string |
relatedOrderLine |
object |
relatedOrderLine.id |
number |
relatedOrderLine.businessKey |
object |
relatedOrderLine.href |
string |
sortOrder |
number |
orderHeader |
object |
orderHeader.id |
number |
orderHeader.businessKey |
object |
orderHeader.href |
string |
item |
object |
item.id |
number |
item.businessKey |
object |
item.href |
string |
pack |
object |
pack.id |
number |
pack.businessKey |
object |
pack.href |
string |
description |
string |
orderPackQuantity |
number |
canceledPackQuantity |
number |
lotNumber |
string |
bornOnDate |
string |
expirationDate |
string |
productCode |
string |
inventoryCondition |
string |
inventoryAttribute1 |
string |
inventoryAttribute2 |
string |
unitPrice |
number |
unitCost |
number |
priceCode |
string |
lineTotal |
number |
taxCost |
number |
taxableTotal |
number |
untaxableTotal |
number |
extendedTotal |
number |
discountAmount |
number |
shippingAmount |
number |
orderLineStatus |
string |
coLine |
object |
coLine.id |
number |
coLine.businessKey |
object |
coLine.href |
string |
allocatedQuantity |
number |
unallocatedQuantity |
number |
pickedPackQuantity |
number |
shortagePackQuantity |
number |
shippedPackQuantity |
number |
returnedPackQuantity |
number |
preallocated |
boolean |
isBackOrdered |
string |
platinumLineNo |
number |
allocateFromZone |
boolean |
Trading partners — Get a list of trading partners
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
code |
string |
name |
string |
partnershipType |
string |
description |
string |
contact |
object |
contact.firstName |
string |
contact.lastName |
string |
contact.email |
string |
contact.phone |
string |
contact.fax |
string |
address |
object |
address.line1 |
string |
address.line2 |
string |
address.line3 |
string |
address.line4 |
string |
address.city |
string |
address.stateProvince |
string |
address.postalCode |
string |
address.country |
string |
billToContact |
object |
billToContact.firstName |
string |
billToContact.lastName |
string |
billToContact.email |
string |
billToContact.phone |
string |
billToAddress |
object |
billToAddress.line1 |
string |
billToAddress.line2 |
string |
billToAddress.line3 |
string |
billToAddress.line4 |
string |
billToAddress.city |
string |
billToAddress.stateProvince |
string |
billToAddress.postalCode |
string |
billToAddress.country |
string |
sites |
object |
sites.data |
objectarray |
sites.data.self |
object |
sites.data.self.id |
number |
sites.data.self.businessKey |
object |
sites.data.self.href |
string |
sites.data.businessUnit |
object |
sites.data.businessUnit.id |
number |
sites.data.businessUnit.businessKey |
object |
sites.data.businessUnit.href |
string |
sites.data.tradingPartner |
object |
sites.data.tradingPartner.id |
number |
sites.data.tradingPartner.businessKey |
object |
sites.data.tradingPartner.href |
string |
sites.data.type |
string |
sites.data.siteName |
string |
sites.data.siteCode |
string |
sites.data.siteKey |
string |
sites.data.address |
object |
sites.data.address.type |
string |
sites.data.address.attentionTo |
string |
sites.data.address.line1 |
string |
sites.data.address.line2 |
string |
sites.data.address.line3 |
string |
sites.data.address.line4 |
string |
sites.data.address.city |
string |
sites.data.address.stateProvince |
string |
sites.data.address.postalCode |
string |
sites.data.address.country |
string |
sites.data.defaultShipVia |
string |
sites.data.createdBy |
object |
sites.data.createdBy.id |
number |
sites.data.createdBy.businessKey |
object |
sites.data.createdBy.href |
string |
sites.data.updatedBy |
object |
sites.data.updatedBy.id |
number |
sites.data.updatedBy.businessKey |
object |
sites.data.updatedBy.href |
string |
sites.data.createdDate |
string |
sites.data.updatedDate |
string |
accountNumber |
string |
accountStatus |
string |
doingBusinessAs |
string |
packingSlipLevel |
string |
packingSlipReport |
string |
zplLabelReport |
string |
sendASN |
string |
groupASNBy |
string |
groupPalletBy |
string |
expirationThresholdInDays |
number |
ssccNumbersRequiredForTrip |
boolean |
sequenceSSCCBy |
string |
ucceanCompanyNumber |
string |
ssccExpansionDigit |
number |
priceList |
object |
priceList.id |
number |
priceList.businessKey |
object |
priceList.href |
string |
taxRate |
number |
dropShipFee |
number |
qualityControlPercent |
number |
useShipFromForShipments |
boolean |
upsAccountNumber |
string |
fedexAccountNumber |
string |
transRoutingEnabled |
boolean |
minOrderAmount |
number |
paymentTerms |
string |
defaultCurrencyCode |
string |
supplierBlackoutCalendar |
object |
supplierBlackoutCalendar.id |
number |
supplierBlackoutCalendar.businessKey |
object |
supplierBlackoutCalendar.href |
string |
parameters |
object |
parameters.data |
objectarray |
parameters.data.self |
object |
parameters.data.self.id |
number |
parameters.data.self.businessKey |
object |
parameters.data.self.href |
string |
parameters.data.businessUnit |
object |
parameters.data.businessUnit.id |
number |
parameters.data.businessUnit.businessKey |
object |
parameters.data.businessUnit.href |
string |
parameters.data.tradingPartner |
object |
parameters.data.tradingPartner.id |
number |
parameters.data.tradingPartner.businessKey |
object |
parameters.data.tradingPartner.href |
string |
parameters.data.code |
string |
parameters.data.number |
string |
parameters.data.description |
string |
parameters.data.resultName |
string |
parameters.data.resultValue |
string |
parameters.data.createdDate |
string |
parameters.data.updatedDate |
string |
parameters.data.createdBy |
object |
parameters.data.createdBy.id |
number |
parameters.data.createdBy.businessKey |
object |
parameters.data.createdBy.href |
string |
parameters.data.updatedBy |
object |
parameters.data.updatedBy.id |
number |
parameters.data.updatedBy.businessKey |
object |
parameters.data.updatedBy.href |
string |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
customAttribute4 |
string |
importReference1 |
string |
importReference2 |
string |
exportReference1 |
string |
exportReference2 |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.schedulerTask |
object |
channels.schedulerTask.id |
number |
channels.schedulerTask.businessKey |
object |
channels.schedulerTask.href |
string |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
Vendor returns — Get a list of vendor returns
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
number |
string |
orderPriority |
number |
orderSummary |
string |
orderSource |
string |
secondaryOrderSource |
string |
customerOrderNumber |
string |
relatedOrderNumber |
string |
partnerInvoiceNumber |
string |
consigneePartner |
object |
consigneePartner.id |
number |
consigneePartner.businessKey |
object |
consigneePartner.href |
string |
tradingPartnerSite |
object |
tradingPartnerSite.id |
number |
tradingPartnerSite.businessKey |
object |
tradingPartnerSite.href |
string |
shipToContact |
object |
shipToContact.attention |
string |
shipToContact.name |
string |
shipToContact.firstName |
string |
shipToContact.lastName |
string |
shipToContact.contactName |
string |
shipToContact.phone |
string |
shipToContact.email |
string |
shipToAddress |
object |
shipToAddress.line1 |
string |
shipToAddress.line2 |
string |
shipToAddress.line3 |
string |
shipToAddress.line4 |
string |
shipToAddress.city |
string |
shipToAddress.stateProvince |
string |
shipToAddress.postalCode |
string |
shipToAddress.country |
string |
billToContact |
object |
billToContact.name |
string |
billToContact.firstName |
string |
billToContact.lastName |
string |
billToContact.contactName |
string |
billToContact.attention |
string |
billToContact.phone |
string |
billToContact.email |
string |
billToAccountNumber |
string |
billToAddress |
object |
billToAddress.line1 |
string |
billToAddress.line2 |
string |
billToAddress.line3 |
string |
billToAddress.line4 |
string |
billToAddress.city |
string |
billToAddress.stateProvince |
string |
billToAddress.postalCode |
string |
billToAddress.country |
string |
shipFromContact |
object |
shipFromContact.name |
string |
shipFromContact.firstName |
string |
shipFromContact.lastName |
string |
shipFromContact.attention |
string |
shipFromContact.phone |
string |
shipFromContact.email |
string |
shipFromAddress |
object |
shipFromAddress.line1 |
string |
shipFromAddress.line2 |
string |
shipFromAddress.city |
string |
shipFromAddress.stateProvince |
string |
shipFromAddress.postalCode |
string |
shipFromAddress.country |
string |
placedDate |
string |
plannedArrivalDate |
string |
plannedReleaseDate |
string |
plannedShipDate |
string |
earliestShipDate |
string |
earliestDeliveryDate |
string |
cancelByArrivalDate |
string |
cancelByReleaseDate |
string |
cancelByShipDate |
string |
actualArrivalDate |
string |
actualReleaseDate |
string |
actualShipDate |
string |
priceList |
object |
priceList.id |
number |
priceList.businessKey |
object |
priceList.href |
string |
orderTotal |
number |
orderSubtotal |
number |
orderDiscountSubtotal |
number |
orderShippingTotal |
number |
orderShipTotal |
number |
taxable |
boolean |
orderTaxTotal |
number |
orderTaxableTotal |
number |
orderUntaxableTotal |
number |
shippingTaxTotal |
number |
shipVia |
string |
shipVendor |
string |
shipMethod |
string |
freightTermsType |
string |
freightBillToContact |
object |
freightBillToContact.name |
string |
freightBillToContact.firstName |
string |
freightBillToContact.lastName |
string |
freightBillToContact.attention |
string |
freightBillToContact.phone |
string |
freightBillToAccount |
string |
freightBillToAddress |
object |
freightBillToAddress.line1 |
string |
freightBillToAddress.line2 |
string |
freightBillToAddress.line3 |
string |
freightBillToAddress.line4 |
string |
freightBillToAddress.city |
string |
freightBillToAddress.stateProvince |
string |
freightBillToAddress.postalCode |
string |
freightBillToAddress.country |
string |
deliverToContact |
object |
deliverToContact.name |
string |
deliverToContact.attention |
string |
deliverToContact.phone |
string |
deliverToAddress |
object |
deliverToAddress.line1 |
string |
deliverToAddress.line2 |
string |
deliverToAddress.city |
string |
deliverToAddress.stateProvince |
string |
deliverToAddress.postalCode |
string |
deliverToAddress.country |
string |
weight |
object |
weight.weight |
number |
weight.units |
string |
returnRequired |
boolean |
returnShipVia |
string |
returnShipOption |
string |
deliveryConfirmation |
string |
insuranceRequired |
boolean |
homeDelivery |
boolean |
residential |
boolean |
saturdayDelivery |
boolean |
hubId |
string |
routingNumber |
string |
incotermsType |
string |
importType |
string |
importReference |
string |
exportReference |
string |
otherReferenceNumber2 |
string |
integrationSource |
object |
integrationSource.id |
number |
integrationSource.businessKey |
object |
integrationSource.href |
string |
sendASN |
string |
dropShip |
boolean |
pickWave |
object |
pickWave.id |
number |
pickWave.businessKey |
object |
pickWave.href |
string |
postReleaseState |
string |
entryName |
string |
entryPhone1 |
string |
saleConditionCode |
string |
seller |
string |
notificationCode1 |
string |
notificationCode2 |
string |
notificationCode3 |
string |
verbalConfirmationName |
string |
verbalConfirmationPhoneNumber |
string |
customAttribute1 |
string |
customAttribute2 |
string |
customAttribute3 |
string |
customAttribute4 |
string |
customAttribute5 |
string |
customAttribute6 |
string |
customAttribute7 |
string |
customFields |
objectarray |
customFields.self |
object |
customFields.self.id |
number |
customFields.self.businessKey |
object |
customFields.self.href |
string |
customFields.name |
string |
customFields.value |
string |
customFields.type |
string |
customFields.item |
object |
customFields.item.id |
number |
customFields.item.businessKey |
object |
customFields.item.href |
string |
customFields.orderHeader |
object |
customFields.orderHeader.id |
number |
customFields.orderHeader.businessKey |
object |
customFields.orderHeader.href |
string |
customFields.orderLine |
object |
customFields.orderLine.id |
number |
customFields.orderLine.businessKey |
object |
customFields.orderLine.href |
string |
customFields.shipment |
object |
customFields.shipment.id |
number |
customFields.shipment.businessKey |
object |
customFields.shipment.href |
string |
customFields.createdDate |
string |
customFields.updatedDate |
string |
customFields.createdBy |
object |
customFields.createdBy.id |
number |
customFields.createdBy.businessKey |
object |
customFields.createdBy.href |
string |
customFields.updatedBy |
object |
customFields.updatedBy.id |
number |
customFields.updatedBy.businessKey |
object |
customFields.updatedBy.href |
string |
notes |
objectarray |
notes.self |
object |
notes.self.id |
number |
notes.self.businessKey |
object |
notes.self.href |
string |
notes.title |
string |
notes.body |
string |
notes.source |
string |
notes.priority |
string |
notes.orderHeader |
object |
notes.orderHeader.id |
number |
notes.orderHeader.businessKey |
object |
notes.orderHeader.href |
string |
notes.orderLine |
object |
notes.orderLine.id |
number |
notes.orderLine.businessKey |
object |
notes.orderLine.href |
string |
channels |
objectarray |
channels.self |
object |
channels.self.id |
number |
channels.self.businessKey |
object |
channels.self.href |
string |
channels.integration |
object |
channels.integration.id |
number |
channels.integration.businessKey |
object |
channels.integration.href |
string |
channels.schedulerTask |
object |
channels.schedulerTask.id |
number |
channels.schedulerTask.businessKey |
object |
channels.schedulerTask.href |
string |
channels.ref1 |
string |
channels.ref2 |
string |
channels.ref3 |
string |
channels.ref4 |
string |
channels.ref5 |
string |
channels.secRef1 |
string |
channels.secRef2 |
string |
channels.secRef3 |
string |
channels.secRef4 |
string |
channels.secRef5 |
string |
channels.createdDate |
string |
channels.updatedDate |
string |
channels.createdBy |
object |
channels.createdBy.id |
number |
channels.createdBy.businessKey |
object |
channels.createdBy.href |
string |
channels.updatedBy |
object |
channels.updatedBy.id |
number |
channels.updatedBy.businessKey |
object |
channels.updatedBy.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |
type |
string |
parentOrder |
object |
parentOrder.id |
number |
parentOrder.businessKey |
object |
parentOrder.href |
string |
orderStatus |
string |
shipFromFacility |
object |
shipFromFacility.id |
number |
shipFromFacility.businessKey |
object |
shipFromFacility.href |
string |
otherReferenceNumber |
string |
dutyPaidBy |
string |
dutyPaidByType |
string |
dutyPaidByContactName |
string |
dutyPaidByAccount |
string |
dutyPaidByPostalCode |
string |
dutyPaidByCountry |
string |
directedToZone |
object |
directedToZone.id |
number |
directedToZone.businessKey |
object |
directedToZone.href |
string |
orderLines |
object |
orderLines.data |
objectarray |
orderLines.data.self |
object |
orderLines.data.self.id |
number |
orderLines.data.self.businessKey |
object |
orderLines.data.self.href |
string |
orderLines.data.businessUnit |
object |
orderLines.data.businessUnit.id |
number |
orderLines.data.businessUnit.businessKey |
object |
orderLines.data.businessUnit.href |
string |
orderLines.data.lineNumber |
string |
orderLines.data.customerLineNumber |
string |
orderLines.data.relatedOrderLine |
object |
orderLines.data.relatedOrderLine.id |
number |
orderLines.data.relatedOrderLine.businessKey |
object |
orderLines.data.relatedOrderLine.href |
string |
orderLines.data.sortOrder |
number |
orderLines.data.orderHeader |
object |
orderLines.data.orderHeader.id |
number |
orderLines.data.orderHeader.businessKey |
object |
orderLines.data.orderHeader.href |
string |
orderLines.data.item |
object |
orderLines.data.item.id |
number |
orderLines.data.item.businessKey |
object |
orderLines.data.item.href |
string |
orderLines.data.pack |
object |
orderLines.data.pack.id |
number |
orderLines.data.pack.businessKey |
object |
orderLines.data.pack.href |
string |
orderLines.data.description |
string |
orderLines.data.orderPackQuantity |
number |
orderLines.data.canceledPackQuantity |
number |
orderLines.data.lotNumber |
string |
orderLines.data.bornOnDate |
string |
orderLines.data.expirationDate |
string |
orderLines.data.productCode |
string |
orderLines.data.inventoryCondition |
string |
orderLines.data.inventoryAttribute1 |
string |
orderLines.data.inventoryAttribute2 |
string |
orderLines.data.plannedShipDate |
string |
orderLines.data.plannedArrivalDate |
string |
orderLines.data.unitPrice |
number |
orderLines.data.unitCost |
number |
orderLines.data.priceCode |
string |
orderLines.data.lineTotal |
number |
orderLines.data.taxable |
boolean |
orderLines.data.taxCost |
number |
orderLines.data.taxableTotal |
number |
orderLines.data.untaxableTotal |
number |
orderLines.data.extendedTotal |
number |
orderLines.data.discountAmount |
number |
orderLines.data.shippingAmount |
number |
orderLines.data.weight |
object |
orderLines.data.weight.weight |
number |
orderLines.data.weight.units |
string |
orderLines.data.importReference |
string |
orderLines.data.exportReference |
string |
orderLines.data.customAttribute1 |
string |
orderLines.data.customAttribute2 |
string |
orderLines.data.customAttribute3 |
string |
orderLines.data.customFields |
objectarray |
orderLines.data.customFields.self |
object |
orderLines.data.customFields.self.id |
number |
orderLines.data.customFields.self.businessKey |
object |
orderLines.data.customFields.self.href |
string |
orderLines.data.customFields.name |
string |
orderLines.data.customFields.value |
string |
orderLines.data.customFields.type |
string |
orderLines.data.customFields.item |
object |
orderLines.data.customFields.item.id |
number |
orderLines.data.customFields.item.businessKey |
object |
orderLines.data.customFields.item.href |
string |
orderLines.data.customFields.orderHeader |
object |
orderLines.data.customFields.orderHeader.id |
number |
orderLines.data.customFields.orderHeader.businessKey |
object |
orderLines.data.customFields.orderHeader.href |
string |
orderLines.data.customFields.orderLine |
object |
orderLines.data.customFields.orderLine.id |
number |
orderLines.data.customFields.orderLine.businessKey |
object |
orderLines.data.customFields.orderLine.href |
string |
orderLines.data.customFields.shipment |
object |
orderLines.data.customFields.shipment.id |
number |
orderLines.data.customFields.shipment.businessKey |
object |
orderLines.data.customFields.shipment.href |
string |
orderLines.data.customFields.createdDate |
string |
orderLines.data.customFields.updatedDate |
string |
orderLines.data.customFields.createdBy |
object |
orderLines.data.customFields.createdBy.id |
number |
orderLines.data.customFields.createdBy.businessKey |
object |
orderLines.data.customFields.createdBy.href |
string |
orderLines.data.customFields.updatedBy |
object |
orderLines.data.customFields.updatedBy.id |
number |
orderLines.data.customFields.updatedBy.businessKey |
object |
orderLines.data.customFields.updatedBy.href |
string |
orderLines.data.notes |
objectarray |
orderLines.data.notes.self |
object |
orderLines.data.notes.self.id |
number |
orderLines.data.notes.self.businessKey |
object |
orderLines.data.notes.self.href |
string |
orderLines.data.notes.title |
string |
orderLines.data.notes.body |
string |
orderLines.data.notes.source |
string |
orderLines.data.notes.priority |
string |
orderLines.data.notes.orderHeader |
object |
orderLines.data.notes.orderHeader.id |
number |
orderLines.data.notes.orderHeader.businessKey |
object |
orderLines.data.notes.orderHeader.href |
string |
orderLines.data.notes.orderLine |
object |
orderLines.data.notes.orderLine.id |
number |
orderLines.data.notes.orderLine.businessKey |
object |
orderLines.data.notes.orderLine.href |
string |
orderLines.data.channels |
objectarray |
orderLines.data.channels.self |
object |
orderLines.data.channels.self.id |
number |
orderLines.data.channels.self.businessKey |
object |
orderLines.data.channels.self.href |
string |
orderLines.data.channels.integration |
object |
orderLines.data.channels.integration.id |
number |
orderLines.data.channels.integration.businessKey |
object |
orderLines.data.channels.integration.href |
string |
orderLines.data.channels.schedulerTask |
object |
orderLines.data.channels.schedulerTask.id |
number |
orderLines.data.channels.schedulerTask.businessKey |
object |
orderLines.data.channels.schedulerTask.href |
string |
orderLines.data.channels.ref1 |
string |
orderLines.data.channels.ref2 |
string |
orderLines.data.channels.ref3 |
string |
orderLines.data.channels.ref4 |
string |
orderLines.data.channels.ref5 |
string |
orderLines.data.channels.secRef1 |
string |
orderLines.data.channels.secRef2 |
string |
orderLines.data.channels.secRef3 |
string |
orderLines.data.channels.secRef4 |
string |
orderLines.data.channels.secRef5 |
string |
orderLines.data.channels.createdDate |
string |
orderLines.data.channels.updatedDate |
string |
orderLines.data.channels.createdBy |
object |
orderLines.data.channels.createdBy.id |
number |
orderLines.data.channels.createdBy.businessKey |
object |
orderLines.data.channels.createdBy.href |
string |
orderLines.data.channels.updatedBy |
object |
orderLines.data.channels.updatedBy.id |
number |
orderLines.data.channels.updatedBy.businessKey |
object |
orderLines.data.channels.updatedBy.href |
string |
orderLines.data.createdDate |
string |
orderLines.data.updatedDate |
string |
orderLines.data.createdBy |
object |
orderLines.data.createdBy.id |
number |
orderLines.data.createdBy.businessKey |
object |
orderLines.data.createdBy.href |
string |
orderLines.data.updatedBy |
object |
orderLines.data.updatedBy.id |
number |
orderLines.data.updatedBy.businessKey |
object |
orderLines.data.updatedBy.href |
string |
orderLines.data.orderLineStatus |
string |
orderLines.data.shipFromFacility |
object |
orderLines.data.shipFromFacility.id |
number |
orderLines.data.shipFromFacility.businessKey |
object |
orderLines.data.shipFromFacility.href |
string |
orderLines.data.allocatedQuantity |
number |
orderLines.data.unallocatedQuantity |
number |
orderLines.data.pickedPackQuantity |
number |
orderLines.data.shippedPackQuantity |
number |
orderLines.data.preallocated |
boolean |
orderLines.data.isBackOrdered |
string |
orderLines.data.directedToZone |
object |
orderLines.data.directedToZone.id |
number |
orderLines.data.directedToZone.businessKey |
object |
orderLines.data.directedToZone.href |
string |
orderLines.data.allocateFromZone |
boolean |
orderLine |
object |
orderLine.id |
number |
orderLine.businessKey |
object |
orderLine.href |
string |
canceledPackQuantity |
number |
shipments |
object |
shipments.data |
objectarray |
shipments.data.id |
number |
shipments.data.businessKey |
object |
shipments.data.href |
string |
lineNumber |
string |
customerLineNumber |
string |
relatedOrderLine |
object |
relatedOrderLine.id |
number |
relatedOrderLine.businessKey |
object |
relatedOrderLine.href |
string |
sortOrder |
number |
orderHeader |
object |
orderHeader.id |
number |
orderHeader.businessKey |
object |
orderHeader.href |
string |
item |
object |
item.id |
number |
item.businessKey |
object |
item.href |
string |
pack |
object |
pack.id |
number |
pack.businessKey |
object |
pack.href |
string |
description |
string |
orderPackQuantity |
number |
canceledPackQuantity |
number |
lotNumber |
string |
bornOnDate |
string |
expirationDate |
string |
productCode |
string |
inventoryCondition |
string |
inventoryAttribute1 |
string |
inventoryAttribute2 |
string |
unitPrice |
number |
unitCost |
number |
priceCode |
string |
lineTotal |
number |
taxCost |
number |
taxableTotal |
number |
untaxableTotal |
number |
extendedTotal |
number |
discountAmount |
number |
shippingAmount |
number |
orderLineStatus |
string |
allocatedQuantity |
number |
unallocatedQuantity |
number |
pickedPackQuantity |
number |
shippedPackQuantity |
number |
preallocated |
boolean |
isBackOrdered |
string |
allocateFromZone |
boolean |
Zones — Get a list of zones
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updatedAfter = {{{lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss[Z] |
Response schema:
| Field | Type |
|---|---|
self |
object |
self.id |
number (Primary key) |
self.businessKey |
object |
self.href |
string |
businessUnit |
object |
businessUnit.id |
number |
businessUnit.businessKey |
object |
businessUnit.href |
string |
facility |
object |
facility.id |
number |
facility.businessKey |
object |
facility.href |
string |
name |
string |
type |
string |
pickRating |
number |
pickSystem |
string |
maxNumberOfUnitsToWorkGroup |
number |
allocateAllStockFromZone |
boolean |
defaultLocation |
object |
defaultLocation.id |
number |
defaultLocation.businessKey |
object |
defaultLocation.href |
string |
locations |
object |
locations.data |
objectarray |
locations.data.id |
number |
locations.data.businessKey |
object |
locations.data.href |
string |
createdDate |
string |
updatedDate |
string |
createdBy |
object |
createdBy.id |
number |
createdBy.businessKey |
object |
createdBy.href |
string |
updatedBy |
object |
updatedBy.id |
number |
updatedBy.businessKey |
object |
updatedBy.href |
string |