senderName required | string Sender's Name |
toLocationId required | string Arrival Location ID |
arrivalId | string Arrival notification ID |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects (NameValue) Custom Fields | |
exceptionCategories | Array of strings References to categories of exceptions related to the arrival |
exceptions | Array of strings Types of exceptions related to the arrival |
expectedArrivalDate | string <date-time> Expected Arrival Date |
extArrivalApiId | string External System Arrival API ID |
extArrivalId | string Reference to arrival on external system (vendor) |
extOrderId | string External TO or PO ID |
extReferenceId | string Reference ID |
extShipmentId | string External shipment ID |
object (Address) | |
fromLocationId | string Sender Location ID (for TO) |
fulfillmentId | string Fulfillment ID |
holdUntil | string <date-time> |
incoterms | string International Commercial Terms |
integration | string Reference to integration that created arrival |
object (InternalInfo) Internal info | |
Array of objects (ArrivalLineItem) | |
orderIntegration | string Reference to integration that created order tied to arrival |
orgKey | string Organization this object belong to |
purchaseId | string Purchase Order ID |
shippingCarrier | string Shipping Carrier |
shippingMethod | string Shipping Method |
shippingNote | string Shipping Note |
object (SourceDoc) Vendor source document | |
status | string Enum: "draft" "shipped" "expected" "partialReceived" "received" "canceled" "failed" Arrival notification Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
Array of objects (ArrivalChangelogEntry) Timeline of updates | |
totalWeight | string Total Weight |
trackingNumber | string Tracking number |
transferId | string Transfer Order ID |
object (ArrivalTransport) | |
updatedAt | string <date-time> When the object was updated within Pipe17 |
weightUnit | string Weight Unit |
{- "arrivalId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "orderIntegration": "string",
- "status": "draft",
- "timeline": [
- {
- "arrivalId": "string",
- "purchaseId": "string",
- "transferId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "senderName": "string",
- "toLocationId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extArrivalApiId": "string",
- "extArrivalId": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "extShipmentId": "string",
- "fromAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "fromLocationId": "string",
- "fulfillmentId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "extOrderId": "string",
- "lotNumber": "string",
- "name": "string",
- "palletQuantity": 0,
- "purchaseId": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "transferId": "string",
- "upc": "string"
}
], - "purchaseId": "string",
- "shippingCarrier": "string",
- "shippingMethod": "string",
- "shippingNote": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "totalWeight": "string",
- "trackingNumber": "string",
- "transferId": "string",
- "transport": {
- "BOL": "string",
- "containerNumber": "string",
- "containerSize": "string",
- "containerType": "string",
- "seal": "string",
- "trailerNumber": "string",
- "trailerSize": "string",
- "trailerType": "string"
}, - "weightUnit": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints:
Uniqueness constraints within organization:
senderName required | string Sender's Name |
toLocationId required | string Arrival Location ID |
Array of objects (NameValue) Custom Fields | |
expectedArrivalDate | string <date-time> Expected Arrival Date |
extArrivalApiId | string External System Arrival API ID |
extArrivalId | string Reference to arrival on external system (vendor) |
extOrderId | string External TO or PO ID |
extReferenceId | string Reference ID |
extShipmentId | string External shipment ID |
object (Address) | |
fromLocationId | string Sender Location ID (for TO) |
fulfillmentId | string Fulfillment ID |
holdUntil | string <date-time> |
incoterms | string International Commercial Terms |
object (InternalInfo) Internal info | |
Array of objects (ArrivalLineItem) | |
purchaseId | string Purchase Order ID |
shippingCarrier | string Shipping Carrier |
shippingMethod | string Shipping Method |
shippingNote | string Shipping Note |
object (SourceDoc) Vendor source document | |
status | string (ArrivalStatus) Enum: "draft" "shipped" "expected" "partialReceived" "received" "canceled" "failed" Arrival notification Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
totalWeight | string Total Weight |
trackingNumber | string Tracking number |
transferId | string Transfer Order ID |
object (ArrivalTransport) | |
weightUnit | string Weight Unit |
[- {
- "senderName": "string",
- "toLocationId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extArrivalApiId": "string",
- "extArrivalId": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "extShipmentId": "string",
- "fromAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "fromLocationId": "string",
- "fulfillmentId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "extOrderId": "string",
- "lotNumber": "string",
- "name": "string",
- "palletQuantity": 0,
- "purchaseId": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "transferId": "string",
- "upc": "string"
}
], - "purchaseId": "string",
- "shippingCarrier": "string",
- "shippingMethod": "string",
- "shippingNote": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "tags": [
- "string"
], - "totalWeight": "string",
- "trackingNumber": "string",
- "transferId": "string",
- "transport": {
- "BOL": "string",
- "containerNumber": "string",
- "containerSize": "string",
- "containerType": "string",
- "seal": "string",
- "trailerNumber": "string",
- "trailerSize": "string",
- "trailerType": "string"
}, - "weightUnit": "string"
}
]
{- "code": 200,
- "success": true,
- "arrivals": [
- {
- "arrival": {
- "arrivalId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "orderIntegration": "string",
- "status": "draft",
- "timeline": [
- {
- "arrivalId": "string",
- "purchaseId": "string",
- "transferId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "senderName": "string",
- "toLocationId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extArrivalApiId": "string",
- "extArrivalId": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "extShipmentId": "string",
- "fromAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "fromLocationId": "string",
- "fulfillmentId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "extOrderId": "string",
- "lotNumber": "string",
- "name": "string",
- "palletQuantity": 0,
- "purchaseId": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "transferId": "string",
- "upc": "string"
}
], - "purchaseId": "string",
- "shippingCarrier": "string",
- "shippingMethod": "string",
- "shippingNote": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "totalWeight": "string",
- "trackingNumber": "string",
- "transferId": "string",
- "transport": {
- "BOL": "string",
- "containerNumber": "string",
- "containerSize": "string",
- "containerType": "string",
- "seal": "string",
- "trailerNumber": "string",
- "trailerSize": "string",
- "trailerType": "string"
}, - "weightUnit": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "status": "submitted"
}
]
}
ArrivalId required | string Id, |
nested | boolean Delete nested entities |
{- "code": 200,
- "success": true
}
action | string (ListDeleteAction) Default: "list" Enum: "list" "soft" Return the list of what to delete, or delete softly |
arrivalId | Array of strings Delete arrivals by list of arrivalId |
count | integer <int32> Default: 100 Delete at most this many arrivals |
deleted | boolean Delete soft deleted arrivals |
extOrderId | Array of strings Delete arrivals by list external orders (PO or TO) |
extReferenceId | Array of strings Delete arrivals by |
fulfillmentId | Array of strings Delete arrivals by list fulfillmentId |
integration | Array of strings Delete arrivals of these integrations. |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete arrivals assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
purchaseId | Array of strings Delete arrivals by list purchase orders |
since | string <date-time> Delete arrivals created after this date-time |
skip | integer <int32> Default: 0 Skip this many arrivals |
status | Array of strings (ArrivalStatus) Items Enum: "draft" "shipped" "expected" "partialReceived" "received" "canceled" "failed" Delete arrivals in specific status |
tags | Array of strings (EntityTags) Tags assigned to entity |
transferId | Array of strings Delete arrivals by list transfer orders |
until | string <date-time> Delete arrivals created before this date-time |
updatedSince | string <date-time> Delete arrivals updated after this date-time |
updatedUntil | string <date-time> Delete arrivals updated before this date-time |
{- "code": 200,
- "success": true,
- "arrivals": [
- {
- "arrivalId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "orderIntegration": "string",
- "status": "draft",
- "timeline": [
- {
- "arrivalId": "string",
- "purchaseId": "string",
- "transferId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "senderName": "string",
- "toLocationId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extArrivalApiId": "string",
- "extArrivalId": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "extShipmentId": "string",
- "fromAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "fromLocationId": "string",
- "fulfillmentId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "extOrderId": "string",
- "lotNumber": "string",
- "name": "string",
- "palletQuantity": 0,
- "purchaseId": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "transferId": "string",
- "upc": "string"
}
], - "purchaseId": "string",
- "shippingCarrier": "string",
- "shippingMethod": "string",
- "shippingNote": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "totalWeight": "string",
- "trackingNumber": "string",
- "transferId": "string",
- "transport": {
- "BOL": "string",
- "containerNumber": "string",
- "containerSize": "string",
- "containerType": "string",
- "seal": "string",
- "trailerNumber": "string",
- "trailerSize": "string",
- "trailerType": "string"
}, - "weightUnit": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "deleted": 0,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "arrivalId": [
- "string"
], - "deleted": true,
- "extArrivalId": [
- "string"
], - "extOrderId": [
- "string"
], - "extReferenceId": [
- "string"
], - "fromLocationId": [
- "string"
], - "fulfillmentId": [
- "string"
], - "hasSourceDoc": true,
- "integration": [
- "string"
], - "purchaseId": [
- "string"
], - "status": [
- "draft"
], - "tags": [
- "string"
], - "toLocationId": [
- "string"
], - "transferId": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
ArrivalId required | string Id, |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
withTimeline | boolean Include timeline of updates when available |
{- "code": 200,
- "success": true,
- "arrival": {
- "arrivalId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "orderIntegration": "string",
- "status": "draft",
- "timeline": [
- {
- "arrivalId": "string",
- "purchaseId": "string",
- "transferId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "senderName": "string",
- "toLocationId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extArrivalApiId": "string",
- "extArrivalId": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "extShipmentId": "string",
- "fromAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "fromLocationId": "string",
- "fulfillmentId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "extOrderId": "string",
- "lotNumber": "string",
- "name": "string",
- "palletQuantity": 0,
- "purchaseId": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "transferId": "string",
- "upc": "string"
}
], - "purchaseId": "string",
- "shippingCarrier": "string",
- "shippingMethod": "string",
- "shippingNote": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "totalWeight": "string",
- "trackingNumber": "string",
- "transferId": "string",
- "transport": {
- "BOL": "string",
- "containerNumber": "string",
- "containerSize": "string",
- "containerType": "string",
- "seal": "string",
- "trailerNumber": "string",
- "trailerSize": "string",
- "trailerType": "string"
}, - "weightUnit": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
arrivalId | Array of strings Arrivals by list of arrivalId |
count | integer <int32> Default: 100 Return at most this many arrivals |
deleted | boolean Soft deleted arrivals |
exceptionCategoryId | Array of strings Arrivals by list of categories of the arrival related exceptions |
exceptionType | Array of strings Arrivals by list of types of the arrival related exceptions ( |
extArrivalId | Array of strings Arrivals by list extArrivalId |
extOrderId | Array of strings Arrivals by list external orders (PO or TO) |
extReferenceId | Array of strings Arrivals by |
fromLocationId | Array of strings Arrivals by list fromLocationId |
fulfillmentId | Array of strings Arrivals by list fulfillmentId |
hasSourceDoc | boolean Arrivals containing a source document |
integration | Array of strings Arrivals of these integrations. |
keys | string Default: "arrivalId,status,transferId,purchaseId,extOrderId,expectedArrivalDate,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
purchaseId | Array of strings Arrivals by list purchase orders |
since | string <date-time> Arrivals created after this date-time |
skip | integer <int32> Default: 0 Skip this many arrivals |
status | Array of strings (ArrivalStatus) Items Enum: "draft" "shipped" "expected" "partialReceived" "received" "canceled" "failed" Arrivals in specific status |
tags | Array of strings (EntityTags) Tags assigned to entity |
toLocationId | Array of strings Arrivals by list toLocationId |
transferId | Array of strings Arrivals by list transfer orders |
until | string <date-time> Arrivals created before this date-time |
updatedSince | string <date-time> Arrivals updated after this date-time |
updatedUntil | string <date-time> Arrivals updated before this date-time |
{- "code": 200,
- "success": true,
- "arrivals": [
- {
- "arrivalId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "orderIntegration": "string",
- "status": "draft",
- "timeline": [
- {
- "arrivalId": "string",
- "purchaseId": "string",
- "transferId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "senderName": "string",
- "toLocationId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extArrivalApiId": "string",
- "extArrivalId": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "extShipmentId": "string",
- "fromAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "fromLocationId": "string",
- "fulfillmentId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "extOrderId": "string",
- "lotNumber": "string",
- "name": "string",
- "palletQuantity": 0,
- "purchaseId": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "transferId": "string",
- "upc": "string"
}
], - "purchaseId": "string",
- "shippingCarrier": "string",
- "shippingMethod": "string",
- "shippingNote": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "totalWeight": "string",
- "trackingNumber": "string",
- "transferId": "string",
- "transport": {
- "BOL": "string",
- "containerNumber": "string",
- "containerSize": "string",
- "containerType": "string",
- "seal": "string",
- "trailerNumber": "string",
- "trailerSize": "string",
- "trailerType": "string"
}, - "weightUnit": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "arrivalId": [
- "string"
], - "deleted": true,
- "extArrivalId": [
- "string"
], - "extOrderId": [
- "string"
], - "extReferenceId": [
- "string"
], - "fromLocationId": [
- "string"
], - "fulfillmentId": [
- "string"
], - "hasSourceDoc": true,
- "integration": [
- "string"
], - "purchaseId": [
- "string"
], - "status": [
- "draft"
], - "tags": [
- "string"
], - "toLocationId": [
- "string"
], - "transferId": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Uniqueness constraints:
Uniqueness constraints within organization:
ArrivalId required | string Id, |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
Array of objects (NameValue) Custom Fields | |
expectedArrivalDate | string <date-time> Expected Arrival Date |
extArrivalId | string Reference to arrival on external system (vendor) |
extReferenceId | string Reference ID |
object (Address) | |
fromLocationId | string Sender Location ID (for TO) |
holdUntil | string or null <date-time> |
incoterms | string International Commercial Terms |
object (InternalInfo) Internal info | |
Array of objects (ArrivalLineItem) | |
senderName | string Sender's Name |
shippingCarrier | string Shipping Carrier |
shippingMethod | string Shipping Method |
shippingNote | string Shipping Note |
object (SourceDoc) Vendor source document | |
status | string (ArrivalStatus) Enum: "draft" "shipped" "expected" "partialReceived" "received" "canceled" "failed" Arrival notification Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
toLocationId | string Arrival Location ID |
totalWeight | string Total Weight |
trackingNumber | string Tracking number |
object (ArrivalTransport) | |
weightUnit | string Weight Unit |
{- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extArrivalId": "string",
- "extReferenceId": "string",
- "fromAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "fromLocationId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "extOrderId": "string",
- "lotNumber": "string",
- "name": "string",
- "palletQuantity": 0,
- "purchaseId": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "transferId": "string",
- "upc": "string"
}
], - "senderName": "string",
- "shippingCarrier": "string",
- "shippingMethod": "string",
- "shippingNote": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "tags": [
- "string"
], - "toLocationId": "string",
- "totalWeight": "string",
- "trackingNumber": "string",
- "transport": {
- "BOL": "string",
- "containerNumber": "string",
- "containerSize": "string",
- "containerType": "string",
- "seal": "string",
- "trailerNumber": "string",
- "trailerSize": "string",
- "trailerType": "string"
}, - "weightUnit": "string"
}
{- "code": 200,
- "success": true,
- "arrival": {
- "arrivalId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "orderIntegration": "string",
- "status": "draft",
- "timeline": [
- {
- "arrivalId": "string",
- "purchaseId": "string",
- "transferId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "senderName": "string",
- "toLocationId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extArrivalApiId": "string",
- "extArrivalId": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "extShipmentId": "string",
- "fromAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "fromLocationId": "string",
- "fulfillmentId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "extOrderId": "string",
- "lotNumber": "string",
- "name": "string",
- "palletQuantity": 0,
- "purchaseId": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "transferId": "string",
- "upc": "string"
}
], - "purchaseId": "string",
- "shippingCarrier": "string",
- "shippingMethod": "string",
- "shippingNote": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "totalWeight": "string",
- "trackingNumber": "string",
- "transferId": "string",
- "transport": {
- "BOL": "string",
- "containerNumber": "string",
- "containerSize": "string",
- "containerType": "string",
- "seal": "string",
- "trailerNumber": "string",
- "trailerSize": "string",
- "trailerType": "string"
}, - "weightUnit": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
catalogId required | string |
sku required | string |
status required | string (CatalogProductStatus) Enum: "included" "excluded" Catalog Product Status |
catalogProductId | string Auto Generated |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects (NameValue) Custom Fields | |
exceptionCategories | Array of strings References to categories of exceptions related to the catalog product |
exceptions | Array of strings Types of exceptions related to the catalog product |
integration | string Reference to integration that created the catalog product |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
object (CatalogProductPriceRule) | |
object (CatalogProductQuantityRule) | |
object (SourceDoc) Vendor source document | |
tags | Array of strings (EntityTags) Tags assigned to entity |
updatedAt | string <date-time> When the object was updated within Pipe17 |
Array of objects (CatalogProductVolumePricing) |
{- "catalogProductId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "catalogId": "string",
- "sku": "string",
- "status": "included",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "quantityRule": {
- "increment": 0,
- "min": 0,
- "max": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "volumePricing": [
- {
- "quantity": 0,
- "value": 0
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
catalogId required | string |
sku required | string |
status required | string (CatalogProductStatus) Enum: "included" "excluded" Catalog Product Status |
Array of objects (NameValue) Custom Fields | |
object (InternalInfo) Internal info | |
object (CatalogProductPriceRule) | |
object (CatalogProductQuantityRule) | |
object (SourceDoc) Vendor source document | |
tags | Array of strings (EntityTags) Tags assigned to entity |
Array of objects (CatalogProductVolumePricing) |
[- {
- "catalogId": "string",
- "sku": "string",
- "status": "included",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "quantityRule": {
- "increment": 0,
- "min": 0,
- "max": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "volumePricing": [
- {
- "quantity": 0,
- "value": 0
}
]
}
]
{- "code": 200,
- "success": true,
- "catalog_products": [
- {
- "catalog_product": {
- "catalogProductId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "catalogId": "string",
- "sku": "string",
- "status": "included",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "quantityRule": {
- "increment": 0,
- "min": 0,
- "max": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "volumePricing": [
- {
- "quantity": 0,
- "value": 0
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "status": "submitted"
}
]
}
CatalogProductId required | string Catalog Product Id to fetch |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
{- "code": 200,
- "success": true,
- "catalog_product": {
- "catalogProductId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "catalogId": "string",
- "sku": "string",
- "status": "included",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "quantityRule": {
- "increment": 0,
- "min": 0,
- "max": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "volumePricing": [
- {
- "quantity": 0,
- "value": 0
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
catalogId | Array of strings Select catalog products by catalogId list |
catalogProductId | Array of strings Select catalog products by catalogProductId list |
count | integer <int32> Default: 100 Return at most this many catalog products |
deleted | boolean Select the soft deleted catalog products |
exceptionCategoryId | Array of strings Select catalog products by list of categories of the product related exceptions |
exceptionType | Array of strings Select catalog products by list of types of the product related exceptions ( |
hasSourceDoc | boolean Select catalog products containing a source document |
integration | Array of strings Select catalog products of these integrations. |
keys | string Default: "catalogProductId,catalogId,sku,status,priceRule,quantityRule,volumePricing,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "-createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Select catalog products created after this date-time |
skip | integer <int32> Default: 0 Skip this many catalog products |
sku | Array of strings Select catalog products by sku list |
status | Array of strings (CatalogProductStatus) Items Enum: "included" "excluded" Select catalog products by status list |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Select catalog products created before this date-time |
updatedSince | string <date-time> Select catalog products updated after this date-time |
updatedUntil | string <date-time> Select catalog products updated before this date-time |
{- "code": 200,
- "success": true,
- "catalog_products": [
- {
- "catalogProductId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "catalogId": "string",
- "sku": "string",
- "status": "included",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "quantityRule": {
- "increment": 0,
- "min": 0,
- "max": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "volumePricing": [
- {
- "quantity": 0,
- "value": 0
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "catalogId": [
- "string"
], - "catalogProductId": [
- "string"
], - "deleted": true,
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "hasSourceDoc": true,
- "integration": [
- "string"
], - "sku": [
- "string"
], - "status": [
- "included"
], - "tags": [
- "string"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
CatalogProductId required | string Catalog Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
catalogId | string |
Array of objects (NameValue) Custom Fields | |
object (InternalInfo) Internal info | |
object (CatalogProductPriceRule) | |
object (CatalogProductQuantityRule) | |
sku | string |
object (SourceDoc) Vendor source document | |
status | string (CatalogProductStatus) Enum: "included" "excluded" Catalog Product Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
Array of objects (CatalogProductVolumePricing) |
{- "catalogId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "quantityRule": {
- "increment": 0,
- "min": 0,
- "max": 0
}, - "sku": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "included",
- "tags": [
- "string"
], - "volumePricing": [
- {
- "quantity": 0,
- "value": 0
}
]
}
{- "code": 200,
- "success": true,
- "catalog_product": {
- "catalogProductId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "catalogId": "string",
- "sku": "string",
- "status": "included",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "quantityRule": {
- "increment": 0,
- "min": 0,
- "max": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "volumePricing": [
- {
- "quantity": 0,
- "value": 0
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
currency required | string Currency code |
name required | string |
catalogId | string Auto Generated |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects (NameValue) Custom Fields | |
description | string |
exceptionCategories | Array of strings References to categories of exceptions related to the catalog |
exceptions | Array of strings Types of exceptions related to the catalog |
extCatalogId | string |
includeAll | boolean |
integration | string Reference to integration that created the catalog |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
object (CatalogPriceRule) | |
object (SourceDoc) Vendor source document | |
status | string (CatalogStatus) Default: "draft" Enum: "draft" "active" "inactive" Catalog Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | string (CatalogType) Default: "other" Enum: "b2b" "market" "collection" "other" Catalog Type |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "catalogId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "currency": "string",
- "name": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "extCatalogId": "string",
- "includeAll": true,
- "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "tags": [
- "string"
], - "type": "b2b",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
currency required | string Currency code |
name required | string |
Array of objects (NameValue) Custom Fields | |
description | string |
extCatalogId | string |
includeAll | boolean |
object (InternalInfo) Internal info | |
object (CatalogPriceRule) | |
object (SourceDoc) Vendor source document | |
status | string (CatalogStatus) Default: "draft" Enum: "draft" "active" "inactive" Catalog Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | string (CatalogType) Default: "other" Enum: "b2b" "market" "collection" "other" Catalog Type |
[- {
- "currency": "string",
- "name": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "extCatalogId": "string",
- "includeAll": true,
- "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "tags": [
- "string"
], - "type": "b2b"
}
]
{- "code": 200,
- "success": true,
- "catalogs": [
- {
- "catalog": {
- "catalogId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "currency": "string",
- "name": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "extCatalogId": "string",
- "includeAll": true,
- "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "tags": [
- "string"
], - "type": "b2b",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "status": "submitted"
}
]
}
CatalogId required | string Catalog Id to fetch |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
{- "code": 200,
- "success": true,
- "catalog": {
- "catalogId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "currency": "string",
- "name": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "extCatalogId": "string",
- "includeAll": true,
- "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "tags": [
- "string"
], - "type": "b2b",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
catalogId | Array of strings Select catalogs by catalogId list |
count | integer <int32> Default: 100 Return at most this many catalogs |
deleted | boolean Select the soft deleted catalogs |
exceptionCategoryId | Array of strings Select catalogs by list of categories of the catalog related exceptions |
exceptionType | Array of strings Select catalogs by list of types of the catalog related exceptions ( |
extCatalogId | Array of strings Select catalogs by extCatalogId list |
hasSourceDoc | boolean Select catalogs containing a source document |
integration | Array of strings Select catalogs of these integrations. |
keys | string Default: "catalogId,extCatalogId,name,status,type,currency,priceRule,includeAll,createdAt,updatedAt,orgKey" Return these top-level fields |
name | Array of strings Select catalogs by name list |
order | string Default: "-createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Select catalogs created after this date-time |
skip | integer <int32> Default: 0 Skip this many catalogs |
status | Array of strings (CatalogStatus) Items Enum: "draft" "active" "inactive" Select catalogs by status list |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | Array of strings (CatalogType) Items Enum: "b2b" "market" "collection" "other" Select catalogs by type list |
until | string <date-time> Select catalogs created before this date-time |
updatedSince | string <date-time> Select catalogs updated after this date-time |
updatedUntil | string <date-time> Select catalogs updated before this date-time |
{- "code": 200,
- "success": true,
- "catalogs": [
- {
- "catalogId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "currency": "string",
- "name": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "extCatalogId": "string",
- "includeAll": true,
- "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "tags": [
- "string"
], - "type": "b2b",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "catalogId": [
- "string"
], - "deleted": true,
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "extCatalogId": [
- "string"
], - "hasSourceDoc": true,
- "integration": [
- "string"
], - "name": [
- "string"
], - "status": [
- "draft"
], - "tags": [
- "string"
], - "type": [
- "b2b"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
CatalogId required | string Catalog Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
currency | string Currency code |
Array of objects (NameValue) Custom Fields | |
description | string |
extCatalogId | string |
includeAll | boolean |
object (InternalInfo) Internal info | |
name | string |
object (CatalogPriceRule) | |
object (SourceDoc) Vendor source document | |
status | string (CatalogStatus) Default: "draft" Enum: "draft" "active" "inactive" Catalog Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | string (CatalogType) Default: "other" Enum: "b2b" "market" "collection" "other" Catalog Type |
{- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "extCatalogId": "string",
- "includeAll": true,
- "internal": {
- "property1": { },
- "property2": { }
}, - "name": "string",
- "priceRule": {
- "type": "fixed",
- "value": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "tags": [
- "string"
], - "type": "b2b"
}
{- "code": 200,
- "success": true,
- "catalog": {
- "catalogId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "currency": "string",
- "name": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "extCatalogId": "string",
- "includeAll": true,
- "internal": {
- "property1": { },
- "property2": { }
}, - "priceRule": {
- "type": "fixed",
- "value": 0
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "tags": [
- "string"
], - "type": "b2b",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
required | object (Address) |
contactId | string Contact ID |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects (ContactCustomField) | |
exceptionCategories | Array of strings References to categories of exceptions related to the contact |
exceptions | Array of strings Types of exceptions related to the contact |
extContactId | string Contact external ID |
object (InternalInfo) Internal info | |
name | string Contact name |
orgKey | string Organization this object belong to |
status | string (ContactStatus) Enum: "active" "deleted" Contact status |
tags | Array of strings (EntityTags) Tags assigned to entity |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "contactId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "extContactId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "name": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
required | object (Address) |
Array of objects (ContactCustomField) | |
extContactId | string Contact external ID |
object (InternalInfo) Internal info | |
name | string Contact name |
tags | Array of strings (EntityTags) Tags assigned to entity |
{- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "extContactId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "name": "string",
- "tags": [
- "string"
]
}
{- "code": 200,
- "success": true,
- "contact": {
- "contactId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "extContactId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "name": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
ContactId required | string ID or |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
{- "code": 200,
- "success": true,
- "contact": {
- "contactId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "extContactId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "name": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
contactId | Array of strings Retrieve by list of contactId |
count | integer <int32> Default: 100 Return at most this many contacts |
emailAddr | Array of strings Retrieve by list of shippingAddress.email |
exceptionCategoryId | Array of strings Retrieve contacts by list of categories of the contact related exceptions |
exceptionType | Array of strings Retrieve contacts by list of types of the contact related exceptions ( |
extContactId | Array of strings Retrieve by list of extContactId |
keys | string Default: "contactId,status,extContactId,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Retrieve contacts created after this date-time |
skip | integer <int32> Default: 0 Skip this many contacts |
status | string (ContactStatus) Enum: "active" "deleted" Retrieve by status |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Retrieve contacts created before this date-time |
updatedSince | string <date-time> Retrieve contacts updated after this date-time |
updatedUntil | string <date-time> Retrieve contacts updated before this date-time |
{- "code": 200,
- "success": true,
- "contacts": [
- {
- "contactId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "extContactId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "name": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "keys": "string",
- "order": "string",
- "contactId": [
- "string"
], - "emailAddr": [
- "string"
], - "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "extContactId": [
- "string"
], - "status": "active",
- "tags": [
- "string"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Uniqueness constraints within organization:
ContactId required | string ID or |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
Array of objects or null (ContactCustomField) | |
extContactId | string Contact external ID |
object (InternalInfo) Internal info | |
name | string Contact name |
object (AddressUpdateData) | |
tags | Array of strings (EntityTags) Tags assigned to entity |
{- "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "extContactId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "name": "string",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "tags": [
- "string"
]
}
{- "code": 200,
- "success": true,
- "contact": {
- "contactId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "extContactId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "name": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
extEntityId required | string |
type required | string Type of the object |
createdAt | string <date-time> When the object was created within Pipe17 |
customObjectId | string Custom Object ID |
data | object Custom data |
exceptionCategories | Array of strings References to categories of exceptions related to the object |
exceptions | Array of strings Types of exceptions related to the object |
integration | string ID of integration that created the object |
orgKey | string Organization this object belong to |
relatedEntityId | string |
relatedEntityType | string (EntityName) Enum: "accounts" "arrivals" "automations" "automation_rules" "automation_runs" "changelog" "connectors" "customers" "custom_objects" "contacts" "entity_filters" "exceptions" "fulfillments" "functions" "inventory" "inventory_groups" "inventoryrules" "invoices" "labels" "locations" "lookup_objects" "metrics" "orders" "order_regions" "order_routings" "catalogs" "catalog_products" "products" "purchases" "receipts" "refunds" "returns" "shipments" "shipment_boxes" "shipping_methods" "statements" "statement_transactions" "suppliers" "transfers" "trackings" "usagedata" "usageplans" "vendor_schemas" Entity Name |
tags | Array of strings (EntityTags) Tags assigned to entity |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "customObjectId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "extEntityId": "string",
- "type": "string",
- "data": { },
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
extEntityId required | string |
type required | string Type of the object |
data | object Custom data |
relatedEntityId | string |
relatedEntityType | string (EntityName) Enum: "accounts" "arrivals" "automations" "automation_rules" "automation_runs" "changelog" "connectors" "customers" "custom_objects" "contacts" "entity_filters" "exceptions" "fulfillments" "functions" "inventory" "inventory_groups" "inventoryrules" "invoices" "labels" "locations" "lookup_objects" "metrics" "orders" "order_regions" "order_routings" "catalogs" "catalog_products" "products" "purchases" "receipts" "refunds" "returns" "shipments" "shipment_boxes" "shipping_methods" "statements" "statement_transactions" "suppliers" "transfers" "trackings" "usagedata" "usageplans" "vendor_schemas" Entity Name |
tags | Array of strings (EntityTags) Tags assigned to entity |
[- {
- "extEntityId": "string",
- "type": "string",
- "data": { },
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "tags": [
- "string"
]
}
]
{- "code": 200,
- "success": true,
- "customObjects": [
- {
- "conflict": { },
- "customObject": {
- "customObjectId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "extEntityId": "string",
- "type": "string",
- "data": { },
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "errors": [
- "string"
], - "message": "string",
- "status": "submitted"
}
]
}
CustomObjectId required | string |
{- "code": 200,
- "success": true,
- "customObject": {
- "customObjectId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "extEntityId": "string",
- "type": "string",
- "data": { },
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many objects |
customObjectId | Array of strings Select by 'customObjectId' list |
exceptionCategoryId | Array of strings Select by list of categories of the object related exceptions |
exceptionType | Array of strings Select by list of types of the object related exceptions ( |
extEntityId | Array of strings Select by 'extEntityId' list |
integration | Array of strings Select by 'integration' list |
keys | string Default: "customObjectId,extEntityId,relatedEntityId,relatedEntityType,type,createdAt,updatedAt,orgKey,integration" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
relatedEntityId | Array of strings Select by 'relatedEntityId' list |
relatedEntityType | Array of strings (EntityName) Items Enum: "accounts" "arrivals" "automations" "automation_rules" "automation_runs" "changelog" "connectors" "customers" "custom_objects" "contacts" "entity_filters" "exceptions" "fulfillments" "functions" "inventory" "inventory_groups" "inventoryrules" "invoices" "labels" "locations" "lookup_objects" "metrics" "orders" "order_regions" "order_routings" "catalogs" "catalog_products" "products" "purchases" "receipts" "refunds" "returns" "shipments" "shipment_boxes" "shipping_methods" "statements" "statement_transactions" "suppliers" "transfers" "trackings" "usagedata" "usageplans" "vendor_schemas" Select by 'relatedEntityType' list |
since | string <date-time> Select objects created after this date-time |
skip | integer <int32> Default: 0 Skip this many objects |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | Array of strings Select by 'type' list |
until | string <date-time> Select objects created before this date-time |
updatedSince | string <date-time> Select objects updated after this date-time |
updatedUntil | string <date-time> Select objects updated before this date-time |
{- "code": 200,
- "success": true,
- "customObjects": [
- {
- "customObjectId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "extEntityId": "string",
- "type": "string",
- "data": { },
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "keys": "string",
- "order": "string",
- "customObjectId": [
- "string"
], - "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "extEntityId": [
- "string"
], - "integration": [
- "string"
], - "relatedEntityId": [
- "string"
], - "relatedEntityType": [
- "accounts"
], - "tags": [
- "string"
], - "type": [
- "string"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
CustomObjectId required | string |
keys | string Default: "" Fields of the updated object that should be returned (- comma separated string, "*" - all) |
data | object or null Custom data |
extEntityId | string |
relatedEntityId | string |
relatedEntityType | string (EntityName) Enum: "accounts" "arrivals" "automations" "automation_rules" "automation_runs" "changelog" "connectors" "customers" "custom_objects" "contacts" "entity_filters" "exceptions" "fulfillments" "functions" "inventory" "inventory_groups" "inventoryrules" "invoices" "labels" "locations" "lookup_objects" "metrics" "orders" "order_regions" "order_routings" "catalogs" "catalog_products" "products" "purchases" "receipts" "refunds" "returns" "shipments" "shipment_boxes" "shipping_methods" "statements" "statement_transactions" "suppliers" "transfers" "trackings" "usagedata" "usageplans" "vendor_schemas" Entity Name |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | string Type of the object |
{- "data": { },
- "extEntityId": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "tags": [
- "string"
], - "type": "string"
}
{- "code": 200,
- "success": true,
- "customObject": {
- "customObjectId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "extEntityId": "string",
- "type": "string",
- "data": { },
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
Array of objects (CustomerAddress) | |
object (CustomerBillingAddress) | |
catalogIds | Array of strings |
object (CustomerCheckoutSettings) Customer checkout settings | |
company | string Customer company name |
createdAt | string <date-time> When the object was created within Pipe17 |
customerId | string Customer ID |
Array of objects (CustomerCustomField) | |
displayName | string Customer display name |
string Customer email | |
exceptionCategories | Array of strings References to categories of exceptions related to the customer |
exceptions | Array of strings Types of exceptions related to the customer |
extCustomerId | string Customer external ID |
firstName | string Customer first name |
object (InternalInfo) Internal info | |
lastName | string Customer last name |
Array of objects (CustomerLink) References to parent customer objects(s) and assigned role(s) of individual in parent customer | |
notes | string |
orgKey | string Organization this object belong to |
object (CustomerPaymentTerms) Customer payment terms | |
phone | string Customer phone |
object (CustomerShippingAddress) | |
object (SourceDoc) Vendor source document | |
status | string Enum: "active" "inactive" "deleted" Customer status |
tags | Array of strings (EntityTags) Tags assigned to entity |
object (CustomerTaxOptions) Customer tax options | |
type | string (CustomerType) Enum: "individual" "company" "company_location" "other" Customer type |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "customerId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "addresses": [
- {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string",
- "type": "billing"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "catalogIds": [
- "string"
], - "checkoutSettings": {
- "checkoutToDraft": true,
- "editableShippingAddress": true,
- "payNowOnly": true
}, - "company": "string",
- "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "displayName": "string",
- "email": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lastName": "string",
- "linkedCustomers": [
- {
- "customerId": "string",
- "roles": [
- "main_contact"
]
}
], - "notes": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueInDays": 0,
- "note": "string"
}, - "phone": "string",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "taxOptions": {
- "taxExempt": true,
- "taxId": "string",
- "taxRules": [
- {
- "name": "string",
- "type": "exempt"
}
]
}, - "type": "individual",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
Array of objects (CustomerAddress) | |
object (CustomerBillingAddress) | |
catalogIds | Array of strings |
object (CustomerCheckoutSettings) Customer checkout settings | |
company | string Customer company name |
Array of objects (CustomerCustomField) | |
displayName | string Customer display name |
string Customer email | |
extCustomerId | string Customer external ID |
firstName | string Customer first name |
object (InternalInfo) Internal info | |
lastName | string Customer last name |
Array of objects (CustomerLink) References to parent customer objects(s) and assigned role(s) of individual in parent customer | |
notes | string |
object (CustomerPaymentTerms) Customer payment terms | |
phone | string Customer phone |
object (CustomerShippingAddress) | |
object (SourceDoc) Vendor source document | |
status | string (CustomerStatus) Enum: "active" "inactive" "deleted" Customer status |
tags | Array of strings (EntityTags) Tags assigned to entity |
object (CustomerTaxOptions) Customer tax options | |
type | string (CustomerType) Enum: "individual" "company" "company_location" "other" Customer type |
{- "addresses": [
- {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string",
- "type": "billing"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "catalogIds": [
- "string"
], - "checkoutSettings": {
- "checkoutToDraft": true,
- "editableShippingAddress": true,
- "payNowOnly": true
}, - "company": "string",
- "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "displayName": "string",
- "email": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lastName": "string",
- "linkedCustomers": [
- {
- "customerId": "string",
- "roles": [
- "main_contact"
]
}
], - "notes": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueInDays": 0,
- "note": "string"
}, - "phone": "string",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "taxOptions": {
- "taxExempt": true,
- "taxId": "string",
- "taxRules": [
- {
- "name": "string",
- "type": "exempt"
}
]
}, - "type": "individual"
}
{- "code": 200,
- "success": true,
- "customer": {
- "customerId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "addresses": [
- {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string",
- "type": "billing"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "catalogIds": [
- "string"
], - "checkoutSettings": {
- "checkoutToDraft": true,
- "editableShippingAddress": true,
- "payNowOnly": true
}, - "company": "string",
- "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "displayName": "string",
- "email": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lastName": "string",
- "linkedCustomers": [
- {
- "customerId": "string",
- "roles": [
- "main_contact"
]
}
], - "notes": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueInDays": 0,
- "note": "string"
}, - "phone": "string",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "taxOptions": {
- "taxExempt": true,
- "taxId": "string",
- "taxRules": [
- {
- "name": "string",
- "type": "exempt"
}
]
}, - "type": "individual",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
action | string (ListDeleteAction) Default: "list" Enum: "list" "soft" Return the list of what to delete, or delete softly |
count | integer <int32> Default: 100 Delete at most this many customers |
customerId | Array of strings Delete customers by list of customerId |
deleted | boolean Delete soft deleted customers |
extCustomerId | Array of strings Delete customers by list of extCustomerId |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete customers assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Delete customers created after this date-time |
skip | integer <int32> Default: 0 Skip this many customers |
status | string (CustomerStatus) Enum: "active" "inactive" "deleted" Delete by status |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Delete customers created before this date-time |
updatedSince | string <date-time> Delete customers updated after this date-time |
updatedUntil | string <date-time> Delete customers updated before this date-time |
{- "code": 200,
- "success": true,
- "customers": [
- {
- "customerId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "addresses": [
- {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string",
- "type": "billing"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "catalogIds": [
- "string"
], - "checkoutSettings": {
- "checkoutToDraft": true,
- "editableShippingAddress": true,
- "payNowOnly": true
}, - "company": "string",
- "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "displayName": "string",
- "email": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lastName": "string",
- "linkedCustomers": [
- {
- "customerId": "string",
- "roles": [
- "main_contact"
]
}
], - "notes": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueInDays": 0,
- "note": "string"
}, - "phone": "string",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "taxOptions": {
- "taxExempt": true,
- "taxId": "string",
- "taxRules": [
- {
- "name": "string",
- "type": "exempt"
}
]
}, - "type": "individual",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "deleted": 0,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "catalogIds": [
- "string"
], - "customerId": [
- "string"
], - "deleted": true,
- "extCustomerId": [
- "string"
], - "linkedCustomerId": [
- "string"
], - "status": "active",
- "tags": [
- "string"
], - "type": "individual",
- "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
CustomerId required | string ID or |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
{- "code": 200,
- "success": true,
- "customer": {
- "customerId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "addresses": [
- {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string",
- "type": "billing"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "catalogIds": [
- "string"
], - "checkoutSettings": {
- "checkoutToDraft": true,
- "editableShippingAddress": true,
- "payNowOnly": true
}, - "company": "string",
- "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "displayName": "string",
- "email": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lastName": "string",
- "linkedCustomers": [
- {
- "customerId": "string",
- "roles": [
- "main_contact"
]
}
], - "notes": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueInDays": 0,
- "note": "string"
}, - "phone": "string",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "taxOptions": {
- "taxExempt": true,
- "taxId": "string",
- "taxRules": [
- {
- "name": "string",
- "type": "exempt"
}
]
}, - "type": "individual",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
catalogIds | Array of strings Retrieve by list of assigned catalog Ids |
company | string Retrieve customers by company name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
count | integer <int32> Default: 100 Return at most this many customers |
customerId | Array of strings Retrieve by list of customerId |
deleted | boolean Retrieve soft deleted customers |
displayName | string Retrieve customers by displayName (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
string Retrieve customers by email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) | |
emailAddr | Array of strings Retrieve by list of billing/shippingAddress.email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
exceptionCategoryId | Array of strings Retrieve customers by list of categories of the customer related exceptions |
exceptionType | Array of strings Retrieve customers by list of types of the customer related exceptions ( |
extCustomerId | Array of strings Retrieve by list of extCustomerId |
firstName | string Retrieve customers by firstName (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
hasSourceDoc | boolean Retrieve customers containing a source document |
keys | string Default: "customerId,status,firstName,lastName,extCustomerId,displayName,shippingAddress,billingAddress,creditCard,createdAt,updatedAt,orgKey" Return these top-level fields |
lastName | string Retrieve customers by lastName (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
linkedCustomerId | Array of strings Retrieve by list of linked customerId |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
phone | string Retrieve customers by phone (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
since | string <date-time> Retrieve customers created after this date-time |
skip | integer <int32> Default: 0 Skip this many customers |
status | string (CustomerStatus) Enum: "active" "inactive" "deleted" Retrieve by status |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | string (CustomerType) Enum: "individual" "company" "company_location" "other" Retrieve by status |
until | string <date-time> Retrieve customers created before this date-time |
updatedSince | string <date-time> Retrieve customers updated after this date-time |
updatedUntil | string <date-time> Retrieve customers updated before this date-time |
{- "code": 200,
- "success": true,
- "customers": [
- {
- "customerId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "addresses": [
- {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string",
- "type": "billing"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "catalogIds": [
- "string"
], - "checkoutSettings": {
- "checkoutToDraft": true,
- "editableShippingAddress": true,
- "payNowOnly": true
}, - "company": "string",
- "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "displayName": "string",
- "email": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lastName": "string",
- "linkedCustomers": [
- {
- "customerId": "string",
- "roles": [
- "main_contact"
]
}
], - "notes": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueInDays": 0,
- "note": "string"
}, - "phone": "string",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "taxOptions": {
- "taxExempt": true,
- "taxId": "string",
- "taxRules": [
- {
- "name": "string",
- "type": "exempt"
}
]
}, - "type": "individual",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "catalogIds": [
- "string"
], - "customerId": [
- "string"
], - "deleted": true,
- "extCustomerId": [
- "string"
], - "linkedCustomerId": [
- "string"
], - "status": "active",
- "tags": [
- "string"
], - "type": "individual",
- "company": "string",
- "displayName": "string",
- "email": "string",
- "emailAddr": [
- "string"
], - "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "firstName": "string",
- "hasSourceDoc": true,
- "lastName": "string",
- "phone": "string",
- "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Uniqueness constraints within organization:
CustomerId required | string ID or |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
Array of objects or null (CustomerAddress) | |
object (CustomerBillingAddress) | |
catalogIds | Array of strings or null |
object (CustomerCheckoutSettings) Customer checkout settings | |
company | string Customer company name |
Array of objects (CustomerCustomField) | |
displayName | string Customer display name |
string Customer email | |
extCustomerId | string Customer external ID |
object (InternalInfo) Internal info | |
Array of objects or null (CustomerLink) References to parent customer objects(s) and assigned role(s) of individual in parent customer | |
notes | string |
object (CustomerPaymentTerms) Customer payment terms | |
phone | string Customer phone |
object (CustomerShippingAddress) | |
object (SourceDoc) Vendor source document | |
status | string (CustomerStatus) Enum: "active" "inactive" "deleted" Customer status |
tags | Array of strings (EntityTags) Tags assigned to entity |
object (CustomerTaxOptions) Customer tax options |
{- "addresses": [
- {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string",
- "type": "billing"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "catalogIds": [
- "string"
], - "checkoutSettings": {
- "checkoutToDraft": true,
- "editableShippingAddress": true,
- "payNowOnly": true
}, - "company": "string",
- "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "displayName": "string",
- "email": "string",
- "extCustomerId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "linkedCustomers": [
- {
- "customerId": "string",
- "roles": [
- "main_contact"
]
}
], - "notes": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueInDays": 0,
- "note": "string"
}, - "phone": "string",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "taxOptions": {
- "taxExempt": true,
- "taxId": "string",
- "taxRules": [
- {
- "name": "string",
- "type": "exempt"
}
]
}
}
{- "code": 200,
- "success": true,
- "customer": {
- "customerId": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "status": "active",
- "addresses": [
- {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string",
- "type": "billing"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "catalogIds": [
- "string"
], - "checkoutSettings": {
- "checkoutToDraft": true,
- "editableShippingAddress": true,
- "payNowOnly": true
}, - "company": "string",
- "customFields": [
- {
- "compliance": "none",
- "name": "string",
- "value": "string"
}
], - "displayName": "string",
- "email": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lastName": "string",
- "linkedCustomers": [
- {
- "customerId": "string",
- "roles": [
- "main_contact"
]
}
], - "notes": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueInDays": 0,
- "note": "string"
}, - "phone": "string",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "taxOptions": {
- "taxExempt": true,
- "taxId": "string",
- "taxRules": [
- {
- "name": "string",
- "type": "exempt"
}
]
}, - "type": "individual",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
Array of objects (FulfillmentAcknowledgment) Integrations acknowledgement info for this fulfillment | |
object ...???... | |
actualShipDate | string <date-time> Actual ship date |
autoEngUpdateStatus | string (AutoEngUpdateStatus) Enum: "initialPending" "pending" "updated" "none" A status that indicates whether or not the automation engine may update the entity sometime in the future. Only set internally. Useful for services such as the order routing engine where the user intended order state is critical before action. Used for orders and shipments. Status definitions:
|
billOfLading | string |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects (NameValue) Custom Fields | |
dimensionsUnit | string Enum: "cm" "in" "ft" Dimensions UOM |
exceptionCategories | Array of strings References to categories of exceptions related to the fulfillment |
exceptions | Array of strings Types of exceptions related to the fulfillment |
expectedArrivalDate | string <date-time> Expected arrival date |
extFulfillmentId | string Reference to fulfillment on external system (vendor) |
extOrderId | string External customer friendly ID |
fulfillmentId | string Fulfillment ID |
fulfillmentType | string (FulfillmentType) Enum: "accepted" "rejected" "voided" |
height | number <float> Height |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
length | number <float> Length |
Array of objects (FulfillmentItemExt) | |
locationId | string locationId of the fulfillment |
orderId | string Pipe17 Internal Order's ID |
orderIntegration | string Reference to integration that created order tied to an item |
orderType | string Enum: "sales" "transfer" "purchase" Type of Pipe17 Internal Order |
orgKey | string Organization this object belong to |
sacCode | string |
shipmentId | string Internal Pipe17 ID of the Shipment |
shipmentIntegration | string Reference to integration that created shipment tied to an item |
shippingCarrier | string Shipping Carrier |
shippingCharge | number <float> Shipping Charge |
shippingClass | string Shipping Class |
object (SourceDoc) Vendor source document | |
ssccCode | string |
tags | Array of strings (EntityTags) Tags assigned to entity |
Array of objects (FulfillmentChangelogEntry) Timeline of updates | |
trackedAtSourceChannel | boolean Whether tracking number were issued by source channel and thus fulfillment reporting is not required |
trackingNumber | Array of strings Tracking number(s). Not required when |
trackingURLs | Array of strings Tracking url(s) |
ucc128 | string |
updatedAt | string <date-time> When the object was updated within Pipe17 |
weight | number <float> Weight |
weightUnit | string Enum: "lb" "oz" "kg" "g" Weight unit |
width | number <float> Width |
{- "acknowledgement": [
- {
- "acknowledgedAt": "2019-08-24T14:15:22Z",
- "integration": "string"
}
], - "acknowledgementSources": {
- "erp": "2019-08-24T14:15:22Z",
- "oms": "2019-08-24T14:15:22Z"
}, - "autoEngUpdateStatus": "initialPending",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "fulfillmentId": "string",
- "integration": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "lotNumber": "string",
- "quantityUnit": "each",
- "serialNumbers": [
- "string"
], - "trackedAtSourceChannel": true,
- "uniqueId": "string",
- "upc": "string",
- "bundleQuantity": 0,
- "bundleQuantityPartial": [
- 0
], - "bundleSKU": "string",
- "bundleUPC": "string"
}
], - "locationId": "string",
- "orderId": "string",
- "orderIntegration": "string",
- "orderType": "sales",
- "shipmentIntegration": "string",
- "timeline": [
- {
- "fulfillmentId": "string",
- "shipmentId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "actualShipDate": "2019-08-24T14:15:22Z",
- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extFulfillmentId": "string",
- "extOrderId": "string",
- "fulfillmentType": "accepted",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "length": 0,
- "sacCode": "string",
- "shipmentId": "string",
- "shippingCarrier": "string",
- "shippingCharge": 0,
- "shippingClass": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "ssccCode": "string",
- "tags": [
- "string"
], - "trackedAtSourceChannel": true,
- "trackingNumber": [
- "string"
], - "trackingURLs": [
- "string"
], - "ucc128": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Acknowledges delivery of fulfillment information by integration
FulfillmentId required | Array of strings Id or |
integration | string Acknowledging integration |
{- "integration": "string"
}
{- "code": 200,
- "success": true
}
Uniqueness constraints within organization:
required | Array of objects (FulfillmentItem) |
shipmentId required | string Internal Pipe17 ID of the Shipment |
trackingNumber required | Array of strings Tracking number(s). Not required when |
actualShipDate | string <date-time> Actual ship date |
billOfLading | string |
Array of objects (NameValue) Custom Fields | |
dimensionsUnit | string Enum: "cm" "in" "ft" Dimensions UOM |
expectedArrivalDate | string <date-time> Expected arrival date |
extFulfillmentId | string Reference to fulfillment on external system (vendor) |
extOrderId | string External customer friendly ID |
fulfillmentType | string (FulfillmentType) Enum: "accepted" "rejected" "voided" |
height | number <float> Height |
object (InternalInfo) Internal info | |
length | number <float> Length |
locationId | string locationId of the fulfillment |
sacCode | string |
shippingCarrier | string Shipping Carrier |
shippingCharge | number <float> Shipping Charge |
shippingClass | string Shipping Class |
object (SourceDoc) Vendor source document | |
ssccCode | string |
tags | Array of strings (EntityTags) Tags assigned to entity |
trackedAtSourceChannel | boolean Whether tracking number were issued by source channel and thus fulfillment reporting is not required |
trackingURLs | Array of strings Tracking url(s) |
ucc128 | string |
weight | number <float> Weight |
weightUnit | string Enum: "lb" "oz" "kg" "g" Weight unit |
width | number <float> Width |
[- {
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "lotNumber": "string",
- "quantityUnit": "each",
- "serialNumbers": [
- "string"
], - "trackedAtSourceChannel": true,
- "uniqueId": "string",
- "upc": "string"
}
], - "actualShipDate": "2019-08-24T14:15:22Z",
- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extFulfillmentId": "string",
- "extOrderId": "string",
- "fulfillmentType": "accepted",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "length": 0,
- "locationId": "string",
- "sacCode": "string",
- "shipmentId": "string",
- "shippingCarrier": "string",
- "shippingCharge": 0,
- "shippingClass": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "ssccCode": "string",
- "tags": [
- "string"
], - "trackedAtSourceChannel": true,
- "trackingNumber": [
- "string"
], - "trackingURLs": [
- "string"
], - "ucc128": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0
}
]
{- "code": 200,
- "success": true,
- "fulfillments": [
- {
- "code": 0,
- "conflict": { },
- "errors": [
- "string"
], - "fulfillment": {
- "acknowledgement": [
- {
- "acknowledgedAt": "2019-08-24T14:15:22Z",
- "integration": "string"
}
], - "acknowledgementSources": {
- "erp": "2019-08-24T14:15:22Z",
- "oms": "2019-08-24T14:15:22Z"
}, - "autoEngUpdateStatus": "initialPending",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "fulfillmentId": "string",
- "integration": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "lotNumber": "string",
- "quantityUnit": "each",
- "serialNumbers": [
- "string"
], - "trackedAtSourceChannel": true,
- "uniqueId": "string",
- "upc": "string",
- "bundleQuantity": 0,
- "bundleQuantityPartial": [
- 0
], - "bundleSKU": "string",
- "bundleUPC": "string"
}
], - "locationId": "string",
- "orderId": "string",
- "orderIntegration": "string",
- "orderType": "sales",
- "shipmentIntegration": "string",
- "timeline": [
- {
- "fulfillmentId": "string",
- "shipmentId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "actualShipDate": "2019-08-24T14:15:22Z",
- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extFulfillmentId": "string",
- "extOrderId": "string",
- "fulfillmentType": "accepted",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "length": 0,
- "sacCode": "string",
- "shipmentId": "string",
- "shippingCarrier": "string",
- "shippingCharge": 0,
- "shippingClass": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "ssccCode": "string",
- "tags": [
- "string"
], - "trackedAtSourceChannel": true,
- "trackingNumber": [
- "string"
], - "trackingURLs": [
- "string"
], - "ucc128": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "message": "string",
- "status": "submitted"
}
]
}
FulfillmentId required | string Id or |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
withTimeline | boolean Include timeline of updates when available |
{- "code": 200,
- "success": true,
- "fulfillment": {
- "acknowledgement": [
- {
- "acknowledgedAt": "2019-08-24T14:15:22Z",
- "integration": "string"
}
], - "acknowledgementSources": {
- "erp": "2019-08-24T14:15:22Z",
- "oms": "2019-08-24T14:15:22Z"
}, - "autoEngUpdateStatus": "initialPending",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "fulfillmentId": "string",
- "integration": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "lotNumber": "string",
- "quantityUnit": "each",
- "serialNumbers": [
- "string"
], - "trackedAtSourceChannel": true,
- "uniqueId": "string",
- "upc": "string",
- "bundleQuantity": 0,
- "bundleQuantityPartial": [
- 0
], - "bundleSKU": "string",
- "bundleUPC": "string"
}
], - "locationId": "string",
- "orderId": "string",
- "orderIntegration": "string",
- "orderType": "sales",
- "shipmentIntegration": "string",
- "timeline": [
- {
- "fulfillmentId": "string",
- "shipmentId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "actualShipDate": "2019-08-24T14:15:22Z",
- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extFulfillmentId": "string",
- "extOrderId": "string",
- "fulfillmentType": "accepted",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "length": 0,
- "sacCode": "string",
- "shipmentId": "string",
- "shippingCarrier": "string",
- "shippingCharge": 0,
- "shippingClass": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "ssccCode": "string",
- "tags": [
- "string"
], - "trackedAtSourceChannel": true,
- "trackingNumber": [
- "string"
], - "trackingURLs": [
- "string"
], - "ucc128": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
acknowledgedBy | Array of strings Fulfillments by list of acknowledged integrations |
autoEngUpdateStatus | Array of strings (AutoEngUpdateStatus) Items Enum: "initialPending" "pending" "updated" "none" |
count | integer <int32> Default: 100 Return at most this many fulfillments |
exceptionCategoryId | Array of strings Fulfillments by list of categories of the fulfillment related exceptions |
exceptionType | Array of strings Fulfillments by list of types of the fulfillment related exceptions ( |
extFulfillmentId | Array of strings Fulfillments by list of extFulfillmentId |
extOrderId | Array of strings Fulfillments by list of extOrderId |
extShipmentId | Array of strings Fulfillments by list of extShipmentId |
fulfillmentId | Array of strings Fulfillments by list of fulfillmentId |
fulfillmentType | Array of strings (FulfillmentType) Items Enum: "accepted" "rejected" "voided" Fulfillments by list of fulfillment types |
hasSourceDoc | boolean Fulfillments containing a source document |
integration | Array of strings Fulfillments by list of integrationId |
keys | string Default: "fulfillmentId,fulfillmentType,shipmentId,extOrderId,actualShipDate,createdAt,updatedAt,orgKey" Return these top-level fields |
locationId | Array of strings Fulfillments by list of locationId |
order | string Default: "createdAt" Sort by these top-level fields |
orderIntegration | Array of strings Fulfillments by list of order integrationId |
orderIntegrationAcknowledged | boolean Fulfillments by order integration acknowledgement |
pagination | string Value: "disabled" Exclude pagination info from the response |
shipmentId | Array of strings Fulfillments by list of shipmentId |
since | string <date-time> Fetch all fulfillments created after this date-time |
skip | integer <int32> Default: 0 Skip this many fulfillments |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Fetch all fulfillments created before this date-time |
updatedSince | string <date-time> Fetch all fulfillments updated after this date-time |
updatedUntil | string <date-time> Fetch all fulfillments updated before this date-time |
{- "code": 200,
- "success": true,
- "fulfillments": [
- {
- "acknowledgement": [
- {
- "acknowledgedAt": "2019-08-24T14:15:22Z",
- "integration": "string"
}
], - "acknowledgementSources": {
- "erp": "2019-08-24T14:15:22Z",
- "oms": "2019-08-24T14:15:22Z"
}, - "autoEngUpdateStatus": "initialPending",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "fulfillmentId": "string",
- "integration": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "lotNumber": "string",
- "quantityUnit": "each",
- "serialNumbers": [
- "string"
], - "trackedAtSourceChannel": true,
- "uniqueId": "string",
- "upc": "string",
- "bundleQuantity": 0,
- "bundleQuantityPartial": [
- 0
], - "bundleSKU": "string",
- "bundleUPC": "string"
}
], - "locationId": "string",
- "orderId": "string",
- "orderIntegration": "string",
- "orderType": "sales",
- "shipmentIntegration": "string",
- "timeline": [
- {
- "fulfillmentId": "string",
- "shipmentId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "actualShipDate": "2019-08-24T14:15:22Z",
- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extFulfillmentId": "string",
- "extOrderId": "string",
- "fulfillmentType": "accepted",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "length": 0,
- "sacCode": "string",
- "shipmentId": "string",
- "shippingCarrier": "string",
- "shippingCharge": 0,
- "shippingClass": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "ssccCode": "string",
- "tags": [
- "string"
], - "trackedAtSourceChannel": true,
- "trackingNumber": [
- "string"
], - "trackingURLs": [
- "string"
], - "ucc128": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "acknowledgedBy": [
- "string"
], - "extFulfillmentId": [
- "string"
], - "extOrderId": [
- "string"
], - "extShipmentId": [
- "string"
], - "fulfillmentId": [
- "string"
], - "fulfillmentType": [
- "accepted"
], - "hasSourceDoc": true,
- "integration": [
- "string"
], - "locationId": [
- "string"
], - "orderIntegration": [
- "string"
], - "orderIntegrationAcknowledged": true,
- "shipmentId": [
- "string"
], - "tags": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Trigger the fulfillments sync
FulfillmentId required | Array of strings |
syncAE | boolean Reset autoEngUpdateStatus |
{- "syncAE": true
}
{- "code": 200,
- "success": true
}
available | integer <int32> Number of items available |
availableToPromise | integer <int32> Number of items available to promise |
commitShip | integer <int32> Number of items being shipped (included in committed) |
committed | integer <int32> Number of items committed |
committedFuture | integer <int32> Number of items committed for pre-order |
commitXfer | integer <int32> Number of items being transferred out (included in committed) |
createdAt | string <date-time> When the object was created within Pipe17 |
damaged | integer <int32> |
entityId | string Related entity ID |
entityType | string Related entity ID's type |
event | string (EventType) Enum: "ingest" "adjust" "custom" "revise" "ship" "fulfill" "xferin" "xferout" "return" "receive" "xferfulfill" "futureShip" "release" "shipCancel" "shipCancelRestock" "futureShipCancel" "virtualCommit" "touch" "POSOrder" Type of event triggering inventory change:
|
future | integer <int32> Number of items that can be sold for pre-order |
hold | integer <int32> |
incoming | integer <int32> Number of incoming items in transit (maybe included in available) |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
inventoryId | string Inventory ID |
inventoryNotTracked | boolean Disables the inventory tracking |
label | string |
locationId | string Location of item |
onHand | integer <int32> Number of items on hand |
orderId | string Pipe17 internal order id that initiated this inventory change |
orderType | string Type of order that initiated this inventory change |
orgKey | string Organization this object belong to |
quantity | integer <int32> Number of items affected |
sku | string Item SKU |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | string Enum: "virtual" "physical" Inventory type (undefined value indicates a physical inventory) |
unavailable | integer <int32> Number of unavailable items |
updatedAt | string <date-time> When the object was updated within Pipe17 |
user | string Pipe17 internal id of the user who makes the inventory adjustment via the portal |
vendorSKU | string Item vendor SKU |
{- "available": 0,
- "availableToPromise": 0,
- "commitShip": 0,
- "commitXfer": 0,
- "committed": 0,
- "committedFuture": 0,
- "damaged": 0,
- "entityId": "string",
- "entityType": "string",
- "event": "ingest",
- "future": 0,
- "hold": 0,
- "incoming": 0,
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryId": "string",
- "inventoryNotTracked": true,
- "label": "string",
- "locationId": "string",
- "onHand": 0,
- "orderId": "string",
- "orderType": "string",
- "quantity": 0,
- "sku": "string",
- "tags": [
- "string"
], - "type": "virtual",
- "unavailable": 0,
- "user": "string",
- "vendorSKU": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints:
committed required | integer <int32> Number of items committed |
event required | string Enum: "ingest" "adjust" Event creating this item |
locationId required | string Location ID of item |
onHand required | integer <int32> Number of items on hand |
ptype required | string (EventSource) Enum: "wms" "ims" "oms" "portal" Event source partner type |
sku required | string Item SKU |
available | integer <int32> Number of items available |
commitShip | integer <int32> Number of items being shipped (included in committed) |
committedFuture | integer <int32> Number of items committed for pre-order |
commitXfer | integer <int32> Number of items being transferred out (included in committed) |
damaged | integer <int32> |
future | integer <int32> Number of items that can be sold for pre-order |
hold | integer <int32> |
incoming | integer <int32> Number of incoming items in transit (maybe included in available) |
object (InternalInfo) Internal info | |
inventoryNotTracked | boolean Disables the inventory tracking (default - false) |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | string Enum: "virtual" "physical" Inventory type |
unavailable | integer <int32> Number of unavailable items |
vendorSKU | string Item vendor SKU |
[- {
- "committed": 0,
- "event": "ingest",
- "locationId": "string",
- "onHand": 0,
- "ptype": "wms",
- "sku": "string",
- "available": 0,
- "commitShip": 0,
- "commitXfer": 0,
- "committedFuture": 0,
- "damaged": 0,
- "future": 0,
- "hold": 0,
- "incoming": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryNotTracked": true,
- "tags": [
- "string"
], - "type": "virtual",
- "unavailable": 0,
- "vendorSKU": "string"
}
]
{- "code": 200,
- "success": true,
- "inventory": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "inventory": {
- "available": 0,
- "availableToPromise": 0,
- "commitShip": 0,
- "commitXfer": 0,
- "committed": 0,
- "committedFuture": 0,
- "damaged": 0,
- "entityId": "string",
- "entityType": "string",
- "event": "ingest",
- "future": 0,
- "hold": 0,
- "incoming": 0,
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryId": "string",
- "inventoryNotTracked": true,
- "label": "string",
- "locationId": "string",
- "onHand": 0,
- "orderId": "string",
- "orderType": "string",
- "quantity": 0,
- "sku": "string",
- "tags": [
- "string"
], - "type": "virtual",
- "unavailable": 0,
- "user": "string",
- "vendorSKU": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "message": "string",
- "status": "submitted"
}
]
}
InventoryId required | string Inventory Item ID to fetch |
{- "code": 200,
- "success": true,
- "inventory": {
- "available": 0,
- "availableToPromise": 0,
- "commitShip": 0,
- "commitXfer": 0,
- "committed": 0,
- "committedFuture": 0,
- "damaged": 0,
- "entityId": "string",
- "entityType": "string",
- "event": "ingest",
- "future": 0,
- "hold": 0,
- "incoming": 0,
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryId": "string",
- "inventoryNotTracked": true,
- "label": "string",
- "locationId": "string",
- "onHand": 0,
- "orderId": "string",
- "orderType": "string",
- "quantity": 0,
- "sku": "string",
- "tags": [
- "string"
], - "type": "virtual",
- "unavailable": 0,
- "user": "string",
- "vendorSKU": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
available | integer Fetch inventory if 'available' value is equal to specified one |
available_gt | integer Fetch inventory if 'available' value is greater than specified one |
available_lt | integer Fetch inventory if 'available' value is less than specified one |
count | integer <int32> Default: 100 Return at most this many inventory items |
entityId | Array of strings Return inventory items related to certain event record by record id |
event | Array of strings (EventType) Items Enum: "ingest" "adjust" "custom" "revise" "ship" "fulfill" "xferin" "xferout" "return" "receive" "xferfulfill" "futureShip" "release" "shipCancel" "shipCancelRestock" "futureShipCancel" "virtualCommit" "touch" "POSOrder" Fetch inventory by event list (- allowed only with 'ledger' flag) |
integration | Array of strings Fetch inventory by integrations id list (- ignored in 'totals' queries) |
inventoryId | Array of strings Inventory items by list of inventoryId |
inventoryNotTracked | boolean Fetch inventory by the inventoryNotTracked value (- ignored in 'totals' queries) |
keys | string Default: "All" Return these top-level fields |
ledger | boolean Return inventory ledger information |
locationId | Array of strings Fetch inventory by its location ID |
onHand | integer Fetch inventory if 'onHand' value is equal to specified one |
onHand_gt | integer Fetch inventory if 'onHand' value is greater than specified one |
onHand_lt | integer Fetch inventory if 'onHand' value is less than specified one |
order | string Default: "-updatedAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
requestorId | string Id of the inventory totals requestor (- used to select availble locations; forcibly replaced with integration ID if the request came from an integration) |
since | string <date-time> Inventory created after this date,time |
skip | integer <int32> Default: 0 Skip this many inventory items |
sku | Array of strings Fetch inventory by its SKU |
sku_gt | string Fetch inventory in which SKU is lexicographically greater than the specified value |
sku_lt | string Fetch inventory in which SKU is lexicographically less than the specified value |
tags | Array of strings (EntityTags) Fetch inventory by tags (- disallowed with 'ledger' or 'totals' flag) |
totals | boolean Return inventory totals across all locations |
type | string Enum: "virtual" "physical" 'virtual' - fetch virtual inventory status, 'physical' - not virtual (it is unallowable parameter when used with 'ledger' or 'totals' flag) |
until | string <date-time> Inventory created before this date,time |
updatedSince | string <date-time> Inventory updated after this date-time |
updatedUntil | string <date-time> Inventory updated before this date-time |
vendorSKU | Array of strings Fetch inventory by its vendorSKU |
{- "code": 200,
- "success": true,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "available": 0,
- "entityId": [
- "string"
], - "inventoryId": [
- "string"
], - "locationId": [
- "string"
], - "sku": [
- "string"
], - "sku_gt": "string",
- "sku_lt": "string",
- "vendorSKU": [
- "string"
], - "keys": "string",
- "order": "string",
- "available_gt": 0,
- "available_lt": 0,
- "event": [
- "ingest"
], - "integration": [
- "string"
], - "inventoryNotTracked": true,
- "ledger": true,
- "onHand": 0,
- "onHand_gt": 0,
- "onHand_lt": 0,
- "requestorId": "string",
- "tags": [
- "string"
], - "totals": true,
- "type": "virtual"
}, - "inventory": [
- {
- "available": 0,
- "availableToPromise": 0,
- "commitShip": 0,
- "commitXfer": 0,
- "committed": 0,
- "committedFuture": 0,
- "damaged": 0,
- "entityId": "string",
- "entityType": "string",
- "event": "ingest",
- "future": 0,
- "hold": 0,
- "incoming": 0,
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryId": "string",
- "inventoryNotTracked": true,
- "label": "string",
- "locationId": "string",
- "onHand": 0,
- "orderId": "string",
- "orderType": "string",
- "quantity": 0,
- "sku": "string",
- "tags": [
- "string"
], - "type": "virtual",
- "unavailable": 0,
- "user": "string",
- "vendorSKU": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "locationId": [
- "string"
], - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Uniqueness constraints:
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
event required | string Enum: "ship" "fulfill" "xferout" "xferfulfill" "xferin" "receive" "futureShip" "release" "shipCancel" "shipCancelRestock" "futureShipCancel" "virtualCommit" "touch" "POSOrder" "custom" "revise" Event updating inventory |
locationId required | string Location Id of item |
ptype required | string (EventSource) Enum: "wms" "ims" "oms" "portal" Event source partner type |
quantity required | integer <int32> Number of items affected |
sku required | string Item SKU |
entityId | string Entity id of the record which is directly related to this inventory change |
entityType | string Enum: "arrivals" "fulfillments" "inventory" "receipts" "shipments" "orders" Type of the record which is directly related to this inventory change |
infinite | boolean Set if item location has "infinite" availability |
object (InternalInfo) Internal info | |
inventoryNotTracked | boolean or null Disables the inventory tracking |
label | string |
orderId | string Pipe17 internal order id that initiated this inventory change |
orderType | string Enum: "sales" "transfer" "purchase" Type of order that initiated this inventory change |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | string Enum: "virtual" "physical" Inventory type |
vendorSKU | string Item vendor SKU |
{- "event": "ship",
- "locationId": "string",
- "ptype": "wms",
- "quantity": 0,
- "sku": "string",
- "entityId": "string",
- "entityType": "arrivals",
- "infinite": true,
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryNotTracked": true,
- "label": "string",
- "orderId": "string",
- "orderType": "sales",
- "tags": [
- "string"
], - "type": "virtual",
- "vendorSKU": "string"
}
{- "code": 200,
- "success": true,
- "inventory": {
- "available": 0,
- "availableToPromise": 0,
- "commitShip": 0,
- "commitXfer": 0,
- "committed": 0,
- "committedFuture": 0,
- "damaged": 0,
- "entityId": "string",
- "entityType": "string",
- "event": "ingest",
- "future": 0,
- "hold": 0,
- "incoming": 0,
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryId": "string",
- "inventoryNotTracked": true,
- "label": "string",
- "locationId": "string",
- "onHand": 0,
- "orderId": "string",
- "orderType": "string",
- "quantity": 0,
- "sku": "string",
- "tags": [
- "string"
], - "type": "virtual",
- "unavailable": 0,
- "user": "string",
- "vendorSKU": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
event required | string (EventType) Enum: "ingest" "adjust" "custom" "revise" "ship" "fulfill" "xferin" "xferout" "return" "receive" "xferfulfill" "futureShip" "release" "shipCancel" "shipCancelRestock" "futureShipCancel" "virtualCommit" "touch" "POSOrder" Type of event triggering inventory change:
|
rule required | string Rule's definition as javascript function |
createdAt | string <date-time> When the object was created within Pipe17 |
description | string Description of the rule |
integration | string Event source integration id |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
partner | string Event source partner name |
ptype | string (EventSource) Enum: "wms" "ims" "oms" "portal" Event source partner type |
ruleId | string Rule ID |
status | string Rule status |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "ruleId": "string",
- "status": "string",
- "event": "ingest",
- "rule": "string",
- "description": "string",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "partner": "string",
- "ptype": "wms",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints:
event required | string (EventType) Enum: "ingest" "adjust" "custom" "revise" "ship" "fulfill" "xferin" "xferout" "return" "receive" "xferfulfill" "futureShip" "release" "shipCancel" "shipCancelRestock" "futureShipCancel" "virtualCommit" "touch" "POSOrder" Type of event triggering inventory change:
|
rule required | string Rule's definition as javascript function |
description | string Description of the rule |
integration | string Event source integration id |
object (InternalInfo) Internal info | |
partner | string Event source partner name |
ptype | string (EventSource) Enum: "wms" "ims" "oms" "portal" Event source partner type |
{- "event": "ingest",
- "rule": "string",
- "description": "string",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "partner": "string",
- "ptype": "wms"
}
{- "code": 200,
- "success": true,
- "inventoryrule": {
- "ruleId": "string",
- "status": "string",
- "event": "ingest",
- "rule": "string",
- "description": "string",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "partner": "string",
- "ptype": "wms",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
action | string (ListDeleteAction) Default: "list" Enum: "list" "soft" Return the list of what to delete, or delete softly |
count | integer <int32> Default: 100 Max number of items to delete |
deleted | boolean Delete soft deleted rules |
integration | Array of strings Delete rules by list of integration ids |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete rules assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
ruleId | Array of strings Delete rules by list of ruleId |
since | string <date-time> Delete rules created after this date-time |
skip | integer <int32> Default: 0 Number of items to skip |
until | string <date-time> Delete rules created before this date-time |
updatedSince | string <date-time> Delete rules updated after this date-time |
updatedUntil | string <date-time> Delete rules updated before this date-time |
{- "code": 200,
- "success": true,
- "deleted": 0,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "integration": [
- "string"
], - "ruleId": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "rules": [
- {
- "ruleId": "string",
- "status": "string",
- "event": "ingest",
- "rule": "string",
- "description": "string",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "partner": "string",
- "ptype": "wms",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
RuleId required | string Rule ID to fetch |
{- "code": 200,
- "success": true,
- "inventoryrule": {
- "ruleId": "string",
- "status": "string",
- "event": "ingest",
- "rule": "string",
- "description": "string",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "partner": "string",
- "ptype": "wms",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many rules |
deleted | boolean Soft deleted rules |
event | Array of strings (EventType) Items Enum: "ingest" "adjust" "custom" "revise" "ship" "fulfill" "xferin" "xferout" "return" "receive" "xferfulfill" "futureShip" "release" "shipCancel" "shipCancelRestock" "futureShipCancel" "virtualCommit" "touch" "POSOrder" Event types trigerring rule |
integration | Array of strings Rules by list of integration ids |
keys | string Default: "ruleId,event,ptype,partner,integration,description,rule,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
partner | Array of strings Event source partner names |
ptype | Array of strings (EventSource) Items Enum: "wms" "ims" "oms" "portal" Event source partner types |
ruleId | Array of strings Rules by list of ruleId |
since | string <date-time> Rules created after this date-time |
skip | integer <int32> Default: 0 Skip this many rules |
until | string <date-time> Rules created before this date-time |
updatedSince | string <date-time> Rules updated after this date-time |
updatedUntil | string <date-time> Rules updated before this date-time |
{- "code": 200,
- "success": true,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "integration": [
- "string"
], - "ruleId": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "rules": [
- {
- "ruleId": "string",
- "status": "string",
- "event": "ingest",
- "rule": "string",
- "description": "string",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "partner": "string",
- "ptype": "wms",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
Uniqueness constraints:
RuleId required | string Rule ID to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
rule required | string Rule's definition as javascript function |
description | string Description of the rule |
object (InternalInfo) Internal info |
{- "rule": "string",
- "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}
}
{- "code": 200,
- "success": true,
- "inventoryrule": {
- "ruleId": "string",
- "status": "string",
- "event": "ingest",
- "rule": "string",
- "description": "string",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "partner": "string",
- "ptype": "wms",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
extInvoiceId required | string External Invoice ID |
Array of objects (InvoiceAdditionalCharge) Additional charges | |
object (Address) | |
createdAt | string <date-time> When the object was created within Pipe17 |
currency | string Invoice currency code |
object (InvoiceCustomer) | |
Array of objects (NameValue) Custom Fields | |
Array of objects (InvoiceDiscount) Discounts | |
dueAt | string <date-time> Invoice due date |
exceptionCategories | Array of strings References to categories of exceptions related to the invoice |
exceptions | Array of strings Types of exceptions related to the invoice |
extInvoiceApiId | string External System Invoice API ID |
extInvoiceCreatedAt | string <date-time> When the invoice was created at source |
extInvoiceUpdatedAt | string <date-time> When the invoice was updated at source |
extInvoiceUrl | string Invoice Url in External System |
extOrderId | string Reference to order |
extReferenceId | string Reference ID |
integration | string Reference to integration that created the invoice |
object (InternalInfo) Internal info | |
invoiceDiscount | number <float> Invoice Discount |
invoiceId | string Auto Generated |
invoiceNote | string Invoice Notes |
invoiceTax | number <float> Invoice Tax |
invoiceType | string (InvoiceType) Enum: "bill" "invoice" "debitMemo" "creditMemo" "cashSale" "cashReturn" Invoice Type |
Array of objects (InvoiceLineItem) | |
orderId | string Reference to order |
orderIntegrations | Array of strings Integrations that created orders related to the invoice |
orgKey | string Organization this object belong to |
paidAt | string <date-time> Invoice paid date |
Array of objects (InvoicePayment) Payments | |
paymentStatus | string status of the payment |
object (SourceDoc) Vendor source document | |
status | string (InvoiceStatus) Enum: "draft" "new" "reviewRequired" "posted" "partialPaid" "paid" "canceled" "closed" Invoice Status |
subTotalPrice | number <float> Sub Total Price |
tags | Array of strings (EntityTags) Tags assigned to entity |
term | string |
totalPrice | number <float> Total Price |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "invoiceId": "string",
- "orderIntegrations": [
- "string"
], - "extInvoiceId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "lastName": "string"
}, - "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "dueAt": "2019-08-24T14:15:22Z",
- "extInvoiceApiId": "string",
- "extInvoiceCreatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUpdatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUrl": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "invoiceDiscount": 0,
- "invoiceNote": "string",
- "invoiceTax": 0,
- "invoiceType": "bill",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extOrderId": "string",
- "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "orderId": "string",
- "quantityUnit": "each",
- "requiresShipping": true,
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true
}
], - "orderId": "string",
- "paidAt": "2019-08-24T14:15:22Z",
- "paymentStatus": "string",
- "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "term": "string",
- "totalPrice": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
extInvoiceId required | string External Invoice ID |
Array of objects (InvoiceAdditionalCharge) Additional charges | |
object (Address) | |
currency | string Invoice currency code |
object (InvoiceCustomer) | |
Array of objects (NameValue) Custom Fields | |
Array of objects (InvoiceDiscount) Discounts | |
dueAt | string <date-time> Invoice due date |
extInvoiceApiId | string External System Invoice API ID |
extInvoiceCreatedAt | string <date-time> When the invoice was created at source |
extInvoiceUpdatedAt | string <date-time> When the invoice was updated at source |
extInvoiceUrl | string Invoice Url in External System |
extOrderId | string Reference to order |
extReferenceId | string Reference ID |
object (InternalInfo) Internal info | |
invoiceDiscount | number <float> Invoice Discount |
invoiceNote | string Invoice Notes |
invoiceTax | number <float> Invoice Tax |
invoiceType | string (InvoiceType) Enum: "bill" "invoice" "debitMemo" "creditMemo" "cashSale" "cashReturn" Invoice Type |
Array of objects (InvoiceLineItem) | |
orderId | string Reference to order |
paidAt | string <date-time> Invoice paid date |
Array of objects (InvoicePayment) Payments | |
paymentStatus | string status of the payment |
object (SourceDoc) Vendor source document | |
status | string (InvoiceStatus) Enum: "draft" "new" "reviewRequired" "posted" "partialPaid" "paid" "canceled" "closed" Invoice Status |
subTotalPrice | number <float> Sub Total Price |
tags | Array of strings (EntityTags) Tags assigned to entity |
term | string |
totalPrice | number <float> Total Price |
[- {
- "extInvoiceId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "lastName": "string"
}, - "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "dueAt": "2019-08-24T14:15:22Z",
- "extInvoiceApiId": "string",
- "extInvoiceCreatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUpdatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUrl": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "invoiceDiscount": 0,
- "invoiceNote": "string",
- "invoiceTax": 0,
- "invoiceType": "bill",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extOrderId": "string",
- "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "orderId": "string",
- "quantityUnit": "each",
- "requiresShipping": true,
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true
}
], - "orderId": "string",
- "paidAt": "2019-08-24T14:15:22Z",
- "paymentStatus": "string",
- "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "term": "string",
- "totalPrice": 0
}
]
{- "code": 200,
- "success": true,
- "invoices": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "invoice": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "invoiceId": "string",
- "orderIntegrations": [
- "string"
], - "extInvoiceId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "lastName": "string"
}, - "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "dueAt": "2019-08-24T14:15:22Z",
- "extInvoiceApiId": "string",
- "extInvoiceCreatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUpdatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUrl": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "invoiceDiscount": 0,
- "invoiceNote": "string",
- "invoiceTax": 0,
- "invoiceType": "bill",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extOrderId": "string",
- "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "orderId": "string",
- "quantityUnit": "each",
- "requiresShipping": true,
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true
}
], - "orderId": "string",
- "paidAt": "2019-08-24T14:15:22Z",
- "paymentStatus": "string",
- "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "term": "string",
- "totalPrice": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "message": "string",
- "status": "submitted"
}
]
}
action | string (ListDeleteAction) Default: "list" Enum: "list" "soft" Return the list of what to delete, or delete softly |
count | integer <int32> Default: 100 Delete at most this many invoices |
deleted | boolean Select soft deleted invoices |
extInvoiceId | Array of strings Select invoices by |
extOrderId | Array of strings Select invoices by |
extReferenceId | Array of strings Select invoices by |
integration | Array of strings Select invoices of these integrations |
invoiceId | Array of strings Select invoices by |
orderId | Array of strings Select invoices by |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Select invoices assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Select invoices created after this date-time |
skip | integer <int32> Default: 0 Skip this many invoices |
status | Array of strings Select invoices by |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Select invoices created before this date-time |
updatedSince | string <date-time> Select invoices updated after this date-time |
updatedUntil | string <date-time> Select invoices updated before this date-time |
{- "code": 200,
- "success": true,
- "deleted": 0,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "extInvoiceApiId": [
- "string"
], - "extInvoiceId": [
- "string"
], - "extOrderId": [
- "string"
], - "extReferenceId": [
- "string"
], - "integration": [
- "string"
], - "invoiceId": [
- "string"
], - "orderId": [
- "string"
], - "status": [
- "draft"
], - "tags": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "invoices": [
- {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "invoiceId": "string",
- "orderIntegrations": [
- "string"
], - "extInvoiceId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "lastName": "string"
}, - "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "dueAt": "2019-08-24T14:15:22Z",
- "extInvoiceApiId": "string",
- "extInvoiceCreatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUpdatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUrl": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "invoiceDiscount": 0,
- "invoiceNote": "string",
- "invoiceTax": 0,
- "invoiceType": "bill",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extOrderId": "string",
- "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "orderId": "string",
- "quantityUnit": "each",
- "requiresShipping": true,
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true
}
], - "orderId": "string",
- "paidAt": "2019-08-24T14:15:22Z",
- "paymentStatus": "string",
- "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "term": "string",
- "totalPrice": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
InvoiceId required | string Invoice identifier - |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
{- "code": 200,
- "success": true,
- "invoice": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "invoiceId": "string",
- "orderIntegrations": [
- "string"
], - "extInvoiceId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "lastName": "string"
}, - "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "dueAt": "2019-08-24T14:15:22Z",
- "extInvoiceApiId": "string",
- "extInvoiceCreatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUpdatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUrl": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "invoiceDiscount": 0,
- "invoiceNote": "string",
- "invoiceTax": 0,
- "invoiceType": "bill",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extOrderId": "string",
- "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "orderId": "string",
- "quantityUnit": "each",
- "requiresShipping": true,
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true
}
], - "orderId": "string",
- "paidAt": "2019-08-24T14:15:22Z",
- "paymentStatus": "string",
- "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "term": "string",
- "totalPrice": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many invoices |
deleted | boolean Select soft deleted invoices |
emailAddr | Array of strings Select invoices by 'billingAddress.email' list |
exceptionCategoryId | Array of strings Select invoices by list of categories of the invoice related exceptions |
exceptionType | Array of strings Select invoices by list of types of the invoice related exceptions ( |
extInvoiceApiId | Array of strings |
extInvoiceId | Array of strings Select invoices by |
extOrderId | Array of strings Select invoices by |
extReferenceId | Array of strings Select invoices by |
hasSourceDoc | boolean Select invoices containing a source document |
integration | Array of strings Select invoices of these integrations |
invoiceId | Array of strings Select invoices by |
keys | string Default: "invoiceId,extInvoiceId,extInvoiceApiId,extReferenceId,integration,status,tags,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "-extOrderCreatedAt" Sort by these top-level fields |
orderId | Array of strings Select invoices by |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Select invoices created after this date-time |
skip | integer <int32> Default: 0 Skip this many invoices |
status | Array of strings Select invoices by |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Select invoices created before this date-time |
updatedSince | string <date-time> Select invoices updated after this date-time |
updatedUntil | string <date-time> Select invoices updated before this date-time |
{- "code": 200,
- "success": true,
- "invoices": [
- {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "invoiceId": "string",
- "orderIntegrations": [
- "string"
], - "extInvoiceId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "lastName": "string"
}, - "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "dueAt": "2019-08-24T14:15:22Z",
- "extInvoiceApiId": "string",
- "extInvoiceCreatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUpdatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUrl": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "invoiceDiscount": 0,
- "invoiceNote": "string",
- "invoiceTax": 0,
- "invoiceType": "bill",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extOrderId": "string",
- "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "orderId": "string",
- "quantityUnit": "each",
- "requiresShipping": true,
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true
}
], - "orderId": "string",
- "paidAt": "2019-08-24T14:15:22Z",
- "paymentStatus": "string",
- "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "term": "string",
- "totalPrice": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "extInvoiceApiId": [
- "string"
], - "extInvoiceId": [
- "string"
], - "extOrderId": [
- "string"
], - "extReferenceId": [
- "string"
], - "integration": [
- "string"
], - "invoiceId": [
- "string"
], - "orderId": [
- "string"
], - "status": [
- "draft"
], - "tags": [
- "string"
], - "keys": "string",
- "order": "string",
- "emailAddr": [
- "string"
], - "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "hasSourceDoc": true
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Uniqueness constraints within organization:
InvoiceId required | string Invoice identifier - |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
Array of objects or null (InvoiceAdditionalCharge) Additional charges | |
object (Address) | |
currency | string Invoice currency code |
object (InvoiceCustomer) | |
Array of objects (NameValue) Custom Fields | |
Array of objects or null (InvoiceDiscount) Discounts | |
dueAt | string <date-time> Invoice due date |
extInvoiceApiId | string External System Invoice API ID |
extInvoiceUpdatedAt | string <date-time> When the invoice was updated at source |
extInvoiceUrl | string Invoice Url in External System |
extReferenceId | string Reference ID |
object (InternalInfo) Internal info | |
invoiceDiscount | number or null <float> Invoice Discount |
invoiceNote | string or null Invoice Notes |
invoiceTax | number or null <float> Invoice Tax |
invoiceType | string (InvoiceType) Enum: "bill" "invoice" "debitMemo" "creditMemo" "cashSale" "cashReturn" Invoice Type |
Array of objects (InvoiceUpdateLineItem) | |
paidAt | string <date-time> Invoice paid date |
Array of objects or null (InvoicePayment) Payments | |
paymentStatus | string or null status of the payment |
object (SourceDoc) Vendor source document | |
status | string (InvoiceStatus) Enum: "draft" "new" "reviewRequired" "posted" "partialPaid" "paid" "canceled" "closed" Invoice Status |
subTotalPrice | number or null <float> Sub Total Price |
tags | Array of strings (EntityTags) Tags assigned to entity |
term | string |
totalPrice | number or null <float> Total Price |
{- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "lastName": "string"
}, - "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "dueAt": "2019-08-24T14:15:22Z",
- "extInvoiceApiId": "string",
- "extInvoiceUpdatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUrl": "string",
- "extReferenceId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "invoiceDiscount": 0,
- "invoiceNote": "string",
- "invoiceTax": 0,
- "invoiceType": "bill",
- "lineItems": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extOrderId": "string",
- "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "orderId": "string",
- "quantity": 0,
- "quantityUnit": "each",
- "requiresShipping": true,
- "requiresShippingSource": "source",
- "routed": true,
- "sku": "string",
- "taxable": true,
- "trackedAtSourceChannel": true,
- "uniqueId": "string"
}
], - "paidAt": "2019-08-24T14:15:22Z",
- "paymentStatus": "string",
- "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "term": "string",
- "totalPrice": 0
}
{- "code": 200,
- "success": true,
- "invoice": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "invoiceId": "string",
- "orderIntegrations": [
- "string"
], - "extInvoiceId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCustomerId": "string",
- "firstName": "string",
- "lastName": "string"
}, - "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "dueAt": "2019-08-24T14:15:22Z",
- "extInvoiceApiId": "string",
- "extInvoiceCreatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUpdatedAt": "2019-08-24T14:15:22Z",
- "extInvoiceUrl": "string",
- "extOrderId": "string",
- "extReferenceId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "invoiceDiscount": 0,
- "invoiceNote": "string",
- "invoiceTax": 0,
- "invoiceType": "bill",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extOrderId": "string",
- "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "orderId": "string",
- "quantityUnit": "each",
- "requiresShipping": true,
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true
}
], - "orderId": "string",
- "paidAt": "2019-08-24T14:15:22Z",
- "paymentStatus": "string",
- "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "term": "string",
- "totalPrice": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
subType required | string (JobSubType) Enum: "inventory" "replenishment" "oos_sku_on_order" "open_orders" "purchases" "transfers" "arrivals" "receipts" "products" "organizations" "orders" "shipments" "fulfillments" "locations" "shipping_methods" "returns" "exceptions" "lookup_objects" "statements" "users" Job sub-type |
type required | string (JobType) Enum: "report" "import" "prepare" "update" "delete" "export" "automation" "sync" Job type |
contentType | string Job result content type |
createdAt | string <date-time> When the object was created within Pipe17 |
createdBy | string Job requester ID |
object (InternalInfo) Internal info | |
jobId | string Job ID |
orgKey | string Organization this object belong to |
params | object Job type specific parameters |
progress | integer (JobProgress) [ 0 .. 100 ] Job progress (0-100) |
state | object (JobState) This is a free form object that can be used to store any state related to the job. |
status | string (JobStatus) Enum: "submitted" "processing" "completed" "canceled" "failed" Job status |
tags | Array of strings (EntityTags) Tags assigned to entity |
timeout | number <int32> Job timeout (in milliseconds) |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "createdBy": "string",
- "jobId": "string",
- "progress": 100,
- "status": "submitted",
- "subType": "inventory",
- "type": "report",
- "contentType": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "params": { },
- "state": { },
- "tags": [
- "string"
], - "timeout": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
subType required | string (JobSubType) Enum: "inventory" "replenishment" "oos_sku_on_order" "open_orders" "purchases" "transfers" "arrivals" "receipts" "products" "organizations" "orders" "shipments" "fulfillments" "locations" "shipping_methods" "returns" "exceptions" "lookup_objects" "statements" "users" Job sub-type |
type required | string (JobType) Enum: "report" "import" "prepare" "update" "delete" "export" "automation" "sync" Job type |
contentType | string Job result content type |
object (InternalInfo) Internal info | |
params | object Job type specific parameters |
state | object (JobState) This is a free form object that can be used to store any state related to the job. |
tags | Array of strings (EntityTags) Tags assigned to entity |
timeout | number <int32> Job timeout (in milliseconds) |
{- "subType": "inventory",
- "type": "report",
- "contentType": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "params": { },
- "state": { },
- "tags": [
- "string"
], - "timeout": 0
}
{- "code": 200,
- "success": true,
- "job": {
- "createdBy": "string",
- "jobId": "string",
- "progress": 100,
- "status": "submitted",
- "subType": "inventory",
- "type": "report",
- "contentType": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "params": { },
- "state": { },
- "tags": [
- "string"
], - "timeout": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
action | string (ListDeleteAction) Default: "list" Enum: "list" "soft" Return the list of what to delete, or delete softly |
count | integer <int32> Default: 100 Max number of items to delete |
jobId | Array of strings Delete jobs by list of jobId |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete jobs assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Delete items created after this date-time |
skip | integer <int32> Default: 0 Number of items to skip |
status | Array of strings (JobStatus) Items Enum: "submitted" "processing" "completed" "canceled" "failed" Delete items with given status |
subType | Array of strings (JobSubType) Items Enum: "inventory" "replenishment" "oos_sku_on_order" "open_orders" "purchases" "transfers" "arrivals" "receipts" "products" "organizations" "orders" "shipments" "fulfillments" "locations" "shipping_methods" "returns" "exceptions" "lookup_objects" "statements" "users" Delete items with given sub-type |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | Array of strings (JobType) Items Enum: "report" "import" "prepare" "update" "delete" "export" "automation" "sync" Delete items with given type |
until | string <date-time> Delete items created before this date-time |
updatedSince | string <date-time> Delete items updated after this date-time |
updatedUntil | string <date-time> Delete items updated before this date-time |
{- "code": 200,
- "success": true,
- "deleted": 0,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "createdBy": [
- "string"
], - "jobId": [
- "string"
], - "status": [
- "submitted"
], - "subType": [
- "inventory"
], - "tags": [
- "string"
], - "type": [
- "report"
], - "orgMode": [
- "sandbox"
]
}, - "jobs": [
- {
- "createdBy": "string",
- "jobId": "string",
- "progress": 100,
- "status": "submitted",
- "subType": "inventory",
- "type": "report",
- "contentType": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "params": { },
- "state": { },
- "tags": [
- "string"
], - "timeout": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
{- "code": 200,
- "success": true,
- "job": {
- "createdBy": "string",
- "jobId": "string",
- "progress": 100,
- "status": "submitted",
- "subType": "inventory",
- "type": "report",
- "contentType": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "params": { },
- "state": { },
- "tags": [
- "string"
], - "timeout": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Max number of items to return |
createdBy | Array of strings Retrieve by list of job requester IDs |
jobId | Array of strings Retrieve by list of jobId |
keys | string Default: "jobId,createdBy,type,subType,params,status,progress,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Fetch items created after this date-time |
skip | integer <int32> Default: 0 Number of items to skip |
status | Array of strings (JobStatus) Items Enum: "submitted" "processing" "completed" "canceled" "failed" Fetch items with given status |
subType | Array of strings (JobSubType) Items Enum: "inventory" "replenishment" "oos_sku_on_order" "open_orders" "purchases" "transfers" "arrivals" "receipts" "products" "organizations" "orders" "shipments" "fulfillments" "locations" "shipping_methods" "returns" "exceptions" "lookup_objects" "statements" "users" Fetch items with given sub-type |
tags | Array of strings (EntityTags) Tags assigned to entity |
type | Array of strings (JobType) Items Enum: "report" "import" "prepare" "update" "delete" "export" "automation" "sync" Fetch items with given type |
until | string <date-time> Fetch items created before this date-time |
updatedSince | string <date-time> Fetch items updated after this date-time |
updatedUntil | string <date-time> Fetch items updated before this date-time |
{- "code": 200,
- "success": true,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "createdBy": [
- "string"
], - "jobId": [
- "string"
], - "status": [
- "submitted"
], - "subType": [
- "inventory"
], - "tags": [
- "string"
], - "type": [
- "report"
], - "keys": "string",
- "order": "string"
}, - "jobs": [
- {
- "createdBy": "string",
- "jobId": "string",
- "progress": 100,
- "status": "submitted",
- "subType": "inventory",
- "type": "report",
- "contentType": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "params": { },
- "state": { },
- "tags": [
- "string"
], - "timeout": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
JobId required | string Job ID |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
object (InternalInfo) Internal info | |
progress | integer (JobProgress) [ 0 .. 100 ] Job progress (0-100) |
resultURL | string <uri> Job result URL |
state | object (JobState) This is a free form object that can be used to store any state related to the job. |
status | string (JobStatus) Enum: "submitted" "processing" "completed" "canceled" "failed" Job status |
tags | Array of strings (EntityTags) Tags assigned to entity |
{- "internal": {
- "property1": { },
- "property2": { }
}, - "progress": 100,
- "state": { },
- "status": "submitted",
- "tags": [
- "string"
]
}
{- "code": 200,
- "success": true,
- "job": {
- "createdBy": "string",
- "jobId": "string",
- "progress": 100,
- "status": "submitted",
- "subType": "inventory",
- "type": "report",
- "contentType": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "params": { },
- "state": { },
- "tags": [
- "string"
], - "timeout": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
contentType required | string |
fileName required | string |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects (NameValue) Custom Fields | |
exceptionCategories | Array of strings References to categories of exceptions related to the label |
exceptions | Array of strings Types of exceptions related to the label |
object (InternalInfo) Internal info | |
labelId | string Label ID |
labelType | string (LabelType) Enum: "shippingLabel" "packingSlip" Label type |
orgKey | string Organization this object belong to |
shippingMethod | string |
status | string Enum: "new" "ready" Label status |
tags | Array of strings (EntityTags) Tags assigned to entity |
trackingNumber | string |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "labelId": "string",
- "status": "new",
- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "string",
- "tags": [
- "string"
], - "trackingNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
contentType required | string |
fileName required | string |
Array of objects (NameValue) Custom Fields | |
object (InternalInfo) Internal info | |
labelType | string (LabelType) Enum: "shippingLabel" "packingSlip" Label type |
shippingMethod | string |
tags | Array of strings (EntityTags) Tags assigned to entity |
trackingNumber | string |
{- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "string",
- "tags": [
- "string"
], - "trackingNumber": "string"
}
{- "code": 200,
- "success": true,
- "label": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "labelId": "string",
- "status": "new",
- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "string",
- "tags": [
- "string"
], - "trackingNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
action | string (ListDeleteAction) Default: "list" Enum: "list" "soft" Return the list of what to delete, or delete softly |
count | integer <int32> Default: 100 Max number of items to delete |
deleted | boolean Delete soft deleted items |
labelId | Array of strings Delete items by list of labelId |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete labels assigned these orgModes. |
since | string <date-time> Delete items created after this date-time |
skip | integer <int32> Default: 0 Number of items to skip |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Delete items created before this date-time |
updatedSince | string <date-time> Delete items updated after this date-time |
updatedUntil | string <date-time> Delete items updated before this date-time |
{- "code": 200,
- "success": true,
- "deleted": 0,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "labelId": [
- "string"
], - "tags": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "labels": [
- {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "labelId": "string",
- "status": "new",
- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "string",
- "tags": [
- "string"
], - "trackingNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
{- "code": 200,
- "success": true,
- "label": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "labelId": "string",
- "status": "new",
- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "string",
- "tags": [
- "string"
], - "trackingNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Max number of items to return |
deleted | boolean Fetch soft deleted items |
exceptionCategoryId | Array of strings Fetch items by list of categories of the item related exceptions |
exceptionType | Array of strings Fetch items by list of types of the item related exceptions ( |
keys | string Default: "labelId,fileName,contentType,createdAt,updatedAt,orgKey,status" Return these top-level fields |
labelId | Array of strings Fetch items by list of labelId |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Fetch items created after this date-time |
skip | integer <int32> Default: 0 Number of items to skip |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Fetch items created before this date-time |
updatedSince | string <date-time> Fetch items updated after this date-time |
updatedUntil | string <date-time> Fetch items updated before this date-time |
{- "code": 200,
- "success": true,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "labelId": [
- "string"
], - "tags": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "labels": [
- {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "labelId": "string",
- "status": "new",
- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "string",
- "tags": [
- "string"
], - "trackingNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
required | object (LocationAddress) |
name required | string Location Name |
createdAt | string <date-time> When the object was created within Pipe17 |
exceptionCategories | Array of strings References to categories of exceptions related to the location |
exceptions | Array of strings Types of exceptions related to the location |
excludeFromTotals | boolean Set to exclude location from calculating inventory totals |
excludeFromTotalsFor | Array of strings Requestors of inventory totals for whom the location should be excluded from calculating totals |
excludeInventoryEvents | Array of strings Set of events to be excluded from automated processing for this location |
Array of objects (LocationExternalSystem) | |
fulfillmentIntegrationId | string Set if this is a fulfillment location |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
inventoryIntegrationId | string Set if inventory source for this location is different from fulfillmentIntegrationId |
inventoryNotTracked | boolean Do not track inventory flag |
locationId | string Location ID |
mergedWithLocationId | string For merged locations, indicates which locationId current location is merged with |
orgKey | string Organization this object belong to |
preserveBundles | boolean Set if shipments to this location should have lineItems referring to bundles kept intact |
routingPaused | boolean Indicates the location is paused from routing |
Array of objects (TimeRange) Time intervals during which routing is paused | |
object (SourceDoc) Vendor source document | |
status | string (LocationStatus) Enum: "active" "inactive" "pending" "merged" "deleted" Location status |
tags | Array of strings (EntityTags) Tags assigned to entity |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "locationId": "string",
- "mergedWithLocationId": "string",
- "address": {
- "address1": "string",
- "country": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "excludeFromTotals": true,
- "excludeFromTotalsFor": [
- "string"
], - "excludeInventoryEvents": [
- "string"
], - "externalSystem": [
- {
- "integrationId": "string",
- "locationValue": "string"
}
], - "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryIntegrationId": "string",
- "inventoryNotTracked": true,
- "preserveBundles": true,
- "routingPaused": true,
- "routingPausedRanges": [
- {
- "end": "2019-08-24T14:15:22Z",
- "start": "2019-08-24T14:15:22Z"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
required | object (LocationAddress) |
name required | string Location Name |
excludeFromTotals | boolean Set to exclude location from calculating inventory totals |
excludeFromTotalsFor | Array of strings Requestors of inventory totals for whom the location should be excluded from calculating totals |
excludeInventoryEvents | Array of strings Set of events to be excluded from automated processing for this location |
Array of objects (LocationExternalSystem) | |
fulfillmentIntegrationId | string Set if this is a fulfillment location |
object (InternalInfo) Internal info | |
inventoryIntegrationId | string Set if inventory source for this location is different from fulfillmentIntegrationId |
inventoryNotTracked | boolean Do not track inventory flag |
preserveBundles | boolean Set if shipments to this location should have lineItems referring to bundles kept intact |
routingPaused | boolean Indicates the location is paused from routing |
Array of objects (TimeRange) Time intervals during which routing is paused | |
object (SourceDoc) Vendor source document | |
status | string (LocationStatus) Enum: "active" "inactive" "pending" "merged" "deleted" Location status |
tags | Array of strings (EntityTags) Tags assigned to entity |
{- "address": {
- "address1": "string",
- "country": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "excludeFromTotals": true,
- "excludeFromTotalsFor": [
- "string"
], - "excludeInventoryEvents": [
- "string"
], - "externalSystem": [
- {
- "integrationId": "string",
- "locationValue": "string"
}
], - "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryIntegrationId": "string",
- "inventoryNotTracked": true,
- "preserveBundles": true,
- "routingPaused": true,
- "routingPausedRanges": [
- {
- "end": "2019-08-24T14:15:22Z",
- "start": "2019-08-24T14:15:22Z"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
]
}
{- "code": 200,
- "success": true,
- "location": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "locationId": "string",
- "mergedWithLocationId": "string",
- "address": {
- "address1": "string",
- "country": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "excludeFromTotals": true,
- "excludeFromTotalsFor": [
- "string"
], - "excludeInventoryEvents": [
- "string"
], - "externalSystem": [
- {
- "integrationId": "string",
- "locationValue": "string"
}
], - "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryIntegrationId": "string",
- "inventoryNotTracked": true,
- "preserveBundles": true,
- "routingPaused": true,
- "routingPausedRanges": [
- {
- "end": "2019-08-24T14:15:22Z",
- "start": "2019-08-24T14:15:22Z"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
action | string (ListDeleteAction) Default: "list" Enum: "list" "soft" Return the list of what to delete, or delete softly |
count | integer <int32> Default: 100 Delete at most this many locations |
deleted | boolean Delete soft deleted locations |
excludeFromTotals | boolean Delete locations excluded from calculating inventory totals |
integration | Array of strings Delete locations of these integrations |
locationId | Array of strings Delete locations by list of locationId |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete locations assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Delete locations created after this date-time |
skip | integer <int32> Default: 0 Skip this many locations |
status | Array of strings (LocationStatus) Items Enum: "active" "inactive" "pending" "merged" "deleted" Delete by list of location statuses |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Delete locations created before this date-time |
updatedSince | string <date-time> Delete locations updated after this date-time |
updatedUntil | string <date-time> Delete locations updated before this date-time |
{- "code": 200,
- "success": true,
- "deleted": 0,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "excludeFromTotals": true,
- "locationId": [
- "string"
], - "status": [
- "active"
], - "tags": [
- "string"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "locations": [
- {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "locationId": "string",
- "mergedWithLocationId": "string",
- "address": {
- "address1": "string",
- "country": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "excludeFromTotals": true,
- "excludeFromTotalsFor": [
- "string"
], - "excludeInventoryEvents": [
- "string"
], - "externalSystem": [
- {
- "integrationId": "string",
- "locationValue": "string"
}
], - "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryIntegrationId": "string",
- "inventoryNotTracked": true,
- "preserveBundles": true,
- "routingPaused": true,
- "routingPausedRanges": [
- {
- "end": "2019-08-24T14:15:22Z",
- "start": "2019-08-24T14:15:22Z"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
LocationId required | string Location ID to fetch |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
{- "code": 200,
- "success": true,
- "location": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "locationId": "string",
- "mergedWithLocationId": "string",
- "address": {
- "address1": "string",
- "country": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "excludeFromTotals": true,
- "excludeFromTotalsFor": [
- "string"
], - "excludeInventoryEvents": [
- "string"
], - "externalSystem": [
- {
- "integrationId": "string",
- "locationValue": "string"
}
], - "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryIntegrationId": "string",
- "inventoryNotTracked": true,
- "preserveBundles": true,
- "routingPaused": true,
- "routingPausedRanges": [
- {
- "end": "2019-08-24T14:15:22Z",
- "start": "2019-08-24T14:15:22Z"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many locations |
deleted | boolean Retrieve soft deleted locations |
string Retrieve locations by email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) | |
exceptionCategoryId | Array of strings Locations by list of categories of the location related exceptions |
exceptionType | Array of strings Locations by list of types of the location related exceptions ( |
excludeFromTotals | boolean Locations excluded from calculating inventory totals |
extIntegrationId | Array of strings Retrieve locations by list of external integration ids |
extLocationId | Array of strings Retrieve locations by list of external location ids |
hasSourceDoc | boolean Locations containing a source document |
integration | Array of strings |
inventoryNotTracked | boolean Retrieve locations by inventoryNotTracked value (default - any) |
keys | string Default: "inventoryNotTracked,locationId,status,name,address,excludeFromTotals,createdAt,updatedAt,orgKey" Return these top-level fields |
locationId | Array of strings Retrieve by list of locationId |
mergedWithLocationId | Array of strings Retrieve locations by list of mergedWithLocationId |
name | string Retrieve locations by name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
phone | string Retrieve locations by phone (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
since | string <date-time> Locations created after this date-time |
skip | integer <int32> Default: 0 Skip this many locations |
status | Array of strings (LocationStatus) Items Enum: "active" "inactive" "pending" "merged" "deleted" Retrieve by list of location statuses |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Locations created before this date-time |
updatedSince | string <date-time> Locations updated after this date-time |
updatedUntil | string <date-time> Locations updated before this date-time |
{- "code": 200,
- "success": true,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "excludeFromTotals": true,
- "locationId": [
- "string"
], - "status": [
- "active"
], - "tags": [
- "string"
], - "keys": "string",
- "order": "string",
- "email": "string",
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "extIntegrationId": [
- "string"
], - "extLocationId": [
- "string"
], - "hasSourceDoc": true,
- "integration": [
- "string"
], - "inventoryNotTracked": true,
- "mergedWithLocationId": [
- "string"
], - "name": "string",
- "phone": "string"
}, - "locations": [
- {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "locationId": "string",
- "mergedWithLocationId": "string",
- "address": {
- "address1": "string",
- "country": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "excludeFromTotals": true,
- "excludeFromTotalsFor": [
- "string"
], - "excludeInventoryEvents": [
- "string"
], - "externalSystem": [
- {
- "integrationId": "string",
- "locationValue": "string"
}
], - "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryIntegrationId": "string",
- "inventoryNotTracked": true,
- "preserveBundles": true,
- "routingPaused": true,
- "routingPausedRanges": [
- {
- "end": "2019-08-24T14:15:22Z",
- "start": "2019-08-24T14:15:22Z"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Uniqueness constraints within organization:
LocationId required | string Location ID to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
object (LocationUpdateAddress) | |
excludeFromTotals | boolean Set to exclude location from calculating inventory totals |
excludeFromTotalsFor | Array of strings or null Requestors of inventory totals for whom the location should be excluded from calculating totals |
excludeInventoryEvents | Array of strings Set of events to be excluded from automated processing for this location |
Array of objects (LocationExternalSystem) | |
fulfillmentIntegrationId | string or null Set if this is a fulfillment location |
object (InternalInfo) Internal info | |
inventoryIntegrationId | string or null Set if inventory source for this location is different from fulfillmentIntegrationId |
inventoryNotTracked | boolean or null Do not track inventory flag |
mergedWithLocationId | string For merged locations, indicates which locationId current location is merged with |
name | string Location Name |
preserveBundles | boolean Set if shipments to this location should have lineItems referring to bundles kept intact |
routingPaused | boolean or null Indicates the location is paused from routing |
Array of objects or null (TimeRange) Time intervals during which routing is paused | |
object (SourceDoc) Vendor source document | |
status | string (LocationStatus) Enum: "active" "inactive" "pending" "merged" "deleted" Location status |
tags | Array of strings (EntityTags) Tags assigned to entity |
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "excludeFromTotals": true,
- "excludeFromTotalsFor": [
- "string"
], - "excludeInventoryEvents": [
- "string"
], - "externalSystem": [
- {
- "integrationId": "string",
- "locationValue": "string"
}
], - "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryIntegrationId": "string",
- "inventoryNotTracked": true,
- "mergedWithLocationId": "string",
- "name": "string",
- "preserveBundles": true,
- "routingPaused": true,
- "routingPausedRanges": [
- {
- "end": "2019-08-24T14:15:22Z",
- "start": "2019-08-24T14:15:22Z"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
]
}
{- "code": 200,
- "success": true,
- "location": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "locationId": "string",
- "mergedWithLocationId": "string",
- "address": {
- "address1": "string",
- "country": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "excludeFromTotals": true,
- "excludeFromTotalsFor": [
- "string"
], - "excludeInventoryEvents": [
- "string"
], - "externalSystem": [
- {
- "integrationId": "string",
- "locationValue": "string"
}
], - "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryIntegrationId": "string",
- "inventoryNotTracked": true,
- "preserveBundles": true,
- "routingPaused": true,
- "routingPausedRanges": [
- {
- "end": "2019-08-24T14:15:22Z",
- "start": "2019-08-24T14:15:22Z"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
extTransactionId required | string External transaction ID |
statementId required | string Statement ID |
transactionType required | string (TransactionType) Value: "orders" Transaction type |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects (NameValue) Custom Fields | |
exceptionCategories | Array of strings References to categories of exceptions related to the transaction |
exceptions | Array of strings Types of exceptions related to the transaction |
extReferenceId | string External ID |
extStatementId | string External statement ID |
integration | string Integration associated with transaction |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
sku | string SKU |
object (SourceDoc) Vendor source document | |
status | string Enum: "new" "draft" "pending" "reported" Transaction status |
Array of objects (Fee) | |
transactionId | string Transaction ID |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "status": "new",
- "transactionId": "string",
- "extTransactionId": "string",
- "statementId": "string",
- "transactionType": "orders",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extReferenceId": "string",
- "extStatementId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sku": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
extTransactionId required | string External transaction ID |
statementId required | string Statement ID |
transactionType required | string (TransactionType) Value: "orders" Transaction type |
Array of objects (NameValue) Custom Fields | |
extReferenceId | string External ID |
extStatementId | string External statement ID |
object (InternalInfo) Internal info | |
sku | string SKU |
object (SourceDoc) Vendor source document | |
status | string (TransactionStatus) Enum: "new" "draft" "pending" "reported" Transaction status |
Array of objects (Fee) |
[- {
- "extTransactionId": "string",
- "statementId": "string",
- "transactionType": "orders",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extReferenceId": "string",
- "extStatementId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sku": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "new",
- "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
]
}
]
{- "code": 200,
- "success": true,
- "transactions": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "status": "submitted",
- "transaction": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "status": "new",
- "transactionId": "string",
- "extTransactionId": "string",
- "statementId": "string",
- "transactionType": "orders",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extReferenceId": "string",
- "extStatementId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sku": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
]
}
TransactionId required | string Id or |
sourceDocVersion | number Fetch specific source doc version if available |
withSourceDoc | boolean Include source doc if available |
withSourceDocVersions | boolean Include available source doc versions |
{- "code": 200,
- "success": true,
- "transaction": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "status": "new",
- "transactionId": "string",
- "extTransactionId": "string",
- "statementId": "string",
- "transactionType": "orders",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extReferenceId": "string",
- "extStatementId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sku": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many transactions |
deleted | boolean Retrieve only soft deleted transactions |
exceptionCategoryId | Array of strings Retrieve transactions by list of categories of the transaction related exceptions |
exceptionType | Array of strings Retrieve transactions by list of types of the transaction related exceptions ( |
extReferenceId | Array of strings Retrieve transactions by extReferenceId list |
extStatementId | Array of strings Retrieve transactions by extStatementId list |
extTransactionId | Array of strings Retrieve transactions by extTransactionId list |
hasSourceDoc | boolean Retrieve transactions containing a source document |
integration | Array of strings Retrieve transactions by integration list |
keys | string Default: "transactionId,extReferenceId,statementId,extStatementId,extTransactionId,integration,sku,transactionType,transactionFees,status,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Transactions created after this date-time |
skip | integer <int32> Default: 0 Skip this many transactions |
sku | Array of strings Retrieve transactions by SKU list |
statementId | Array of strings Retrieve transactions by statementId list |
status | Array of strings (TransactionStatus) Items Enum: "new" "draft" "pending" "reported" Retrieve transactions by status list |
transactionId | Array of strings Retrieve transactions by transactionId list |
transactionType | Array of strings Retrieve transactions by transactionType list |
until | string <date-time> Transactions created before this date-time |
updatedSince | string <date-time> Transactions updated after this date-time |
updatedUntil | string <date-time> Transactions updated before this date-time |
{- "code": 200,
- "success": true,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "extReferenceId": [
- "string"
], - "extStatementId": [
- "string"
], - "extTransactionId": [
- "string"
], - "hasSourceDoc": true,
- "integration": [
- "string"
], - "sku": [
- "string"
], - "statementId": [
- "string"
], - "status": [
- "new"
], - "transactionId": [
- "string"
], - "transactionType": [
- "string"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "transactions": [
- {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "status": "new",
- "transactionId": "string",
- "extTransactionId": "string",
- "statementId": "string",
- "transactionType": "orders",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extReferenceId": "string",
- "extStatementId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sku": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
TransactionId required | string Transaction Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
Array of objects or null (NameValue) Custom Fields | |
object (InternalInfo) Internal info | |
object (SourceDoc) Vendor source document | |
status | string (TransactionStatus) Enum: "new" "draft" "pending" "reported" Transaction status |
Array of objects (Fee) |
{- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "new",
- "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
]
}
{- "code": 200,
- "success": true,
- "transaction": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "status": "new",
- "transactionId": "string",
- "extTransactionId": "string",
- "statementId": "string",
- "transactionType": "orders",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extReferenceId": "string",
- "extStatementId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sku": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
extStatementId required | string External statement ID |
extStatementStartDate required | string <date-time> External statement start-date |
createdAt | string <date-time> When the object was created within Pipe17 |
currency | string Currency |
Array of objects (NameValue) Custom Fields | |
depositTotal | number Deposit total |
exceptionCategories | Array of strings References to categories of exceptions related to the statement |
exceptions | Array of strings Types of exceptions related to the statement |
extStatementApiId | string External statement Api ID |
extStatementDepositDate | string <date-time> External statement deposit-date |
extStatementEndDate | string <date-time> External statement end-date |
integration | string Integration associated with statement |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
object (SourceDoc) Vendor source document | |
statementId | string Statement ID |
statementTotal | number Statement total |
status | string Enum: "new" "draft" "pending" "paid" "reported" Statement status |
tags | Array of strings (EntityTags) Tags assigned to entity |
Array of objects (Fee) | |
Array of objects (Fee) Fees totals by all registered transactions | |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "statementId": "string",
- "status": "new",
- "transactionFeesTotals": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "extStatementId": "string",
- "extStatementStartDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "depositTotal": 0,
- "extStatementApiId": "string",
- "extStatementDepositDate": "2019-08-24T14:15:22Z",
- "extStatementEndDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "statementTotal": 0,
- "tags": [
- "string"
], - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
extStatementId required | string External statement ID |
extStatementStartDate required | string <date-time> External statement start-date |
currency | string Currency |
Array of objects (NameValue) Custom Fields | |
depositTotal | number Deposit total |
extStatementApiId | string External statement Api ID |
extStatementDepositDate | string <date-time> External statement deposit-date |
extStatementEndDate | string <date-time> External statement end-date |
object (InternalInfo) Internal info | |
object (SourceDoc) Vendor source document | |
statementTotal | number Statement total |
status | string (StatementStatus) Enum: "new" "draft" "pending" "paid" "reported" Statement status |
tags | Array of strings (EntityTags) Tags assigned to entity |
Array of objects (Fee) |
[- {
- "extStatementId": "string",
- "extStatementStartDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "depositTotal": 0,
- "extStatementApiId": "string",
- "extStatementDepositDate": "2019-08-24T14:15:22Z",
- "extStatementEndDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "statementTotal": 0,
- "status": "new",
- "tags": [
- "string"
], - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
]
}
]
{- "code": 200,
- "success": true,
- "statements": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "statement": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "statementId": "string",
- "status": "new",
- "transactionFeesTotals": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "extStatementId": "string",
- "extStatementStartDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "depositTotal": 0,
- "extStatementApiId": "string",
- "extStatementDepositDate": "2019-08-24T14:15:22Z",
- "extStatementEndDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "statementTotal": 0,
- "tags": [
- "string"
], - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "status": "submitted"
}
]
}
StatementId required | string Id or |
sourceDocVersion | number Fetch specific source doc version if available |
withFeesTotals | boolean Add the fees totals in the response |
withSourceDoc | boolean Include source doc if available |
withSourceDocVersions | boolean Include available source doc versions |
{- "code": 200,
- "success": true,
- "statement": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "statementId": "string",
- "status": "new",
- "transactionFeesTotals": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "extStatementId": "string",
- "extStatementStartDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "depositTotal": 0,
- "extStatementApiId": "string",
- "extStatementDepositDate": "2019-08-24T14:15:22Z",
- "extStatementEndDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "statementTotal": 0,
- "tags": [
- "string"
], - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many statements |
deleted | boolean Retrieve only soft deleted statements |
depositSince | string <date-time> Statements where (extStatementDepositDate >= depositSince) |
depositUntil | string <date-time> Statements where (extStatementDepositDate < depositUntil) |
endPeriodSince | string <date-time> Statements where (extStatementEndDate >= endPeriodSince) |
endPeriodUntil | string <date-time> Statements where (extStatementEndDate < endPeriodUntil) |
exceptionCategoryId | Array of strings Retrieve statements by list of categories of the statement related exceptions |
exceptionType | Array of strings Retrieve statements by list of types of the statement related exceptions ( |
extStatementApiId | Array of strings Retrieve statements by extStatementApiId list |
extStatementId | Array of strings Retrieve statements by extStatementId list |
hasSourceDoc | boolean Retrieve statements containing a source document |
integration | Array of strings Retrieve statements by integration list |
keys | string Default: "statementId,extStatementId,extStatementApiId,integration,extStatementStartDate,extStatementEndDate,extStatementDepositDate,depositTotal,transactionFees,statementTotal,currency,status,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Statements created after this date-time |
skip | integer <int32> Default: 0 Skip this many statements |
startPeriodSince | string <date-time> Statements where (extStatementStartDate >= startPeriodSince) |
startPeriodUntil | string <date-time> Statements where (extStatementStartDate < startPeriodUntil) |
statementId | Array of strings Retrieve statements by statementId list |
status | Array of strings (StatementStatus) Items Enum: "new" "draft" "pending" "paid" "reported" Retrieve statements by status list |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Statements created before this date-time |
updatedSince | string <date-time> Statements updated after this date-time |
updatedUntil | string <date-time> Statements updated before this date-time |
{- "code": 200,
- "success": true,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "depositSince": true,
- "depositUntil": true,
- "endPeriodSince": true,
- "endPeriodUntil": true,
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "extStatementApiId": [
- "string"
], - "extStatementId": [
- "string"
], - "hasSourceDoc": true,
- "integration": [
- "string"
], - "startPeriodSince": true,
- "startPeriodUntil": true,
- "statementId": [
- "string"
], - "status": [
- "new"
], - "tags": [
- "string"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "statements": [
- {
- "integration": "string",
- "statementId": "string",
- "status": "new",
- "extStatementId": "string",
- "extStatementStartDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "depositTotal": 0,
- "extStatementApiId": "string",
- "extStatementDepositDate": "2019-08-24T14:15:22Z",
- "extStatementEndDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "statementTotal": 0,
- "tags": [
- "string"
], - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
StatementId required | string Statement Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
currency | string Currency |
Array of objects or null (NameValue) Custom Fields | |
depositTotal | number Deposit total |
extStatementDepositDate | string <date-time> External statement deposit-date |
extStatementEndDate | string <date-time> External statement end-date |
extStatementStartDate | string <date-time> External statement start-date |
object (InternalInfo) Internal info | |
object (SourceDoc) Vendor source document | |
statementTotal | number Statement total |
status | string (StatementStatus) Enum: "new" "draft" "pending" "paid" "reported" Statement status |
tags | Array of strings (EntityTags) Tags assigned to entity |
Array of objects (Fee) |
{- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "depositTotal": 0,
- "extStatementDepositDate": "2019-08-24T14:15:22Z",
- "extStatementEndDate": "2019-08-24T14:15:22Z",
- "extStatementStartDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "statementTotal": 0,
- "status": "new",
- "tags": [
- "string"
], - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
]
}
{- "code": 200,
- "success": true,
- "statement": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "statementId": "string",
- "status": "new",
- "transactionFeesTotals": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "extStatementId": "string",
- "extStatementStartDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "depositTotal": 0,
- "extStatementApiId": "string",
- "extStatementDepositDate": "2019-08-24T14:15:22Z",
- "extStatementEndDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "statementTotal": 0,
- "tags": [
- "string"
], - "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
extOrderId required | string External Order ID |
Array of objects (AdditionalCharge) Additional charges | |
autoEngUpdateStatus | string (AutoEngUpdateStatus) Enum: "initialPending" "pending" "updated" "none" A status that indicates whether or not the automation engine may update the entity sometime in the future. Only set internally. Useful for services such as the order routing engine where the user intended order state is critical before action. Used for orders and shipments. Status definitions:
|
autoEngUpdateStatusUpdatedAt | string <date-time> (AutoEngUpdateStatusUpdatedAt) When the autoEngUpdateStatus was last updated |
object (Address) | |
createdAt | string <date-time> When the object was created within Pipe17 |
currency | string Order currency code |
object (OrderCustomer) | |
customerPONumber | string or null |
Array of objects (NameValue) Custom Fields | |
disableShipmentsReuse | boolean Hint to whether shipmentId should be re-used, or not |
Array of objects (Discount) Discounts | |
disposition | Array of strings (OrderDispositionType) Items Enum: "partiallyRouted" "routed" "partiallySent" "sent" "partiallyFulfilled" "fulfilled" "partiallyCanceled" "canceled" "partiallyFailed" "failed" "partiallyRejected" "rejected" "partiallyUnrouted" "unrouted" "partiallyUnsent" "unsent" "partiallyUnfulfilled" "unfulfilled" Order disposition |
Array of objects (OrderLineDisposition) Disposition of line items | |
exceptionCategories | Array of strings References to categories of exceptions related to the order |
exceptions | Array of strings Types of exceptions related to the order |
expectedDeliveryDate | string <date-time> First Priority to be respected |
extOrderApiId | string External System Order API ID |
extOrderCreatedAt | string <date-time> When the order was created at source |
extOrderUpdatedAt | string <date-time> When the order was updated at source |
extOrderUrl | string Order Url in External System |
fulfillmentStatus | string status of the fulfillment |
giftNote | string Order Gift note |
holdUntil | string <date-time> |
incoterms | string International Commercial Terms |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
isMultiAddress | boolean Indicates the order is a multi address destination order (default - false) |
isMultiDestination | boolean Multi-destination order indicator |
lastRerunRoutingTrigger | string (LastRerunRoutingTrigger) Enum: "manual" "auto" Indicates if the order was rerun manually by a user action or automatically. |
lastRoutedAt | string <date-time> When the order was last routed. |
Array of objects (OrderLineItem) | |
locationId | string Id of location defined in organization. Used as item origin for shipment. |
orderDiscount | number <float> Order Discount |
orderId | string Auto Generated |
orderNote | string Order Notes |
orderSource | string The original order platform, walmart, etsy, etc |
orderSourceType | string (OrderType) Enum: "online" "pos" "wholesale" "edi" "other" "b2b" Order Type (online, pos, etc) |
orderTax | number <float> Order Tax |
orgKey | string Organization this object belong to |
Array of objects (Payment) Payments | |
paymentStatus | string status of the payment |
object (OrderPaymentTerms) order payment terms | |
preferredLocationGroupId | Array of strings List of location-group IDs |
privacyPolicy | Array of strings (PrivacyPolicy) Items Value: "amazon" |
Array of objects (OrderRefund) Additional charges | |
requireShippingLabels | boolean Indicates if fetching of shipping labels is required |
respectLocationId | boolean Use locationId if defined on order level or lineItems level as valid item origin for shipment (pre-route). |
routingStatus | string (RoutingStatus) Enum: "disabled" "pending" "ready" "acknowledged" "failed" "excluded" "pendingInventory" Routing Status:
|
shipAfterDate | string <date-time> Ship After Date |
shipByDate | string <date-time> Ship By Date |
shipCancelByDate | string <date-time> Ship Cancel By Date |
object (Address) | |
shippingCarrier | string Required with ShippingClass, 2nd Priority |
shippingClass | string Required with ShippingCarrier, 2nd Priority |
shippingCode | string 1st Priority |
Array of objects (Destination) | |
shippingNote | string Shipping Notes |
shippingPrice | number <float> Shipping price |
object (SourceDoc) Vendor source document | |
status | string Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Order Status |
subTotalPrice | number <float> Sub Total Price |
tags | Array of strings (EntityTags) Tags assigned to entity |
timestamp | string <date-time> General Purpose Time Stamp |
totalPrice | number <float> Total Price |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "extOrderId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCompanyCustomerId": "string",
- "extCustomerId": "string",
- "extLocationCustomerId": "string",
- "firstName": "string",
- "lastName": "string",
- "type": "individual"
}, - "customerPONumber": "string",
- "disableShipmentsReuse": true,
- "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extOrderCreatedAt": "2019-08-24T14:15:22Z",
- "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
- "extOrderUrl": "string",
- "fulfillmentStatus": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiAddress": true,
- "lastRerunRoutingTrigger": "manual",
- "lastRoutedAt": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "quantity": 0,
- "requiresShipping": true,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true,
- "upc": "string",
- "canceled": 0,
- "fulfillable": 0,
- "fulfilled": 0,
- "ordered": 0,
- "preferredLocationGroupId": [
- "string"
], - "refunded": 0,
- "reported": 0,
- "returned": 0
}
], - "locationId": "string",
- "orderDiscount": 0,
- "orderNote": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderTax": 0,
- "paymentStatus": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueDate": "2019-08-24T14:15:22Z",
- "dueInDays": 0,
- "note": "string"
}, - "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "preferredLocationGroupId": [
- "string"
], - "privacyPolicy": [
- "amazon"
], - "refunds": [
- {
- "type": "lineItem",
- "value": 0,
- "label": "string",
- "lineItemId": "string",
- "lineItemQuantity": 0,
- "lineItemRestock": true,
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "requireShippingLabels": true,
- "respectLocationId": true,
- "routingStatus": "disabled",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingDestinations": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extDestinationId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "quantityUnit": "each",
- "sku": "string",
- "uniqueId": "string"
}
], - "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}
}
], - "shippingNote": "string",
- "shippingPrice": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0,
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "disposition": [
- "partiallyRouted"
], - "dispositions": [
- {
- "uniqueId": "string",
- "values": [
- {
- "type": "routed",
- "quantity": 0
}
]
}
], - "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
withTransform | boolean Enable order transformation engine for this request |
extOrderId required | string External Order ID |
Array of objects (AdditionalCharge) Additional charges | |
object (Address) | |
currency | string Order currency code |
object (OrderCustomer) | |
customerPONumber | string or null |
Array of objects (NameValue) Custom Fields | |
disableShipmentsReuse | boolean Hint to whether shipmentId should be re-used, or not |
Array of objects (Discount) Discounts | |
expectedDeliveryDate | string <date-time> First Priority to be respected |
extOrderApiId | string External System Order API ID |
extOrderCreatedAt | string <date-time> When the order was created at source |
extOrderUpdatedAt | string <date-time> When the order was updated at source |
extOrderUrl | string Order Url in External System |
fulfillmentStatus | string status of the fulfillment |
giftNote | string Order Gift note |
holdUntil | string <date-time> |
incoterms | string International Commercial Terms |
object (InternalInfo) Internal info | |
isMultiAddress | boolean Indicates the order is a multi address destination order (default - false) |
lastRerunRoutingTrigger | string (LastRerunRoutingTrigger) Enum: "manual" "auto" Indicates if the order was rerun manually by a user action or automatically. |
lastRoutedAt | string <date-time> When the order was last routed. |
Array of objects (OrderLineItem) | |
locationId | string Id of location defined in organization. Used as item origin for shipment. |
orderDiscount | number <float> Order Discount |
orderNote | string Order Notes |
orderSource | string The original order platform, walmart, etsy, etc |
orderSourceType | string (OrderType) Enum: "online" "pos" "wholesale" "edi" "other" "b2b" Order Type (online, pos, etc) |
orderTax | number <float> Order Tax |
Array of objects (Payment) Payments | |
paymentStatus | string status of the payment |
object (OrderPaymentTerms) order payment terms | |
preferredLocationGroupId | Array of strings List of location-group IDs |
privacyPolicy | Array of strings (PrivacyPolicy) Items Value: "amazon" |
Array of objects (OrderRefund) Additional charges | |
requireShippingLabels | boolean Indicates if fetching of shipping labels is required |
respectLocationId | boolean Use locationId if defined on order level or lineItems level as valid item origin for shipment (pre-route). |
routingStatus | string (RoutingStatus) Enum: "disabled" "pending" "ready" "acknowledged" "failed" "excluded" "pendingInventory" Routing Status:
|
shipAfterDate | string <date-time> Ship After Date |
shipByDate | string <date-time> Ship By Date |
shipCancelByDate | string <date-time> Ship Cancel By Date |
object (Address) | |
shippingCarrier | string Required with ShippingClass, 2nd Priority |
shippingClass | string Required with ShippingCarrier, 2nd Priority |
shippingCode | string 1st Priority |
Array of objects (Destination) | |
shippingNote | string Shipping Notes |
shippingPrice | number <float> Shipping price |
object (SourceDoc) Vendor source document | |
status | string (OrderStatus) Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Order Status |
subTotalPrice | number <float> Sub Total Price |
tags | Array of strings (EntityTags) Tags assigned to entity |
timestamp | string <date-time> General Purpose Time Stamp |
totalPrice | number <float> Total Price |
[- {
- "extOrderId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCompanyCustomerId": "string",
- "extCustomerId": "string",
- "extLocationCustomerId": "string",
- "firstName": "string",
- "lastName": "string",
- "type": "individual"
}, - "customerPONumber": "string",
- "disableShipmentsReuse": true,
- "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extOrderCreatedAt": "2019-08-24T14:15:22Z",
- "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
- "extOrderUrl": "string",
- "fulfillmentStatus": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiAddress": true,
- "lastRerunRoutingTrigger": "manual",
- "lastRoutedAt": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "quantity": 0,
- "requiresShipping": true,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true,
- "upc": "string",
- "canceled": 0,
- "fulfillable": 0,
- "fulfilled": 0,
- "ordered": 0,
- "preferredLocationGroupId": [
- "string"
], - "refunded": 0,
- "reported": 0,
- "returned": 0
}
], - "locationId": "string",
- "orderDiscount": 0,
- "orderNote": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderTax": 0,
- "paymentStatus": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueDate": "2019-08-24T14:15:22Z",
- "dueInDays": 0,
- "note": "string"
}, - "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "preferredLocationGroupId": [
- "string"
], - "privacyPolicy": [
- "amazon"
], - "refunds": [
- {
- "type": "lineItem",
- "value": 0,
- "label": "string",
- "lineItemId": "string",
- "lineItemQuantity": 0,
- "lineItemRestock": true,
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "requireShippingLabels": true,
- "respectLocationId": true,
- "routingStatus": "disabled",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingDestinations": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extDestinationId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "quantityUnit": "each",
- "sku": "string",
- "uniqueId": "string"
}
], - "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}
}
], - "shippingNote": "string",
- "shippingPrice": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0
}
]
{- "code": 200,
- "success": true,
- "orders": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "order": {
- "extOrderId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCompanyCustomerId": "string",
- "extCustomerId": "string",
- "extLocationCustomerId": "string",
- "firstName": "string",
- "lastName": "string",
- "type": "individual"
}, - "customerPONumber": "string",
- "disableShipmentsReuse": true,
- "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extOrderCreatedAt": "2019-08-24T14:15:22Z",
- "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
- "extOrderUrl": "string",
- "fulfillmentStatus": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiAddress": true,
- "lastRerunRoutingTrigger": "manual",
- "lastRoutedAt": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "quantity": 0,
- "requiresShipping": true,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true,
- "upc": "string",
- "canceled": 0,
- "fulfillable": 0,
- "fulfilled": 0,
- "ordered": 0,
- "preferredLocationGroupId": [
- "string"
], - "refunded": 0,
- "reported": 0,
- "returned": 0
}
], - "locationId": "string",
- "orderDiscount": 0,
- "orderNote": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderTax": 0,
- "paymentStatus": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueDate": "2019-08-24T14:15:22Z",
- "dueInDays": 0,
- "note": "string"
}, - "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "preferredLocationGroupId": [
- "string"
], - "privacyPolicy": [
- "amazon"
], - "refunds": [
- {
- "type": "lineItem",
- "value": 0,
- "label": "string",
- "lineItemId": "string",
- "lineItemQuantity": 0,
- "lineItemRestock": true,
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "requireShippingLabels": true,
- "respectLocationId": true,
- "routingStatus": "disabled",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingDestinations": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extDestinationId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "quantityUnit": "each",
- "sku": "string",
- "uniqueId": "string"
}
], - "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}
}
], - "shippingNote": "string",
- "shippingPrice": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0,
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "disposition": [
- "partiallyRouted"
], - "dispositions": [
- {
- "uniqueId": "string",
- "values": [
- {
- "type": "routed",
- "quantity": 0
}
]
}
], - "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "status": "submitted"
}
]
}
action | string (ListDeleteAction) Default: "list" Enum: "list" "soft" Return the list of what to delete, or delete softly |
count | integer <int32> Default: 100 Delete at most this many orders |
deleted | boolean Delete soft deleted orders |
extOrderId | Array of strings Delete orders by list of extOrderId |
integration | Array of strings Delete orders of these integrations |
orderId | Array of strings Delete orders by list of orderId |
orderSource | Array of strings Delete orders by list of order sources |
orderSourceType | Array of strings (OrderType) Items Enum: "online" "pos" "wholesale" "edi" "other" "b2b" Delete orders by list of order types |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete orders assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
routingStatus | Array of strings (RoutingStatus) Items Enum: "disabled" "pending" "ready" "acknowledged" "failed" "excluded" "pendingInventory" Delete orders by list of routing statuses |
since | string <date-time> Delete orders created after this date-time |
skip | integer <int32> Default: 0 Skip this many orders |
status | Array of strings (OrderStatus) Items Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Delete orders by list of statuses |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Delete orders created before this date-time |
updatedSince | string <date-time> Delete orders updated after this date-time |
updatedUntil | string <date-time> Delete orders updated before this date-time |
{- "code": 200,
- "success": true,
- "deleted": 0,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "extOrderId": [
- "string"
], - "locationId": [
- "string"
], - "orderId": [
- "string"
], - "orderSource": [
- "string"
], - "orderSourceType": [
- "online"
], - "routingStatus": [
- "disabled"
], - "status": [
- "draft"
], - "tags": [
- "string"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "orders": [
- {
- "extOrderId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCompanyCustomerId": "string",
- "extCustomerId": "string",
- "extLocationCustomerId": "string",
- "firstName": "string",
- "lastName": "string",
- "type": "individual"
}, - "customerPONumber": "string",
- "disableShipmentsReuse": true,
- "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extOrderCreatedAt": "2019-08-24T14:15:22Z",
- "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
- "extOrderUrl": "string",
- "fulfillmentStatus": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiAddress": true,
- "lastRerunRoutingTrigger": "manual",
- "lastRoutedAt": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "quantity": 0,
- "requiresShipping": true,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true,
- "upc": "string",
- "canceled": 0,
- "fulfillable": 0,
- "fulfilled": 0,
- "ordered": 0,
- "preferredLocationGroupId": [
- "string"
], - "refunded": 0,
- "reported": 0,
- "returned": 0
}
], - "locationId": "string",
- "orderDiscount": 0,
- "orderNote": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderTax": 0,
- "paymentStatus": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueDate": "2019-08-24T14:15:22Z",
- "dueInDays": 0,
- "note": "string"
}, - "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "preferredLocationGroupId": [
- "string"
], - "privacyPolicy": [
- "amazon"
], - "refunds": [
- {
- "type": "lineItem",
- "value": 0,
- "label": "string",
- "lineItemId": "string",
- "lineItemQuantity": 0,
- "lineItemRestock": true,
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "requireShippingLabels": true,
- "respectLocationId": true,
- "routingStatus": "disabled",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingDestinations": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extDestinationId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "quantityUnit": "each",
- "sku": "string",
- "uniqueId": "string"
}
], - "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}
}
], - "shippingNote": "string",
- "shippingPrice": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0,
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "disposition": [
- "partiallyRouted"
], - "dispositions": [
- {
- "uniqueId": "string",
- "values": [
- {
- "type": "routed",
- "quantity": 0
}
]
}
], - "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
OrderId required | string Id, |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
{- "code": 200,
- "success": true,
- "order": {
- "extOrderId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCompanyCustomerId": "string",
- "extCustomerId": "string",
- "extLocationCustomerId": "string",
- "firstName": "string",
- "lastName": "string",
- "type": "individual"
}, - "customerPONumber": "string",
- "disableShipmentsReuse": true,
- "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extOrderCreatedAt": "2019-08-24T14:15:22Z",
- "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
- "extOrderUrl": "string",
- "fulfillmentStatus": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiAddress": true,
- "lastRerunRoutingTrigger": "manual",
- "lastRoutedAt": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "quantity": 0,
- "requiresShipping": true,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true,
- "upc": "string",
- "canceled": 0,
- "fulfillable": 0,
- "fulfilled": 0,
- "ordered": 0,
- "preferredLocationGroupId": [
- "string"
], - "refunded": 0,
- "reported": 0,
- "returned": 0
}
], - "locationId": "string",
- "orderDiscount": 0,
- "orderNote": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderTax": 0,
- "paymentStatus": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueDate": "2019-08-24T14:15:22Z",
- "dueInDays": 0,
- "note": "string"
}, - "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "preferredLocationGroupId": [
- "string"
], - "privacyPolicy": [
- "amazon"
], - "refunds": [
- {
- "type": "lineItem",
- "value": 0,
- "label": "string",
- "lineItemId": "string",
- "lineItemQuantity": 0,
- "lineItemRestock": true,
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "requireShippingLabels": true,
- "respectLocationId": true,
- "routingStatus": "disabled",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingDestinations": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extDestinationId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "quantityUnit": "each",
- "sku": "string",
- "uniqueId": "string"
}
], - "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}
}
], - "shippingNote": "string",
- "shippingPrice": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0,
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "disposition": [
- "partiallyRouted"
], - "dispositions": [
- {
- "uniqueId": "string",
- "values": [
- {
- "type": "routed",
- "quantity": 0
}
]
}
], - "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
autoEngUpdateStatus | Array of strings (AutoEngUpdateStatus) Items Enum: "initialPending" "pending" "updated" "none" |
autoEngUpdateStatusUpdatedSince | string <date-time> Fetch all orders with autoEngUpdateStatus updated after this date-time |
autoEngUpdateStatusUpdatedUntil | string <date-time> Fetch all orders with autoEngUpdateStatus updated before this date-time |
count | integer <int32> Default: 100 Return at most this many orders |
deleted | boolean Fetch soft deleted orders |
disposition | Array of strings (OrderDispositionType) Items Enum: "partiallyRouted" "routed" "partiallySent" "sent" "partiallyFulfilled" "fulfilled" "partiallyCanceled" "canceled" "partiallyFailed" "failed" "partiallyRejected" "rejected" "partiallyUnrouted" "unrouted" "partiallyUnsent" "unsent" "partiallyUnfulfilled" "unfulfilled" Fetch orders by list of order disposition types |
string Fetch orders by recipient email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) | |
emailAddr | Array of strings Retrieve orders by list of billing/shippingAddress.email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
exceptionCategoryId | Array of strings Fetch orders by list of categories of the order related exceptions |
exceptionType | Array of strings Fetch orders by list of types of the order related exceptions ( |
extOrderId | Array of strings Fetch orders by list of extOrderId |
hasSourceDoc | boolean Orders containing a source document |
holdUntilSince | string <date-time> Fetch all orders with holdUntil after or at this date-time. Rounded down to the nearest minute |
holdUntilUntil | string <date-time> Fetch all orders with holdUntil before or at this date-time. Rounded down to the nearest minute |
integration | Array of strings Fetch orders by list of integrationId |
keys | string Default: "orderId,extOrderId,email,status,shipByDate,expectedDeliveryDate,tags,createdAt,updatedAt,orgKey" Return these top-level fields |
lastRerunRoutingTrigger | Array of strings (LastRerunRoutingTrigger) Items Enum: "manual" "auto" Fetch orders by list of rerun routing triggers |
locationId | Array of strings Fetch orders by list of locationId |
order | string Default: "createdAt" Sort by these top-level fields |
orderId | Array of strings Fetch orders by list of orderId |
orderSource | Array of strings Fetch orders by list of order sources |
orderSourceType | Array of strings (OrderType) Items Enum: "online" "pos" "wholesale" "edi" "other" "b2b" Fetch orders by list of types |
pagination | string Value: "disabled" Exclude pagination info from the response |
requireShippingLabels | boolean Filter orders by shipping labels requirement |
routingStatus | Array of strings (RoutingStatus) Items Enum: "disabled" "pending" "ready" "acknowledged" "failed" "excluded" "pendingInventory" Orders by list of routing statuses |
since | string <date-time> Fetch all orders created after this date-time |
skip | integer <int32> Default: 0 Skip this many orders |
status | Array of strings (OrderStatus) Items Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Fetch orders by list of statuses |
tags | Array of strings (EntityTags) Tags assigned to entity |
timestamp | boolean if set to true use timestamp instead of create time |
until | string <date-time> Fetch all orders created before this date-time |
updatedSince | string <date-time> Fetch all orders updated after this date-time |
updatedUntil | string <date-time> Fetch all orders updated before this date-time |
{- "code": 200,
- "success": true,
- "orders": [
- {
- "extOrderId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCompanyCustomerId": "string",
- "extCustomerId": "string",
- "extLocationCustomerId": "string",
- "firstName": "string",
- "lastName": "string",
- "type": "individual"
}, - "customerPONumber": "string",
- "disableShipmentsReuse": true,
- "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extOrderCreatedAt": "2019-08-24T14:15:22Z",
- "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
- "extOrderUrl": "string",
- "fulfillmentStatus": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiAddress": true,
- "lastRerunRoutingTrigger": "manual",
- "lastRoutedAt": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "quantity": 0,
- "requiresShipping": true,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true,
- "upc": "string",
- "canceled": 0,
- "fulfillable": 0,
- "fulfilled": 0,
- "ordered": 0,
- "preferredLocationGroupId": [
- "string"
], - "refunded": 0,
- "reported": 0,
- "returned": 0
}
], - "locationId": "string",
- "orderDiscount": 0,
- "orderNote": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderTax": 0,
- "paymentStatus": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueDate": "2019-08-24T14:15:22Z",
- "dueInDays": 0,
- "note": "string"
}, - "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "preferredLocationGroupId": [
- "string"
], - "privacyPolicy": [
- "amazon"
], - "refunds": [
- {
- "type": "lineItem",
- "value": 0,
- "label": "string",
- "lineItemId": "string",
- "lineItemQuantity": 0,
- "lineItemRestock": true,
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "requireShippingLabels": true,
- "respectLocationId": true,
- "routingStatus": "disabled",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingDestinations": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extDestinationId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "quantityUnit": "each",
- "sku": "string",
- "uniqueId": "string"
}
], - "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}
}
], - "shippingNote": "string",
- "shippingPrice": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0,
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "disposition": [
- "partiallyRouted"
], - "dispositions": [
- {
- "uniqueId": "string",
- "values": [
- {
- "type": "routed",
- "quantity": 0
}
]
}
], - "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "extOrderId": [
- "string"
], - "locationId": [
- "string"
], - "orderId": [
- "string"
], - "orderSource": [
- "string"
], - "orderSourceType": [
- "online"
], - "routingStatus": [
- "disabled"
], - "status": [
- "draft"
], - "tags": [
- "string"
], - "keys": "string",
- "order": "string",
- "disposition": [
- "partiallyRouted"
], - "email": "string",
- "emailAddr": [
- "string"
], - "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "hasSourceDoc": true,
- "holdUntilSince": "2019-08-24T14:15:22Z",
- "holdUntilUntil": "2019-08-24T14:15:22Z",
- "requireShippingLabels": true,
- "timestamp": true
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Trigger the orders sync
OrderId required | Array of strings |
syncAE | boolean Reset autoEngUpdateStatus |
{- "syncAE": true
}
{- "code": 200,
- "success": true
}
Uniqueness constraints within organization:
OrderId required | string Id, |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
withTransform | boolean Enable order transformation engine for this request |
Array of objects or null (AdditionalCharge) Additional charges | |
autoEngUpdateStatus | string (AutoEngUpdateStatus) Enum: "initialPending" "pending" "updated" "none" A status that indicates whether or not the automation engine may update the entity sometime in the future. Only set internally. Useful for services such as the order routing engine where the user intended order state is critical before action. Used for orders and shipments. Status definitions:
|
object (AddressUpdateData) | |
currency | string Order currency code |
object (OrderCustomer) | |
customerPONumber | string or null |
Array of objects (NameValue) Custom Fields | |
disableShipmentsReuse | boolean or null Hint to whether shipmentId should be re-used, or not |
Array of objects or null (Discount) Discounts | |
expectedDeliveryDate | string or null <date-time> First Priority to be respected |
extOrderApiId | string or null External System Order API ID |
extOrderCreatedAt | string or null <date-time> When the order was created at source |
extOrderId | string External Order ID |
extOrderUpdatedAt | string or null <date-time> When the order was updated at source |
extOrderUrl | string Order Url in External System |
fulfillmentStatus | string or null status of the fulfillment |
giftNote | string or null Order Gift note |
holdUntil | string or null <date-time> |
object (InternalInfo) Internal info | |
isMultiAddress | boolean or null Indicates the order is a multi address destination order (default - false) |
lastRerunRoutingTrigger | string (LastRerunRoutingTrigger) Enum: "manual" "auto" Indicates if the order was rerun manually by a user action or automatically. |
lastRoutedAt | string <date-time> When the order was last routed. |
Array of objects (OrderLineItem) | |
locationId | string or null Id of location defined in organization. Used as item origin for shipment. |
orderDiscount | number or null <float> Order Discount |
orderNote | string or null Order Notes |
orderSource | string or null The original order platform, walmart, etsy, etc |
orderSourceType | string (OrderType) Enum: "online" "pos" "wholesale" "edi" "other" "b2b" Order Type (online, pos, etc) |
orderTax | number or null <float> Order Tax |
Array of objects or null (Payment) Payments | |
paymentStatus | string or null status of the payment |
object (OrderPaymentTerms) order payment terms | |
preferredLocationGroupId | Array of strings or null List of location-group IDs |
privacyPolicy | Array of strings or null (PrivacyPolicy) Value: "amazon" |
Array of objects or null (OrderRefund) Order refunds | |
requireShippingLabels | boolean or null Indicates if fetching of shipping labels is required |
respectLocationId | boolean or null Use locationId if defined on order level or lineItems level as valid item origin for shipment (pre-route). |
routingStatus | string (RoutingStatus) Enum: "disabled" "pending" "ready" "acknowledged" "failed" "excluded" "pendingInventory" Routing Status:
|
shipAfterDate | string or null <date-time> Ship After Date |
shipByDate | string or null <date-time> Ship By Date |
shipCancelByDate | string or null <date-time> Ship Cancel By Date |
object (AddressUpdateData) | |
shippingCarrier | string or null Required with ShippingClass, 2nd Priority |
shippingClass | string or null Required with ShippingCarrier, 2nd Priority |
shippingCode | string or null 1st Priority |
Array of objects (Destination) | |
shippingNote | string or null Shipping Notes |
shippingPrice | number or null <float> |
object (SourceDoc) Vendor source document | |
status | string (OrderStatus) Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Order Status |
subTotalPrice | number or null <float> Sub Total Price |
tags | Array of strings (EntityTags) Tags assigned to entity |
timestamp | string or null <date-time> General Purpose Time Stamp |
totalPrice | number or null <float> Total Price |
{- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "autoEngUpdateStatus": "initialPending",
- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCompanyCustomerId": "string",
- "extCustomerId": "string",
- "extLocationCustomerId": "string",
- "firstName": "string",
- "lastName": "string",
- "type": "individual"
}, - "customerPONumber": "string",
- "disableShipmentsReuse": true,
- "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extOrderCreatedAt": "2019-08-24T14:15:22Z",
- "extOrderId": "string",
- "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
- "extOrderUrl": "string",
- "fulfillmentStatus": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiAddress": true,
- "lastRerunRoutingTrigger": "manual",
- "lastRoutedAt": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "quantity": 0,
- "requiresShipping": true,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true,
- "upc": "string",
- "canceled": 0,
- "fulfillable": 0,
- "fulfilled": 0,
- "ordered": 0,
- "preferredLocationGroupId": [
- "string"
], - "refunded": 0,
- "reported": 0,
- "returned": 0
}
], - "locationId": "string",
- "orderDiscount": 0,
- "orderNote": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderTax": 0,
- "paymentStatus": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueDate": "2019-08-24T14:15:22Z",
- "dueInDays": 0,
- "note": "string"
}, - "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "preferredLocationGroupId": [
- "string"
], - "privacyPolicy": [
- "amazon"
], - "refunds": [
- {
- "type": "lineItem",
- "value": 0,
- "label": "string",
- "lineItemId": "string",
- "lineItemQuantity": 0,
- "lineItemRestock": true,
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "requireShippingLabels": true,
- "respectLocationId": true,
- "routingStatus": "disabled",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingDestinations": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extDestinationId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "quantityUnit": "each",
- "sku": "string",
- "uniqueId": "string"
}
], - "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}
}
], - "shippingNote": "string",
- "shippingPrice": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0
}
{- "code": 200,
- "success": true,
- "order": {
- "extOrderId": "string",
- "additionalCharges": [
- {
- "type": "handling",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customer": {
- "company": "string",
- "customerId": "string",
- "extCompanyCustomerId": "string",
- "extCustomerId": "string",
- "extLocationCustomerId": "string",
- "firstName": "string",
- "lastName": "string",
- "type": "individual"
}, - "customerPONumber": "string",
- "disableShipmentsReuse": true,
- "discounts": [
- {
- "type": "coupon",
- "value": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "label": "string",
- "lineItemId": "string",
- "reference": "string"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extOrderCreatedAt": "2019-08-24T14:15:22Z",
- "extOrderUpdatedAt": "2019-08-24T14:15:22Z",
- "extOrderUrl": "string",
- "fulfillmentStatus": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiAddress": true,
- "lastRerunRoutingTrigger": "manual",
- "lastRoutedAt": "2019-08-24T14:15:22Z",
- "lineItems": [
- {
- "quantity": 0,
- "requiresShipping": true,
- "sku": "string",
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "requiresShippingSource": "source",
- "routed": true,
- "taxable": true,
- "trackedAtSourceChannel": true,
- "upc": "string",
- "canceled": 0,
- "fulfillable": 0,
- "fulfilled": 0,
- "ordered": 0,
- "preferredLocationGroupId": [
- "string"
], - "refunded": 0,
- "reported": 0,
- "returned": 0
}
], - "locationId": "string",
- "orderDiscount": 0,
- "orderNote": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderTax": 0,
- "paymentStatus": "string",
- "paymentTerms": {
- "term": "net",
- "depositPercentage": 0,
- "dueDate": "2019-08-24T14:15:22Z",
- "dueInDays": 0,
- "note": "string"
}, - "payments": [
- {
- "amount": 0,
- "currency": "string",
- "method": "cash",
- "status": "succeeded",
- "conversion": 0,
- "customMethod": "string",
- "kind": "visa",
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "preferredLocationGroupId": [
- "string"
], - "privacyPolicy": [
- "amazon"
], - "refunds": [
- {
- "type": "lineItem",
- "value": 0,
- "label": "string",
- "lineItemId": "string",
- "lineItemQuantity": 0,
- "lineItemRestock": true,
- "processedAt": "2019-08-24T14:15:22Z",
- "reference": "string"
}
], - "requireShippingLabels": true,
- "respectLocationId": true,
- "routingStatus": "disabled",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingDestinations": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extDestinationId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "quantityUnit": "each",
- "sku": "string",
- "uniqueId": "string"
}
], - "shippingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}
}
], - "shippingNote": "string",
- "shippingPrice": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0,
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "disposition": [
- "partiallyRouted"
], - "dispositions": [
- {
- "uniqueId": "string",
- "values": [
- {
- "type": "routed",
- "quantity": 0
}
]
}
], - "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
name required | string Display Name |
sku required | string Product SKU |
autoEngUpdateStatus | string (AutoEngUpdateStatus) Enum: "initialPending" "pending" "updated" "none" A status that indicates whether or not the automation engine may update the entity sometime in the future. Only set internally. Useful for services such as the order routing engine where the user intended order state is critical before action. Used for orders and shipments. Status definitions:
|
autoEngUpdateStatusUpdatedAt | string <date-time> (AutoEngUpdateStatusUpdatedAt) When the autoEngUpdateStatus was last updated |
Array of objects (ProductBundleItem) Bundle Item need to reference the SKU of the actual product | |
cost | number <float> Cost |
costCurrency | string Currency |
countryOfOrigin | string Country of Origin |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects (NameValue) Custom Fields | |
description | string Description |
dimensionsUnit | string Enum: "cm" "in" "ft" Dimensions UOM |
exceptionCategories | Array of strings References to categories of exceptions related to the product |
exceptions | Array of strings Types of exceptions related to the product |
extProductApiId | string External Product API Id |
extProductCreatedAt | string <date-time> |
extProductId | string External Product Id |
extProductUpdatedAt | string <date-time> |
harmonizedCode | string Harmonized System/Tarrif Code |
height | number <float> Height |
hideInStore | boolean Mark item as hidden in marketplace Storefront |
imageURLs | Array of strings Image URLs |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
inventoryNotTracked | boolean Do not track inventory flag |
length | number <float> Length |
object (ProductPublishedItem) | |
orgKey | string Organization this object belong to |
parentExtProductId | string Variant parent external product Id |
partId | string Manufacturer part number |
Array of objects (Price) Start off with basePrice | |
productId | string Product ID |
Array of objects (ProductPublishedItem) Published Channels | |
object (SourceDoc) Vendor source document | |
status | string (ProductStatus) Enum: "active" "inactive" Product Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
taxable | boolean Taxable |
types | Array of strings (ProductType) Items Enum: "simple" "bundle" "bundleItem" "child" "parent" Product types |
upc | string UPC |
updatedAt | string <date-time> When the object was updated within Pipe17 |
Array of objects (NameValue) this let us know the variant description | |
vendor | string vendor |
weight | number <float> Weight |
weightUnit | string Enum: "lb" "oz" "kg" "g" Weight UOM |
width | number <float> Width |
{- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "mappedProduct": {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}, - "productId": "string",
- "name": "string",
- "sku": "string",
- "bundleItems": [
- {
- "quantity": 0,
- "sku": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "cost": 0,
- "costCurrency": "string",
- "countryOfOrigin": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "dimensionsUnit": "cm",
- "extProductApiId": "string",
- "extProductCreatedAt": "2019-08-24T14:15:22Z",
- "extProductId": "string",
- "extProductUpdatedAt": "2019-08-24T14:15:22Z",
- "harmonizedCode": "string",
- "height": 0,
- "hideInStore": true,
- "imageURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryNotTracked": true,
- "length": 0,
- "parentExtProductId": "string",
- "partId": "string",
- "prices": [
- {
- "currency": "string",
- "name": "string",
- "value": 0
}
], - "published": [
- {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "taxable": true,
- "types": [
- "simple"
], - "upc": "string",
- "variantOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "vendor": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
name required | string Display Name |
sku required | string Product SKU |
Array of objects (ProductBundleItem) Bundle Item need to reference the SKU of the actual product | |
cost | number <float> Cost |
costCurrency | string Currency |
countryOfOrigin | string Country of Origin |
Array of objects (NameValue) Custom Fields | |
description | string Description |
dimensionsUnit | string Enum: "cm" "in" "ft" Dimensions UOM |
extProductApiId | string External Product API Id |
extProductCreatedAt | string <date-time> |
extProductId | string External Product Id |
extProductUpdatedAt | string <date-time> |
harmonizedCode | string Harmonized System/Tarrif Code |
height | number <float> Height |
hideInStore | boolean Mark item as hidden in marketplace Storefront |
imageURLs | Array of strings Image URLs |
object (InternalInfo) Internal info | |
inventoryNotTracked | boolean Do not track inventory flag |
length | number <float> Length |
parentExtProductId | string Variant parent external product Id |
partId | string Manufacturer part number |
Array of objects (Price) Start off with basePrice | |
Array of objects (ProductPublishedItem) Published Channels | |
object (SourceDoc) Vendor source document | |
status | string (ProductStatus) Enum: "active" "inactive" Product Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
taxable | boolean Taxable |
types | Array of strings (ProductType) Items Enum: "simple" "bundle" "bundleItem" "child" "parent" Product types |
upc | string UPC |
Array of objects (NameValue) this let us know the variant description | |
vendor | string vendor |
weight | number <float> Weight |
weightUnit | string Enum: "lb" "oz" "kg" "g" Weight UOM |
width | number <float> Width |
[- {
- "name": "string",
- "sku": "string",
- "bundleItems": [
- {
- "quantity": 0,
- "sku": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "cost": 0,
- "costCurrency": "string",
- "countryOfOrigin": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "dimensionsUnit": "cm",
- "extProductApiId": "string",
- "extProductCreatedAt": "2019-08-24T14:15:22Z",
- "extProductId": "string",
- "extProductUpdatedAt": "2019-08-24T14:15:22Z",
- "harmonizedCode": "string",
- "height": 0,
- "hideInStore": true,
- "imageURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryNotTracked": true,
- "length": 0,
- "parentExtProductId": "string",
- "partId": "string",
- "prices": [
- {
- "currency": "string",
- "name": "string",
- "value": 0
}
], - "published": [
- {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "taxable": true,
- "types": [
- "simple"
], - "upc": "string",
- "variantOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "vendor": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0
}
]
{- "code": 200,
- "success": true,
- "products": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "product": {
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "mappedProduct": {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}, - "productId": "string",
- "name": "string",
- "sku": "string",
- "bundleItems": [
- {
- "quantity": 0,
- "sku": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "cost": 0,
- "costCurrency": "string",
- "countryOfOrigin": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "dimensionsUnit": "cm",
- "extProductApiId": "string",
- "extProductCreatedAt": "2019-08-24T14:15:22Z",
- "extProductId": "string",
- "extProductUpdatedAt": "2019-08-24T14:15:22Z",
- "harmonizedCode": "string",
- "height": 0,
- "hideInStore": true,
- "imageURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryNotTracked": true,
- "length": 0,
- "parentExtProductId": "string",
- "partId": "string",
- "prices": [
- {
- "currency": "string",
- "name": "string",
- "value": 0
}
], - "published": [
- {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "taxable": true,
- "types": [
- "simple"
], - "upc": "string",
- "variantOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "vendor": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "status": "submitted"
}
]
}
action | string (ListDeleteAction) Default: "list" Enum: "list" "soft" Return the list of what to delete, or delete softly |
count | integer <int32> Default: 100 Delete at most this many products |
deleted | boolean Delete soft deleted products |
extProductId | Array of strings Delete products by list of extProductId |
integration | Array of strings Delete products of these integrations |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete products assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
parentExtProductId | Array of strings Delete all variants of a parent product by list of external id |
productId | Array of strings Delete products by list of productId |
since | string <date-time> Delete products created after this date-time |
skip | integer <int32> Default: 0 Skip this many products |
status | Array of strings (ProductStatus) Items Enum: "active" "inactive" Delete products with this status |
tags | Array of strings (EntityTags) Tags assigned to entity |
types | Array of strings (ProductType) Items Enum: "simple" "bundle" "bundleItem" "child" "parent" Delete products matching specified types |
until | string <date-time> Delete products created before this date-time |
updatedSince | string <date-time> Delete products updated after this date-time |
updatedUntil | string <date-time> Delete products updated before this date-time |
{- "code": 200,
- "success": true,
- "deleted": 0,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "extProductId": [
- "string"
], - "integration": [
- "string"
], - "mappedSKU": true,
- "parentExtProductId": [
- "string"
], - "productId": [
- "string"
], - "status": [
- "active"
], - "tags": [
- "string"
], - "types": [
- "simple"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "products": [
- {
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "mappedProduct": {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}, - "productId": "string",
- "name": "string",
- "sku": "string",
- "bundleItems": [
- {
- "quantity": 0,
- "sku": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "cost": 0,
- "costCurrency": "string",
- "countryOfOrigin": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "dimensionsUnit": "cm",
- "extProductApiId": "string",
- "extProductCreatedAt": "2019-08-24T14:15:22Z",
- "extProductId": "string",
- "extProductUpdatedAt": "2019-08-24T14:15:22Z",
- "harmonizedCode": "string",
- "height": 0,
- "hideInStore": true,
- "imageURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryNotTracked": true,
- "length": 0,
- "parentExtProductId": "string",
- "partId": "string",
- "prices": [
- {
- "currency": "string",
- "name": "string",
- "value": 0
}
], - "published": [
- {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "taxable": true,
- "types": [
- "simple"
], - "upc": "string",
- "variantOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "vendor": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
autoEngUpdateStatus | Array of strings (AutoEngUpdateStatus) Items Enum: "initialPending" "pending" "updated" "none" |
autoEngUpdateStatusUpdatedSince | string <date-time> Fetch all products with autoEngUpdateStatus updated after this date-time |
autoEngUpdateStatusUpdatedUntil | string <date-time> Fetch all products with autoEngUpdateStatus updated before this date-time |
bundleSKU | string Retrieve all products of the bundle with this SKU |
count | integer <int32> Default: 100 Return at most this many products |
deleted | boolean Retrieve soft deleted products |
exceptionCategoryId | Array of strings Retrieve products by list of categories of the product related exceptions |
exceptionType | Array of strings Retrieve products by list of types of the product related exceptions ( |
extProductId | Array of strings Retrieve products by list of extProductId |
hasSourceDoc | boolean Retrieve products containing a source document |
inBundle | string Retrieve all bundles containing the item with this SKU |
integration | Array of strings Retrieve products of these integrations |
inventoryNotTracked | boolean Retrieve products by inventoryNotTracked value (default - any) |
keys | string Default: "inventoryNotTracked,productId,extProductId,parentExtProductId,status,types,sku,name,tags,createdAt,updatedAt,orgKey" Return these top-level fields |
mappedSKU | boolean Retrieve products with SKU mapping defined |
name | string Retrieve products by name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
notPublished | boolean Retrieve products that do not have "published channels" |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
parentExtProductId | Array of strings Retrieve all variants of a parent product by list of external id |
productId | Array of strings Retrieve by list of productId |
publishedSKU | Array of strings Retrieve all products with published SKU |
publishedStatus | Array of strings (ProductPublishedItemStatus) Items Enum: "tobepublished" "published" "tobeunpublished" "unpublished" "disabled" Retrieve all products with published status |
requestorId | string Requestor Id (- forcibly replaced with integration ID if the request came from an integration) |
since | string <date-time> Retrieve all products created after this date-time |
skip | integer <int32> Default: 0 Skip this many products |
sku | Array of strings Retrieve products by list of SKU |
status | Array of strings (ProductStatus) Items Enum: "active" "inactive" Retrieve all products with this status |
tags | Array of strings (EntityTags) Tags assigned to entity |
types | Array of strings (ProductType) Items Enum: "simple" "bundle" "bundleItem" "child" "parent" Retrieve all products matching specified types |
until | string <date-time> Retrieve all products created before this date-time |
updatedSince | string <date-time> Retrieve all products updated after this date-time |
updatedUntil | string <date-time> Retrieve all products updated before this date-time |
{- "code": 200,
- "success": true,
- "products": [
- {
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "mappedProduct": {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}, - "productId": "string",
- "name": "string",
- "sku": "string",
- "bundleItems": [
- {
- "quantity": 0,
- "sku": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "cost": 0,
- "costCurrency": "string",
- "countryOfOrigin": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "dimensionsUnit": "cm",
- "extProductApiId": "string",
- "extProductCreatedAt": "2019-08-24T14:15:22Z",
- "extProductId": "string",
- "extProductUpdatedAt": "2019-08-24T14:15:22Z",
- "harmonizedCode": "string",
- "height": 0,
- "hideInStore": true,
- "imageURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryNotTracked": true,
- "length": 0,
- "parentExtProductId": "string",
- "partId": "string",
- "prices": [
- {
- "currency": "string",
- "name": "string",
- "value": 0
}
], - "published": [
- {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "taxable": true,
- "types": [
- "simple"
], - "upc": "string",
- "variantOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "vendor": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "extProductId": [
- "string"
], - "integration": [
- "string"
], - "mappedSKU": true,
- "parentExtProductId": [
- "string"
], - "productId": [
- "string"
], - "status": [
- "active"
], - "tags": [
- "string"
], - "types": [
- "simple"
], - "keys": "string",
- "order": "string",
- "bundleSKU": "string",
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "hasSourceDoc": true,
- "inBundle": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "notPublished": true,
- "publishedSKU": [
- "string"
], - "publishedStatus": [
- "tobepublished"
], - "requestorId": "string",
- "sku": [
- "string"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
ProductId required | string Id, |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
{- "code": 200,
- "success": true,
- "product": {
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "mappedProduct": {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}, - "productId": "string",
- "name": "string",
- "sku": "string",
- "bundleItems": [
- {
- "quantity": 0,
- "sku": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "cost": 0,
- "costCurrency": "string",
- "countryOfOrigin": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "dimensionsUnit": "cm",
- "extProductApiId": "string",
- "extProductCreatedAt": "2019-08-24T14:15:22Z",
- "extProductId": "string",
- "extProductUpdatedAt": "2019-08-24T14:15:22Z",
- "harmonizedCode": "string",
- "height": 0,
- "hideInStore": true,
- "imageURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryNotTracked": true,
- "length": 0,
- "parentExtProductId": "string",
- "partId": "string",
- "prices": [
- {
- "currency": "string",
- "name": "string",
- "value": 0
}
], - "published": [
- {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "taxable": true,
- "types": [
- "simple"
], - "upc": "string",
- "variantOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "vendor": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
Trigger the products sync
ProductId required | Array of strings |
syncAE | boolean Reset autoEngUpdateStatus |
{- "syncAE": true
}
{- "code": 200,
- "success": true
}
Uniqueness constraints within organization:
ProductId required | string Id, |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
autoEngUpdateStatus | string (AutoEngUpdateStatus) Enum: "initialPending" "pending" "updated" "none" A status that indicates whether or not the automation engine may update the entity sometime in the future. Only set internally. Useful for services such as the order routing engine where the user intended order state is critical before action. Used for orders and shipments. Status definitions:
|
Array of objects or null (ProductBundleItem) Bundle Item need to reference the SKU of the actual product | |
cost | number or null <float> Cost |
costCurrency | string or null Currency |
countryOfOrigin | string or null Country of Origin |
Array of objects or null (NameValue) Custom Fields | |
description | string Description |
dimensionsUnit | string Enum: "cm" "in" "ft" Dimensions UOM |
extProductApiId | string External Product API Id |
extProductCreatedAt | string or null <date-time> |
extProductUpdatedAt | string or null <date-time> |
harmonizedCode | string or null Harmonized System/Tariff Code |
height | number or null <float> Height |
hideInStore | boolean or null Mark item as hidden in marketplace Storefront |
imageURLs | Array of strings or null Image URLs |
object (InternalInfo) Internal info | |
inventoryNotTracked | boolean or null Do not track inventory flag |
length | number or null <float> Length |
object (ProductPublishedItemUpdate) | |
name | string Display Name |
parentExtProductId | string or null Variant parent external product Id |
partId | string or null Manufacturer part number |
Array of objects or null (Price) Start off with basePrice | |
Array of objects or null (ProductPublishedItem) Published Channels | |
sku | string Product SKU |
object (SourceDoc) Vendor source document | |
status | string (ProductStatus) Enum: "active" "inactive" Product Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
taxable | boolean or null Taxable |
types | Array of strings (ProductType) Items Enum: "simple" "bundle" "bundleItem" "child" "parent" Product types |
upc | string or null UPC |
Array of objects or null (NameValue) this let us know the variant description | |
vendor | string or null vendor |
weight | number or null <float> Weight |
weightUnit | string or null Enum: "lb" "oz" "kg" "g" Weight UOM |
width | number or null <float> Width |
{- "autoEngUpdateStatus": "initialPending",
- "bundleItems": [
- {
- "quantity": 0,
- "sku": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "cost": 0,
- "costCurrency": "string",
- "countryOfOrigin": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "dimensionsUnit": "cm",
- "extProductApiId": "string",
- "extProductCreatedAt": "2019-08-24T14:15:22Z",
- "extProductUpdatedAt": "2019-08-24T14:15:22Z",
- "harmonizedCode": "string",
- "height": 0,
- "hideInStore": true,
- "imageURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryNotTracked": true,
- "length": 0,
- "mappedProduct": {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "integrationId": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}, - "name": "string",
- "parentExtProductId": "string",
- "partId": "string",
- "prices": [
- {
- "currency": "string",
- "name": "string",
- "value": 0
}
], - "published": [
- {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "sku": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "taxable": true,
- "types": [
- "simple"
], - "upc": "string",
- "variantOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "vendor": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0
}
{- "code": 200,
- "success": true,
- "product": {
- "autoEngUpdateStatus": "initialPending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "mappedProduct": {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}, - "productId": "string",
- "name": "string",
- "sku": "string",
- "bundleItems": [
- {
- "quantity": 0,
- "sku": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "cost": 0,
- "costCurrency": "string",
- "countryOfOrigin": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "description": "string",
- "dimensionsUnit": "cm",
- "extProductApiId": "string",
- "extProductCreatedAt": "2019-08-24T14:15:22Z",
- "extProductId": "string",
- "extProductUpdatedAt": "2019-08-24T14:15:22Z",
- "harmonizedCode": "string",
- "height": 0,
- "hideInStore": true,
- "imageURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "inventoryNotTracked": true,
- "length": 0,
- "parentExtProductId": "string",
- "partId": "string",
- "prices": [
- {
- "currency": "string",
- "name": "string",
- "value": 0
}
], - "published": [
- {
- "integrationId": "string",
- "bufferInventory": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extProductId": "string",
- "inventoryNotTracked": true,
- "name": "string",
- "sku": "string",
- "status": "tobepublished",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "string"
}
], - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "active",
- "tags": [
- "string"
], - "taxable": true,
- "types": [
- "simple"
], - "upc": "string",
- "variantOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "vendor": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
extOrderId required | string External Purchase Order ID |
actualArrivalDate | string <date-time> Actual Arrival Date (from most recent Arrival) |
object (Address) | |
Array of objects or null (PurchaseCosts) Purchase costs | |
createdAt | string <date-time> When the object was created within Pipe17 |
currency | string Order currency code |
Array of objects (NameValue) Custom Fields | |
disableShipmentsReuse | boolean Hint to whether shipmentId should be re-used, or not |
employeeName | string Purchase order created by |
exceptionCategories | Array of strings References to categories of exceptions related to the purchase |
exceptions | Array of strings Types of exceptions related to the purchase |
expectedArrivalDate | string <date-time> Expected Arrival Date |
extOrderApiId | string External System Purchase Order API ID |
extReferenceId | string Reference ID |
holdUntil | string <date-time> |
incoterms | string International Commercial Terms |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
Array of objects (PurchaseLineItem) | |
orgKey | string Organization this object belong to |
purchaseId | string Purchase ID |
purchaseNotes | string Purchase Notes |
purchaseOrderDate | string <date-time> Purchase Order Date |
purchaseTax | number <float> Purchase Tax |
referenceNumber | string Purchase order reference number |
shipByDate | string <date-time> Ship By Date |
shippingCarrier | string Shipping Carrier |
shippingNotes | string Shipping Notes |
shippingService | string Shipping Service Type |
object (SourceDoc) Vendor source document | |
status | string (PurchaseStatus) Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Purchase Status |
subTotalPrice | number <float> Sub Total Price |
tags | Array of strings (EntityTags) Tags assigned to entity |
timestamp | string <date-time> General Purpose Time Stamp |
object (Address) | |
toLocationId | string Ship to location ID |
totalPrice | number <float> Total Price |
updatedAt | string <date-time> When the object was updated within Pipe17 |
object (Address) |
{- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "purchaseId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "costs": [
- {
- "cost": 0,
- "name": "string",
- "quantity": 0
}
], - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extReferenceId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "locationId": "string",
- "name": "string",
- "partId": "string",
- "price": 0,
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "sku": "string",
- "upc": "string"
}
], - "purchaseNotes": "string",
- "purchaseOrderDate": "2019-08-24T14:15:22Z",
- "purchaseTax": 0,
- "referenceNumber": "string",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingNotes": "string",
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "toAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "toLocationId": "string",
- "totalPrice": 0,
- "vendorAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
extOrderId required | string External Purchase Order ID |
actualArrivalDate | string <date-time> Actual Arrival Date (from most recent Arrival) |
object (Address) | |
Array of objects or null (PurchaseCosts) Purchase costs | |
currency | string Order currency code |
Array of objects (NameValue) Custom Fields | |
disableShipmentsReuse | boolean Hint to whether shipmentId should be re-used, or not |
employeeName | string Purchase order created by |
expectedArrivalDate | string <date-time> Expected Arrival Date |
extOrderApiId | string External System Purchase Order API ID |
extReferenceId | string Reference ID |
holdUntil | string <date-time> |
incoterms | string International Commercial Terms |
object (InternalInfo) Internal info | |
Array of objects (PurchaseLineItem) | |
purchaseNotes | string Purchase Notes |
purchaseOrderDate | string <date-time> Purchase Order Date |
purchaseTax | number <float> Purchase Tax |
referenceNumber | string Purchase order reference number |
shipByDate | string <date-time> Ship By Date |
shippingCarrier | string Shipping Carrier |
shippingNotes | string Shipping Notes |
shippingService | string Shipping Service Type |
object (SourceDoc) Vendor source document | |
status | string (PurchaseStatus) Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Purchase Status |
subTotalPrice | number <float> Sub Total Price |
tags | Array of strings (EntityTags) Tags assigned to entity |
timestamp | string <date-time> General Purpose Time Stamp |
object (Address) | |
toLocationId | string Ship to location ID |
totalPrice | number <float> Total Price |
object (Address) |
[- {
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "costs": [
- {
- "cost": 0,
- "name": "string",
- "quantity": 0
}
], - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extReferenceId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "locationId": "string",
- "name": "string",
- "partId": "string",
- "price": 0,
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "sku": "string",
- "upc": "string"
}
], - "purchaseNotes": "string",
- "purchaseOrderDate": "2019-08-24T14:15:22Z",
- "purchaseTax": 0,
- "referenceNumber": "string",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingNotes": "string",
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "toAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "toLocationId": "string",
- "totalPrice": 0,
- "vendorAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}
}
]
{- "code": 200,
- "success": true,
- "purchases": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "purchase": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "purchaseId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "costs": [
- {
- "cost": 0,
- "name": "string",
- "quantity": 0
}
], - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extReferenceId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "locationId": "string",
- "name": "string",
- "partId": "string",
- "price": 0,
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "sku": "string",
- "upc": "string"
}
], - "purchaseNotes": "string",
- "purchaseOrderDate": "2019-08-24T14:15:22Z",
- "purchaseTax": 0,
- "referenceNumber": "string",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingNotes": "string",
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "toAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "toLocationId": "string",
- "totalPrice": 0,
- "vendorAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "status": "submitted"
}
]
}
action | string (ListDeleteAction) Default: "list" Enum: "list" "soft" Return the list of what to delete, or delete softly |
count | integer <int32> Default: 100 Delete at most this many purchases |
deleted | boolean Delete soft deleted purchaases |
extOrderId | Array of strings Delete purchases by list of external purchase IDs |
extReferenceId | Array of strings Delete purchases by |
integration | Array of strings Delete purchases of these integrations |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete purchases assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
purchaseId | Array of strings Delete purchases by list of purchaseId |
since | string <date-time> Delete purchases created after this date-time |
skip | integer <int32> Default: 0 Skip this many purchases |
status | Array of strings (PurchaseStatus) Items Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Delete purchases by list of statuses |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Delete purchases created before this date-time |
updatedSince | string <date-time> Delete purchases updated after this date-time |
updatedUntil | string <date-time> Delete purchases updated before this date-time |
{- "code": 200,
- "success": true,
- "deleted": 0,
- "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "extOrderId": [
- "string"
], - "extReferenceId": [
- "string"
], - "integration": [
- "string"
], - "purchaseId": [
- "string"
], - "status": [
- "draft"
], - "tags": [
- "string"
], - "toLocationId": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "purchases": [
- {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "purchaseId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "costs": [
- {
- "cost": 0,
- "name": "string",
- "quantity": 0
}
], - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extReferenceId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "locationId": "string",
- "name": "string",
- "partId": "string",
- "price": 0,
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "sku": "string",
- "upc": "string"
}
], - "purchaseNotes": "string",
- "purchaseOrderDate": "2019-08-24T14:15:22Z",
- "purchaseTax": 0,
- "referenceNumber": "string",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingNotes": "string",
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "toAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "toLocationId": "string",
- "totalPrice": 0,
- "vendorAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
PurchaseId required | string Id, |
nested | boolean Delete nested entities |
{- "code": 200,
- "success": true
}
PurchaseId required | string Id, |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
{- "code": 200,
- "success": true,
- "purchase": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "purchaseId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "costs": [
- {
- "cost": 0,
- "name": "string",
- "quantity": 0
}
], - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extReferenceId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "locationId": "string",
- "name": "string",
- "partId": "string",
- "price": 0,
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "sku": "string",
- "upc": "string"
}
], - "purchaseNotes": "string",
- "purchaseOrderDate": "2019-08-24T14:15:22Z",
- "purchaseTax": 0,
- "referenceNumber": "string",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingNotes": "string",
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "toAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "toLocationId": "string",
- "totalPrice": 0,
- "vendorAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many purchases |
deleted | boolean Retrieve soft deleted purchaases |
exceptionCategoryId | Array of strings Retrieve purchases by list of categories of the purchase related exceptions |
exceptionType | Array of strings Retrieve purchases by list of types of the purchase related exceptions ( |
extOrderId | Array of strings Retrieve by list of external purchase IDs |
extReferenceId | Array of strings Retrieve by |
hasSourceDoc | boolean Retrieve purchases containing a source document |
integration | Array of strings Retrieve purchases of these integrations |
keys | string Default: "purchaseId,extOrderId,referenceNumber,vendorAddress,expectedArrivalDate,shipByDate,toLocationId,totalPrice,status,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
purchaseId | Array of strings Retrieve by list of purchaseId |
since | string <date-time> Retrieve all purchases created after this date-time |
skip | integer <int32> Default: 0 Skip this many purchases |
status | Array of strings (PurchaseStatus) Items Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Retrieve by list of statuses |
tags | Array of strings (EntityTags) Tags assigned to entity |
timestamp | boolean if set to true use timestamp instead of create time |
toLocationId | Array of strings Retrieve by list of toLocationId |
until | string <date-time> Retrieve all purchases created before this date-time |
updatedSince | string <date-time> Retrieve all purchases updated after this date-time |
updatedUntil | string <date-time> Retrieve all purchases updated before this date-time |
{- "code": 200,
- "success": true,
- "purchases": [
- {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "purchaseId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "costs": [
- {
- "cost": 0,
- "name": "string",
- "quantity": 0
}
], - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extReferenceId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "locationId": "string",
- "name": "string",
- "partId": "string",
- "price": 0,
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "sku": "string",
- "upc": "string"
}
], - "purchaseNotes": "string",
- "purchaseOrderDate": "2019-08-24T14:15:22Z",
- "purchaseTax": 0,
- "referenceNumber": "string",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingNotes": "string",
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "toAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "toLocationId": "string",
- "totalPrice": 0,
- "vendorAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "filters": {
- "count": 0,
- "pagination": "disabled",
- "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z",
- "deleted": true,
- "extOrderId": [
- "string"
], - "extReferenceId": [
- "string"
], - "integration": [
- "string"
], - "purchaseId": [
- "string"
], - "status": [
- "draft"
], - "tags": [
- "string"
], - "toLocationId": [
- "string"
], - "keys": "string",
- "order": "string",
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "hasSourceDoc": true,
- "timestamp": true
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Uniqueness constraints within organization:
PurchaseId required | string Id, |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
actualArrivalDate | string or null <date-time> Actual Arrival Date (from most recent Arrival) |
object (AddressUpdateData) | |
Array of objects or null (PurchaseCosts) Purchase costs | |
currency | string Order currency code |
Array of objects (NameValue) Custom Fields | |
disableShipmentsReuse | boolean or null Hint to whether shipmentId should be re-used, or not |
employeeName | string or null Purchase order created by |
expectedArrivalDate | string or null <date-time> Expected Arrival Date |
extReferenceId | string Reference ID |
holdUntil | string or null <date-time> |
object (InternalInfo) Internal info | |
Array of objects (PurchaseUpdateLineItem) | |
purchaseNotes | string or null Purchase Notes |
purchaseTax | number or null <float> Purchase Tax |
referenceNumber | string or null Purchase order reference number |
shipByDate | string or null <date-time> Ship By Date |
shippingCarrier | string or null Shipping Carrier |
shippingNotes | string or null Shipping Notes |
shippingService | string or null Shipping Service Type |
object (SourceDoc) Vendor source document | |
status | string (PurchaseStatus) Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Purchase Status |
subTotalPrice | number or null <float> Sub Total Price |
tags | Array of strings (EntityTags) Tags assigned to entity |
timestamp | string or null <date-time> General Purpose Time Stamp |
object or null (AddressNullable) | |
toLocationId | string or null Ship to location ID |
totalPrice | number or null <float> Total Price |
object (AddressUpdateData) |
{- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "costs": [
- {
- "cost": 0,
- "name": "string",
- "quantity": 0
}
], - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extReferenceId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "locationId": "string",
- "name": "string",
- "partId": "string",
- "price": 0,
- "quantity": 0,
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "upc": "string"
}
], - "purchaseNotes": "string",
- "purchaseTax": 0,
- "referenceNumber": "string",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingNotes": "string",
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "toAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "toLocationId": "string",
- "totalPrice": 0,
- "vendorAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}
}
{- "code": 200,
- "success": true,
- "purchase": {
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "integration": "string",
- "purchaseId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "costs": [
- {
- "cost": 0,
- "name": "string",
- "quantity": 0
}
], - "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extOrderApiId": "string",
- "extReferenceId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "uniqueId": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "locationId": "string",
- "name": "string",
- "partId": "string",
- "price": 0,
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "sku": "string",
- "upc": "string"
}
], - "purchaseNotes": "string",
- "purchaseOrderDate": "2019-08-24T14:15:22Z",
- "purchaseTax": 0,
- "referenceNumber": "string",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingNotes": "string",
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "draft",
- "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "toAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "toLocationId": "string",
- "totalPrice": 0,
- "vendorAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
arrivalId required | string Arrival ID |
actualArrivalDate | string <date-time> Actual arrival date |
arrivalIntegration | string Reference to integration that created arrival tied to receipt |
createdAt | string <date-time> When the object was created within Pipe17 |
currency | string Currency |
Array of objects (NameValue) Custom Fields | |
exceptionCategories | Array of strings References to categories of exceptions related to the receipt |
exceptions | Array of strings Types of exceptions related to the receipt |
extArrivalId | string External arrival ID |
extOrderId | string External Order ID |
extReceiptApiId | string External System Receipt API ID |
extReceiptId | string Reference to receipt on external system (vendor) |
integration | string Reference to integration that created receipt |
object (InternalInfo) Internal info | |
Array of objects (ReceiptItemWithRefs) | |
orderIntegration | string Reference to integration that created order tied to receipt |
orgKey | string Organization this object belong to |
receiptId | string Receipt ID |
shippingCarrier | string Shipping Carrier |
shippingClass | string Shipping Carrier |
object (SourceDoc) Vendor source document | |
tags | Array of strings (EntityTags) Tags assigned to entity |
Array of objects (ReceiptChangelogEntry) Timeline of updates | |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "arrivalIntegration": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "extArrivalId": "string",
- "extOrderId": "string",
- "integration": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "lotNumber": "string",
- "palletQuantity": 0,
- "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string",
- "extOrderId": "string",
- "purchaseId": "string",
- "transferId": "string"
}
], - "orderIntegration": "string",
- "receiptId": "string",
- "timeline": [
- {
- "arrivalId": "string",
- "receiptId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "arrivalId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extReceiptApiId": "string",
- "extReceiptId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
arrivalId required | string Arrival ID |
required | Array of objects (ReceiptItem) |
actualArrivalDate | string <date-time> Actual arrival date |
currency | string Currency |
Array of objects (NameValue) Custom Fields | |
extReceiptApiId | string External System Receipt API ID |
extReceiptId | string Reference to receipt on external system (vendor) |
object (InternalInfo) Internal info | |
shippingCarrier | string Shipping Carrier |
shippingClass | string Shipping Carrier |
object (SourceDoc) Vendor source document | |
tags | Array of strings (EntityTags) Tags assigned to entity |
[- {
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "lotNumber": "string",
- "palletQuantity": 0,
- "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "arrivalId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extReceiptApiId": "string",
- "extReceiptId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "tags": [
- "string"
]
}
]
{- "code": 200,
- "success": true,
- "receipts": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "receipt": {
- "arrivalIntegration": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "extArrivalId": "string",
- "extOrderId": "string",
- "integration": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expirationDate": "2019-08-24T14:15:22Z",
- "lotNumber": "string",
- "palletQuantity": 0,
- "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string",
- "extOrderId": "string",
- "purchaseId": "string",
- "transferId": "string"
}
], - "orderIntegration": "string",
- "receiptId": "string",
- "timeline": [
- {
- "arrivalId": "string",
- "receiptId": "string",
- "apikeyId": "string",
- "eventId": "string",
- "integrationId": "string",
- "logId": "string",
- "operation": "create",
- "status": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "arrivalId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extReceiptApiId": "string",
- "extReceiptId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "shippingCarrier": "string",
- "shippingClass": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "status": "submitted"
}
]
}
ReceiptId required | string Id, |
sourceDocVersion | number Fetch specific vendor source doc version if available |
withSourceDoc | boolean Include vendor source doc if available |
withSourceDocVersions | boolean Include available vendor source doc versions |
withTimeline | boolean Include timeline of updates when available |
{- "code": 200,
- "success": true,
- "receipt": {
- "arrivalIntegration": "string",
- "exceptionCategories": [
- "string"
], - "exceptions": [
- "string"
], - "extArrivalId": "string",
- "extOrderId": "string",
- "integration": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string"