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 | |
exceptions | Array of strings References to exceptions related to the arrival |
expectedArrivalDate | string <date-time> Expected Arrival Date |
extArrivalId | string Reference to arrival on external system (vendor) |
extOrderId | string External TO or PO 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 an item |
object (InternalInfo) Internal info | |
Array of objects (ArrivalLineItem) | |
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 |
Array of ArrivalChangelogEntry (object) or FulfillmentChangelogEntry (object) or ReceiptChangelogEntry (object) or ShipmentChangelogEntry (object) (ChangelogEntry) 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",
- "exceptions": [
- "string"
], - "integration": "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",
- "extArrivalId": "string",
- "extOrderId": "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"
}
]
}, - "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 |
extArrivalId | string Reference to arrival on external system (vendor) |
extOrderId | string External TO or PO 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 |
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",
- "extArrivalId": "string",
- "extOrderId": "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",
- "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",
- "exceptions": [
- "string"
], - "integration": "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",
- "extArrivalId": "string",
- "extOrderId": "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"
}
]
}, - "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"
}
]
}
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) |
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 |
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",
- "exceptions": [
- "string"
], - "integration": "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",
- "extArrivalId": "string",
- "extOrderId": "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"
}
]
}, - "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"
], - "fromLocationId": [
- "string"
], - "fulfillmentId": [
- "string"
], - "hasSourceDoc": true,
- "purchaseId": [
- "string"
], - "status": [
- "draft"
], - "toLocationId": [
- "string"
], - "transferId": [
- "string"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
ArrivalId 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,
- "arrival": {
- "arrivalId": "string",
- "exceptions": [
- "string"
], - "integration": "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",
- "extArrivalId": "string",
- "extOrderId": "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"
}
]
}, - "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) |
fromLocationId | Array of strings Arrivals by list fromLocationId |
fulfillmentId | Array of strings Arrivals by list fulfillmentId |
hasSourceDoc | boolean Arrivals containing a source document |
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 |
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",
- "exceptions": [
- "string"
], - "integration": "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",
- "extArrivalId": "string",
- "extOrderId": "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"
}
]
}, - "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"
], - "fromLocationId": [
- "string"
], - "fulfillmentId": [
- "string"
], - "hasSourceDoc": true,
- "purchaseId": [
- "string"
], - "status": [
- "draft"
], - "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 Arrival Id to update |
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) |
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 |
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",
- "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",
- "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",
- "exceptions": [
- "string"
], - "integration": "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",
- "extArrivalId": "string",
- "extOrderId": "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"
}
]
}, - "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 | |
exceptions | Array of strings References to 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",
- "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",
- "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",
- "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 |
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",
- "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,
- "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",
- "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 |
exceptions | Array of strings References to 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",
- "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",
- "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",
- "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 |
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",
- "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,
- "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",
- "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) | |
exceptions | Array of strings References to 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",
- "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",
- "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",
- "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 |
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",
- "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"
}, - "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",
- "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"
}
}
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 | |
exceptions | Array of strings References to 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 |
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",
- "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 |
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",
- "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 |
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",
- "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",
- "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",
- "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 |
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",
- "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",
- "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 |
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",
- "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: "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 |
exceptions | Array of strings References to 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 |
orderIntegration | string Reference to integration that created order tied to an item |
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 ArrivalChangelogEntry (object) or FulfillmentChangelogEntry (object) or ReceiptChangelogEntry (object) or ShipmentChangelogEntry (object) (ChangelogEntry) 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": "pending",
- "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",
- "orderIntegration": "string",
- "shipmentIntegration": "string",
- "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"
}
], - "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:
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 |
Array of objects (FulfillmentItem) | |
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": "pending",
- "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",
- "orderIntegration": "string",
- "shipmentIntegration": "string",
- "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"
}
], - "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": "pending",
- "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",
- "orderIntegration": "string",
- "shipmentIntegration": "string",
- "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"
}
], - "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: "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 extShipmentId |
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 |
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": "pending",
- "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",
- "orderIntegration": "string",
- "shipmentIntegration": "string",
- "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"
}
], - "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"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
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" "ship" "fulfill" "xferin" "xferout" "return" "receive" "xferfulfill" "futureShip" "release" "shipCancel" "shipCancelRestock" "futureShipCancel" "virtualCommit" "touch" "POSOrder" Type of event triggering inventory change:
|
exceptions | Array of strings References to exceptions related to the inventory |
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 |
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 |
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",
- "exceptions": [
- "string"
], - "future": 0,
- "hold": 0,
- "incoming": 0,
- "integration": "string",
- "inventoryId": "string",
- "inventoryNotTracked": true,
- "label": "string",
- "locationId": "string",
- "onHand": 0,
- "orderId": "string",
- "orderType": "string",
- "quantity": 0,
- "sku": "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) |
inventoryNotTracked | boolean Disables the inventory tracking (default - false) |
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,
- "inventoryNotTracked": true,
- "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",
- "exceptions": [
- "string"
], - "future": 0,
- "hold": 0,
- "incoming": 0,
- "integration": "string",
- "inventoryId": "string",
- "inventoryNotTracked": true,
- "label": "string",
- "locationId": "string",
- "onHand": 0,
- "orderId": "string",
- "orderType": "string",
- "quantity": 0,
- "sku": "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",
- "exceptions": [
- "string"
], - "future": 0,
- "hold": 0,
- "incoming": 0,
- "integration": "string",
- "inventoryId": "string",
- "inventoryNotTracked": true,
- "label": "string",
- "locationId": "string",
- "onHand": 0,
- "orderId": "string",
- "orderType": "string",
- "quantity": 0,
- "sku": "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" "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) |
exceptionCategoryId | Array of strings Fetch inventory by list of categories of the inventory related exceptions (- ignored in 'totals' queries) |
exceptionType | Array of strings Fetch inventory by list of types of the inventory related exceptions (- ignored in 'totals' queries) |
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 |
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"
], - "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "integration": [
- "string"
], - "inventoryNotTracked": true,
- "ledger": true,
- "onHand": 0,
- "onHand_gt": 0,
- "onHand_lt": 0,
- "requestorId": "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",
- "exceptions": [
- "string"
], - "future": 0,
- "hold": 0,
- "incoming": 0,
- "integration": "string",
- "inventoryId": "string",
- "inventoryNotTracked": true,
- "label": "string",
- "locationId": "string",
- "onHand": 0,
- "orderId": "string",
- "orderType": "string",
- "quantity": 0,
- "sku": "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" 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 |
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 |
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,
- "inventoryNotTracked": true,
- "label": "string",
- "orderId": "string",
- "orderType": "sales",
- "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",
- "exceptions": [
- "string"
], - "future": 0,
- "hold": 0,
- "incoming": 0,
- "integration": "string",
- "inventoryId": "string",
- "inventoryNotTracked": true,
- "label": "string",
- "locationId": "string",
- "onHand": 0,
- "orderId": "string",
- "orderType": "string",
- "quantity": 0,
- "sku": "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" "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" "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" "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 |
exceptions | Array of strings References to 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 |
{- "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": {
- "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 |
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"
], - "invoiceId": [
- "string"
], - "orderId": [
- "string"
], - "status": [
- "draft"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "invoices": [
- {
- "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": {
- "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 |
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 |
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": [
- {
- "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"
], - "invoiceId": [
- "string"
], - "orderId": [
- "string"
], - "status": [
- "draft"
], - "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": {
- "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" "purchases" "transfers" "arrivals" "products" "organizations" "orders" "shipments" "fulfillments" "locations" "shipping_methods" "returns" "exceptions" "lookup_objects" Job sub-type |
type required | string (JobType) Enum: "report" "import" "prepare" "update" "delete" "export" "automation" 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 |
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": { },
- "timeout": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
subType required | string (JobSubType) Enum: "inventory" "replenishment" "purchases" "transfers" "arrivals" "products" "organizations" "orders" "shipments" "fulfillments" "locations" "shipping_methods" "returns" "exceptions" "lookup_objects" Job sub-type |
type required | string (JobType) Enum: "report" "import" "prepare" "update" "delete" "export" "automation" 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. |
timeout | number <int32> Job timeout (in milliseconds) |
{- "subType": "inventory",
- "type": "report",
- "contentType": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "params": { },
- "state": { },
- "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": { },
- "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" "purchases" "transfers" "arrivals" "products" "organizations" "orders" "shipments" "fulfillments" "locations" "shipping_methods" "returns" "exceptions" "lookup_objects" Delete items with given sub-type |
type | Array of strings (JobType) Items Enum: "report" "import" "prepare" "update" "delete" "export" "automation" 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"
], - "type": [
- "report"
], - "orgMode": [
- "sandbox"
]
}, - "jobs": [
- {
- "createdBy": "string",
- "jobId": "string",
- "progress": 100,
- "status": "submitted",
- "subType": "inventory",
- "type": "report",
- "contentType": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "params": { },
- "state": { },
- "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": { },
- "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" "purchases" "transfers" "arrivals" "products" "organizations" "orders" "shipments" "fulfillments" "locations" "shipping_methods" "returns" "exceptions" "lookup_objects" Fetch items with given sub-type |
type | Array of strings (JobType) Items Enum: "report" "import" "prepare" "update" "delete" "export" "automation" 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"
], - "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": { },
- "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 |
{- "internal": {
- "property1": { },
- "property2": { }
}, - "progress": 100,
- "state": { },
- "status": "submitted"
}
{- "code": 200,
- "success": true,
- "job": {
- "createdBy": "string",
- "jobId": "string",
- "progress": 100,
- "status": "submitted",
- "subType": "inventory",
- "type": "report",
- "contentType": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "params": { },
- "state": { },
- "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 | |
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 |
trackingNumber | string |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "labelId": "string",
- "status": "new",
- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "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 |
trackingNumber | string |
{- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "string",
- "trackingNumber": "string"
}
{- "code": 200,
- "success": true,
- "label": {
- "labelId": "string",
- "status": "new",
- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "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 |
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,
- "labelId": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "labels": [
- {
- "labelId": "string",
- "status": "new",
- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "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": {
- "labelId": "string",
- "status": "new",
- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "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 |
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 |
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,
- "labelId": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "labels": [
- {
- "labelId": "string",
- "status": "new",
- "contentType": "string",
- "fileName": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "labelType": "shippingLabel",
- "shippingMethod": "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 |
exceptions | Array of strings References to 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 |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "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",
- "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 |
{- "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"
}
{- "code": 200,
- "success": true,
- "location": {
- "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",
- "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 |
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"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "locations": [
- {
- "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",
- "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": {
- "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",
- "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 |
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"
], - "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": [
- {
- "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",
- "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 |
{- "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"
}
{- "code": 200,
- "success": true,
- "location": {
- "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",
- "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 | |
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 |
{- "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": {
- "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": {
- "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 |
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,
- "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": [
- {
- "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": {
- "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 |
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 |
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 |
{- "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,
- "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 |
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",
- "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
]
}
]
{- "code": 200,
- "success": true,
- "statements": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "statement": {
- "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,
- "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": {
- "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,
- "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) |
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 |
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,
- "extStatementApiId": [
- "string"
], - "extStatementId": [
- "string"
], - "hasSourceDoc": true,
- "integration": [
- "string"
], - "startPeriodSince": true,
- "startPeriodUntil": true,
- "statementId": [
- "string"
], - "status": [
- "new"
]
}, - "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,
- "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 |
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",
- "transactionFees": [
- {
- "name": "string",
- "value": 0,
- "category": "charge",
- "kind": "credit",
- "ordinal": 0,
- "term": "gross"
}
]
}
{- "code": 200,
- "success": true,
- "statement": {
- "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,
- "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: "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 | |
exceptions | Array of strings References to 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 | |
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 |
{- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "status": "draft",
- "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"
}
], - "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"
}
], - "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"
}
]
}, - "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0,
- "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 | |
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"
}
], - "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"
}
], - "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": {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "status": "draft",
- "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"
}
], - "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"
}
], - "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"
}
]
}, - "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 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 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 |
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"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "orders": [
- {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "status": "draft",
- "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"
}
], - "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"
}
], - "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"
}
]
}, - "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "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
}
}
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": {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "status": "draft",
- "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"
}
], - "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"
}
], - "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"
}
]
}, - "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
autoEngUpdateStatus | Array of strings (AutoEngUpdateStatus) Items Enum: "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 |
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 |
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": [
- {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "status": "draft",
- "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"
}
], - "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"
}
], - "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"
}
]
}, - "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "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,
- "extOrderId": [
- "string"
], - "locationId": [
- "string"
], - "orderId": [
- "string"
], - "orderSource": [
- "string"
], - "orderSourceType": [
- "online"
], - "routingStatus": [
- "disabled"
], - "status": [
- "draft"
], - "keys": "string",
- "order": "string",
- "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: "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 (OrderUpdateLineItem) | |
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 | |
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": "pending",
- "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": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "itemTax": 0,
- "locationId": "string",
- "name": "string",
- "quantity": 0,
- "quantityUnit": "each",
- "requiresShipping": true,
- "requiresShippingSource": "source",
- "routed": true,
- "sku": "string",
- "taxable": true,
- "trackedAtSourceChannel": true,
- "uniqueId": "string",
- "upc": "string"
}
], - "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"
}
], - "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": {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "exceptions": [
- "string"
], - "integration": "string",
- "isMultiDestination": true,
- "orderId": "string",
- "status": "draft",
- "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"
}
], - "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"
}
], - "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"
}
]
}, - "subTotalPrice": 0,
- "tags": [
- "string"
], - "timestamp": "2019-08-24T14:15:22Z",
- "totalPrice": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
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 |
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 |
exceptions | Array of strings References to 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 |
{- "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": {
- "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 |
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"
], - "mappedSKU": true,
- "parentExtProductId": [
- "string"
], - "productId": [
- "string"
], - "status": [
- "active"
], - "types": [
- "simple"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "products": [
- {
- "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"
}
]
}
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 |
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 |
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": [
- {
- "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"
], - "mappedSKU": true,
- "parentExtProductId": [
- "string"
], - "productId": [
- "string"
], - "status": [
- "active"
], - "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": {
- "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:
ProductId required | string Id, |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
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 |
{- "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": {
- "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 |
exceptions | Array of strings References to exceptions related to the purchase |
expectedArrivalDate | string <date-time> Expected Arrival Date |
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 |
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) |
{- "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",
- "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,
- "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 |
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 |
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",
- "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,
- "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": {
- "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",
- "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,
- "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 |
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 |
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"
], - "purchaseId": [
- "string"
], - "status": [
- "draft"
], - "toLocationId": [
- "string"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "purchases": [
- {
- "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",
- "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,
- "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 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,
- "purchase": {
- "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",
- "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,
- "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 |
hasSourceDoc | boolean Retrieve purchases containing a source document |
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 |
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": [
- {
- "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",
- "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,
- "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"
], - "purchaseId": [
- "string"
], - "status": [
- "draft"
], - "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 or |
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 |
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 |
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",
- "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,
- "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": {
- "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",
- "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,
- "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 |
createdAt | string <date-time> When the object was created within Pipe17 |
currency | string Currency |
Array of objects (NameValue) Custom Fields | |
exceptions | Array of strings References to exceptions related to the receipt |
extOrderId | string External Order ID |
extReceiptId | string Reference to receipt on external system (vendor) |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
Array of objects (ReceiptItemWithRefs) | |
orgKey | string Organization this object belong to |
receiptId | string Receipt ID |
shippingCarrier | string Shipping Carrier |
shippingClass | string Shipping Carrier |
object (SourceDoc) Vendor source document | |
Array of ArrivalChangelogEntry (object) or FulfillmentChangelogEntry (object) or ReceiptChangelogEntry (object) or ShipmentChangelogEntry (object) (ChangelogEntry) Timeline of updates | |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "exceptions": [
- "string"
], - "extOrderId": "string",
- "integration": "string",
- "lineItems": [
- {
- "extOrderId": "string",
- "purchaseId": "string",
- "transferId": "string",
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "receiptId": "string",
- "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"
}
], - "arrivalId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "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"
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
arrivalId required | string Arrival ID |
actualArrivalDate | string <date-time> Actual arrival date |
currency | string Currency |
Array of objects (NameValue) Custom Fields | |
extReceiptId | string Reference to receipt on external system (vendor) |
object (InternalInfo) Internal info | |
Array of objects (ReceiptItem) | |
shippingCarrier | string Shipping Carrier |
shippingClass | string Shipping Carrier |
object (SourceDoc) Vendor source document |
[- {
- "arrivalId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extReceiptId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "shippingCarrier": "string",
- "shippingClass": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}
}
]
{- "code": 200,
- "success": true,
- "receipts": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "receipt": {
- "exceptions": [
- "string"
], - "extOrderId": "string",
- "integration": "string",
- "lineItems": [
- {
- "extOrderId": "string",
- "purchaseId": "string",
- "transferId": "string",
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "receiptId": "string",
- "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"
}
], - "arrivalId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "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"
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "status": "submitted"
}
]
}
ReceiptId 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,
- "receipt": {
- "exceptions": [
- "string"
], - "extOrderId": "string",
- "integration": "string",
- "lineItems": [
- {
- "extOrderId": "string",
- "purchaseId": "string",
- "transferId": "string",
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "receiptId": "string",
- "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"
}
], - "arrivalId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "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"
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
arrivalId | Array of strings Receipts by list of arrivalId |
count | integer <int32> Default: 100 Return at most this many receipts |
exceptionCategoryId | Array of strings Receipts by list of categories of the receipt related exceptions |
exceptionType | Array of strings Receipts by list of types of the receipt related exceptions ( |
extOrderId | Array of strings Receipts by list of extOrderId |
hasSourceDoc | boolean Receipts containing a source document |
keys | string Default: "receiptId,arrivalId,extOrderId,actualArrivalDate,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 |
receiptId | Array of strings Receipts by list of receiptId |
since | string <date-time> Receipts created after this date-time |
skip | integer <int32> Default: 0 Skip this many receipts |
until | string <date-time> Receipts created before this date-time |
updatedSince | string <date-time> Receipts updated after this date-time |
updatedUntil | string <date-time> Receipts updated before this date-time |
{- "code": 200,
- "success": true,
- "receipts": [
- {
- "exceptions": [
- "string"
], - "extOrderId": "string",
- "integration": "string",
- "lineItems": [
- {
- "extOrderId": "string",
- "purchaseId": "string",
- "transferId": "string",
- "quantity": 0,
- "sku": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "receiptId": "string",
- "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"
}
], - "arrivalId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "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"
}
]
}, - "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"
], - "extOrderId": [
- "string"
], - "hasSourceDoc": true,
- "receiptId": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
returnId required | string Return ID |
type required | string (RefundType) Enum: "refund" "voucher" Refund type |
amount | number <float> Refund amount |
createdAt | string <date-time> When the object was created within Pipe17 |
creditIssued | number <float> Credit issued to customer |
creditSpent | number <float> Credit spent by customer |
currency | string Refund currency |
customerInvoiceAmount | number <float> Customer invoice amount |
Array of objects (NameValue) Custom Fields | |
extOrderId | string Order ID on external system |
extRefundId | string Refund ID on external system |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
merchantInvoiceAmount | number <float> Merchant invoice amount |
orgKey | string Organization this object belong to |
refundId | string Refund ID |
object (SourceDoc) Vendor source document | |
status | string (RefundStatus) Enum: "pending" "settled" Refund status |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "integration": "string",
- "refundId": "string",
- "returnId": "string",
- "type": "refund",
- "amount": 0,
- "creditIssued": 0,
- "creditSpent": 0,
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerInvoiceAmount": 0,
- "extOrderId": "string",
- "extRefundId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "merchantInvoiceAmount": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "pending",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
returnId required | string Return ID |
type required | string (RefundType) Enum: "refund" "voucher" Refund type |
amount | number <float> Refund amount |
creditIssued | number <float> Credit issued to customer |
creditSpent | number <float> Credit spent by customer |
currency | string Refund currency |
customerInvoiceAmount | number <float> Customer invoice amount |
Array of objects (NameValue) Custom Fields | |
extOrderId | string Order ID on external system |
extRefundId | string Refund ID on external system |
object (InternalInfo) Internal info | |
merchantInvoiceAmount | number <float> Merchant invoice amount |
object (SourceDoc) Vendor source document | |
status | string (RefundStatus) Enum: "pending" "settled" Refund status |
{- "returnId": "string",
- "type": "refund",
- "amount": 0,
- "creditIssued": 0,
- "creditSpent": 0,
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerInvoiceAmount": 0,
- "extOrderId": "string",
- "extRefundId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "merchantInvoiceAmount": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "pending"
}
{- "code": 200,
- "success": true,
- "refund": {
- "integration": "string",
- "refundId": "string",
- "returnId": "string",
- "type": "refund",
- "amount": 0,
- "creditIssued": 0,
- "creditSpent": 0,
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerInvoiceAmount": 0,
- "extOrderId": "string",
- "extRefundId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "merchantInvoiceAmount": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "pending",
- "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 refunds |
deleted | boolean Delete soft deleted refunds |
extOrderId | Array of strings Delete refunds by list of external order ids |
extRefundId | Array of strings Delete refunds by list of external refund ids |
extReturnId | Array of strings Delete refunds by list of external return ids |
integration | Array of strings Delete refunds of these integrations |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete refunds assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
refundId | Array of strings Delete by list of refundId |
since | string <date-time> Delete refunds created after this date-time |
skip | integer <int32> Default: 0 Skip this many refunds |
status | Array of strings (RefundStatus) Items Enum: "pending" "settled" |
type | Array of strings (RefundType) Items Enum: "refund" "voucher" |
until | string <date-time> Delete refunds created before this date-time |
updatedSince | string <date-time> Delete refunds updated after this date-time |
updatedUntil | string <date-time> Delete refunds 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"
], - "extRefundId": [
- "string"
], - "extReturnId": [
- "string"
], - "refundId": [
- "string"
], - "status": [
- "pending"
], - "type": [
- "refund"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "refunds": [
- {
- "integration": "string",
- "refundId": "string",
- "returnId": "string",
- "type": "refund",
- "amount": 0,
- "creditIssued": 0,
- "creditSpent": 0,
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerInvoiceAmount": 0,
- "extOrderId": "string",
- "extRefundId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "merchantInvoiceAmount": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "pending",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
RefundId 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,
- "refund": {
- "integration": "string",
- "refundId": "string",
- "returnId": "string",
- "type": "refund",
- "amount": 0,
- "creditIssued": 0,
- "creditSpent": 0,
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerInvoiceAmount": 0,
- "extOrderId": "string",
- "extRefundId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "merchantInvoiceAmount": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "pending",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many refunds |
deleted | boolean Retrieve soft deleted refunds |
extOrderId | Array of strings Retrieve refunds by list of external order ids |
extRefundId | Array of strings Retrieve refunds by list of external refund ids |
extReturnId | Array of strings Retrieve refunds by list of external return ids |
hasSourceDoc | boolean Retrieve refunds containing a source document |
keys | string Default: "refundId,extRefundId,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 |
refundId | Array of strings Retrieve by list of refundId |
returnId | Array of strings Retrieve refunds by list of return ids |
since | string <date-time> Refunds created after this date-time |
skip | integer <int32> Default: 0 Skip this many refunds |
status | Array of strings (RefundStatus) Items Enum: "pending" "settled" |
type | Array of strings (RefundType) Items Enum: "refund" "voucher" |
until | string <date-time> Refunds created before this date-time |
updatedSince | string <date-time> Refunds updated after this date-time |
updatedUntil | string <date-time> Refunds 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,
- "extOrderId": [
- "string"
], - "extRefundId": [
- "string"
], - "extReturnId": [
- "string"
], - "refundId": [
- "string"
], - "status": [
- "pending"
], - "type": [
- "refund"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "refunds": [
- {
- "integration": "string",
- "refundId": "string",
- "returnId": "string",
- "type": "refund",
- "amount": 0,
- "creditIssued": 0,
- "creditSpent": 0,
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerInvoiceAmount": 0,
- "extOrderId": "string",
- "extRefundId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "merchantInvoiceAmount": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "pending",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
Uniqueness constraints within organization:
RefundId required | string Id or |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
amount | number <float> Refund amount |
creditIssued | number <float> Credit issued to customer |
creditSpent | number <float> Credit spent by customer |
customerInvoiceAmount | number <float> Customer invoice amount |
Array of objects (NameValue) Custom Fields | |
object (InternalInfo) Internal info | |
merchantInvoiceAmount | number <float> Merchant invoice amount |
object (SourceDoc) Vendor source document | |
status | string (RefundStatus) Enum: "pending" "settled" Refund status |
{- "amount": 0,
- "creditIssued": 0,
- "creditSpent": 0,
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerInvoiceAmount": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "merchantInvoiceAmount": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "pending"
}
{- "code": 200,
- "success": true,
- "refund": {
- "integration": "string",
- "refundId": "string",
- "returnId": "string",
- "type": "refund",
- "amount": 0,
- "creditIssued": 0,
- "creditSpent": 0,
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerInvoiceAmount": 0,
- "extOrderId": "string",
- "extRefundId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "merchantInvoiceAmount": 0,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "status": "pending",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
arrivedAt | string <date-time> |
completedAt | string <date-time> |
createdAt | string <date-time> When the object was created within Pipe17 |
currency | string Currency value, e.g. 'USD' |
customerNotes | string Customer notes |
Array of objects (NameValue) Custom Fields | |
discount | number <float> |
estimatedTotal | number <float> |
exceptions | Array of strings References to exceptions related to the return |
expectedArrivalDate | string <date-time> Expected arrival date |
extReferenceId | string |
extReferenceUrl | string |
extReturnId | string Return ID on external system |
fulfillmentIntegrationId | string fulfillment integration Id |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
isExchange | boolean |
isGift | boolean |
Array of objects (ReturnLineItem) | |
locationId | string Destination location Id |
notes | string Merchant notes |
orgKey | string Organization this object belong to |
Array of objects (ReturnReceipt) | |
refundedAt | string <date-time> |
requiresShipping | boolean |
restockingFee | number <float> |
returnId | string Return ID |
object (Address) | |
shippingCarrier | string shipping carrier |
shippingLabelFee | number <float> |
shippingPrice | number <float> |
shippingQuote | number <float> |
shippingRefund | number <float> |
shippingService | string shipping service |
object (SourceDoc) Vendor source document | |
status | string Enum: "draft" "authorized" "shipped" "expected" "partialReceived" "received" "accepted" "refunded" "completed" "expired" "canceled" "deleted" "failed" Return status |
subTotal | number <float> |
tax | number <float> |
total | number <float> |
trackingNumber | string Tracking number |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "exceptions": [
- "string"
], - "extReferenceId": "string",
- "extReferenceUrl": "string",
- "integration": "string",
- "receipts": [
- {
- "extReceiptId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "returnId": "string",
- "status": "draft",
- "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerNotes": "string",
- "discount": 0,
- "estimatedTotal": 0,
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extReturnId": "string",
- "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isExchange": true,
- "isGift": true,
- "lineItems": [
- {
- "cause": "size",
- "extOrderId": "string",
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "action": "refund",
- "causeNote": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extShipmentId": "string",
- "itemCharge": 0,
- "itemDiscount": 0,
- "itemEstimatedTotal": 0,
- "itemLabelCost": 0,
- "itemRestockingFee": 0,
- "itemReturnShippingPaid": 0,
- "itemShippingCharge": 0,
- "itemTax": 0,
- "itemTotal": 0,
- "name": "string",
- "quantityDamaged": 0,
- "quantityExchanged": 0,
- "quantityReceived": 0,
- "quantityRefunded": 0,
- "quantityUnit": "each",
- "skuExchange": "string",
- "upc": "string",
- "upcExchange": "string"
}
], - "locationId": "string",
- "notes": "string",
- "refundedAt": "2019-08-24T14:15:22Z",
- "requiresShipping": true,
- "restockingFee": 0,
- "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",
- "shippingLabelFee": 0,
- "shippingPrice": 0,
- "shippingQuote": 0,
- "shippingRefund": 0,
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "subTotal": 0,
- "tax": 0,
- "total": 0,
- "trackingNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
arrivedAt | string <date-time> |
completedAt | string <date-time> |
currency | string Currency value, e.g. 'USD' |
customerNotes | string Customer notes |
Array of objects (NameValue) Custom Fields | |
discount | number <float> |
estimatedTotal | number <float> |
expectedArrivalDate | string <date-time> Expected arrival date |
extReturnId | string Return ID on external system |
fulfillmentIntegrationId | string fulfillment integration Id |
object (InternalInfo) Internal info | |
isExchange | boolean |
isGift | boolean |
Array of objects (ReturnLineItem) | |
locationId | string Destination location Id |
notes | string Merchant notes |
refundedAt | string <date-time> |
requiresShipping | boolean |
restockingFee | number <float> |
object (Address) | |
shippingCarrier | string shipping carrier |
shippingLabelFee | number <float> |
shippingPrice | number <float> |
shippingQuote | number <float> |
shippingRefund | number <float> |
shippingService | string shipping service |
object (SourceDoc) Vendor source document | |
status | string (ReturnStatus) Enum: "draft" "authorized" "shipped" "expected" "partialReceived" "received" "accepted" "refunded" "completed" "expired" "canceled" "deleted" "failed" Return status |
subTotal | number <float> |
tax | number <float> |
total | number <float> |
trackingNumber | string Tracking number |
{- "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerNotes": "string",
- "discount": 0,
- "estimatedTotal": 0,
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extReturnId": "string",
- "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isExchange": true,
- "isGift": true,
- "lineItems": [
- {
- "cause": "size",
- "extOrderId": "string",
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "action": "refund",
- "causeNote": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extShipmentId": "string",
- "itemCharge": 0,
- "itemDiscount": 0,
- "itemEstimatedTotal": 0,
- "itemLabelCost": 0,
- "itemRestockingFee": 0,
- "itemReturnShippingPaid": 0,
- "itemShippingCharge": 0,
- "itemTax": 0,
- "itemTotal": 0,
- "name": "string",
- "quantityDamaged": 0,
- "quantityExchanged": 0,
- "quantityReceived": 0,
- "quantityRefunded": 0,
- "quantityUnit": "each",
- "skuExchange": "string",
- "upc": "string",
- "upcExchange": "string"
}
], - "locationId": "string",
- "notes": "string",
- "refundedAt": "2019-08-24T14:15:22Z",
- "requiresShipping": true,
- "restockingFee": 0,
- "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",
- "shippingLabelFee": 0,
- "shippingPrice": 0,
- "shippingQuote": 0,
- "shippingRefund": 0,
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "subTotal": 0,
- "tax": 0,
- "total": 0,
- "trackingNumber": "string"
}
{- "code": 200,
- "success": true,
- "return": {
- "exceptions": [
- "string"
], - "extReferenceId": "string",
- "extReferenceUrl": "string",
- "integration": "string",
- "receipts": [
- {
- "extReceiptId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "returnId": "string",
- "status": "draft",
- "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerNotes": "string",
- "discount": 0,
- "estimatedTotal": 0,
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extReturnId": "string",
- "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isExchange": true,
- "isGift": true,
- "lineItems": [
- {
- "cause": "size",
- "extOrderId": "string",
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "action": "refund",
- "causeNote": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extShipmentId": "string",
- "itemCharge": 0,
- "itemDiscount": 0,
- "itemEstimatedTotal": 0,
- "itemLabelCost": 0,
- "itemRestockingFee": 0,
- "itemReturnShippingPaid": 0,
- "itemShippingCharge": 0,
- "itemTax": 0,
- "itemTotal": 0,
- "name": "string",
- "quantityDamaged": 0,
- "quantityExchanged": 0,
- "quantityReceived": 0,
- "quantityRefunded": 0,
- "quantityUnit": "each",
- "skuExchange": "string",
- "upc": "string",
- "upcExchange": "string"
}
], - "locationId": "string",
- "notes": "string",
- "refundedAt": "2019-08-24T14:15:22Z",
- "requiresShipping": true,
- "restockingFee": 0,
- "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",
- "shippingLabelFee": 0,
- "shippingPrice": 0,
- "shippingQuote": 0,
- "shippingRefund": 0,
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "subTotal": 0,
- "tax": 0,
- "total": 0,
- "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 Delete at most this many returns |
deleted | boolean Delete soft deleted returns |
extReturnId | Array of strings Delete returns by list of external return ids |
integration | Array of strings Delete returns of these integrations |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete returns assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
returnId | Array of strings Delete returns by list of returnId |
since | string <date-time> Delete returns created after this date-time |
skip | integer <int32> Default: 0 Skip this many returns |
status | Array of strings (ReturnStatus) Items Enum: "draft" "authorized" "shipped" "expected" "partialReceived" "received" "accepted" "refunded" "completed" "expired" "canceled" "deleted" "failed" |
until | string <date-time> Delete returns created before this date-time |
updatedSince | string <date-time> Delete returns updated after this date-time |
updatedUntil | string <date-time> Delete returns 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"
], - "extReturnId": [
- "string"
], - "locationId": [
- "string"
], - "returnId": [
- "string"
], - "status": [
- "draft"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "returns": [
- {
- "exceptions": [
- "string"
], - "extReferenceId": "string",
- "extReferenceUrl": "string",
- "integration": "string",
- "receipts": [
- {
- "extReceiptId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "returnId": "string",
- "status": "draft",
- "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerNotes": "string",
- "discount": 0,
- "estimatedTotal": 0,
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extReturnId": "string",
- "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isExchange": true,
- "isGift": true,
- "lineItems": [
- {
- "cause": "size",
- "extOrderId": "string",
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "action": "refund",
- "causeNote": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extShipmentId": "string",
- "itemCharge": 0,
- "itemDiscount": 0,
- "itemEstimatedTotal": 0,
- "itemLabelCost": 0,
- "itemRestockingFee": 0,
- "itemReturnShippingPaid": 0,
- "itemShippingCharge": 0,
- "itemTax": 0,
- "itemTotal": 0,
- "name": "string",
- "quantityDamaged": 0,
- "quantityExchanged": 0,
- "quantityReceived": 0,
- "quantityRefunded": 0,
- "quantityUnit": "each",
- "skuExchange": "string",
- "upc": "string",
- "upcExchange": "string"
}
], - "locationId": "string",
- "notes": "string",
- "refundedAt": "2019-08-24T14:15:22Z",
- "requiresShipping": true,
- "restockingFee": 0,
- "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",
- "shippingLabelFee": 0,
- "shippingPrice": 0,
- "shippingQuote": 0,
- "shippingRefund": 0,
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "subTotal": 0,
- "tax": 0,
- "total": 0,
- "trackingNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
ReturnId 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,
- "return": {
- "exceptions": [
- "string"
], - "extReferenceId": "string",
- "extReferenceUrl": "string",
- "integration": "string",
- "receipts": [
- {
- "extReceiptId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "returnId": "string",
- "status": "draft",
- "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerNotes": "string",
- "discount": 0,
- "estimatedTotal": 0,
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extReturnId": "string",
- "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isExchange": true,
- "isGift": true,
- "lineItems": [
- {
- "cause": "size",
- "extOrderId": "string",
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "action": "refund",
- "causeNote": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extShipmentId": "string",
- "itemCharge": 0,
- "itemDiscount": 0,
- "itemEstimatedTotal": 0,
- "itemLabelCost": 0,
- "itemRestockingFee": 0,
- "itemReturnShippingPaid": 0,
- "itemShippingCharge": 0,
- "itemTax": 0,
- "itemTotal": 0,
- "name": "string",
- "quantityDamaged": 0,
- "quantityExchanged": 0,
- "quantityReceived": 0,
- "quantityRefunded": 0,
- "quantityUnit": "each",
- "skuExchange": "string",
- "upc": "string",
- "upcExchange": "string"
}
], - "locationId": "string",
- "notes": "string",
- "refundedAt": "2019-08-24T14:15:22Z",
- "requiresShipping": true,
- "restockingFee": 0,
- "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",
- "shippingLabelFee": 0,
- "shippingPrice": 0,
- "shippingQuote": 0,
- "shippingRefund": 0,
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "subTotal": 0,
- "tax": 0,
- "total": 0,
- "trackingNumber": "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 returns |
deleted | boolean Retrieve soft deleted returns |
emailAddr | Array of strings Retrieve by list of shippingAddress.email |
exceptionCategoryId | Array of strings Retrieve returns by list of categories of the return related exceptions |
exceptionType | Array of strings Retrieve returns by list of types of the return related exceptions ( |
extOrderId | Array of strings Retrieve returns by list of external order ids |
extReturnId | Array of strings Retrieve returns by list of external return ids |
hasSourceDoc | boolean Retrieve returns containing a source document |
keys | string Default: "returnId,extReturnId,status,createdAt,updatedAt,orgKey" Return these top-level fields |
locationId | Array of strings Retrieve returns by list of location ids |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
returnId | Array of strings Retrieve by list of returnId |
since | string <date-time> Returns created after this date-time |
skip | integer <int32> Default: 0 Skip this many returns |
status | Array of strings (ReturnStatus) Items Enum: "draft" "authorized" "shipped" "expected" "partialReceived" "received" "accepted" "refunded" "completed" "expired" "canceled" "deleted" "failed" |
until | string <date-time> Returns created before this date-time |
updatedSince | string <date-time> Returns updated after this date-time |
updatedUntil | string <date-time> Returns 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,
- "extOrderId": [
- "string"
], - "extReturnId": [
- "string"
], - "locationId": [
- "string"
], - "returnId": [
- "string"
], - "status": [
- "draft"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "returns": [
- {
- "exceptions": [
- "string"
], - "extReferenceId": "string",
- "extReferenceUrl": "string",
- "integration": "string",
- "receipts": [
- {
- "extReceiptId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "returnId": "string",
- "status": "draft",
- "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerNotes": "string",
- "discount": 0,
- "estimatedTotal": 0,
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extReturnId": "string",
- "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isExchange": true,
- "isGift": true,
- "lineItems": [
- {
- "cause": "size",
- "extOrderId": "string",
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "action": "refund",
- "causeNote": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extShipmentId": "string",
- "itemCharge": 0,
- "itemDiscount": 0,
- "itemEstimatedTotal": 0,
- "itemLabelCost": 0,
- "itemRestockingFee": 0,
- "itemReturnShippingPaid": 0,
- "itemShippingCharge": 0,
- "itemTax": 0,
- "itemTotal": 0,
- "name": "string",
- "quantityDamaged": 0,
- "quantityExchanged": 0,
- "quantityReceived": 0,
- "quantityRefunded": 0,
- "quantityUnit": "each",
- "skuExchange": "string",
- "upc": "string",
- "upcExchange": "string"
}
], - "locationId": "string",
- "notes": "string",
- "refundedAt": "2019-08-24T14:15:22Z",
- "requiresShipping": true,
- "restockingFee": 0,
- "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",
- "shippingLabelFee": 0,
- "shippingPrice": 0,
- "shippingQuote": 0,
- "shippingRefund": 0,
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "subTotal": 0,
- "tax": 0,
- "total": 0,
- "trackingNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
Uniqueness constraints within organization:
ReturnId required | string Id or |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
arrivedAt | string <date-time> |
completedAt | string <date-time> |
currency | string Currency value, e.g. 'USD' |
customerNotes | string Customer notes |
Array of objects (NameValue) Custom Fields | |
discount | number <float> |
estimatedTotal | number <float> |
expectedArrivalDate | string <date-time> Expected arrival date |
extReferenceId | string |
extReferenceUrl | string |
fulfillmentIntegrationId | string fulfillment integration Id |
object (InternalInfo) Internal info | |
isExchange | boolean |
isGift | boolean |
Array of objects (ReturnLineItem) | |
locationId | string Destination location Id |
notes | string Merchant notes |
Array of objects (ReturnReceipt) | |
refundedAt | string <date-time> |
requiresShipping | boolean |
restockingFee | number <float> |
object (Address) | |
shippingCarrier | string shipping carrier |
shippingLabelFee | number <float> |
shippingPrice | number <float> |
shippingQuote | number <float> |
shippingRefund | number <float> |
shippingService | string shipping service |
object (SourceDoc) Vendor source document | |
status | string (ReturnStatus) Enum: "draft" "authorized" "shipped" "expected" "partialReceived" "received" "accepted" "refunded" "completed" "expired" "canceled" "deleted" "failed" Return status |
subTotal | number <float> |
tax | number <float> |
total | number <float> |
trackingNumber | string Tracking number |
{- "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerNotes": "string",
- "discount": 0,
- "estimatedTotal": 0,
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extReferenceId": "string",
- "extReferenceUrl": "string",
- "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isExchange": true,
- "isGift": true,
- "lineItems": [
- {
- "cause": "size",
- "extOrderId": "string",
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "action": "refund",
- "causeNote": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extShipmentId": "string",
- "itemCharge": 0,
- "itemDiscount": 0,
- "itemEstimatedTotal": 0,
- "itemLabelCost": 0,
- "itemRestockingFee": 0,
- "itemReturnShippingPaid": 0,
- "itemShippingCharge": 0,
- "itemTax": 0,
- "itemTotal": 0,
- "name": "string",
- "quantityDamaged": 0,
- "quantityExchanged": 0,
- "quantityReceived": 0,
- "quantityRefunded": 0,
- "quantityUnit": "each",
- "skuExchange": "string",
- "upc": "string",
- "upcExchange": "string"
}
], - "locationId": "string",
- "notes": "string",
- "receipts": [
- {
- "extReceiptId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "refundedAt": "2019-08-24T14:15:22Z",
- "requiresShipping": true,
- "restockingFee": 0,
- "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",
- "shippingLabelFee": 0,
- "shippingPrice": 0,
- "shippingQuote": 0,
- "shippingRefund": 0,
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "draft",
- "subTotal": 0,
- "tax": 0,
- "total": 0,
- "trackingNumber": "string"
}
{- "code": 200,
- "success": true,
- "return": {
- "exceptions": [
- "string"
], - "extReferenceId": "string",
- "extReferenceUrl": "string",
- "integration": "string",
- "receipts": [
- {
- "extReceiptId": "string",
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityDamaged": 0,
- "quantityUnit": "each",
- "uniqueId": "string"
}
], - "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
]
}
], - "returnId": "string",
- "status": "draft",
- "arrivedAt": "2019-08-24T14:15:22Z",
- "completedAt": "2019-08-24T14:15:22Z",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "customerNotes": "string",
- "discount": 0,
- "estimatedTotal": 0,
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "extReturnId": "string",
- "fulfillmentIntegrationId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isExchange": true,
- "isGift": true,
- "lineItems": [
- {
- "cause": "size",
- "extOrderId": "string",
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "action": "refund",
- "causeNote": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "extShipmentId": "string",
- "itemCharge": 0,
- "itemDiscount": 0,
- "itemEstimatedTotal": 0,
- "itemLabelCost": 0,
- "itemRestockingFee": 0,
- "itemReturnShippingPaid": 0,
- "itemShippingCharge": 0,
- "itemTax": 0,
- "itemTotal": 0,
- "name": "string",
- "quantityDamaged": 0,
- "quantityExchanged": 0,
- "quantityReceived": 0,
- "quantityRefunded": 0,
- "quantityUnit": "each",
- "skuExchange": "string",
- "upc": "string",
- "upcExchange": "string"
}
], - "locationId": "string",
- "notes": "string",
- "refundedAt": "2019-08-24T14:15:22Z",
- "requiresShipping": true,
- "restockingFee": 0,
- "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",
- "shippingLabelFee": 0,
- "shippingPrice": 0,
- "shippingQuote": 0,
- "shippingRefund": 0,
- "shippingService": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "subTotal": 0,
- "tax": 0,
- "total": 0,
- "trackingNumber": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
extBoxId required | string External Box Id |
billOfLading | string |
boxId | string Box Id |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects or null (NameValue) Custom Fields | |
dimensionsUnit | string Enum: "cm" "in" "ft" Dimensions UOM |
height | number <float> Height |
object (InternalInfo) Internal info | |
labelId | Array of strings Label Ids |
length | number <float> Length |
Array of objects (ShipmentBoxLineItem) | |
orgKey | string Organization this object belong to |
shipmentId | string Shipment Id |
ssccCode | string |
status | string (ShipmentBoxStatus) Enum: "new" "packed" "reported" "labeled" "shipped" Box Status |
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 UOM |
width | number <float> Width |
{- "boxId": "string",
- "extBoxId": "string",
- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "labelId": [
- "string"
], - "length": 0,
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityUnit": "each"
}
], - "shipmentId": "string",
- "ssccCode": "string",
- "status": "new",
- "ucc128": "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:
extBoxId required | string External Box Id |
billOfLading | string |
Array of objects or null (NameValue) Custom Fields | |
dimensionsUnit | string Enum: "cm" "in" "ft" Dimensions UOM |
height | number <float> Height |
object (InternalInfo) Internal info | |
labelId | Array of strings Label Ids |
length | number <float> Length |
Array of objects (ShipmentBoxLineItem) | |
shipmentId | string Shipment Id |
ssccCode | string |
status | string (ShipmentBoxStatus) Enum: "new" "packed" "reported" "labeled" "shipped" Box Status |
ucc128 | string |
weight | number <float> Weight |
weightUnit | string Enum: "lb" "oz" "kg" "g" Weight UOM |
width | number <float> Width |
{- "extBoxId": "string",
- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "labelId": [
- "string"
], - "length": 0,
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityUnit": "each"
}
], - "shipmentId": "string",
- "ssccCode": "string",
- "status": "new",
- "ucc128": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0
}
{- "code": 200,
- "success": true,
- "box": {
- "boxId": "string",
- "extBoxId": "string",
- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "labelId": [
- "string"
], - "length": 0,
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityUnit": "each"
}
], - "shipmentId": "string",
- "ssccCode": "string",
- "status": "new",
- "ucc128": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
BoxId required | string Box Id to fetch |
{- "code": 200,
- "success": true,
- "box": {
- "boxId": "string",
- "extBoxId": "string",
- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "labelId": [
- "string"
], - "length": 0,
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityUnit": "each"
}
], - "shipmentId": "string",
- "ssccCode": "string",
- "status": "new",
- "ucc128": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
boxId | Array of strings Retrieve by list of boxId |
count | integer <int32> Default: 100 Return at most this many shipment boxes |
extBoxId | Array of strings Retrieve shipment by list of extBoxId |
keys | string Default: "boxId,extBoxId,shipmentId,createdAt,updatedAt,orgKey,status" 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 |
shipmentId | Array of strings Retrieve shipment by list of shipmentId |
since | string <date-time> Shipment boxes created after this date-time |
skip | integer <int32> Default: 0 Skip this many shipment boxes |
status | Array of strings (ShipmentBoxStatus) Items Enum: "new" "packed" "reported" "labeled" "shipped" |
until | string <date-time> Shipment boxes created before this date-time |
updatedSince | string <date-time> Shipment boxes updated after this date-time |
updatedUntil | string <date-time> Shipment boxes updated before this date-time |
{- "code": 200,
- "success": true,
- "boxes": [
- {
- "boxId": "string",
- "extBoxId": "string",
- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "labelId": [
- "string"
], - "length": 0,
- "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "quantityUnit": "each"
}
], - "shipmentId": "string",
- "ssccCode": "string",
- "status": "new",
- "ucc128": "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",
- "boxId": [
- "string"
], - "extBoxId": [
- "string"
], - "shipmentId": [
- "string"
], - "status": [
- "new"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Uniqueness constraints within organization:
BoxId required | string Box Id to update |
billOfLading | string |
Array of objects or null (NameValue) Custom Fields | |
dimensionsUnit | string Enum: "cm" "in" "ft" Dimensions UOM |
height | number <float> Height |
object (InternalInfo) Internal info | |
labelId | Array of strings Label Ids |
length | number <float> Length |
Array of objects (ShipmentBoxUpdateLineItem) | |
shipmentId | string Shipment Id |
ssccCode | string |
status | string (ShipmentBoxStatus) Enum: "new" "packed" "reported" "labeled" "shipped" Box Status |
ucc128 | string |
weight | number <float> Weight |
weightUnit | string Enum: "lb" "oz" "kg" "g" Weight UOM |
width | number <float> Width |
{- "billOfLading": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "dimensionsUnit": "cm",
- "height": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "labelId": [
- "string"
], - "length": 0,
- "lineItems": [
- {
- "quantity": 0,
- "quantityUnit": "each",
- "sku": "string"
}
], - "shipmentId": "string",
- "ssccCode": "string",
- "status": "new",
- "ucc128": "string",
- "weight": 0,
- "weightUnit": "lb",
- "width": 0
}
{- "code": 200,
- "success": true
}
sourceType required | string (ShippingMethodSourceType) Enum: "logistics" "ecommerce" "finance" Shipping Source type |
createdAt | string <date-time> When the object was created within Pipe17 |
description | string Shipping method description |
extMethodId | string Shipping method external Id |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
isDefault | boolean Marks shipping method as default for given sourceIntegrationId |
isPassthrough | boolean Marks shipping method as passthrough for given sourceIntegrationId |
Array of objects (ShippingMethodMapping) List of mapped methods | |
methodId | string Shipping Method ID |
name | string Shipping method name |
orgKey | string Organization this object belong to |
shippingCarrier | string Shipping carrier |
shippingCode | string Shipping code |
shippingService | string Shipping service |
sourceIntegrationId | string Shipping method source integrationId |
status | string (ShippingMethodStatus) Enum: "active" "inactive" "deleted" Shipping Method status |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "integration": "string",
- "methodId": "string",
- "sourceType": "logistics",
- "description": "string",
- "extMethodId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": true,
- "isPassthrough": true,
- "mappedMethods": [
- {
- "methodId": "string"
}
], - "name": "string",
- "shippingCarrier": "string",
- "shippingCode": "string",
- "shippingService": "string",
- "sourceIntegrationId": "string",
- "status": "active",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
sourceType required | string (ShippingMethodSourceType) Enum: "logistics" "ecommerce" "finance" Shipping Source type |
description | string Shipping method description |
extMethodId | string Shipping method external Id |
object (InternalInfo) Internal info | |
isDefault | boolean Marks shipping method as default for given sourceIntegrationId |
isPassthrough | boolean Marks shipping method as passthrough for given sourceIntegrationId |
Array of objects (ShippingMethodMapping) List of mapped methods | |
name | string Shipping method name |
shippingCarrier | string Shipping carrier |
shippingCode | string Shipping code |
shippingService | string Shipping service |
sourceIntegrationId | string Shipping method source integrationId |
status | string (ShippingMethodStatus) Enum: "active" "inactive" "deleted" Shipping Method status |
[- {
- "sourceType": "logistics",
- "description": "string",
- "extMethodId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": true,
- "isPassthrough": true,
- "mappedMethods": [
- {
- "methodId": "string"
}
], - "name": "string",
- "shippingCarrier": "string",
- "shippingCode": "string",
- "shippingService": "string",
- "sourceIntegrationId": "string",
- "status": "active"
}
]
{- "code": 200,
- "success": true,
- "methods": [
- {
- "code": 0,
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "method": {
- "integration": "string",
- "methodId": "string",
- "sourceType": "logistics",
- "description": "string",
- "extMethodId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": true,
- "isPassthrough": true,
- "mappedMethods": [
- {
- "methodId": "string"
}
], - "name": "string",
- "shippingCarrier": "string",
- "shippingCode": "string",
- "shippingService": "string",
- "sourceIntegrationId": "string",
- "status": "active",
- "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 shipping methods |
methodId | Array of strings Delete shipping methods by list of methodId |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete shipping methods assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Delete shipping methods created after this date-time |
skip | integer <int32> Default: 0 Skip this many shipping methods |
until | string <date-time> Delete shipping methods created before this date-time |
updatedSince | string <date-time> Delete shipping methods updated after this date-time |
updatedUntil | string <date-time> Delete shipping methods 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",
- "methodId": [
- "string"
], - "orgMode": [
- "sandbox"
], - "source": [
- "string"
], - "sourceIntegrationId": [
- "string"
]
}, - "methods": [
- {
- "integration": "string",
- "methodId": "string",
- "sourceType": "logistics",
- "description": "string",
- "extMethodId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": true,
- "isPassthrough": true,
- "mappedMethods": [
- {
- "methodId": "string"
}
], - "name": "string",
- "shippingCarrier": "string",
- "shippingCode": "string",
- "shippingService": "string",
- "sourceIntegrationId": "string",
- "status": "active",
- "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
}
}
MethodId required | string Id or |
{- "code": 200,
- "success": true,
- "method": {
- "integration": "string",
- "methodId": "string",
- "sourceType": "logistics",
- "description": "string",
- "extMethodId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": true,
- "isPassthrough": true,
- "mappedMethods": [
- {
- "methodId": "string"
}
], - "name": "string",
- "shippingCarrier": "string",
- "shippingCode": "string",
- "shippingService": "string",
- "sourceIntegrationId": "string",
- "status": "active",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many shipping methods |
isDefault | boolean Shipping method default flag |
isPassthrough | boolean Shipping method passthrough flag |
keys | string Default: "methodId,name,createdAt,updatedAt,orgKey" Return these top-level fields |
mappedMethodId | Array of strings Mapped shipping method Ids |
methodId | Array of strings Retrieve by list of methodId |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
shippingCarrier | Array of strings Retrieve by list of shipping carriers |
shippingCode | Array of strings Retrieve by list of shipping codes |
shippingService | Array of strings Retrieve by list of shipping services |
since | string <date-time> Shipping Methods created after this date-time |
skip | integer <int32> Default: 0 Skip this many shipping methods |
sourceIntegrationId | Array of strings Shipping method source IntegrationIds |
sourceType | Array of strings (ShippingMethodSourceType) Items Enum: "logistics" "ecommerce" "finance" Shipping method source types |
status | Array of strings (ShippingMethodStatus) Items Enum: "active" "inactive" "deleted" Shipping method statuses |
until | string <date-time> Shipping Methods created before this date-time |
updatedSince | string <date-time> Shipping Methods updated after this date-time |
updatedUntil | string <date-time> Shipping Methods 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",
- "methodId": [
- "string"
], - "keys": "string",
- "order": "string",
- "isDefault": true,
- "isPassthrough": true,
- "mappedMethodId": [
- "string"
], - "shippingCarrier": [
- "string"
], - "shippingCode": [
- "string"
], - "shippingService": [
- "string"
], - "sourceIntegrationId": [
- "string"
], - "sourceType": [
- "logistics"
], - "status": [
- "active"
]
}, - "methods": [
- {
- "integration": "string",
- "methodId": "string",
- "sourceType": "logistics",
- "description": "string",
- "extMethodId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": true,
- "isPassthrough": true,
- "mappedMethods": [
- {
- "methodId": "string"
}
], - "name": "string",
- "shippingCarrier": "string",
- "shippingCode": "string",
- "shippingService": "string",
- "sourceIntegrationId": "string",
- "status": "active",
- "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:
MethodId required | string Id or |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
description | string Shipping method description |
object (InternalInfo) Internal info | |
isDefault | boolean Marks shipping method as default for given sourceIntegrationId |
isPassthrough | boolean Marks shipping method as passthrough for given sourceIntegrationId |
Array of objects or null (ShippingMethodMapping) List of mapped methods | |
name | string Shipping method name |
shippingCarrier | string or null Shipping carrier |
shippingCode | string or null Shipping code |
shippingService | string or null Shipping service |
status | string (ShippingMethodStatus) Enum: "active" "inactive" "deleted" Shipping Method status |
{- "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": true,
- "isPassthrough": true,
- "mappedMethods": [
- {
- "methodId": "string"
}
], - "name": "string",
- "shippingCarrier": "string",
- "shippingCode": "string",
- "shippingService": "string",
- "status": "active"
}
{- "code": 200,
- "success": true,
- "method": {
- "integration": "string",
- "methodId": "string",
- "sourceType": "logistics",
- "description": "string",
- "extMethodId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": true,
- "isPassthrough": true,
- "mappedMethods": [
- {
- "methodId": "string"
}
], - "name": "string",
- "shippingCarrier": "string",
- "shippingCode": "string",
- "shippingService": "string",
- "sourceIntegrationId": "string",
- "status": "active",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
Operations with shipping requests. The obsolete /shipments
path will be supported along with /shipping_requests
until further notice.
extOrderId required | string Customer friendly ID on the order object |
required | object (Address) |
autoEngUpdateStatus | string (AutoEngUpdateStatus) Enum: "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 |
canceledAt | string <date-time> The cancellation date |
canceledBy | string The cancel requester Id |
canceledByType | string Enum: "user" "integration" "apikey" The cancel requester Id type |
cancellationStatus | string (ShipmentCancellationStatus) Enum: "pending" "accepted" "rejected" Shipping request cancellation status |
createdAt | string <date-time> When the object was created within Pipe17 |
currency | string Currency code (inherited from order) |
Array of objects (NameValue) Custom Fields | |
exceptions | Array of strings References to exceptions related to the shipment |
expectedDeliveryDate | string <date-time> First Priority to be respected |
expectedShipDate | string <date-time> Expected ship date |
extOrderApiId | string External System Order API ID |
extReferenceId | string Customer Friendly reference to this shipping request on destination vendor |
extReferenceUrl | string Direct link to this shipping request on destination vendor |
extShipmentId | string Customer Friendly reference to this shipping request on originating vendor, auto generated if not provided |
fulfillmentIntegrationId | string Destination of this shipping request |
giftNote | string Shipping Gift note |
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 (ShipmentLineItem) | |
locationId | string Id of location defined in organization |
orderCreateTime | string <date-time> Create time of linked order |
orderId | string Pipe17 Internal Order's orderId |
orderIntegration | string Reference to integration that created order tied to an item |
orderSource | string Actual Order source, Walmart, Etsy, etc |
orderSourceType | string (OrderType) Enum: "online" "pos" "wholesale" "edi" "other" "b2b" Order Type (online, pos, etc) |
orderType | string (ShipmentOrderType) Enum: "sales" "transfer" "purchase" Type of order that initiated this shipping request |
orgKey | string Organization this object belong to |
overfulfillPolicy | string (OverfulfillPolicy) Enum: "strict" "report" "approved" Overfulfill policy |
reused | boolean Indicates the shipment's extShipmentId is being reused in another one |
sentToFulfillmentAt | string <date-time> Sent to fulfillment timestamp |
shipAfterDate | string <date-time> Ship After Date |
shipByDate | string <date-time> Ship By Date |
shipCancelByDate | string <date-time> Ship Cancel By Date |
shipmentId | string Shipment ID |
shippingCarrier | string Required with ShippingClass, 2nd Priority |
shippingClass | string Required with ShippingCarrier, 2nd Priority |
shippingCode | string 1st Priority |
shippingLabels | Array of strings Shipping Labels |
shippingMethodMapping | boolean Enable shipping method mapping (defaults to company setting if not provided) |
shippingNote | string Shipping Note |
shippingPrice | number <float> Shipping price |
skipLocation | boolean A flag to indicate the location in this SR should be skipped during rerun-routing |
object (SourceDoc) Vendor source document | |
status | string Enum: "new" "pendingInventory" "pendingShippingLabel" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "fulfilled" "partialFulfillment" "canceled" "canceledRestock" "failed" "onHold" Shipping request Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
Array of ArrivalChangelogEntry (object) or FulfillmentChangelogEntry (object) or ReceiptChangelogEntry (object) or ShipmentChangelogEntry (object) (ChangelogEntry) Timeline of updates | |
updatedAt | string <date-time> When the object was updated within Pipe17 |
version | number Shipping request ordinal number - each new shipping request will have this value incremented for the same orderId |
{- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "canceledBy": "string",
- "canceledByType": "user",
- "cancellationStatus": "pending",
- "exceptions": [
- "string"
], - "extOrderApiId": "string",
- "integration": "string",
- "orderIntegration": "string",
- "reused": true,
- "sentToFulfillmentAt": "2019-08-24T14:15:22Z",
- "shipmentId": "string",
- "status": "new",
- "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"
}
], - "version": 0,
- "extOrderId": "string",
- "shippingAddress": {
- "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"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "extReferenceId": "string",
- "extReferenceUrl": "string",
- "extShipmentId": "string",
- "fulfillmentIntegrationId": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "bundleQuantity": 0,
- "bundleSKU": "string",
- "bundleUPC": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "name": "string",
- "quantityUnit": "each",
- "shippedQuantity": 0,
- "trackedAtSourceChannel": true,
- "upc": "string"
}
], - "locationId": "string",
- "orderCreateTime": "2019-08-24T14:15:22Z",
- "orderId": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderType": "sales",
- "overfulfillPolicy": "strict",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingLabels": [
- "string"
], - "shippingMethodMapping": true,
- "shippingNote": "string",
- "shippingPrice": 0,
- "skipLocation": true,
- "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:
extOrderId required | string Customer friendly ID on the order object |
required | object (Address) |
currency | string Currency code (inherited from order) |
Array of objects (NameValue) Custom Fields | |
expectedDeliveryDate | string <date-time> First Priority to be respected |
expectedShipDate | string <date-time> Expected ship date |
extReferenceId | string Customer Friendly reference to this shipping request on destination vendor |
extReferenceUrl | string Direct link to this shipping request on destination vendor |
extShipmentId | string Customer Friendly reference to this shipping request on originating vendor, auto generated if not provided |
fulfillmentIntegrationId | string Destination of this shipping request |
giftNote | string Shipping Gift note |
holdUntil | string <date-time> |
incoterms | string International Commercial Terms |
object (InternalInfo) Internal info | |
Array of objects (ShipmentLineItem) | |
locationId | string Id of location defined in organization |
orderCreateTime | string <date-time> Create time of linked order |
orderId | string Pipe17 Internal Order's orderId |
orderSource | string Actual Order source, Walmart, Etsy, etc |
orderSourceType | string (OrderType) Enum: "online" "pos" "wholesale" "edi" "other" "b2b" Order Type (online, pos, etc) |
orderType | string (ShipmentOrderType) Enum: "sales" "transfer" "purchase" Type of order that initiated this shipping request |
overfulfillPolicy | string (OverfulfillPolicy) Enum: "strict" "report" "approved" Overfulfill policy |
shipAfterDate | string <date-time> Ship After Date |
shipByDate | string <date-time> Ship By Date |
shipCancelByDate | string <date-time> Ship Cancel By Date |
shippingCarrier | string Required with ShippingClass, 2nd Priority |
shippingClass | string Required with ShippingCarrier, 2nd Priority |
shippingCode | string 1st Priority |
shippingLabels | Array of strings Shipping Labels |
shippingMethodMapping | boolean Enable shipping method mapping (defaults to company setting if not provided) |
shippingNote | string Shipping Note |
shippingPrice | number <float> Shipping price |
skipLocation | boolean A flag to indicate the location in this SR should be skipped during rerun-routing |
object (SourceDoc) Vendor source document | |
status | string (ShipmentCreateStatus) Enum: "new" "pendingInventory" "pendingShippingLabel" "reviewRequired" "readyForFulfillment" Shipment Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
[- {
- "extOrderId": "string",
- "shippingAddress": {
- "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"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "extReferenceId": "string",
- "extReferenceUrl": "string",
- "extShipmentId": "string",
- "fulfillmentIntegrationId": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "bundleQuantity": 0,
- "bundleSKU": "string",
- "bundleUPC": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "name": "string",
- "quantityUnit": "each",
- "shippedQuantity": 0,
- "trackedAtSourceChannel": true,
- "upc": "string"
}
], - "locationId": "string",
- "orderCreateTime": "2019-08-24T14:15:22Z",
- "orderId": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderType": "sales",
- "overfulfillPolicy": "strict",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingLabels": [
- "string"
], - "shippingMethodMapping": true,
- "shippingNote": "string",
- "shippingPrice": 0,
- "skipLocation": true,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "new",
- "tags": [
- "string"
]
}
]
{- "code": 200,
- "success": true,
- "shipments": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "shipment": {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "canceledBy": "string",
- "canceledByType": "user",
- "cancellationStatus": "pending",
- "exceptions": [
- "string"
], - "extOrderApiId": "string",
- "integration": "string",
- "orderIntegration": "string",
- "reused": true,
- "sentToFulfillmentAt": "2019-08-24T14:15:22Z",
- "shipmentId": "string",
- "status": "new",
- "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"
}
], - "version": 0,
- "extOrderId": "string",
- "shippingAddress": {
- "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"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "extReferenceId": "string",
- "extReferenceUrl": "string",
- "extShipmentId": "string",
- "fulfillmentIntegrationId": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "bundleQuantity": 0,
- "bundleSKU": "string",
- "bundleUPC": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "name": "string",
- "quantityUnit": "each",
- "shippedQuantity": 0,
- "trackedAtSourceChannel": true,
- "upc": "string"
}
], - "locationId": "string",
- "orderCreateTime": "2019-08-24T14:15:22Z",
- "orderId": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderType": "sales",
- "overfulfillPolicy": "strict",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingLabels": [
- "string"
], - "shippingMethodMapping": true,
- "shippingNote": "string",
- "shippingPrice": 0,
- "skipLocation": true,
- "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"
}
]
}
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 shipping requests |
deleted | boolean Soft deleted shipping requests |
extOrderId | Array of strings Shipping requests by list of External Order Ids |
integration | Array of strings Shipping requests of these integrations |
orderId | Array of strings Shipping requests by list of Pipe17 Order Ids |
orderType | Array of strings (ShipmentOrderType) Items Enum: "sales" "transfer" "purchase" Shipping requests by list of order types |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete shipping requests assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
shipmentId | Array of strings Shipping requests by list of shipmentId |
since | string <date-time> Shipping requests created after this date-time |
skip | integer <int32> Default: 0 Skip this many shipping requests |
status | Array of strings (ShipmentStatus) Items Enum: "new" "pendingInventory" "pendingShippingLabel" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "fulfilled" "partialFulfillment" "canceled" "canceledRestock" "failed" "onHold" Shipping requests by list of statuses |
until | string <date-time> Shipping requests created before this date-time |
updatedSince | string <date-time> Shipping requests updated after this date-time |
updatedUntil | string <date-time> Shipping requests updated before this date-time |
version | number Shipping requests by version number |
{- "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",
- "cancellationStatus": [
- "pending"
], - "deleted": true,
- "emailAddr": [
- "string"
], - "extOrderId": [
- "string"
], - "extReferenceId": [
- "string"
], - "extShipmentId": [
- "string"
], - "fulfillmentIntegrationId": [
- "string"
], - "locationId": [
- "string"
], - "orderId": [
- "string"
], - "orderType": [
- "string"
], - "shipmentId": [
- "string"
], - "status": [
- "new"
], - "version": 0,
- "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "shipments": [
- {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "canceledBy": "string",
- "canceledByType": "user",
- "cancellationStatus": "pending",
- "exceptions": [
- "string"
], - "extOrderApiId": "string",
- "integration": "string",
- "orderIntegration": "string",
- "reused": true,
- "sentToFulfillmentAt": "2019-08-24T14:15:22Z",
- "shipmentId": "string",
- "status": "new",
- "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"
}
], - "version": 0,
- "extOrderId": "string",
- "shippingAddress": {
- "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"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "extReferenceId": "string",
- "extReferenceUrl": "string",
- "extShipmentId": "string",
- "fulfillmentIntegrationId": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "bundleQuantity": 0,
- "bundleSKU": "string",
- "bundleUPC": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "name": "string",
- "quantityUnit": "each",
- "shippedQuantity": 0,
- "trackedAtSourceChannel": true,
- "upc": "string"
}
], - "locationId": "string",
- "orderCreateTime": "2019-08-24T14:15:22Z",
- "orderId": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderType": "sales",
- "overfulfillPolicy": "strict",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingLabels": [
- "string"
], - "shippingMethodMapping": true,
- "shippingNote": "string",
- "shippingPrice": 0,
- "skipLocation": true,
- "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"
}
]
}
ShipmentId required | string Id, |
nested | boolean Delete nested entities |
{- "code": 200,
- "success": true
}
ShipmentId 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,
- "shipment": {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "canceledBy": "string",
- "canceledByType": "user",
- "cancellationStatus": "pending",
- "exceptions": [
- "string"
], - "extOrderApiId": "string",
- "integration": "string",
- "orderIntegration": "string",
- "reused": true,
- "sentToFulfillmentAt": "2019-08-24T14:15:22Z",
- "shipmentId": "string",
- "status": "new",
- "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"
}
], - "version": 0,
- "extOrderId": "string",
- "shippingAddress": {
- "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"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "extReferenceId": "string",
- "extReferenceUrl": "string",
- "extShipmentId": "string",
- "fulfillmentIntegrationId": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "bundleQuantity": 0,
- "bundleSKU": "string",
- "bundleUPC": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "name": "string",
- "quantityUnit": "each",
- "shippedQuantity": 0,
- "trackedAtSourceChannel": true,
- "upc": "string"
}
], - "locationId": "string",
- "orderCreateTime": "2019-08-24T14:15:22Z",
- "orderId": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderType": "sales",
- "overfulfillPolicy": "strict",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingLabels": [
- "string"
], - "shippingMethodMapping": true,
- "shippingNote": "string",
- "shippingPrice": 0,
- "skipLocation": true,
- "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"
}
}
autoEngUpdateStatus | Array of strings (AutoEngUpdateStatus) Items Enum: "pending" "updated" "none" |
autoEngUpdateStatusUpdatedSince | string <date-time> Fetch all shipping requests with autoEngUpdateStatus updated after this date-time |
autoEngUpdateStatusUpdatedUntil | string <date-time> Fetch all shipping requests with autoEngUpdateStatus updated before this date-time |
cancellationStatus | Array of strings (ShipmentCancellationStatus) Items Enum: "pending" "accepted" "rejected" |
count | integer <int32> Default: 100 Return at most this many shipping requests |
deleted | boolean Soft deleted shipping requests |
emailAddr | Array of strings Shipping requests by list of shippingAddress.email |
exceptionCategoryId | Array of strings Shipping requests by list of categories of the request related exceptions |
exceptionType | Array of strings Shipping requests by list of types of the request related exceptions ( |
extOrderId | Array of strings Shipping requests by list of External Order Ids |
extReferenceId | Array of strings Shipping requests by list of extReferenceId |
extShipmentId | Array of strings Shipping requests by list of extShipmentId |
fulfillmentIntegrationId | Array of strings Shipping requests by list of fulfillmentIntegrationId |
hasSourceDoc | boolean Shipping requests containing a source document |
holdUntilSince | string <date-time> Fetch all shipping requests with holdUntil after or at this date-time. Rounded down to the nearest minute |
holdUntilUntil | string <date-time> Fetch all shipping requests with holdUntil before or at this date-time. Rounded down to the nearest minute |
keys | string Default: "shipmentId,status,extShipmentId,extReferenceId,orderId,extOrderId,orderType,orderCreateTime,shipByDate,expectedDeliveryDate,sentToFulfillmentAt,tags,createdAt,updatedAt,orgKey,version" Return these top-level fields |
locationId | Array of strings Shipping requests by list of locationId |
order | string Default: "createdAt" Sort by these top-level fields |
orderId | Array of strings Shipping requests by list of Pipe17 Order Ids |
orderType | Array of strings (ShipmentOrderType) Items Enum: "sales" "transfer" "purchase" Shipping requests by list of order types |
pagination | string Value: "disabled" Exclude pagination info from the response |
shipmentId | Array of strings Shipping requests by list of shipmentId |
since | string <date-time> Shipping requests created after this date-time |
skip | integer <int32> Default: 0 Skip this many shipping requests |
status | Array of strings (ShipmentStatus) Items Enum: "new" "pendingInventory" "pendingShippingLabel" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "fulfilled" "partialFulfillment" "canceled" "canceledRestock" "failed" "onHold" Shipping requests by list of statuses |
until | string <date-time> Shipping requests created before this date-time |
updatedSince | string <date-time> Shipping requests updated after this date-time |
updatedUntil | string <date-time> Shipping requests updated before this date-time |
version | number Shipping requests by version number |
{- "code": 200,
- "success": true,
- "shipments": [
- {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "canceledBy": "string",
- "canceledByType": "user",
- "cancellationStatus": "pending",
- "exceptions": [
- "string"
], - "extOrderApiId": "string",
- "integration": "string",
- "orderIntegration": "string",
- "reused": true,
- "sentToFulfillmentAt": "2019-08-24T14:15:22Z",
- "shipmentId": "string",
- "status": "new",
- "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"
}
], - "version": 0,
- "extOrderId": "string",
- "shippingAddress": {
- "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"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "extReferenceId": "string",
- "extReferenceUrl": "string",
- "extShipmentId": "string",
- "fulfillmentIntegrationId": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "bundleQuantity": 0,
- "bundleSKU": "string",
- "bundleUPC": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "name": "string",
- "quantityUnit": "each",
- "shippedQuantity": 0,
- "trackedAtSourceChannel": true,
- "upc": "string"
}
], - "locationId": "string",
- "orderCreateTime": "2019-08-24T14:15:22Z",
- "orderId": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderType": "sales",
- "overfulfillPolicy": "strict",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingLabels": [
- "string"
], - "shippingMethodMapping": true,
- "shippingNote": "string",
- "shippingPrice": 0,
- "skipLocation": true,
- "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"
}
], - "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",
- "cancellationStatus": [
- "pending"
], - "deleted": true,
- "emailAddr": [
- "string"
], - "extOrderId": [
- "string"
], - "extReferenceId": [
- "string"
], - "extShipmentId": [
- "string"
], - "fulfillmentIntegrationId": [
- "string"
], - "locationId": [
- "string"
], - "orderId": [
- "string"
], - "orderType": [
- "string"
], - "shipmentId": [
- "string"
], - "status": [
- "new"
], - "version": 0
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Trigger the shipping requests sync
ShipmentId required | Array of strings |
syncAE | boolean Reset autoEngUpdateStatus |
{- "syncAE": true
}
{- "code": 200,
- "success": true
}
Uniqueness constraints within organization:
ShipmentId required | string Shipping Request Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
autoEngUpdateStatus | string (AutoEngUpdateStatus) Enum: "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:
|
cancellationStatus | string (ShipmentCancellationStatus) Enum: "pending" "accepted" "rejected" Shipping request cancellation status |
currency | string Currency code (updating is prohibited if the SR status is in [ |
Array of objects (NameValue) Custom Fields | |
expectedDeliveryDate | string <date-time> First Priority to be respected (updating is prohibited if the SR status is in [ |
expectedShipDate | string <date-time> Expected ship date (updating is prohibited if the SR status is in [ |
extReferenceId | string Customer Friendly reference to this shipping request on destination vendor |
extReferenceUrl | string Direct link to this shipping request on destination vendor |
extShipmentId | string Customer Friendly reference to this shipping request on originating vendor, auto generated if not provided |
giftNote | string Shipping Gift note |
holdUntil | string or null <date-time> |
incoterms | string International Commercial Terms (updating is prohibited if the SR status is in [ |
object (InternalInfo) Internal info | |
Array of objects (ShipmentUpdateLineItem) | |
locationId | string Id of location defined in organization (can be updated only if the SR is sentToFulfillment already) |
overfulfillPolicy | string (OverfulfillPolicy) Enum: "strict" "report" "approved" Overfulfill policy |
shipAfterDate | string <date-time> Ship After Date |
shipByDate | string <date-time> Ship By Date (updating is prohibited if the SR status is in [ |
shipCancelByDate | string or null <date-time> Ship Cancel By Date |
object (AddressUpdateData) | |
shippingCarrier | string Required with ShippingClass, 2nd Priority (updating is prohibited if the SR status is in [ |
shippingClass | string Required with ShippingCarrier, 2nd Priority (updating is prohibited if the SR status is in [ |
shippingCode | string 1st Priority (updating is prohibited if the SR status is in [ |
shippingLabels | Array of strings Shipping Labels (updating is prohibited if the SR status is in [ |
shippingMethodMapping | boolean Enable shipping method mapping (defaults to company setting if not provided) |
shippingNote | string Shipping Note (updating is prohibited if the SR status is in [ |
shippingPrice | number <float> Shipping price (updating is prohibited if the SR status is in [ |
skipLocation | boolean A flag to indicate the location in this SR should be skipped during rerun-routing |
object (SourceDoc) Vendor source document | |
status | string (ShipmentStatus) Enum: "new" "pendingInventory" "pendingShippingLabel" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "fulfilled" "partialFulfillment" "canceled" "canceledRestock" "failed" "onHold" Shipping request Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
{- "autoEngUpdateStatus": "pending",
- "cancellationStatus": "pending",
- "currency": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "extReferenceId": "string",
- "extReferenceUrl": "string",
- "extShipmentId": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "bundleQuantity": 0,
- "bundleSKU": "string",
- "bundleUPC": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "name": "string",
- "quantityUnit": "each",
- "shippedQuantity": 0,
- "sku": "string",
- "trackedAtSourceChannel": true,
- "upc": "string"
}
], - "locationId": "string",
- "overfulfillPolicy": "strict",
- "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",
- "shippingLabels": [
- "string"
], - "shippingMethodMapping": true,
- "shippingNote": "string",
- "shippingPrice": 0,
- "skipLocation": true,
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}, - "status": "new",
- "tags": [
- "string"
]
}
{- "code": 200,
- "success": true,
- "shipment": {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "canceledAt": "2019-08-24T14:15:22Z",
- "canceledBy": "string",
- "canceledByType": "user",
- "cancellationStatus": "pending",
- "exceptions": [
- "string"
], - "extOrderApiId": "string",
- "integration": "string",
- "orderIntegration": "string",
- "reused": true,
- "sentToFulfillmentAt": "2019-08-24T14:15:22Z",
- "shipmentId": "string",
- "status": "new",
- "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"
}
], - "version": 0,
- "extOrderId": "string",
- "shippingAddress": {
- "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"
}
], - "expectedDeliveryDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "extReferenceId": "string",
- "extReferenceUrl": "string",
- "extShipmentId": "string",
- "fulfillmentIntegrationId": "string",
- "giftNote": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "quantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "bundleQuantity": 0,
- "bundleSKU": "string",
- "bundleUPC": "string",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "itemDiscount": 0,
- "itemPrice": 0,
- "name": "string",
- "quantityUnit": "each",
- "shippedQuantity": 0,
- "trackedAtSourceChannel": true,
- "upc": "string"
}
], - "locationId": "string",
- "orderCreateTime": "2019-08-24T14:15:22Z",
- "orderId": "string",
- "orderSource": "string",
- "orderSourceType": "online",
- "orderType": "sales",
- "overfulfillPolicy": "strict",
- "shipAfterDate": "2019-08-24T14:15:22Z",
- "shipByDate": "2019-08-24T14:15:22Z",
- "shipCancelByDate": "2019-08-24T14:15:22Z",
- "shippingCarrier": "string",
- "shippingClass": "string",
- "shippingCode": "string",
- "shippingLabels": [
- "string"
], - "shippingMethodMapping": true,
- "shippingNote": "string",
- "shippingPrice": 0,
- "skipLocation": true,
- "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"
}
}
required | object (SupplierAddress) |
name required | string Supplier Name |
Array of objects (SupplierContact) | |
createdAt | string <date-time> When the object was created within Pipe17 |
exceptions | Array of strings References to exceptions related to the supplier |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
object (SourceDoc) Vendor source document | |
supplierId | string Supplier ID |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "exceptions": [
- "string"
], - "supplierId": "string",
- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "contacts": [
- {
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
required | object (SupplierAddress) |
name required | string Supplier Name |
Array of objects (SupplierContact) | |
object (InternalInfo) Internal info | |
object (SourceDoc) Vendor source document |
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "contacts": [
- {
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}
}
{- "code": 200,
- "success": true,
- "supplier": {
- "exceptions": [
- "string"
], - "supplierId": "string",
- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "contacts": [
- {
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "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 suppliers |
deleted | boolean Delete soft deleted suppliers |
name | string Delete suppliers matching name string |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Delete suppliers assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Delete suppliers created after this date-time |
skip | integer <int32> Default: 0 Skip this many suppliers |
supplierId | Array of strings Delete suppliers by list of supplierId |
until | string <date-time> Delete suppliers created before this date-time |
updatedSince | string <date-time> Delete suppliers updated after this date-time |
updatedUntil | string <date-time> Delete suppliers 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,
- "supplierId": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "suppliers": [
- {
- "exceptions": [
- "string"
], - "supplierId": "string",
- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "contacts": [
- {
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
SupplierId required | string Supplier 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,
- "supplier": {
- "exceptions": [
- "string"
], - "supplierId": "string",
- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "contacts": [
- {
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "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 suppliers |
deleted | boolean Retrieve soft deleted suppliers |
exceptionCategoryId | Array of strings Retrieve suppliers by list of categories of the supplier related exceptions |
exceptionType | Array of strings Retrieve suppliers by list of types of the supplier related exceptions ( |
hasSourceDoc | boolean Suppliers containing a source document |
keys | string Default: "supplierId,name,address,contacts,createdAt,updatedAt,orgKey" Return these top-level fields |
name | string Retrieve suppliers 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 |
since | string <date-time> Suppliers created after this date-time |
skip | integer <int32> Default: 0 Skip this many suppliers |
supplierId | Array of strings Retrieve by list of supplierId |
until | string <date-time> Suppliers created before this date-time |
updatedSince | string <date-time> Suppliers updated after this date-time |
updatedUntil | string <date-time> Suppliers 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,
- "supplierId": [
- "string"
], - "keys": "string",
- "order": "string",
- "exceptionCategoryId": [
- "string"
], - "exceptionType": [
- "string"
], - "hasSourceDoc": true,
- "name": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "suppliers": [
- {
- "exceptions": [
- "string"
], - "supplierId": "string",
- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "contacts": [
- {
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
Uniqueness constraints within organization:
SupplierId required | string Supplier ID to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
object (SupplierAddress) | |
Array of objects (SupplierContact) Supplier Contacts | |
object (InternalInfo) Internal info | |
name | string Supplier Name |
object (SourceDoc) Vendor source document |
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "contacts": [
- {
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "name": "string",
- "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "version": "string"
}
]
}
}
{- "code": 200,
- "success": true,
- "supplier": {
- "exceptions": [
- "string"
], - "supplierId": "string",
- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "country": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "name": "string",
- "contacts": [
- {
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "sourceDoc": {
- "content": "string",
- "contentType": "string",
- "status": "string",
- "version": "string",
- "versions": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "version": "string"
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
fulfillmentId required | string |
shippingCarrier required | string (ShippingCarrier) Enum: "ups" "usps" "fedex" "deliverr" "amazon" "other" |
trackingNumber required | string |
actualArrivalDate | string <date-time> |
actualShipDate | string <date-time> |
createdAt | string <date-time> When the object was created within Pipe17 |
expectedArrivalDate | string <date-time> |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
status | string (TrackingStatus) Enum: "created" "shipped" "delivered" |
trackingId | string |
updatedAt | string <date-time> When the object was updated within Pipe17 |
url | string |
{- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "actualShipDate": "2019-08-24T14:15:22Z",
- "status": "created",
- "trackingId": "string",
- "fulfillmentId": "string",
- "shippingCarrier": "ups",
- "trackingNumber": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "url": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
fulfillmentId required | string |
shippingCarrier required | string (ShippingCarrier) Enum: "ups" "usps" "fedex" "deliverr" "amazon" "other" |
trackingNumber required | string |
expectedArrivalDate | string <date-time> |
object (InternalInfo) Internal info | |
url | string |
{- "fulfillmentId": "string",
- "shippingCarrier": "ups",
- "trackingNumber": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "url": "string"
}
{- "code": 200,
- "success": true,
- "tracking": {
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "actualShipDate": "2019-08-24T14:15:22Z",
- "status": "created",
- "trackingId": "string",
- "fulfillmentId": "string",
- "shippingCarrier": "ups",
- "trackingNumber": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "url": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
TrackingId required | string Id or |
{- "code": 200,
- "success": true,
- "tracking": {
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "actualShipDate": "2019-08-24T14:15:22Z",
- "status": "created",
- "trackingId": "string",
- "fulfillmentId": "string",
- "shippingCarrier": "ups",
- "trackingNumber": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "url": "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 tracking |
fulfillmentId | Array of strings |
keys | string Default: "trackingId,trackingNumber,fulfillmentId,shipper,url,actualShipDate,expectedArrivalDate,actualArrivalDate,createdAt,updatedAt,orgKey,status" 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 |
shippingCarrier | Array of strings |
since | string <date-time> Tracking created after this date-time |
skip | integer <int32> Default: 0 Skip this many tracking |
status | Array of strings (TrackingStatus) Items Enum: "created" "shipped" "delivered" |
trackingId | Array of strings |
trackingNumber | Array of strings |
until | string <date-time> Tracking created before this date-time |
updatedSince | string <date-time> Tracking updated after this date-time |
updatedUntil | string <date-time> Tracking updated before this date-time |
{- "code": 200,
- "success": true,
- "filters": {
- "count": 0,
- "fulfillmentId": [
- "string"
], - "keys": "string",
- "order": "string",
- "shippingCarrier": [
- "string"
], - "since": "2019-08-24T14:15:22Z",
- "skip": 0,
- "status": [
- "created"
], - "trackingId": [
- "string"
], - "trackingNumber": [
- "string"
], - "until": "2019-08-24T14:15:22Z",
- "updatedSince": "2019-08-24T14:15:22Z",
- "updatedUntil": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "trackings": [
- {
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "actualShipDate": "2019-08-24T14:15:22Z",
- "status": "created",
- "trackingId": "string",
- "fulfillmentId": "string",
- "shippingCarrier": "ups",
- "trackingNumber": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "url": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
Uniqueness constraints within organization:
TrackingId required | string Id or |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
status required | string Enum: "shipped" "delivered" |
expectedArrivalDate | string <date-time> |
object (InternalInfo) Internal info |
{- "status": "shipped",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}
}
{- "code": 200,
- "success": true,
- "tracking": {
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "actualShipDate": "2019-08-24T14:15:22Z",
- "status": "created",
- "trackingId": "string",
- "fulfillmentId": "string",
- "shippingCarrier": "ups",
- "trackingNumber": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "url": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
extOrderId required | string External Transfer Order ID |
actualArrivalDate | string <date-time> Actual Arrival Date (from most recent Arrival) |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects (NameValue) Custom Fields | |
disableShipmentsReuse | boolean Hint to whether shipmentId should be re-used, or not |
employeeName | string Transfer order created by |
exceptions | Array of strings References to exceptions related to the transfer |
expectedArrivalDate | string <date-time> Expected Arrival Date |
expectedShipDate | string <date-time> Expected Ship Date |
object (TransfersFromLocationAddress) Shipping Location Address | |
fromLocationId | string Shipping Location 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 (TransferLineItem) | |
orderSourceType | string (OrderType) Enum: "online" "pos" "wholesale" "edi" "other" "b2b" Order Type (online, pos, etc) |
orgKey | string Organization this object belong to |
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 (TransferStatus) Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Transfer Status |
timestamp | string <date-time> General Purpose Time Stamp |
object (Address) | |
toLocationId | string Arrival Location ID |
transferId | string Transfer ID |
transferNotes | string Transfer Notes |
transferOrderDate | string <date-time> Transfer Order Date |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "exceptions": [
- "string"
], - "fromLocationAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "integration": "string",
- "transferId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "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"
}
], - "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "upc": "string"
}
], - "orderSourceType": "online",
- "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",
- "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",
- "transferNotes": "string",
- "transferOrderDate": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
extOrderId required | string External Transfer Order ID |
actualArrivalDate | string <date-time> Actual Arrival Date (from most recent Arrival) |
Array of objects (NameValue) Custom Fields | |
disableShipmentsReuse | boolean Hint to whether shipmentId should be re-used, or not |
employeeName | string Transfer order created by |
expectedArrivalDate | string <date-time> Expected Arrival Date |
expectedShipDate | string <date-time> Expected Ship Date |
fromLocationId | string Shipping Location ID |
holdUntil | string <date-time> |
incoterms | string International Commercial Terms |
object (InternalInfo) Internal info | |
Array of objects (TransferLineItem) | |
orderSourceType | string (OrderType) Enum: "online" "pos" "wholesale" "edi" "other" "b2b" Order Type (online, pos, etc) |
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 (TransferStatus) Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Transfer Status |
timestamp | string <date-time> General Purpose Time Stamp |
object (Address) | |
toLocationId | string Arrival Location ID |
transferNotes | string Transfer Notes |
transferOrderDate | string <date-time> Transfer Order Date |
[- {
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "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"
}
], - "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "upc": "string"
}
], - "orderSourceType": "online",
- "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",
- "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",
- "transferNotes": "string",
- "transferOrderDate": "2019-08-24T14:15:22Z"
}
]
{- "code": 200,
- "success": true,
- "transfers": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "message": "string",
- "status": "submitted",
- "transfer": {
- "exceptions": [
- "string"
], - "fromLocationAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "integration": "string",
- "transferId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "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"
}
], - "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "upc": "string"
}
], - "orderSourceType": "online",
- "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",
- "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",
- "transferNotes": "string",
- "transferOrderDate": "2019-08-24T14:15:22Z",
- "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 transfers |
deleted | boolean Delete soft deleted transfers |
extOrderId | Array of strings Delete transfers by list of external transfer IDs |
integration | Array of strings Delete transfers of these integrations |
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 transfers assigned these orgModes. |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Delete transfers created after this date-time |
skip | integer <int32> Default: 0 Skip this many transfers |
status | Array of strings (TransferStatus) Items Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Delete transfers by list of statuses |
transferId | Array of strings Delete transfers by list of transferId |
until | string <date-time> Delete transfers created before this date-time |
updatedSince | string <date-time> Delete transfers updated after this date-time |
updatedUntil | string <date-time> Delete transfers 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"
], - "fromLocationId": [
- "string"
], - "orderSourceType": [
- "online"
], - "status": [
- "draft"
], - "toLocationId": [
- "string"
], - "transferId": [
- "string"
], - "integration": [
- "string"
], - "orgMode": [
- "sandbox"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "transfers": [
- {
- "exceptions": [
- "string"
], - "fromLocationAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "integration": "string",
- "transferId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "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"
}
], - "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "upc": "string"
}
], - "orderSourceType": "online",
- "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",
- "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",
- "transferNotes": "string",
- "transferOrderDate": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
TransferId 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,
- "transfer": {
- "exceptions": [
- "string"
], - "fromLocationAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "integration": "string",
- "transferId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "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"
}
], - "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "upc": "string"
}
], - "orderSourceType": "online",
- "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",
- "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",
- "transferNotes": "string",
- "transferOrderDate": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many transfers |
deleted | boolean Retrieve soft deleted transfers |
exceptionCategoryId | Array of strings Retrieve transfers by list of categories of the transfer related exceptions |
exceptionType | Array of strings Retrieve transfers by list of types of the transfer related exceptions ( |
extOrderId | Array of strings Retrieve by list of external transfer IDs |
fromLocationId | Array of strings Retrieve by list of fromLocationId |
hasSourceDoc | boolean Retrieve transfers containing a source document |
keys | string Default: "transferId,extOrderId,status,shipByDate,expectedArrivalDate,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level fields |
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 |
since | string <date-time> Retrieve all transfers created after this date-time |
skip | integer <int32> Default: 0 Skip this many transfers |
status | Array of strings (TransferStatus) Items Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Retrieve by list of statuses |
timestamp | boolean if set to true use timestamp instead of create time |
toLocationId | Array of strings Retrieve by list of toLocationId |
transferId | Array of strings Retrieve by list of transferId |
until | string <date-time> Retrieve all transfers created before this date-time |
updatedSince | string <date-time> Retrieve all transfers updated after this date-time |
updatedUntil | string <date-time> Retrieve all transfers updated before this date-time |
{- "code": 200,
- "success": true,
- "transfers": [
- {
- "exceptions": [
- "string"
], - "fromLocationAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "integration": "string",
- "transferId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "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"
}
], - "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "upc": "string"
}
], - "orderSourceType": "online",
- "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",
- "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",
- "transferNotes": "string",
- "transferOrderDate": "2019-08-24T14:15:22Z",
- "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"
], - "fromLocationId": [
- "string"
], - "orderSourceType": [
- "online"
], - "status": [
- "draft"
], - "toLocationId": [
- "string"
], - "transferId": [
- "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:
TransferId required | string Id or |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
actualArrivalDate | string or null <date-time> Actual Arrival Date (from most recent Arrival) |
Array of objects (NameValue) Custom Fields | |
disableShipmentsReuse | boolean or null Hint to whether shipmentId should be re-used, or not |
employeeName | string or null Transfer order created by |
expectedArrivalDate | string or null <date-time> Expected Arrival Date |
expectedShipDate | string or null <date-time> Expected Ship Date |
fromLocationId | string or null Shipping Location ID |
holdUntil | string or null <date-time> |
incoterms | string or null International Commercial Terms |
object (InternalInfo) Internal info | |
Array of objects (TransferUpdateLineItem) | |
orderSourceType | string (OrderType) Enum: "online" "pos" "wholesale" "edi" "other" "b2b" Order Type (online, pos, etc) |
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 (TransferStatus) Enum: "draft" "new" "onHold" "toBeValidated" "reviewRequired" "readyForFulfillment" "sentToFulfillment" "partialFulfillment" "fulfilled" "inTransit" "partialReceived" "received" "canceled" "returned" "refunded" "archived" "closed" Transfer Status |
timestamp | string or null <date-time> General Purpose Time Stamp |
object or null (AddressNullable) | |
toLocationId | string or null Arrival Location ID |
transferNotes | string or null Transfer Notes |
{- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "fromLocationId": "string",
- "holdUntil": "2019-08-24T14:15:22Z",
- "incoterms": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "lineItems": [
- {
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "locationId": "string",
- "name": "string",
- "quantity": 0,
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "sku": "string",
- "uniqueId": "string",
- "upc": "string"
}
], - "orderSourceType": "online",
- "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",
- "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",
- "transferNotes": "string"
}
{- "code": 200,
- "success": true,
- "transfer": {
- "exceptions": [
- "string"
], - "fromLocationAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "email": "string",
- "phone": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "integration": "string",
- "transferId": "string",
- "extOrderId": "string",
- "actualArrivalDate": "2019-08-24T14:15:22Z",
- "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "disableShipmentsReuse": true,
- "employeeName": "string",
- "expectedArrivalDate": "2019-08-24T14:15:22Z",
- "expectedShipDate": "2019-08-24T14:15:22Z",
- "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"
}
], - "locationId": "string",
- "name": "string",
- "quantityUnit": "each",
- "receivedQuantity": 0,
- "routed": true,
- "shippedQuantity": 0,
- "upc": "string"
}
], - "orderSourceType": "online",
- "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",
- "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",
- "transferNotes": "string",
- "transferOrderDate": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
allowedIPs required | Array of strings IP/CIDR Whitelist |
required | object (Methods) Access Methods Allowed |
name required | string API Key Name |
apikeyId | string API key Id |
connector | string Connector ID |
createdAt | string <date-time> When the object was created within Pipe17 |
description | string API Key Description |
environment | string (Env) Enum: "test" "prod" Environment ID |
integration | string Integration ID |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
tier | string (Tier) Enum: "free" "basic" "enterprise" Tier (usage plan) |
type | string Enum: "regular" "temporary" API Key type (default - |
updatedAt | string <date-time> When the object was updated within Pipe17 |
userId | string User ID of the key creator, if known |
{- "apikeyId": "string",
- "userId": "string",
- "allowedIPs": [
- "string"
], - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "name": "string",
- "connector": "string",
- "description": "string",
- "environment": "test",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "tier": "free",
- "type": "regular",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
allowedIPs required | Array of strings IP/CIDR Whitelist |
required | object (Methods) Access Methods Allowed |
name required | string API Key Name |
connector | string Connector ID |
description | string API Key Description |
environment | string (Env) Enum: "test" "prod" Environment ID |
integration | string Integration ID |
object (InternalInfo) Internal info | |
tier | string (Tier) Enum: "free" "basic" "enterprise" Tier (usage plan) |
type | string Enum: "regular" "temporary" API Key type (default - |
{- "allowedIPs": [
- "string"
], - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "name": "string",
- "connector": "string",
- "description": "string",
- "environment": "test",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "tier": "free",
- "type": "regular"
}
{- "code": 200,
- "success": true,
- "apikey": "string",
- "apikeyId": "string"
}
ApiKey required | string Value or ID of API key to fetch |
{- "code": 200,
- "success": true,
- "apikey": {
- "apikeyId": "string",
- "userId": "string",
- "allowedIPs": [
- "string"
], - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "name": "string",
- "connector": "string",
- "description": "string",
- "environment": "test",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "tier": "free",
- "type": "regular",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
ApiKey required | string Value or ID of API key to fetch |
{- "code": 200,
- "success": true,
- "apikey": {
- "apikey": "string",
- "apikeyId": "string",
- "userId": "string",
- "allowedIPs": [
- "string"
], - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "name": "string",
- "connector": "string",
- "description": "string",
- "environment": "test",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "tier": "free",
- "type": "regular",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
apikeyId | Array of strings API Keys by list of apikey ids |
connector | Array of strings List API Keys matching to provided connector id(s) |
count | integer <int32> Default: 100 Return at most this many API Keys |
integration | Array of strings List API Keys matching to provided integration id(s) |
keys | string Default: "apikeyId,name,description,integration,connector,tier,environment,methods,allowedIPs,createdAt,updatedAt,orgKey" Return these top-level fields |
name | string List API Keys matching to provided name(s) |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> List API Keys created after this date-time |
skip | integer <int32> Default: 0 Skip this many API Keys |
type | string Enum: "regular" "temporary" List API Keys of this type (default - all) |
until | string <date-time> List API Keys created before this date-time |
updatedSince | string <date-time> List API Keys updated after this date-time |
updatedUntil | string <date-time> List API Keys updated before this date-time |
{- "code": 200,
- "success": true,
- "apikeys": [
- {
- "apikeyId": "string",
- "userId": "string",
- "allowedIPs": [
- "string"
], - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "name": "string",
- "connector": "string",
- "description": "string",
- "environment": "test",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "tier": "free",
- "type": "regular",
- "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",
- "apikeyId": [
- "string"
], - "connector": [
- "string"
], - "integration": [
- "string"
], - "name": "string",
- "type": "regular",
- "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
ApiKey required | string Value or ID of API key to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
allowedIPs | Array of strings IP/CIDR Whitelist |
description | string API Key Description |
object (InternalInfo) Internal info | |
object (MethodsUpdateData) Access Methods Allowed | |
name | string API Key Name |
tier | string Usage plan |
{- "allowedIPs": [
- "string"
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "name": "string",
- "tier": "string"
}
{- "code": 200,
- "success": true,
- "apikey": {
- "apikeyId": "string",
- "userId": "string",
- "allowedIPs": [
- "string"
], - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "name": "string",
- "connector": "string",
- "description": "string",
- "environment": "test",
- "integration": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "tier": "free",
- "type": "regular",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
Operations around Automation Rules. An automation rule contains filters and actions that determine when and how to execute automation actions. An automation rule always belongs to an automation.
automationId required | string (AutomationRuleAutomationId) The ID of the parent automation |
required | object (AutomationRuleFilter) Determines whether or not the automation rule is applied to the entity. |
name required | string (AutomationRuleName) The name of the automation rule. Must be unique within the automation. |
Array of objects (AutomationRuleActions) The actions to be performed by the automation rule. An automation rule must contain at least one action. | |
assessmentOrder | integer >= -1 The order that the automation rule gets assessed. The default rule's order will be -1. |
automationRuleId | string The unique identifier of the automation rule |
createdAt | string <date-time> When the object was created within Pipe17 |
createdBy | string ID of the user who created the automation rule |
description | string (AutomationRuleDescription) The description of the automation rule. A good place to note a rule's when, where and why. |
object (InternalInfo) Internal info | |
isDefault | boolean (AutomationRuleIsDefault) Default: false Whether or not this is the default rule for the automation. There can only be one default rule within an automation rule and it must be enabled. The default automation rule is something that's managed by the platform and will always execute last if no other rules that terminate the automation run are applied. |
isEnabled | boolean (AutomationRuleIsEnabled) Default: true Whether the automation rule is enabled or not. Disabled rules will not be assesesed when their parent automation is triggered. |
orgKey | string Organization this object belong to |
updatedAt | string <date-time> When the object was updated within Pipe17 |
updatedBy | string ID of the user who last updated the automation rule |
{- "assessmentOrder": -1,
- "automationRuleId": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "automationId": "string",
- "filter": {
- "dependencies": [ ],
- "entityFilter": {
- "name": "string",
- "query": {
- "conditions": [
- { }
], - "operator": "string",
- "inverse": true,
- "version": "string"
}, - "entity": "accounts"
}, - "integrationIds": [ ],
- "relatedFilters": { },
- "statuses": [
- "string"
]
}, - "name": "string",
- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { },
- "isEnabled": true
}
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": false,
- "isEnabled": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints:
automationId required | string (AutomationRuleAutomationId) The ID of the parent automation |
required | object (AutomationRuleFilter) Determines whether or not the automation rule is applied to the entity. |
name required | string (AutomationRuleName) The name of the automation rule. Must be unique within the automation. |
Array of objects (AutomationRuleActions) The actions to be performed by the automation rule. An automation rule must contain at least one action. | |
description | string (AutomationRuleDescription) The description of the automation rule. A good place to note a rule's when, where and why. |
object (InternalInfo) Internal info | |
isDefault | boolean (AutomationRuleIsDefault) Default: false Whether or not this is the default rule for the automation. There can only be one default rule within an automation rule and it must be enabled. The default automation rule is something that's managed by the platform and will always execute last if no other rules that terminate the automation run are applied. |
isEnabled | boolean (AutomationRuleIsEnabled) Default: true Whether the automation rule is enabled or not. Disabled rules will not be assesesed when their parent automation is triggered. |
{- "automationId": "string",
- "filter": {
- "dependencies": [ ],
- "entityFilter": {
- "name": "string",
- "query": {
- "conditions": [
- { }
], - "operator": "string",
- "inverse": true,
- "version": "string"
}, - "entity": "accounts"
}, - "integrationIds": [ ],
- "relatedFilters": { },
- "statuses": [
- "string"
]
}, - "name": "string",
- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { },
- "isEnabled": true
}
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": false,
- "isEnabled": true
}
{- "code": 200,
- "success": true,
- "automationRule": {
- "assessmentOrder": -1,
- "automationRuleId": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "automationId": "string",
- "filter": {
- "dependencies": [ ],
- "entityFilter": {
- "name": "string",
- "query": {
- "conditions": [
- { }
], - "operator": "string",
- "inverse": true,
- "version": "string"
}, - "entity": "accounts"
}, - "integrationIds": [ ],
- "relatedFilters": { },
- "statuses": [
- "string"
]
}, - "name": "string",
- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { },
- "isEnabled": true
}
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": false,
- "isEnabled": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
AutomationRuleId required | string Id of the automation rule to fetch |
{- "code": 200,
- "success": true,
- "automationRule": {
- "assessmentOrder": -1,
- "automationRuleId": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "automationId": "string",
- "filter": {
- "dependencies": [ ],
- "entityFilter": {
- "name": "string",
- "query": {
- "conditions": [
- { }
], - "operator": "string",
- "inverse": true,
- "version": "string"
}, - "entity": "accounts"
}, - "integrationIds": [ ],
- "relatedFilters": { },
- "statuses": [
- "string"
]
}, - "name": "string",
- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { },
- "isEnabled": true
}
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": false,
- "isEnabled": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
automationId | Array of strings (AutomationRulesListFilterAutomationId) Filter by list of automationIds |
automationRuleId | Array of strings (AutomationRulesListFilterAutomationRuleId) Filter by list of automationRuleIds |
count | integer <int32> Default: 100 Max number of items to return |
deleted | boolean Whether to retrieve soft deleted items |
isDefault | boolean Filter by isDefault |
isEnabled | boolean Filter by isEnabled |
keys | string Default: "automationId,automationRuleId,isEnabled,createdAt,updatedAt,orgKey,assessmentOrder,name,description,isDefault" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level field |
orgKey | string Organization key |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Select items created after this date-time |
skip | integer <int32> Default: 0 Number of items to skip |
until | string <date-time> Select items created before this date-time |
updatedSince | string <date-time> Select items updated after this date-time |
updatedUntil | string <date-time> Select items updated before this date-time |
{- "code": 200,
- "success": true,
- "automationRules": [
- {
- "assessmentOrder": -1,
- "automationRuleId": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "automationId": "string",
- "filter": {
- "dependencies": [ ],
- "entityFilter": {
- "name": "string",
- "query": {
- "conditions": [
- { }
], - "operator": "string",
- "inverse": true,
- "version": "string"
}, - "entity": "accounts"
}, - "integrationIds": [ ],
- "relatedFilters": { },
- "statuses": [
- "string"
]
}, - "name": "string",
- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { },
- "isEnabled": true
}
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isDefault": false,
- "isEnabled": true,
- "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",
- "automationId": [
- "string"
], - "automationRuleId": [
- "string"
], - "deleted": true,
- "isEnabled": true
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
AutomationRuleId required | string Id of the automation rule to update |
Array of objects (AutomationRuleActions) The actions to be performed by the automation rule. An automation rule must contain at least one action. | |
description | string (AutomationRuleDescription) The description of the automation rule. A good place to note a rule's when, where and why. |
object (AutomationRuleFilter) Determines whether or not the automation rule is applied to the entity. | |
object (InternalInfo) Internal info | |
isEnabled | boolean (AutomationRuleIsEnabled) Default: true Whether the automation rule is enabled or not. Disabled rules will not be assesesed when their parent automation is triggered. |
name | string (AutomationRuleName) The name of the automation rule. Must be unique within the automation. |
{- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { },
- "isEnabled": true
}
], - "description": "string",
- "filter": {
- "dependencies": [ ],
- "entityFilter": {
- "name": "string",
- "query": {
- "conditions": [
- { }
], - "operator": "string",
- "inverse": true,
- "version": "string"
}, - "entity": "accounts"
}, - "integrationIds": [ ],
- "relatedFilters": { },
- "statuses": [
- "string"
]
}, - "internal": {
- "property1": { },
- "property2": { }
}, - "isEnabled": true,
- "name": "string"
}
{- "code": 200,
- "success": true
}
Operations around Automation Runs. An automation run captures the history of an automation being executed on an entity.
automationId required | string The type of the entity being operated on |
automationRunId required | string The unique identifier of the automation. |
entityId required | string The id of the entity being operated on |
entityType required | string Enum: "orders" "shipments" "fulfillments" "exceptions" |
status required | string Enum: "IN_PROGRESS" "FAILED" "COMPLETED" Status of the automation run |
Array of objects (AutomationRunAction) Required. The actions that were planned out for the automation run. | |
automationRuleIds | Array of strings IDs of the automation rules that matched the filter and had actions that were used. Some rules may have a passing filter but won't be used if a preceding rule had a terminal action. In this case, those rule ids should not be included in this array. |
completedAt | string <date-time> The time the automation run was completed |
createdAt | string <date-time> When the object was created within Pipe17 |
errorMessage | string The error message if the automation run failed |
execCount | integer (AutomationRunExecCount) >= 1 The number of times the automation run has been executed. If a job fails and is retried, this number will increase. |
failedAt | string <date-time> The time the automation run failed |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
Array of objects (AutomationStep) Required. The steps that were planned out for the automation run. | |
trigger | string Enum: "event" "manual" event: (default) The run was created due to an event that triggered the automation manual: The run was manually created by an user |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "automationRunId": "string",
- "status": "IN_PROGRESS",
- "execCount": 1,
- "automationId": "string",
- "entityId": "string",
- "entityType": "orders",
- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { }
}
], - "automationRuleIds": [
- "string"
], - "completedAt": "2019-08-24T14:15:22Z",
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "steps": [
- {
- "status": "PENDING",
- "type": "UPDATE_ORDER",
- "automationRuleId": "string",
- "completedAt": "2019-08-24T14:15:22Z",
- "config": { },
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z"
}
], - "trigger": "event",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
automationId required | string The type of the entity being operated on |
entityId required | string The id of the entity being operated on |
entityType required | string Enum: "orders" "shipments" "fulfillments" "exceptions" |
Array of objects (AutomationRunAction) Required. The actions that were planned out for the automation run. | |
automationRuleIds | Array of strings IDs of the automation rules that matched the filter and had actions that were used. Some rules may have a passing filter but won't be used if a preceding rule had a terminal action. In this case, those rule ids should not be included in this array. |
completedAt | string <date-time> The time the automation run was completed |
errorMessage | string The error message if the automation run failed |
failedAt | string <date-time> The time the automation run failed |
object (InternalInfo) Internal info | |
status | string (AutomationRunStatus) Enum: "IN_PROGRESS" "FAILED" "COMPLETED" |
Array of objects (AutomationStep) Required. The steps that were planned out for the automation run. | |
trigger | string Enum: "event" "manual" event: (default) The run was created due to an event that triggered the automation manual: The run was manually created by an user |
{- "automationId": "string",
- "entityId": "string",
- "entityType": "orders",
- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { }
}
], - "automationRuleIds": [
- "string"
], - "completedAt": "2019-08-24T14:15:22Z",
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "status": "IN_PROGRESS",
- "steps": [
- {
- "status": "PENDING",
- "type": "UPDATE_ORDER",
- "automationRuleId": "string",
- "completedAt": "2019-08-24T14:15:22Z",
- "config": { },
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z"
}
], - "trigger": "event"
}
{- "code": 200,
- "success": true,
- "automationRun": {
- "automationRunId": "string",
- "status": "IN_PROGRESS",
- "execCount": 1,
- "automationId": "string",
- "entityId": "string",
- "entityType": "orders",
- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { }
}
], - "automationRuleIds": [
- "string"
], - "completedAt": "2019-08-24T14:15:22Z",
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "steps": [
- {
- "status": "PENDING",
- "type": "UPDATE_ORDER",
- "automationRuleId": "string",
- "completedAt": "2019-08-24T14:15:22Z",
- "config": { },
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z"
}
], - "trigger": "event",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
AutomationRunId required | string Id of the automation run |
{- "code": 200,
- "success": true,
- "automationRun": {
- "automationRunId": "string",
- "status": "IN_PROGRESS",
- "execCount": 1,
- "automationId": "string",
- "entityId": "string",
- "entityType": "orders",
- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { }
}
], - "automationRuleIds": [
- "string"
], - "completedAt": "2019-08-24T14:15:22Z",
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "steps": [
- {
- "status": "PENDING",
- "type": "UPDATE_ORDER",
- "automationRuleId": "string",
- "completedAt": "2019-08-24T14:15:22Z",
- "config": { },
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z"
}
], - "trigger": "event",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
automationId | Array of strings (AutomationRunsListFilterAutomationId) Filter by list of automationIds |
automationRunId | Array of strings (AutomationRunsListFilterAutomationRunId) Filter by list of automationRunIds |
count | integer <int32> Default: 100 Max number of items to return |
deleted | boolean Whether to retrieve soft deleted items |
entityId | Array of strings (AutomationRunsListFilterEntityId) Filter by list of entityIds |
keys | string Default: "orgKey,automationId,automationRunId,entityId,orgKey,createdAt,updatedAt,status,completedAt,failedAt,errorMessage,trigger" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level field |
orgKey | string Organization key |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Select items created after this date-time |
skip | integer <int32> Default: 0 Number of items to skip |
status | Array of strings (AutomationRunsListFilterStatus) Filter by automation run status |
until | string <date-time> Select items created before this date-time |
updatedSince | string <date-time> Select items updated after this date-time |
updatedUntil | string <date-time> Select items updated before this date-time |
{- "code": 200,
- "success": true,
- "automationRuns": [
- {
- "automationRunId": "string",
- "status": "IN_PROGRESS",
- "execCount": 1,
- "automationId": "string",
- "entityId": "string",
- "entityType": "orders",
- "actions": [
- {
- "type": "UPDATE_EXCEPTION_PROP",
- "config": { }
}
], - "automationRuleIds": [
- "string"
], - "completedAt": "2019-08-24T14:15:22Z",
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "steps": [
- {
- "status": "PENDING",
- "type": "UPDATE_ORDER",
- "automationRuleId": "string",
- "completedAt": "2019-08-24T14:15:22Z",
- "config": { },
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z"
}
], - "trigger": "event",
- "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",
- "automationId": [
- "string"
], - "automationRunId": [
- "string"
], - "entityId": [
- "string"
], - "status": [
- "string"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
AutomationRunId required | string Id of the automation run to update |
automationRuleIds | Array of strings IDs of the automation rules that matched the filter and had actions that were used. Some rules may have a passing filter but won't be used if a preceding rule had a terminal action. In this case, those rule ids should not be included in this array. |
completedAt | string <date-time> The time the automation run was completed |
errorMessage | string The error message if the automation run failed |
execCount | integer (AutomationRunExecCount) >= 1 The number of times the automation run has been executed. If a job fails and is retried, this number will increase. |
failedAt | string <date-time> The time the automation run failed |
object (InternalInfo) Internal info | |
status | string (AutomationRunStatus) Enum: "IN_PROGRESS" "FAILED" "COMPLETED" |
Array of objects (AutomationStep) The steps that the automation run will take. |
{- "automationRuleIds": [
- "string"
], - "completedAt": "2019-08-24T14:15:22Z",
- "errorMessage": "string",
- "execCount": 1,
- "failedAt": "2019-08-24T14:15:22Z",
- "internal": {
- "property1": { },
- "property2": { }
}, - "status": "IN_PROGRESS",
- "steps": [
- {
- "status": "PENDING",
- "type": "UPDATE_ORDER",
- "automationRuleId": "string",
- "completedAt": "2019-08-24T14:15:22Z",
- "config": { },
- "errorMessage": "string",
- "failedAt": "2019-08-24T14:15:22Z"
}
]
}
{- "code": 200,
- "success": true
}
Operations around Automations. An automation is the highest level entity of the Automation Engine.
trigger required | string (AutomationTrigger) Enum: "NEW_ORDER" "ORDER_UPDATED" "SHIPMENT_UPDATED" "FULFILLMENT_CREATED" "MANUAL_ORDER" "MANUAL_SHIPMENT" "MANUAL_FULFILLMENT" "EXCEPTION_MODIFIED" The name of the event that starts the automation. |
automationId | string The unique identifier of the automation. |
createdAt | string <date-time> When the object was created within Pipe17 |
object (InternalInfo) Internal info | |
isEnabled | boolean Default: true Whether the automation is enabled or not. |
orgKey | string Organization this object belong to |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "automationId": "string",
- "trigger": "NEW_ORDER",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isEnabled": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints:
trigger required | string (AutomationTrigger) Enum: "NEW_ORDER" "ORDER_UPDATED" "SHIPMENT_UPDATED" "FULFILLMENT_CREATED" "MANUAL_ORDER" "MANUAL_SHIPMENT" "MANUAL_FULFILLMENT" "EXCEPTION_MODIFIED" The name of the event that starts the automation. |
object (InternalInfo) Internal info | |
isEnabled | boolean Default: true Whether the automation is enabled or not. |
{- "trigger": "NEW_ORDER",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isEnabled": true
}
{- "code": 200,
- "success": true,
- "automation": {
- "automationId": "string",
- "trigger": "NEW_ORDER",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isEnabled": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
AutomationId required | string Id of the automation to fetch |
{- "code": 200,
- "success": true,
- "automation": {
- "automationId": "string",
- "trigger": "NEW_ORDER",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isEnabled": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
automationId | Array of strings (AutomationsListFilterAutomationId) Filter by list of automationId |
count | integer <int32> Default: 100 Max number of items to return |
deleted | boolean Whether to retrieve soft deleted items |
isEnabled | boolean |
keys | string Default: "automationId,isEnabled,trigger,createdAt,updatedAt,orgKey" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level field |
orgKey | string Organization key |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Select items created after this date-time |
skip | integer <int32> Default: 0 Number of items to skip |
trigger | Array of strings (AutomationsListFilterTrigger) Items Enum: "NEW_ORDER" "ORDER_UPDATED" "SHIPMENT_UPDATED" "FULFILLMENT_CREATED" "MANUAL_ORDER" "MANUAL_SHIPMENT" "MANUAL_FULFILLMENT" "EXCEPTION_MODIFIED" Filter by matching trigger |
until | string <date-time> Select items created before this date-time |
updatedSince | string <date-time> Select items updated after this date-time |
updatedUntil | string <date-time> Select items updated before this date-time |
{- "code": 200,
- "success": true,
- "automations": [
- {
- "automationId": "string",
- "trigger": "NEW_ORDER",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isEnabled": true,
- "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",
- "automationId": [
- "string"
], - "deleted": true,
- "trigger": [
- "NEW_ORDER"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
AutomationId required | string Automation Id to update |
automationRuleIds | Array of strings List of automation rule ids in the order they should be evaluated. Must include all automation rule ids for the automation, excluding that of the default automation rule. |
{- "automationRuleIds": [
- "string"
]
}
{- "code": 200,
- "success": true
}
AutomationId required | string Automation Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
object (InternalInfo) Internal info | |
isEnabled | boolean Whether the automation is enabled or not. |
{- "internal": {
- "property1": { },
- "property2": { }
}, - "isEnabled": true
}
{- "code": 200,
- "success": true,
- "automation": {
- "automationId": "string",
- "trigger": "NEW_ORDER",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isEnabled": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
connectorName required | string Connector Name |
connectorType required | string (ConnectorType) Enum: "ecommerce" "finance" "logistics" "plugin" "other" Connector Type |
Array of objects (ConnectorAction) List of actions supported by connector | |
availabilityStatus | string (ConnectorAvailabilityStatus) Enum: "general" "limited" "future" "beta" "deprecated" Connector availability status |
capability | Array of strings Items Enum: "arrivals:in" "arrivals:out" "customers:in" "customers:out" "contacts:in" "contacts:out" "fulfillments:in" "fulfillments:out" "inventory:in" "inventory:out" "labels:in" "labels:out" "locations:in" "locations:out" "orders:in" "orders:out" "products:in" "products:out" "purchases:in" "purchases:out" "receipts:in" "receipts:out" "refunds:in" "refunds:out" "returns:in" "returns:out" "shipments:in" "shipments:out" "suppliers:in" "suppliers:out" "transfers:in" "transfers:out" "shipping_methods" "sku_mapping" "shipments_cancel_in" "shipments_cancel_out" "events_outbound_replay" "events_outbound_batch" "inventory_requires_products" "orders_cancel_in" "orders_cancel_out" "inventory_incremental" "locations_multiple" "orders_multiple_destinations" |
object (ConnectorConnection) 3rd party's credentials | |
connectorId | string Connector ID |
createdAt | string <date-time> When the object was created within Pipe17 |
description | string Connector description |
disableAutoProvision | boolean Disables plugin connector from being auto-provisioned to new orgs |
displayName | string Connector Display Name |
Array of objects (ConnectorEntity) | |
intentName | string Connector intent label |
intentRank | number Connector intent rank (higher ranks indicate better match) |
intentShow | boolean Indicates whether to show connector on intent |
object (InternalInfo) Internal info | |
isPublic | boolean Public connector indicator |
linkedConnectorId | string Link connector with parent connectorId to allow parent accessing all integrations of this connector |
linkedConnectorName | string Link connector with parent by name to allow parent accessing all integrations of this connector |
logoUrl | string Logo URL |
orgKey | string Organization this object belong to |
orgUnique | boolean Indicates whether only one integration is allowed to be created in org |
orgWideAccess | boolean Indicates whether connector/integration should have access to all declared entity types |
pricingCategory | string Connector pricing category |
rank | number Connector rank in category (higher ranks indicate better match) |
readme | string Connector readme markup |
selfServiceMode | string (ConnectorSelfServiceMode) Enum: "full" "assisted" "disabled" Connector self service mode status |
object (ConnectorSettings) Connector specific settings | |
slug | string Connector Slug |
status | string (ConnectorStatus) Enum: "created" "active" "inactive" "deleted" Connector Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
updatedAt | string <date-time> When the object was updated within Pipe17 |
version | string Connector version |
object (ConnectorWebhook) |
{- "availabilityStatus": "general",
- "capability": [
- "string"
], - "connectorId": "string",
- "disableAutoProvision": true,
- "intentName": "string",
- "intentRank": 0,
- "intentShow": true,
- "isPublic": true,
- "rank": 0,
- "selfServiceMode": "full",
- "status": "created",
- "connectorName": "string",
- "connectorType": "ecommerce",
- "actions": [
- {
- "actionName": "string",
- "actionType": "string",
- "description": "string",
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "verb": "string"
}
], - "connection": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "type": "basic",
- "url": "string"
}, - "description": "string",
- "displayName": "string",
- "entities": [
- {
- "direction": "in",
- "name": "arrivals",
- "mappingUuid": "string",
- "restrictions": [
- {
- "path": "restricted"
}
], - "routingUuid": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "logoUrl": "string",
- "orgUnique": true,
- "orgWideAccess": true,
- "pricingCategory": "string",
- "readme": "string",
- "settings": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
]
}, - "slug": "string",
- "tags": [
- "string"
], - "version": "string",
- "webhook": {
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints:
connectorName required | string Connector Name |
connectorType required | string (ConnectorType) Enum: "ecommerce" "finance" "logistics" "plugin" "other" Connector Type |
Array of objects (ConnectorAction) List of actions supported by connector | |
capability | Array of strings |
object (ConnectorConnection) 3rd party's credentials | |
description | string Connector description |
displayName | string Connector Display Name |
Array of objects (ConnectorEntity) | |
object (InternalInfo) Internal info | |
linkedConnectorId | string Link connector with parent connectorId to allow parent accessing all integrations of this connector |
linkedConnectorName | string Link connector with parent by name to allow parent accessing all integrations of this connector |
logoUrl | string Logo URL |
orgUnique | boolean Indicates whether only one integration is allowed to be created in org |
orgWideAccess | boolean Indicates whether connector/integration should have access to all declared entity types |
pricingCategory | string Connector pricing category |
readme | string Connector readme markup |
object (ConnectorSettings) Connector specific settings | |
slug | string Connector Slug |
tags | Array of strings (EntityTags) Tags assigned to entity |
version | string Connector version |
object (ConnectorWebhook) |
{- "connectorName": "string",
- "connectorType": "ecommerce",
- "actions": [
- {
- "actionName": "string",
- "actionType": "string",
- "description": "string",
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "verb": "string"
}
], - "capability": [
- "string"
], - "connection": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "type": "basic",
- "url": "string"
}, - "description": "string",
- "displayName": "string",
- "entities": [
- {
- "direction": "in",
- "name": "arrivals",
- "mappingUuid": "string",
- "restrictions": [
- {
- "path": "restricted"
}
], - "routingUuid": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "logoUrl": "string",
- "orgUnique": true,
- "orgWideAccess": true,
- "pricingCategory": "string",
- "readme": "string",
- "settings": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
]
}, - "slug": "string",
- "tags": [
- "string"
], - "version": "string",
- "webhook": {
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string"
}
}
{- "code": 200,
- "success": true,
- "connector": {
- "availabilityStatus": "general",
- "capability": [
- "string"
], - "connectorId": "string",
- "disableAutoProvision": true,
- "intentName": "string",
- "intentRank": 0,
- "intentShow": true,
- "isPublic": true,
- "rank": 0,
- "selfServiceMode": "full",
- "status": "created",
- "connectorName": "string",
- "connectorType": "ecommerce",
- "actions": [
- {
- "actionName": "string",
- "actionType": "string",
- "description": "string",
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "verb": "string"
}
], - "connection": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "type": "basic",
- "url": "string"
}, - "description": "string",
- "displayName": "string",
- "entities": [
- {
- "direction": "in",
- "name": "arrivals",
- "mappingUuid": "string",
- "restrictions": [
- {
- "path": "restricted"
}
], - "routingUuid": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "logoUrl": "string",
- "orgUnique": true,
- "orgWideAccess": true,
- "pricingCategory": "string",
- "readme": "string",
- "settings": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
]
}, - "slug": "string",
- "tags": [
- "string"
], - "version": "string",
- "webhook": {
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
ConnectorId required | string Connector Id to fetch |
{- "code": 200,
- "success": true,
- "connector": {
- "availabilityStatus": "general",
- "capability": [
- "string"
], - "connectorId": "string",
- "disableAutoProvision": true,
- "intentName": "string",
- "intentRank": 0,
- "intentShow": true,
- "isPublic": true,
- "rank": 0,
- "selfServiceMode": "full",
- "status": "created",
- "connectorName": "string",
- "connectorType": "ecommerce",
- "actions": [
- {
- "actionName": "string",
- "actionType": "string",
- "description": "string",
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "verb": "string"
}
], - "connection": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "type": "basic",
- "url": "string"
}, - "description": "string",
- "displayName": "string",
- "entities": [
- {
- "direction": "in",
- "name": "arrivals",
- "mappingUuid": "string",
- "restrictions": [
- {
- "path": "restricted"
}
], - "routingUuid": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "logoUrl": "string",
- "orgUnique": true,
- "orgWideAccess": true,
- "pricingCategory": "string",
- "readme": "string",
- "settings": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
]
}, - "slug": "string",
- "tags": [
- "string"
], - "version": "string",
- "webhook": {
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
availabilityStatus | Array of strings (ConnectorAvailabilityStatus) Items Enum: "general" "limited" "future" "beta" "deprecated" Retrieve connectors by list of availability statuses |
capability | Array of strings Retrieve connectors by list of capabilities |
connectorId | Array of strings Retrieve connectors by list of connectorId |
connectorName | Array of strings Retrieve connectors by list of connector names |
connectorType | Array of strings (ConnectorType) Items Enum: "ecommerce" "finance" "logistics" "plugin" "other" |
count | integer <int32> Default: 100 Return at most this many connectors |
intentShow | boolean Retrieve connectors by intentShow attribute |
keys | string Default: "displayName,description,version,connectorId,status,connectorName,connectorType,logoUrl,entities,settings,connection,createdAt,updatedAt,orgKey,tags" 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 |
selfServiceMode | Array of strings (ConnectorSelfServiceMode) Items Enum: "full" "assisted" "disabled" Retrieve connectors by list of self-service modes |
since | string <date-time> Connectors created after this date-time |
skip | integer <int32> Default: 0 Skip this many connectors |
slug | Array of strings Retrieve connectors by list of connector slugs |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Connectors created before this date-time |
updatedSince | string <date-time> Connectors updated after this date-time |
updatedUntil | string <date-time> Connectors updated before this date-time |
{- "code": 200,
- "success": true,
- "connectors": [
- {
- "availabilityStatus": "general",
- "capability": [
- "string"
], - "connectorId": "string",
- "disableAutoProvision": true,
- "intentName": "string",
- "intentRank": 0,
- "intentShow": true,
- "isPublic": true,
- "rank": 0,
- "selfServiceMode": "full",
- "status": "created",
- "connectorName": "string",
- "connectorType": "ecommerce",
- "actions": [
- {
- "actionName": "string",
- "actionType": "string",
- "description": "string",
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": null,
- "value": null
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "verb": "string"
}
], - "connection": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "type": "basic",
- "url": "string"
}, - "description": "string",
- "displayName": "string",
- "entities": [
- {
- "direction": "in",
- "name": "arrivals",
- "mappingUuid": "string",
- "restrictions": [
- {
- "path": "restricted"
}
], - "routingUuid": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "logoUrl": "string",
- "orgUnique": true,
- "orgWideAccess": true,
- "pricingCategory": "string",
- "readme": "string",
- "settings": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
]
}, - "slug": "string",
- "tags": [
- "string"
], - "version": "string",
- "webhook": {
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "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",
- "availabilityStatus": [
- "general"
], - "capability": [
- "string"
], - "connectorId": [
- "string"
], - "connectorName": [
- "string"
], - "connectorType": [
- "string"
], - "intentShow": true,
- "selfServiceMode": [
- "full"
], - "slug": [
- "string"
], - "status": [
- "created"
], - "tags": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Uniqueness constraints:
ConnectorId required | string Connector Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
Array of objects or null (ConnectorAction) List of actions supported by connector | |
capability | Array of strings or null |
object (ConnectorConnection) 3rd party's credentials | |
connectorType | string (ConnectorType) Enum: "ecommerce" "finance" "logistics" "plugin" "other" Connector Type |
description | string Connector description |
displayName | string Connector Display Name |
Array of objects (ConnectorEntity) | |
object (InternalInfo) Internal info | |
linkedConnectorId | string or null Link connector with parent connectorId to allow parent accessing all integrations of this connector |
linkedConnectorName | string or null Link connector with parent by name to allow parent accessing all integrations of this connector |
logoUrl | string or null Logo URL |
orgUnique | boolean Indicates whether only one integration is allowed to be created in org |
orgWideAccess | boolean Indicates whether connector/integration should have access to all declared entity types |
pricingCategory | string Connector pricing category |
readme | string Connector readme markup |
object (ConnectorSettings) Connector specific settings | |
slug | string Connector Slug |
status | string Enum: "active" "inactive" Connector Status |
tags | Array of strings (EntityTags) Tags assigned to entity |
version | string Connector version |
object or null Connector Webhook |
{- "actions": [
- {
- "actionName": "string",
- "actionType": "string",
- "description": "string",
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "verb": "string"
}
], - "capability": [
- "string"
], - "connection": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "type": "basic",
- "url": "string"
}, - "connectorType": "ecommerce",
- "description": "string",
- "displayName": "string",
- "entities": [
- {
- "direction": "in",
- "name": "arrivals",
- "mappingUuid": "string",
- "restrictions": [
- {
- "path": "restricted"
}
], - "routingUuid": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "logoUrl": "string",
- "orgUnique": true,
- "orgWideAccess": true,
- "pricingCategory": "string",
- "readme": "string",
- "settings": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
]
}, - "slug": "string",
- "status": "active",
- "tags": [
- "string"
], - "version": "string",
- "webhook": {
- "url": "string",
- "apikey": "string",
- "topics": [
- "arrivals"
]
}
}
{- "code": 200,
- "success": true,
- "connector": {
- "availabilityStatus": "general",
- "capability": [
- "string"
], - "connectorId": "string",
- "disableAutoProvision": true,
- "intentName": "string",
- "intentRank": 0,
- "intentShow": true,
- "isPublic": true,
- "rank": 0,
- "selfServiceMode": "full",
- "status": "created",
- "connectorName": "string",
- "connectorType": "ecommerce",
- "actions": [
- {
- "actionName": "string",
- "actionType": "string",
- "description": "string",
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "verb": "string"
}
], - "connection": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
], - "type": "basic",
- "url": "string"
}, - "description": "string",
- "displayName": "string",
- "entities": [
- {
- "direction": "in",
- "name": "arrivals",
- "mappingUuid": "string",
- "restrictions": [
- {
- "path": "restricted"
}
], - "routingUuid": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "logoUrl": "string",
- "orgUnique": true,
- "orgWideAccess": true,
- "pricingCategory": "string",
- "readme": "string",
- "settings": {
- "fields": [
- {
- "group": "string",
- "options": {
- "common": true,
- "component": "string",
- "defaultValue": { },
- "endAdornment": "string",
- "extra": { },
- "fields": [
- { }
], - "genkey": "apikey",
- "group": "string",
- "helperText": "string",
- "hidden": true,
- "label": "string",
- "placeholder": "string",
- "readme": "string",
- "readonly": true,
- "startAdornment": "string",
- "values": [
- {
- "label": "string",
- "value": "string"
}
], - "wizard": true
}, - "path": "string",
- "secret": true,
- "type": "string",
- "validation": [
- {
- "type": "required",
- "value": "string",
- "message": "string"
}
]
}
]
}, - "slug": "string",
- "tags": [
- "string"
], - "version": "string",
- "webhook": {
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
createdAt | string <date-time> When the object was created within Pipe17 |
direction | string (Direction) Enum: "in" "out" Route/Mapping Direction |
duration | number <int32> operation duration |
entityId | string entityId |
entityType | string entity type |
eventId | string Event ID |
extEntityId | string extEntityId |
integration | string integration id |
isBatch | boolean Indicates if the event is for a batch action |
keywords | Array of strings |
operation | string (EventOperation) Enum: "create" "update" "delete" "poll" "acknowledge" "check" "cleanup" "detach" "download" "mode" "move" "reinvite" "replay" "reset_password" "results" "set-rule-order" "setup" "sync" "upgrade" "upload" "variables" Name of operation with entity. The following operations are applicable only to particular types of entities:
|
orgKey | string Organization this object belong to |
object (EventRequestData) | |
requestId | string API request Id |
object (EventResponseData) | |
source | string Enum: "custom" "api" "api-webhook" Event Type |
status | string (EventRequestStatus) Enum: "pending" "acknowledged" "completed" "failed" Event Status |
timestamp | string <date-time> When the event was triggered |
updatedAt | string <date-time> When the object was updated within Pipe17 |
userId | string API user id |
{- "eventId": "string",
- "keywords": [
- "string"
], - "source": "custom",
- "direction": "in",
- "duration": 0,
- "entityId": "string",
- "entityType": "string",
- "extEntityId": "string",
- "integration": "string",
- "isBatch": true,
- "operation": "create",
- "request": {
- "authobj": { },
- "body": "string",
- "headers": { },
- "method": "string",
- "url": "string"
}, - "requestId": "string",
- "response": {
- "body": "string",
- "headers": { },
- "message": "string",
- "retries": 0,
- "status": 0
}, - "status": "pending",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
direction | string (Direction) Enum: "in" "out" Route/Mapping Direction |
duration | number <int32> operation duration |
entityId | string entityId |
entityType | string entity type |
extEntityId | string extEntityId |
integration | string integration id |
isBatch | boolean Indicates if the event is for a batch action |
operation | string (EventOperation) Enum: "create" "update" "delete" "poll" "acknowledge" "check" "cleanup" "detach" "download" "mode" "move" "reinvite" "replay" "reset_password" "results" "set-rule-order" "setup" "sync" "upgrade" "upload" "variables" Name of operation with entity. The following operations are applicable only to particular types of entities:
|
object (EventRequestData) | |
requestId | string API request Id |
object (EventResponseData) | |
source | string (EventRequestSourcePublic) Value: "custom" Event Type |
status | string (EventRequestStatus) Enum: "pending" "acknowledged" "completed" "failed" Event Status |
timestamp | string <date-time> When the event was triggered |
userId | string API user id |
{- "direction": "in",
- "duration": 0,
- "entityId": "string",
- "entityType": "string",
- "extEntityId": "string",
- "integration": "string",
- "isBatch": true,
- "operation": "create",
- "request": {
- "authobj": { },
- "body": "string",
- "headers": { },
- "method": "string",
- "url": "string"
}, - "requestId": "string",
- "response": {
- "body": "string",
- "headers": { },
- "message": "string",
- "retries": 0,
- "status": 0
}, - "source": "custom",
- "status": "pending",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string"
}
{- "code": 200,
- "success": true,
- "event": {
- "eventId": "string",
- "keywords": [
- "string"
], - "source": "custom",
- "direction": "in",
- "duration": 0,
- "entityId": "string",
- "entityType": "string",
- "extEntityId": "string",
- "integration": "string",
- "isBatch": true,
- "operation": "create",
- "request": {
- "authobj": { },
- "body": "string",
- "headers": { },
- "method": "string",
- "url": "string"
}, - "requestId": "string",
- "response": {
- "body": "string",
- "headers": { },
- "message": "string",
- "retries": 0,
- "status": 0
}, - "status": "pending",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
{- "code": 200,
- "success": true,
- "event": {
- "eventId": "string",
- "keywords": [
- "string"
], - "source": "custom",
- "direction": "in",
- "duration": 0,
- "entityId": "string",
- "entityType": "string",
- "extEntityId": "string",
- "integration": "string",
- "isBatch": true,
- "operation": "create",
- "request": {
- "authobj": { },
- "body": "string",
- "headers": { },
- "method": "string",
- "url": "string"
}, - "requestId": "string",
- "response": {
- "body": "string",
- "headers": { },
- "message": "string",
- "retries": 0,
- "status": 0
}, - "status": "pending",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
apikeyId | Array of strings Fetch by list of api keys |
count | integer <int32> Default: 100 Max number of events to return |
direction | Array of strings (Direction) Items Enum: "in" "out" Fetch by list of direction |
entityId | Array of strings Fetch by list of entityId |
entityType | Array of strings Fetch by list of entity types |
eventId | Array of strings Fetch by list of eventId |
extEntityId | Array of strings Fetch by list of extEntityId |
identity | Array of strings Fetch by identity ids (- either integration, apikeyId, or userId) |
integration | Array of strings Fetch by list of integrations |
keys | string Default: "eventId,source,status,operation,direction,entityType,entityId,integration,extEntityId,requestId,userId,createdAt,updatedAt,orgKey" Return these top-level fields |
keywords | Array of strings Fetch by keywords |
operation | Array of strings (EventOperation) Items Enum: "create" "update" "delete" "poll" "acknowledge" "check" "cleanup" "detach" "download" "mode" "move" "reinvite" "replay" "reset_password" "results" "set-rule-order" "setup" "sync" "upgrade" "upload" "variables" Fetch by list of operation types |
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 events triggered after this date-time |
skip | integer <int32> Default: 0 Number of events to skip |
source | Array of strings (EventRequestSource) Items Enum: "api" "api-webhook" "custom" Fetch by list of event sources |
status | Array of strings (EventRequestStatus) Items Enum: "pending" "acknowledged" "completed" "failed" Fetch by list of event statuses |
until | string <date-time> Fetch events triggered before this date-time |
userId | Array of strings Fetch by list of userId |
{- "code": 200,
- "success": true,
- "events": [
- {
- "eventId": "string",
- "keywords": [
- "string"
], - "source": "custom",
- "direction": "in",
- "duration": 0,
- "entityId": "string",
- "entityType": "string",
- "extEntityId": "string",
- "integration": "string",
- "isBatch": true,
- "operation": "create",
- "request": {
- "authobj": { },
- "body": "string",
- "headers": { },
- "method": "string",
- "url": "string"
}, - "requestId": "string",
- "response": {
- "body": "string",
- "headers": { },
- "message": "string",
- "retries": 0,
- "status": 0
}, - "status": "pending",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "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",
- "apikeyId": [
- "string"
], - "direction": [
- "in"
], - "entityId": [
- "string"
], - "entityType": [
- "string"
], - "eventId": [
- "string"
], - "extEntityId": [
- "string"
], - "identity": [
- "string"
], - "integration": [
- "string"
], - "keywords": [
- "string"
], - "operation": [
- "create"
], - "source": [
- "api"
], - "status": [
- "pending"
], - "userId": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
EventId required | string |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
duration | number <int32> operation duration |
isBatch | boolean Indicates if the event is for a batch action |
object (EventResponseData) | |
status | string (EventRequestStatus) Enum: "pending" "acknowledged" "completed" "failed" Event Status |
{- "duration": 0,
- "isBatch": true,
- "response": {
- "body": "string",
- "headers": { },
- "message": "string",
- "retries": 0,
- "status": 0
}, - "status": "pending"
}
{- "code": 200,
- "success": true,
- "event": {
- "eventId": "string",
- "keywords": [
- "string"
], - "source": "custom",
- "direction": "in",
- "duration": 0,
- "entityId": "string",
- "entityType": "string",
- "extEntityId": "string",
- "integration": "string",
- "isBatch": true,
- "operation": "create",
- "request": {
- "authobj": { },
- "body": "string",
- "headers": { },
- "method": "string",
- "url": "string"
}, - "requestId": "string",
- "response": {
- "body": "string",
- "headers": { },
- "message": "string",
- "retries": 0,
- "status": 0
}, - "status": "pending",
- "timestamp": "2019-08-24T14:15:22Z",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
entityId required | string Entity ID |
entityType required | string (ExceptionEntityName) Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "changelog" "connectors" "customers" "contacts" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "functions" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "invoices" "jobs" "labels" "locations" "lookup_objects" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "catalogs" "catalog_products" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "vendor_schemas" "webhooks" Exception Entity Name |
exceptionType required | string (ExceptionType) Enum: "eAutomation" "eAutomationCodeFilterError" "eAutomationCodeActionError" "eGeneric" "eSyncFailure" "eUnacknowledged" "eDelayed" "eLate" "eLateCancel" "eEarly" "eLost" "eToday" "eSplit" "eStuck" "eLarge" "eLow" "eMissing" "eMissingSKU" "eMissingLocation" "eMismatch" "eMismatchTax" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidSKU" "eInvalidMethod" "eIncomplete" "eIncompleteAddress" "eDuplicate" "eDuplicateSKU" "eUnexpected" "eUnexpectedDate" "eUnexpectedRoutingDelay" "ePotentialShipByDateDelay" "eRestock" "eOutOfStock" "eFraudSuspected" "eApprovalRequired" "ePartiallyCanceled" "eRouteNotFound" "eRouteOutOfStock" "eShippingMethod" "ePaymentRequired" "eUnfulfillable" "eTransform" "eShipmentMismatch" "eUnexpectedSplitShipment" "ePotentialOverfulfill" "eStuckShippingRequest" "eCreditMemoInsufficient" "eOrderSyncFailure" "eOrderTaxMismatch" "eInventoryOutOfStock" Exception type |
aiTip | string |
autoEngUpdateStatus | string (AutoEngUpdateStatus) Enum: "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 |
categoryId | string Exception category ID |
createdAt | string <date-time> When the object was created within Pipe17 |
exceptionDetails | string Exception specific error message/details |
exceptionId | string Exception ID |
exceptionPriority | string (ExceptionPriority) Enum: "high" "medium" "low" Exception priority |
exceptionSeverity | string (ExceptionSeverity) Enum: "high" "medium" "low" Exception severity |
extEntityId | string External Entity ID |
extRelatedEntityId | string External ID of Related Entity |
integration | string Reference to integration that created an item |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
recommendation | string |
relatedEntityId | string Related Entity ID (e.g. for shipping request related entity is sales order or transfer order) |
relatedEntityType | string (ExceptionEntityName) Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "changelog" "connectors" "customers" "contacts" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "functions" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "invoices" "jobs" "labels" "locations" "lookup_objects" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "catalogs" "catalog_products" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "vendor_schemas" "webhooks" Exception Entity Name |
status | string (ExceptionStatus) Enum: "active" "dismissed" "resolved" Exception status |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "categoryId": "string",
- "exceptionId": "string",
- "integration": "string",
- "status": "active",
- "entityId": "string",
- "entityType": "accounts",
- "exceptionType": "eAutomation",
- "aiTip": "string",
- "exceptionDetails": "string",
- "exceptionPriority": "high",
- "exceptionSeverity": "high",
- "extEntityId": "string",
- "extRelatedEntityId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "recommendation": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
entityId required | string Entity ID |
entityType required | string (ExceptionEntityName) Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "changelog" "connectors" "customers" "contacts" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "functions" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "invoices" "jobs" "labels" "locations" "lookup_objects" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "catalogs" "catalog_products" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "vendor_schemas" "webhooks" Exception Entity Name |
exceptionType required | string (ExceptionType) Enum: "eAutomation" "eAutomationCodeFilterError" "eAutomationCodeActionError" "eGeneric" "eSyncFailure" "eUnacknowledged" "eDelayed" "eLate" "eLateCancel" "eEarly" "eLost" "eToday" "eSplit" "eStuck" "eLarge" "eLow" "eMissing" "eMissingSKU" "eMissingLocation" "eMismatch" "eMismatchTax" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidSKU" "eInvalidMethod" "eIncomplete" "eIncompleteAddress" "eDuplicate" "eDuplicateSKU" "eUnexpected" "eUnexpectedDate" "eUnexpectedRoutingDelay" "ePotentialShipByDateDelay" "eRestock" "eOutOfStock" "eFraudSuspected" "eApprovalRequired" "ePartiallyCanceled" "eRouteNotFound" "eRouteOutOfStock" "eShippingMethod" "ePaymentRequired" "eUnfulfillable" "eTransform" "eShipmentMismatch" "eUnexpectedSplitShipment" "ePotentialOverfulfill" "eStuckShippingRequest" "eCreditMemoInsufficient" "eOrderSyncFailure" "eOrderTaxMismatch" "eInventoryOutOfStock" Exception type |
aiTip | string |
exceptionDetails | string Exception specific error message/details |
exceptionPriority | string (ExceptionPriority) Enum: "high" "medium" "low" Exception priority |
exceptionSeverity | string (ExceptionSeverity) Enum: "high" "medium" "low" Exception severity |
extEntityId | string External Entity ID |
extRelatedEntityId | string External ID of Related Entity |
object (InternalInfo) Internal info | |
recommendation | string |
relatedEntityId | string Related Entity ID (e.g. for shipping request related entity is sales order or transfer order) |
relatedEntityType | string (ExceptionEntityName) Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "changelog" "connectors" "customers" "contacts" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "functions" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "invoices" "jobs" "labels" "locations" "lookup_objects" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "catalogs" "catalog_products" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "vendor_schemas" "webhooks" Exception Entity Name |
{- "entityId": "string",
- "entityType": "accounts",
- "exceptionType": "eAutomation",
- "aiTip": "string",
- "exceptionDetails": "string",
- "exceptionPriority": "high",
- "exceptionSeverity": "high",
- "extEntityId": "string",
- "extRelatedEntityId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "recommendation": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "accounts"
}
{- "code": 200,
- "success": true,
- "exception": {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "categoryId": "string",
- "exceptionId": "string",
- "integration": "string",
- "status": "active",
- "entityId": "string",
- "entityType": "accounts",
- "exceptionType": "eAutomation",
- "aiTip": "string",
- "exceptionDetails": "string",
- "exceptionPriority": "high",
- "exceptionSeverity": "high",
- "extEntityId": "string",
- "extRelatedEntityId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "recommendation": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
ExceptionId required | string Exception ID to fetch |
{- "code": 200,
- "success": true,
- "exception": {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "categoryId": "string",
- "exceptionId": "string",
- "integration": "string",
- "status": "active",
- "entityId": "string",
- "entityType": "accounts",
- "exceptionType": "eAutomation",
- "aiTip": "string",
- "exceptionDetails": "string",
- "exceptionPriority": "high",
- "exceptionSeverity": "high",
- "extEntityId": "string",
- "extRelatedEntityId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "recommendation": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
autoEngUpdateStatus | Array of strings (AutoEngUpdateStatus) Items Enum: "pending" "updated" "none" Return exceptions with the specified autoEngUpdateStatus values |
autoEngUpdateStatusUpdatedSince | string <date-time> Fetch with autoEngUpdateStatus updated after this date-time |
autoEngUpdateStatusUpdatedUntil | string <date-time> Fetch with autoEngUpdateStatus updated before this date-time |
categoryId | Array of strings Exceptions by categoryId-list |
count | integer <int32> Default: 100 Max number of exceptions to return |
entityId | Array of strings Exceptions related to this list of entities |
entityType | Array of strings (ExceptionEntityName) Items Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "changelog" "connectors" "customers" "contacts" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "functions" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "invoices" "jobs" "labels" "locations" "lookup_objects" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "catalogs" "catalog_products" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "vendor_schemas" "webhooks" Exceptions related to list of entity types |
exceptionDetails | Array of strings Exceptions with the status |
exceptionId | Array of strings Exceptions by exceptionId-list |
exceptionPriority | Array of strings (ExceptionPriority) Items Enum: "high" "medium" "low" Exceptions by exceptionPriority-list |
exceptionSeverity | Array of strings (ExceptionSeverity) Items Enum: "high" "medium" "low" Exceptions by exceptionSeverity-list |
exceptionType | Array of strings (ExceptionType) Items Enum: "eAutomation" "eAutomationCodeFilterError" "eAutomationCodeActionError" "eGeneric" "eSyncFailure" "eUnacknowledged" "eDelayed" "eLate" "eLateCancel" "eEarly" "eLost" "eToday" "eSplit" "eStuck" "eLarge" "eLow" "eMissing" "eMissingSKU" "eMissingLocation" "eMismatch" "eMismatchTax" "eInvalid" "eInvalidAddress" "eInvalidDate" "eInvalidLocation" "eInvalidSKU" "eInvalidMethod" "eIncomplete" "eIncompleteAddress" "eDuplicate" "eDuplicateSKU" "eUnexpected" "eUnexpectedDate" "eUnexpectedRoutingDelay" "ePotentialShipByDateDelay" "eRestock" "eOutOfStock" "eFraudSuspected" "eApprovalRequired" "ePartiallyCanceled" "eRouteNotFound" "eRouteOutOfStock" "eShippingMethod" "ePaymentRequired" "eUnfulfillable" "eTransform" "eShipmentMismatch" "eUnexpectedSplitShipment" "ePotentialOverfulfill" "eStuckShippingRequest" "eCreditMemoInsufficient" "eOrderSyncFailure" "eOrderTaxMismatch" "eInventoryOutOfStock" Exceptions by exceptionType-list |
extEntityId | Array of strings Exceptions related to this list of entities |
extRelatedEntityId | Array of strings Exceptions related to this list of related entities |
integrationOwned | boolean Exceptions created by current integration only |
keys | string Default: "exceptionId,categoryId,exceptionType,exceptionDetails,entityId,entityType,relatedEntityId,relatedEntityType,extEntityId,extRelatedEntityId,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 |
relatedEntityId | Array of strings Exceptions related to this list of related entities |
relatedEntityType | Array of strings (ExceptionEntityName) Items Enum: "accounts" "apikey" "arrivals" "automation_rules" "automation_runs" "automations" "changelog" "connectors" "customers" "contacts" "entity_filters" "entity_schemas" "events" "exception_categories" "exception_filters" "exceptions" "fulfillments" "functions" "integration_actions" "integration_state" "integrations" "inventory" "inventoryrules" "invoices" "jobs" "labels" "locations" "lookup_objects" "mappings" "notes" "order_routing_runs" "order_routings" "orders" "organizations" "catalogs" "catalog_products" "pricing" "products" "purchases" "receipts" "references" "refunds" "returns" "roles" "routings" "shipment_boxes" "shipments" "shipping_methods" "statement_transactions" "statements" "suppliers" "trackings" "transfers" "usagedata" "usageplans" "users" "vendor_schemas" "webhooks" Exceptions related to list of related entity types |
since | string <date-time> Exceptions created after this date-time |
skip | integer <int32> Default: 0 Number of exceptions to skip |
status | Array of strings (ExceptionStatus) Items Enum: "active" "dismissed" "resolved" Exceptions by status-list |
until | string <date-time> Exceptions created before this date-time |
updatedSince | string <date-time> Exceptions updated after this date-time |
updatedUntil | string <date-time> Exceptions updated before this date-time |
{- "code": 200,
- "success": true,
- "exceptions": [
- {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "categoryId": "string",
- "exceptionId": "string",
- "integration": "string",
- "status": "active",
- "entityId": "string",
- "entityType": "accounts",
- "exceptionType": "eAutomation",
- "aiTip": "string",
- "exceptionDetails": "string",
- "exceptionPriority": "high",
- "exceptionSeverity": "high",
- "extEntityId": "string",
- "extRelatedEntityId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "recommendation": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "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",
- "autoEngUpdateStatus": [
- "pending"
], - "categoryId": [
- "string"
], - "entityId": [
- "string"
], - "entityType": [
- "string"
], - "exceptionDetails": [
- "string"
], - "exceptionId": [
- "string"
], - "exceptionPriority": [
- "high"
], - "exceptionSeverity": [
- "high"
], - "exceptionType": [
- "string"
], - "extEntityId": [
- "string"
], - "extRelatedEntityId": [
- "string"
], - "relatedEntityId": [
- "string"
], - "relatedEntityType": [
- "string"
], - "status": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Uniqueness constraints within organization:
ExceptionId required | string Exception ID to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
aiTip | string or null |
autoEngUpdateStatus | string (AutoEngUpdateStatus) Enum: "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 (InternalInfo) Internal info | |
recommendation | string or null |
status | string (ExceptionStatus) Enum: "active" "dismissed" "resolved" Exception status |
{- "aiTip": "string",
- "autoEngUpdateStatus": "pending",
- "internal": {
- "property1": { },
- "property2": { }
}, - "recommendation": "string",
- "status": "active"
}
{- "code": 200,
- "success": true,
- "exception": {
- "autoEngUpdateStatus": "pending",
- "autoEngUpdateStatusUpdatedAt": "2019-08-24T14:15:22Z",
- "categoryId": "string",
- "exceptionId": "string",
- "integration": "string",
- "status": "active",
- "entityId": "string",
- "entityType": "accounts",
- "exceptionType": "eAutomation",
- "aiTip": "string",
- "exceptionDetails": "string",
- "exceptionPriority": "high",
- "exceptionSeverity": "high",
- "extEntityId": "string",
- "extRelatedEntityId": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "recommendation": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "accounts",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
actionType required | string Action Type (matches to what is included in connector manifest) |
integrationId required | string Integration ID |
actionId | string Integration action ID |
actionName | string Action Name - label for this action invocation |
Array of objects (IntegrationActionParam) Action parameters (array of parameters, collected for this action from user) | |
createdAt | string <date-time> When the object was created within Pipe17 |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
progress | number Percent action complete |
status | string (IntegrationActionStatus) Enum: "submitted" "processing" "completed" "canceled" "failed" Integration action status |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "actionId": "string",
- "progress": 0,
- "status": "submitted",
- "actionType": "string",
- "integrationId": "string",
- "actionName": "string",
- "actionParams": [
- {
- "path": "string",
- "value": { }
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
actionType required | string Action Type (matches to what is included in connector manifest) |
integrationId required | string Integration ID |
actionName | string Action Name - label for this action invocation |
Array of objects (IntegrationActionParam) Action parameters (array of parameters, collected for this action from user) | |
object (InternalInfo) Internal info |
{- "actionType": "string",
- "integrationId": "string",
- "actionName": "string",
- "actionParams": [
- {
- "path": "string",
- "value": { }
}
], - "internal": {
- "property1": { },
- "property2": { }
}
}
{- "code": 200,
- "success": true,
- "action": {
- "actionId": "string",
- "progress": 0,
- "status": "submitted",
- "actionType": "string",
- "integrationId": "string",
- "actionName": "string",
- "actionParams": [
- {
- "path": "string",
- "value": { }
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "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 |
actionId | Array of strings Delete actions by list of actionId |
actionType | Array of strings Delete actions by list of actionType |
count | integer <int32> Default: 100 Max number of actions to delete |
deleted | boolean Delete soft deleted actions |
integrationId | Array of strings Delete actions by list of integrationId |
since | string <date-time> Delete actions created after this date-time |
skip | integer <int32> Default: 0 Number of actions to skip |
status | Array of strings Delete actions by list of statuses |
until | string <date-time> Delete actions created before this date-time |
updatedSince | string <date-time> Delete actions updated after this date-time |
updatedUntil | string <date-time> Delete actions updated before this date-time |
{- "code": 200,
- "success": true,
- "actions": [
- {
- "actionId": "string",
- "progress": 0,
- "status": "submitted",
- "actionType": "string",
- "integrationId": "string",
- "actionName": "string",
- "actionParams": [
- {
- "path": "string",
- "value": { }
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "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",
- "actionId": [
- "string"
], - "actionType": [
- "string"
], - "deleted": true,
- "integrationId": [
- "string"
], - "status": [
- "string"
]
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
IntegrationActionId required | string |
{- "code": 200,
- "success": true,
- "action": {
- "actionId": "string",
- "progress": 0,
- "status": "submitted",
- "actionType": "string",
- "integrationId": "string",
- "actionName": "string",
- "actionParams": [
- {
- "path": "string",
- "value": { }
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
actionId | Array of strings Fetch actions by list of actionId |
actionType | Array of strings Fetch actions by list of actionType |
count | integer <int32> Default: 100 Max number of actions to return |
deleted | boolean Fetch soft deleted actions |
integrationId | Array of strings Fetch actions by list of integrationId |
keys | string Default: "actionId,actionType,actionName,actionParams,integrationId,createdAt,updatedAt,orgKey,status,progress" 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 actions created after this date-time |
skip | integer <int32> Default: 0 Number of actions to skip |
status | Array of strings Fetch actions by list of action statuses |
until | string <date-time> Fetch actions created before this date-time |
updatedSince | string <date-time> Fetch actions updated after this date-time |
updatedUntil | string <date-time> Fetch actions updated before this date-time |
{- "code": 200,
- "success": true,
- "actions": [
- {
- "actionId": "string",
- "progress": 0,
- "status": "submitted",
- "actionType": "string",
- "integrationId": "string",
- "actionName": "string",
- "actionParams": [
- {
- "path": "string",
- "value": { }
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "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",
- "actionId": [
- "string"
], - "actionType": [
- "string"
], - "deleted": true,
- "integrationId": [
- "string"
], - "status": [
- "string"
], - "keys": "string",
- "order": "string"
}
}
IntegrationActionId required | string |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
object (InternalInfo) Internal info | |
progress | number Action progress (0-100) |
status | string (IntegrationActionStatus) Enum: "submitted" "processing" "completed" "canceled" "failed" Integration action status |
{- "internal": {
- "property1": { },
- "property2": { }
}, - "progress": 0,
- "status": "submitted"
}
{- "code": 200,
- "success": true,
- "action": {
- "actionId": "string",
- "progress": 0,
- "status": "submitted",
- "actionType": "string",
- "integrationId": "string",
- "actionName": "string",
- "actionParams": [
- {
- "path": "string",
- "value": { }
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
integrationName required | string Integration Name |
Array of objects (IntegrationActionSimple) List of integration actions | |
apikey | string Integration api Key |
capability | Array of strings Items Enum: "arrivals:in" "arrivals:out" "customers:in" "customers:out" "contacts:in" "contacts:out" "fulfillments:in" "fulfillments:out" "inventory:in" "inventory:out" "labels:in" "labels:out" "locations:in" "locations:out" "orders:in" "orders:out" "products:in" "products:out" "purchases:in" "purchases:out" "receipts:in" "receipts:out" "refunds:in" "refunds:out" "returns:in" "returns:out" "shipments:in" "shipments:out" "suppliers:in" "suppliers:out" "transfers:in" "transfers:out" "shipping_methods" "sku_mapping" "shipments_cancel_in" "shipments_cancel_out" "events_outbound_replay" "events_outbound_batch" "inventory_requires_products" "orders_cancel_in" "orders_cancel_out" "inventory_incremental" "locations_multiple" "orders_multiple_destinations" |
object (IntegrationConnection) 3rd party's credentials | |
connectorId | string Connector ID (either Name or ID required) |
connectorName | string Connector Name (either Name or ID required) |
createdAt | string <date-time> When the object was created within Pipe17 |
Array of objects (IntegrationEntity) | |
environment | string (Env) Enum: "test" "prod" Environment ID |
errorText | string Error message |
extIntegrationId | string Unique integration identifier as defined by Connector logic |
integrationId | string Integration Id |
object (InternalInfo) Internal info | |
linkedConnectorId | string |
linkedConnectorName | string |
orgKey | string Organization this object belong to |
object (IntegrationSettings) Connector specific | |
status | string (IntegrationStatus) Enum: "created" "configured" "initializing" "connected" "error" "disabled" "future" Integration Status |
updatedAt | string <date-time> When the object was updated within Pipe17 |
object | |
version | string Integration version |
{- "actions": [
- {
- "actionName": "string",
- "actionType": "string"
}
], - "apikey": "string",
- "capability": [
- "arrivals:in"
], - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "errorText": "string",
- "extIntegrationId": "string",
- "integrationId": "string",
- "status": "created",
- "variables": {
- "property1": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}, - "property2": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}
}, - "version": "string",
- "integrationName": "string",
- "connection": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "connectorId": "string",
- "connectorName": "string",
- "entities": [
- {
- "direction": "in",
- "mappingUuid": "string",
- "name": "accounts",
- "restrictions": [
- {
- "path": "restricted",
- "type": "boolean",
- "value": { }
}
], - "routingUuid": "string"
}
], - "environment": "test",
- "internal": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
integrationName required | string Integration Name |
object (IntegrationConnection) 3rd party's credentials | |
connectorId | string Connector ID (either Name or ID required) |
connectorName | string Connector Name (either Name or ID required) |
Array of objects (IntegrationEntity) | |
environment | string (Env) Enum: "test" "prod" Environment ID |
object (InternalInfo) Internal info | |
object (IntegrationSettings) Connector specific |
{- "integrationName": "string",
- "connection": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "connectorId": "string",
- "connectorName": "string",
- "entities": [
- {
- "direction": "in",
- "mappingUuid": "string",
- "name": "accounts",
- "restrictions": [
- {
- "path": "restricted",
- "type": "boolean",
- "value": { }
}
], - "routingUuid": "string"
}
], - "environment": "test",
- "internal": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}
}
{- "code": 200,
- "success": true,
- "integration": {
- "actions": [
- {
- "actionName": "string",
- "actionType": "string"
}
], - "apikey": "string",
- "capability": [
- "arrivals:in"
], - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "errorText": "string",
- "extIntegrationId": "string",
- "integrationId": "string",
- "status": "created",
- "variables": {
- "property1": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}, - "property2": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}
}, - "version": "string",
- "integrationName": "string",
- "connection": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "connectorId": "string",
- "connectorName": "string",
- "entities": [
- {
- "direction": "in",
- "mappingUuid": "string",
- "name": "accounts",
- "restrictions": [
- {
- "path": "restricted",
- "type": "boolean",
- "value": { }
}
], - "routingUuid": "string"
}
], - "environment": "test",
- "internal": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
IntegrationId required | string Integration Id to fetch |
keys | string Default: "*" Return these top-level fields |
{- "code": 200,
- "success": true,
- "integration": {
- "actions": [
- {
- "actionName": "string",
- "actionType": "string"
}
], - "apikey": "string",
- "capability": [
- "arrivals:in"
], - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "errorText": "string",
- "extIntegrationId": "string",
- "integrationId": "string",
- "status": "created",
- "variables": {
- "property1": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}, - "property2": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}
}, - "version": "string",
- "integrationName": "string",
- "connection": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "connectorId": "string",
- "connectorName": "string",
- "entities": [
- {
- "direction": "in",
- "mappingUuid": "string",
- "name": "accounts",
- "restrictions": [
- {
- "path": "restricted",
- "type": "boolean",
- "value": { }
}
], - "routingUuid": "string"
}
], - "environment": "test",
- "internal": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
IntegrationId required | string Integration Id to update |
name | Array of strings Retrieve variables by list of their names |
{- "code": 200,
- "success": true,
- "variables": {
- "property1": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}, - "property2": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}
}
}
capability | Array of strings (IntegrationCapability) Items Enum: "arrivals:in" "arrivals:out" "customers:in" "customers:out" "contacts:in" "contacts:out" "fulfillments:in" "fulfillments:out" "inventory:in" "inventory:out" "labels:in" "labels:out" "locations:in" "locations:out" "orders:in" "orders:out" "products:in" "products:out" "purchases:in" "purchases:out" "receipts:in" "receipts:out" "refunds:in" "refunds:out" "returns:in" "returns:out" "shipments:in" "shipments:out" "suppliers:in" "suppliers:out" "transfers:in" "transfers:out" "shipping_methods" "sku_mapping" "shipments_cancel_in" "shipments_cancel_out" "events_outbound_replay" "events_outbound_batch" "inventory_requires_products" "orders_cancel_in" "orders_cancel_out" "inventory_incremental" "locations_multiple" "orders_multiple_destinations" Retrieve connectors by list of capabilities |
connectorId | Array of strings Retrieve integrations by connector Id(s) |
connectorName | Array of strings Retrieve integrations by list of connector names |
count | integer <int32> Default: 100 Return at most this many integrations |
extIntegrationId | Array of strings Retrieve by list of extIntegrationId |
integrationId | Array of strings Retrieve by list of integrationId |
keys | string Default: "version,integrationId,integrationName,status,connectorName,connectorId,entities,settings,connection,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> Integrations created after this date-time |
skip | integer <int32> Default: 0 Skip this many integrations |
status | Array of strings (IntegrationStatus) Items Enum: "created" "configured" "initializing" "connected" "error" "disabled" "future" Retrieve integrations by status |
until | string <date-time> Integrations created before this date-time |
updatedSince | string <date-time> Integrations updated after this date-time |
updatedUntil | string <date-time> Integrations 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",
- "capability": [
- "arrivals:in"
], - "connectorId": "string",
- "connectorName": [
- "string"
], - "extIntegrationId": [
- "string"
], - "integrationId": [
- "string"
], - "status": "created",
- "keys": "string",
- "order": "string"
}, - "integrations": [
- {
- "capability": [
- "arrivals:in"
], - "errorText": "string",
- "extIntegrationId": "string",
- "integrationId": "string",
- "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "status": "created",
- "variables": {
- "property1": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}, - "property2": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}
}, - "version": "string",
- "integrationName": "string",
- "connection": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "connectorId": "string",
- "connectorName": "string",
- "entities": [
- {
- "direction": "in",
- "mappingUuid": "string",
- "name": "accounts",
- "restrictions": [
- {
- "path": "restricted",
- "type": "boolean",
- "value": { }
}
], - "routingUuid": "string"
}
], - "environment": "test",
- "internal": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "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:
IntegrationId required | string Integration Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
apikey | boolean Update integration api key |
object (IntegrationConnection) 3rd party's credentials | |
Array of objects (IntegrationEntity) | |
errorText | string or null Error message |
extIntegrationId | string Unique integration identifier as defined by Connector logic |
integrationName | string Integration Name |
object (InternalInfo) Internal info | |
object (IntegrationSettings) Connector specific | |
status | string (IntegrationStatus) Enum: "created" "configured" "initializing" "connected" "error" "disabled" "future" Integration Status |
object or null |
{- "apikey": true,
- "connection": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "entities": [
- {
- "direction": "in",
- "mappingUuid": "string",
- "name": "accounts",
- "restrictions": [
- {
- "path": "restricted",
- "type": "boolean",
- "value": { }
}
], - "routingUuid": "string"
}
], - "errorText": "string",
- "extIntegrationId": "string",
- "integrationName": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "status": "created",
- "variables": {
- "property1": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}, - "property2": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}
}
}
{- "code": 200,
- "success": true,
- "integration": {
- "actions": [
- {
- "actionName": "string",
- "actionType": "string"
}
], - "apikey": "string",
- "capability": [
- "arrivals:in"
], - "linkedConnectorId": "string",
- "linkedConnectorName": "string",
- "errorText": "string",
- "extIntegrationId": "string",
- "integrationId": "string",
- "status": "created",
- "variables": {
- "property1": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}, - "property2": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}
}, - "version": "string",
- "integrationName": "string",
- "connection": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "connectorId": "string",
- "connectorName": "string",
- "entities": [
- {
- "direction": "in",
- "mappingUuid": "string",
- "name": "accounts",
- "restrictions": [
- {
- "path": "restricted",
- "type": "boolean",
- "value": { }
}
], - "routingUuid": "string"
}
], - "environment": "test",
- "internal": {
- "property1": { },
- "property2": { }
}, - "settings": {
- "fields": [
- {
- "path": "string",
- "value": { }
}
]
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
IntegrationId required | string Integration Id to update |
object or null |
{- "variables": {
- "property1": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}, - "property2": {
- "expiry": "2019-08-24T14:15:22Z",
- "type": "string",
- "value": { }
}
}
}
{- "code": 200,
- "success": true
}
IntegrationId required | string Integration Id to upgrade |
version | string Connector version |
{- "version": "string"
}
{- "code": 200,
- "success": true
}
description required | string Description |
isPublic required | boolean Public mapping indicator |
apikeyId | string Id of apikey modified mapping |
connectorId | string Connector that uses this mapping |
createdAt | string <date-time> When the object was created within Pipe17 |
documentationURLs | Array of strings |
object (InternalInfo) Internal info | |
mappingId | string Mapping ID |
Array of objects (MappingRule) | |
orgKey | string Organization this object belong to |
originId | string |
readme | string |
updatedAt | string <date-time> When the object was updated within Pipe17 |
userId | string Id of user modified mapping |
uuid | string UUID (generated if not provided) |
version | number Mapping version |
{- "apikeyId": "string",
- "connectorId": "string",
- "mappingId": "string",
- "userId": "string",
- "version": 0,
- "description": "string",
- "isPublic": true,
- "documentationURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "mappings": [
- {
- "enabled": true,
- "name": "string",
- "source": "string",
- "target": "string",
- "default": { },
- "desc": "string",
- "lookup": { },
- "missing": { },
- "options": "normal",
- "readme": "string",
- "require": true,
- "type": "string"
}
], - "originId": "string",
- "readme": "string",
- "uuid": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints:
description required | string Description |
isPublic required | boolean Public mapping indicator |
documentationURLs | Array of strings |
object (InternalInfo) Internal info | |
Array of objects (MappingRule) | |
originId | string |
readme | string |
uuid | string UUID (generated if not provided) |
{- "description": "string",
- "isPublic": true,
- "documentationURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "mappings": [
- {
- "enabled": true,
- "name": "string",
- "source": "string",
- "target": "string",
- "default": { },
- "desc": "string",
- "lookup": { },
- "missing": { },
- "options": "normal",
- "readme": "string",
- "require": true,
- "type": "string"
}
], - "originId": "string",
- "readme": "string",
- "uuid": "string"
}
{- "code": 200,
- "success": true,
- "mapping": {
- "apikeyId": "string",
- "connectorId": "string",
- "mappingId": "string",
- "userId": "string",
- "version": 0,
- "description": "string",
- "isPublic": true,
- "documentationURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "mappings": [
- {
- "enabled": true,
- "name": "string",
- "source": "string",
- "target": "string",
- "default": { },
- "desc": "string",
- "lookup": { },
- "missing": { },
- "options": "normal",
- "readme": "string",
- "require": true,
- "type": "string"
}
], - "originId": "string",
- "readme": "string",
- "uuid": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
MappingId required | string ID or |
merge | string (MappingsMergeMode) Enum: "origin" "none" Mapping merge mode |
version | string ID of mapping rules version to retrieve |
{- "code": 200,
- "success": true,
- "mapping": {
- "apikeyId": "string",
- "connectorId": "string",
- "mappingId": "string",
- "userId": "string",
- "version": 0,
- "description": "string",
- "isPublic": true,
- "documentationURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "mappings": [
- {
- "enabled": true,
- "name": "string",
- "source": "string",
- "target": "string",
- "default": { },
- "desc": "string",
- "lookup": { },
- "missing": { },
- "options": "normal",
- "readme": "string",
- "require": true,
- "type": "string"
}
], - "originId": "string",
- "readme": "string",
- "uuid": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
connectorId | Array of strings Mappings by list of connectorId |
count | integer <int32> Default: 100 Return at most this many mappings |
desc | string Fetch mappings by description (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
keys | string Default: "mappingId,connectorId,uuid,description,createdAt,updatedAt,orgKey,isPublic,originId,documentationURLs,readme" Return these top-level fields |
mappingId | Array of strings Mappings by list of mappingId |
order | string Default: "createdAt" Sort by these top-level fields |
originId | Array of strings Mappings by list of originId |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Mappings created after this date-time |
skip | integer <int32> Default: 0 Skip this many mappings |
until | string <date-time> Mappings created before this date-time |
updatedSince | string <date-time> Mappings updated after this date-time |
updatedUntil | string <date-time> Mappings updated before this date-time |
uuid | Array of strings Mappings by list of UUIDs |
{- "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",
- "connectorId": [
- "string"
], - "desc": "string",
- "mappingId": [
- "string"
], - "originId": [
- "string"
], - "uuid": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "mappings": [
- {
- "apikeyId": "string",
- "connectorId": "string",
- "mappingId": "string",
- "userId": "string",
- "version": 0,
- "description": "string",
- "isPublic": true,
- "documentationURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "mappings": [
- {
- "enabled": true,
- "name": "string",
- "source": "string",
- "target": "string",
- "default": { },
- "desc": "string",
- "lookup": { },
- "missing": { },
- "options": "normal",
- "readme": "string",
- "require": true,
- "type": "string"
}
], - "originId": "string",
- "readme": "string",
- "uuid": "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:
MappingId required | string ID or |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
description | string Description |
documentationURLs | Array of strings or null |
object (InternalInfo) Internal info | |
isPublic | boolean Public mapping indicator |
Array of objects (MappingUpdateRule) | |
originId | string |
readme | string or null |
{- "description": "string",
- "documentationURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "mappings": [
- {
- "default": { },
- "desc": "string",
- "enabled": true,
- "lookup": { },
- "missing": { },
- "name": "string",
- "options": "normal",
- "readme": "string",
- "require": true,
- "source": "string",
- "target": "string",
- "type": "string"
}
], - "originId": "string",
- "readme": "string"
}
{- "code": 200,
- "success": true,
- "mapping": {
- "apikeyId": "string",
- "connectorId": "string",
- "mappingId": "string",
- "userId": "string",
- "version": 0,
- "description": "string",
- "isPublic": true,
- "documentationURLs": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "mappings": [
- {
- "enabled": true,
- "name": "string",
- "source": "string",
- "target": "string",
- "default": { },
- "desc": "string",
- "lookup": { },
- "missing": { },
- "options": "normal",
- "readme": "string",
- "require": true,
- "type": "string"
}
], - "originId": "string",
- "readme": "string",
- "uuid": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
changeSource required | string (NoteChangeSource) Enum: "ui" "api" "other" Change source |
changeType required | string (NoteChangeType) Enum: "config" "comment" "other" Change type |
entityId required | string Target entity ID |
entityType required | string Target entity type |
action | string (NoteAction) Enum: "create" "update" "delete" Action enum |
createdAt | string <date-time> When the object was created within Pipe17 |
eventId | string Event ID associated with note |
extEntityId | string Target entity external ID |
generatedText | string Generated summary of changes |
hasPostValue | boolean Indicates the postValue is defined |
hasPreValue | boolean Indicates the preValue is defined |
object (InternalInfo) Internal info | |
isPublic | boolean Public note indicator (default - true) |
noteId | string Note Id |
orgKey | string Organization this object belong to |
postValue | object Value of target entity after change |
preValue | object Value of target entity before change |
reference | string |
relatedEntityId | string Related entity ID |
relatedEntityType | string Related entity type |
relatedReference | string |
severity | string (NoteSeverity) Enum: "normal" "low" "high" Note severity |
status | string (NoteStatus) Value: "valid" Note status |
tags | Array of strings (EntityTags) Tags assigned to entity |
text | string Note content |
updatedAt | string <date-time> When the object was updated within Pipe17 |
userId | string Author |
{- "hasPostValue": true,
- "hasPreValue": true,
- "noteId": "string",
- "userId": "string",
- "changeSource": "ui",
- "changeType": "config",
- "entityId": "string",
- "entityType": "string",
- "action": "create",
- "eventId": "string",
- "extEntityId": "string",
- "generatedText": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "postValue": { },
- "preValue": { },
- "reference": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "string",
- "relatedReference": "string",
- "severity": "normal",
- "status": "valid",
- "tags": [
- "string"
], - "text": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
changeSource required | string (NoteChangeSource) Enum: "ui" "api" "other" Change source |
changeType required | string (NoteChangeType) Enum: "config" "comment" "other" Change type |
entityId required | string Target entity ID |
entityType required | string Target entity type |
action | string (NoteAction) Enum: "create" "update" "delete" Action enum |
eventId | string Event ID associated with note |
extEntityId | string Target entity external ID |
generatedText | string Generated summary of changes |
object (InternalInfo) Internal info | |
isPublic | boolean Public note indicator (default - true) |
postValue | object Value of target entity after change |
preValue | object Value of target entity before change |
reference | string |
relatedEntityId | string Related entity ID |
relatedEntityType | string Related entity type |
relatedReference | string |
severity | string (NoteSeverity) Enum: "normal" "low" "high" Note severity |
status | string (NoteStatus) Value: "valid" Note status |
tags | Array of strings (EntityTags) Tags assigned to entity |
text | string Note content |
{- "changeSource": "ui",
- "changeType": "config",
- "entityId": "string",
- "entityType": "string",
- "action": "create",
- "eventId": "string",
- "extEntityId": "string",
- "generatedText": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "postValue": { },
- "preValue": { },
- "reference": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "string",
- "relatedReference": "string",
- "severity": "normal",
- "status": "valid",
- "tags": [
- "string"
], - "text": "string"
}
{- "code": 200,
- "success": true,
- "note": {
- "hasPostValue": true,
- "hasPreValue": true,
- "noteId": "string",
- "userId": "string",
- "changeSource": "ui",
- "changeType": "config",
- "entityId": "string",
- "entityType": "string",
- "action": "create",
- "eventId": "string",
- "extEntityId": "string",
- "generatedText": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "postValue": { },
- "preValue": { },
- "reference": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "string",
- "relatedReference": "string",
- "severity": "normal",
- "status": "valid",
- "tags": [
- "string"
], - "text": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
NoteId required | string Note Id to fetch |
{- "code": 200,
- "success": true,
- "note": {
- "hasPostValue": true,
- "hasPreValue": true,
- "noteId": "string",
- "userId": "string",
- "changeSource": "ui",
- "changeType": "config",
- "entityId": "string",
- "entityType": "string",
- "action": "create",
- "eventId": "string",
- "extEntityId": "string",
- "generatedText": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "postValue": { },
- "preValue": { },
- "reference": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "string",
- "relatedReference": "string",
- "severity": "normal",
- "status": "valid",
- "tags": [
- "string"
], - "text": "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 Notes |
entityId | Array of strings Retrieve notes by entityId list |
entityType | Array of strings Retrieve notes by entityType list |
eventId | Array of strings Retrieve notes by eventId list |
keys | string Default: "hasPreValue,hasPostValue,changeSource,changeType,text,generatedText,noteId,entityId,entityType,extEntityId,relatedEntityId,relatedEntityType,eventId,isPublic,severity,tags,userId,createdAt,updatedAt,orgKey,status" Return these top-level fields |
noteId | Array of strings Retrieve notes by noteId list |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
severity | Array of strings (NoteSeverity) Items Enum: "normal" "low" "high" Retrieve notes by severity list |
since | string <date-time> Notes created after this date-time |
skip | integer <int32> Default: 0 Skip this many Notes |
status | Array of strings (NoteStatus) Items Value: "valid" Retrieve notes by status list |
tags | Array of strings (EntityTags) Tags assigned to entity |
until | string <date-time> Notes created before this date-time |
updatedSince | string <date-time> Notes updated after this date-time |
updatedUntil | string <date-time> Notes 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",
- "entityId": [
- "string"
], - "entityType": [
- "string"
], - "eventId": [
- "string"
], - "noteId": [
- "string"
], - "severity": [
- "normal"
], - "status": [
- "valid"
], - "tags": [
- "string"
]
}, - "notes": [
- {
- "hasPostValue": true,
- "hasPreValue": true,
- "noteId": "string",
- "userId": "string",
- "changeSource": "ui",
- "changeType": "config",
- "entityId": "string",
- "entityType": "string",
- "action": "create",
- "eventId": "string",
- "extEntityId": "string",
- "generatedText": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "postValue": { },
- "preValue": { },
- "reference": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "string",
- "relatedReference": "string",
- "severity": "normal",
- "status": "valid",
- "tags": [
- "string"
], - "text": "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
}
}
NoteId required | string Note Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
action | string (NoteAction) Enum: "create" "update" "delete" Action enum |
generatedText | string or null Generated summary of changes |
object (InternalInfo) Internal info | |
isPublic | boolean Public note indicator |
postValue | object or null Value of target entity after change |
preValue | object or null Value of target entity before change |
reference | string |
relatedEntityId | string Related entity ID |
relatedEntityType | string Related entity type |
relatedReference | string |
severity | string (NoteSeverity) Enum: "normal" "low" "high" Note severity |
status | string (NoteStatus) Value: "valid" Note status |
tags | Array of strings (EntityTags) Tags assigned to entity |
text | string Note content |
{- "action": "create",
- "generatedText": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "postValue": { },
- "preValue": { },
- "reference": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "string",
- "relatedReference": "string",
- "severity": "normal",
- "status": "valid",
- "tags": [
- "string"
], - "text": "string"
}
{- "code": 200,
- "success": true,
- "note": {
- "hasPostValue": true,
- "hasPreValue": true,
- "noteId": "string",
- "userId": "string",
- "changeSource": "ui",
- "changeType": "config",
- "entityId": "string",
- "entityType": "string",
- "action": "create",
- "eventId": "string",
- "extEntityId": "string",
- "generatedText": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "postValue": { },
- "preValue": { },
- "reference": "string",
- "relatedEntityId": "string",
- "relatedEntityType": "string",
- "relatedReference": "string",
- "severity": "normal",
- "status": "valid",
- "tags": [
- "string"
], - "text": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
apikey required | string Webhook api key |
topics required | Array of strings (WebhookTopics) Items Enum: "arrivals" "fulfillments" "integrations" "integration_actions" "inventory" "labels" "locations" "orders" "products" "purchases" "receipts" "refunds" "returns" "shipments" "suppliers" "transfers" "trackings" "exceptions" Webhook topics |
url required | string Webhook URL |
connectorId | string Connector ID |
createdAt | string <date-time> When the object was created within Pipe17 |
integration | string Integration ID |
object (InternalInfo) Internal info | |
orgKey | string Organization this object belong to |
updatedAt | string <date-time> When the object was updated within Pipe17 |
webhookId | string Webhook ID |
{- "connectorId": "string",
- "integration": "string",
- "webhookId": "string",
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
apikey required | string Webhook api key |
topics required | Array of strings (WebhookTopics) Items Enum: "arrivals" "fulfillments" "integrations" "integration_actions" "inventory" "labels" "locations" "orders" "products" "purchases" "receipts" "refunds" "returns" "shipments" "suppliers" "transfers" "trackings" "exceptions" Webhook topics |
url required | string Webhook URL |
object (InternalInfo) Internal info |
{- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string",
- "internal": {
- "property1": { },
- "property2": { }
}
}
{- "code": 200,
- "success": true,
- "webhook": {
- "connectorId": "string",
- "integration": "string",
- "webhookId": "string",
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
WebhookId required | string Webhook ID to fetch |
{- "code": 200,
- "success": true,
- "webhook": {
- "connectorId": "string",
- "integration": "string",
- "webhookId": "string",
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
count | integer <int32> Default: 100 Return at most this many webhooks |
keys | string Default: "createdAt,orgKey,topics,updatedAt,webhookId" 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 |
related | boolean Include related webhooks |
since | string <date-time> Webhooks created after this date-time |
skip | integer <int32> Default: 0 Skip this many webhooks |
topic | string (WebhookTopics) Enum: "arrivals" "fulfillments" "integrations" "integration_actions" "inventory" "labels" "locations" "orders" "products" "purchases" "receipts" "refunds" "returns" "shipments" "suppliers" "transfers" "trackings" "exceptions" Webhooks for this topic |
until | string <date-time> Webhooks created before this date-time |
updatedSince | string <date-time> Webhooks updated after this date-time |
updatedUntil | string <date-time> Webhooks updated before this date-time |
webhookId | Array of strings Webhooks by list of webhookId |
{- "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",
- "related": true,
- "topic": "arrivals",
- "webhookId": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "webhooks": [
- {
- "connectorId": "string",
- "integration": "string",
- "webhookId": "string",
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
WebhookId required | string Webhook ID to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
apikey | string Webhook api key |
object (InternalInfo) Internal info | |
topics | Array of strings (WebhookTopics) Items Enum: "arrivals" "fulfillments" "integrations" "integration_actions" "inventory" "labels" "locations" "orders" "products" "purchases" "receipts" "refunds" "returns" "shipments" "suppliers" "transfers" "trackings" "exceptions" Webhook Topics |
url | string Webhook URL |
{- "apikey": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "topics": [
- "arrivals"
], - "url": "string"
}
{- "code": 200,
- "success": true,
- "webhook": {
- "connectorId": "string",
- "integration": "string",
- "webhookId": "string",
- "apikey": "string",
- "topics": [
- "arrivals"
], - "url": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
activationKey | string Account Activation Key |
object (Branding) Branding information | |
Array of objects (AccountContact) | |
createdAt | string <date-time> When the object was created within Pipe17 |
deletedAt | string <date-time> |
enforceMFA | string (AccountEnforceMFA) Enum: "all" "primary" "selected" |
expirationDate | string <date> |
integrations | Array of strings Account Integrations |
object (InternalInfo) Internal info | |
isMultiOrgAllowed | boolean Indicates whether customer allowed to create secondary orgs |
isRebrandingAllowed | boolean Indicates whether customer allowed to re-brand app dashboard |
orgKey | string Organization this object belong to |
pausedAt | string <date-time> |
object (AccountPayment) | |
prodOrgLimit | number Defines maximum number of 'production' orgs allowed for account (default - 1) |
roleIds | Array of strings Account Role IDs |
secondaryOrgLimit | number Defines maximum number of secondary orgs allowed for account (default - 0) |
status | string (AccountStatusWithDeleted) Enum: "pending" "active" "disabled" "paused" "deleted" "retired" Account's Status |
updatedAt | string <date-time> When the object was updated within Pipe17 |
userId | string Account User ID |
{- "activationKey": "string",
- "branding": {
- "copyright": "string",
- "logoUrl": "string",
- "privacyUrl": "string"
}, - "contacts": [
- {
- "name": "string",
- "type": "Finance owner",
- "additionalEmails": [
- "string"
], - "email": "string",
- "phone": "string",
- "phone2": "string"
}
], - "deletedAt": "2019-08-24T14:15:22Z",
- "enforceMFA": "all",
- "expirationDate": "2019-08-24",
- "integrations": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiOrgAllowed": true,
- "isRebrandingAllowed": true,
- "pausedAt": "2019-08-24T14:15:22Z",
- "payment": {
- "billing": {
- "amount": 0,
- "basePeriod": "monthly",
- "plan": "string",
- "source": "string",
- "status": "trial",
- "addOns": [
- {
- "name": "string",
- "period": "monthly",
- "quantity": 0,
- "value": 0
}
], - "chargeEnterpriseSupport": true,
- "csm": "string",
- "effectivePlan": "string",
- "note": "string",
- "overageAmount": 0,
- "overagePeriod": "monthly",
- "quota": 0,
- "renewalDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "pricingId": "string",
- "salesDiscountCode": [
- "string"
]
}, - "prodOrgLimit": 0,
- "roleIds": [
- "string"
], - "secondaryOrgLimit": 0,
- "status": "pending",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
OrgKeyOrActivationKey required | string Account OrgKey to fetch |
{- "code": 200,
- "success": true,
- "account": {
- "activationKey": "string",
- "branding": {
- "copyright": "string",
- "logoUrl": "string",
- "privacyUrl": "string"
}, - "contacts": [
- {
- "name": "string",
- "type": "Finance owner",
- "additionalEmails": [
- "string"
], - "email": "string",
- "phone": "string",
- "phone2": "string"
}
], - "deletedAt": "2019-08-24T14:15:22Z",
- "enforceMFA": "all",
- "expirationDate": "2019-08-24",
- "integrations": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiOrgAllowed": true,
- "isRebrandingAllowed": true,
- "pausedAt": "2019-08-24T14:15:22Z",
- "payment": {
- "billing": {
- "amount": 0,
- "basePeriod": "monthly",
- "plan": "string",
- "source": "string",
- "status": "trial",
- "addOns": [
- {
- "name": "string",
- "period": "monthly",
- "quantity": 0,
- "value": 0
}
], - "chargeEnterpriseSupport": true,
- "csm": "string",
- "effectivePlan": "string",
- "note": "string",
- "overageAmount": 0,
- "overagePeriod": "monthly",
- "quota": 0,
- "renewalDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "pricingId": "string",
- "salesDiscountCode": [
- "string"
]
}, - "prodOrgLimit": 0,
- "roleIds": [
- "string"
], - "secondaryOrgLimit": 0,
- "status": "pending",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
billingStatus | Array of strings (AccountBillingStatus) Items Enum: "trial" "paid" "paidCanceled" "unpaid" "pastDue" "discontinued" "unknown" Accounts by list of billingStatus |
count | integer <int32> Default: 100 Return at most this many accounts |
deletedSince | string <date-time> Accounts with deletedAt after this date-time |
deletedUntil | string <date-time> Accounts with deletedAt before this date-time |
expirationSince | string <date-time> Accounts with expiration after this date-time |
expirationUntil | string <date-time> Accounts with expiration before this date-time |
isMultiOrgAllowed | boolean Accounts by isMultiOrgAllowed |
keys | string Default: "activationKey,expirationDate,integrations,payment,roleIds,userId,orgKey,status,isMultiOrgAllowed,secondaryOrgLimit,prodOrgLimit,isRebrandingAllowed,createdAt,updatedAt" Return these top-level fields |
order | string Default: "createdAt" Sort by these top-level fields |
orgKey | Array of strings Accounts by list of orgKey |
pagination | string Value: "disabled" Exclude pagination info from the response |
pausedSince | string <date-time> Accounts with pausedAt after this date-time |
pausedUntil | string <date-time> Accounts with pausedAt before this date-time |
renewalSince | string <date-time> Accounts with renewalDate after this date-time |
renewalUntil | string <date-time> Accounts with renewalDate before this date-time |
since | string <date-time> Accounts created after this date-time |
skip | integer <int32> Default: 0 Skip this many accounts |
status | Array of strings (AccountStatusWithDeleted) Items Enum: "pending" "active" "disabled" "paused" "deleted" "retired" Accounts by list of status |
until | string <date-time> Accounts created before this date-time |
updatedSince | string <date-time> Accounts updated after this date-time |
updatedUntil | string <date-time> Accounts updated before this date-time |
{- "code": 200,
- "success": true,
- "accounts": [
- {
- "activationKey": "string",
- "branding": {
- "copyright": "string",
- "logoUrl": "string",
- "privacyUrl": "string"
}, - "contacts": [
- {
- "name": "string",
- "type": "Finance owner",
- "additionalEmails": [
- "string"
], - "email": "string",
- "phone": "string",
- "phone2": "string"
}
], - "deletedAt": "2019-08-24T14:15:22Z",
- "enforceMFA": "all",
- "expirationDate": "2019-08-24",
- "integrations": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiOrgAllowed": true,
- "isRebrandingAllowed": true,
- "pausedAt": "2019-08-24T14:15:22Z",
- "payment": {
- "billing": {
- "amount": 0,
- "basePeriod": "monthly",
- "plan": "string",
- "source": "string",
- "status": "trial",
- "addOns": [
- {
- "name": "string",
- "period": "monthly",
- "quantity": 0,
- "value": 0
}
], - "chargeEnterpriseSupport": true,
- "csm": "string",
- "effectivePlan": "string",
- "note": "string",
- "overageAmount": 0,
- "overagePeriod": "monthly",
- "quota": 0,
- "renewalDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "pricingId": "string",
- "salesDiscountCode": [
- "string"
]
}, - "prodOrgLimit": 0,
- "roleIds": [
- "string"
], - "secondaryOrgLimit": 0,
- "status": "pending",
- "userId": "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",
- "billingStatus": [
- "trial"
], - "deletedSince": "2019-08-24T14:15:22Z",
- "deletedUntil": "2019-08-24T14:15:22Z",
- "expirationSince": "2019-08-24T14:15:22Z",
- "expirationUntil": "2019-08-24T14:15:22Z",
- "isMultiOrgAllowed": true,
- "orgKey": [
- "string"
], - "pausedSince": "2019-08-24T14:15:22Z",
- "pausedUntil": "2019-08-24T14:15:22Z",
- "renewalSince": "2019-08-24T14:15:22Z",
- "renewalUntil": "2019-08-24T14:15:22Z",
- "status": [
- "pending"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
OrgKeyOrActivationKey required | string Account Activation key |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
Array of objects or null (AccountContact) | |
enforceMFA | string (AccountEnforceMFA) Enum: "all" "primary" "selected" |
expirationDate | string <date> |
object (InternalInfo) Internal info | |
isMultiOrgAllowed | boolean Indicates whether customer allowed to create secondary orgs |
isRebrandingAllowed | boolean Indicates whether customer allowed to re-brand app dashboard |
object or null (AccountPaymentUpdate) | |
prodOrgLimit | number Defines maximum number of 'production' orgs allowed for account (default - 1) |
secondaryOrgLimit | number Defines maximum number of secondary orgs allowed for account (default - 0) |
status | string (AccountStatus) Enum: "pending" "active" "disabled" "paused" "retired" Account's Status |
{- "contacts": [
- {
- "name": "string",
- "type": "Finance owner",
- "additionalEmails": [
- "string"
], - "email": "string",
- "phone": "string",
- "phone2": "string"
}
], - "enforceMFA": "all",
- "expirationDate": "2019-08-24",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiOrgAllowed": true,
- "isRebrandingAllowed": true,
- "payment": {
- "billing": {
- "addOns": [
- {
- "name": "string",
- "period": "monthly",
- "quantity": 0,
- "value": 0
}
], - "amount": 0,
- "basePeriod": "monthly",
- "chargeEnterpriseSupport": true,
- "csm": "string",
- "effectivePlan": "string",
- "note": "string",
- "overageAmount": 0,
- "overagePeriod": "monthly",
- "plan": "string",
- "quota": 0,
- "renewalDate": "2019-08-24T14:15:22Z",
- "source": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "status": "trial"
}, - "pricingId": "string",
- "salesDiscountCode": [
- "string"
]
}, - "prodOrgLimit": 0,
- "secondaryOrgLimit": 0,
- "status": "pending"
}
{- "code": 200,
- "success": true,
- "account": {
- "activationKey": "string",
- "branding": {
- "copyright": "string",
- "logoUrl": "string",
- "privacyUrl": "string"
}, - "contacts": [
- {
- "name": "string",
- "type": "Finance owner",
- "additionalEmails": [
- "string"
], - "email": "string",
- "phone": "string",
- "phone2": "string"
}
], - "deletedAt": "2019-08-24T14:15:22Z",
- "enforceMFA": "all",
- "expirationDate": "2019-08-24",
- "integrations": [
- "string"
], - "internal": {
- "property1": { },
- "property2": { }
}, - "isMultiOrgAllowed": true,
- "isRebrandingAllowed": true,
- "pausedAt": "2019-08-24T14:15:22Z",
- "payment": {
- "billing": {
- "amount": 0,
- "basePeriod": "monthly",
- "plan": "string",
- "source": "string",
- "status": "trial",
- "addOns": [
- {
- "name": "string",
- "period": "monthly",
- "quantity": 0,
- "value": 0
}
], - "chargeEnterpriseSupport": true,
- "csm": "string",
- "effectivePlan": "string",
- "note": "string",
- "overageAmount": 0,
- "overagePeriod": "monthly",
- "quota": 0,
- "renewalDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "pricingId": "string",
- "salesDiscountCode": [
- "string"
]
}, - "prodOrgLimit": 0,
- "roleIds": [
- "string"
], - "secondaryOrgLimit": 0,
- "status": "pending",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
required | object (OrganizationAddress) |
email required | string Organization Contact email |
name required | string Organization Name |
phone required | string Organization Contact Phone |
tier required | string (OrganizationServiceTier) Enum: "free" "basic" "enterprise" Organization Service Tier |
timeZone required | string (Timezone) Enum: "Africa/Algiers" "Africa/Cairo" "Africa/Casablanca" "Africa/Harare" "Africa/Johannesburg" "Africa/Monrovia" "Africa/Nairobi" "America/Argentina/Buenos_Aires" "America/Bogota" "America/Caracas" "America/Chicago" "America/Chihuahua" "America/Denver" "America/Godthab" "America/Guatemala" "America/Guyana" "America/Halifax" "America/Indiana/Indianapolis" "America/Juneau" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Mazatlan" "America/Mexico_City" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Phoenix" "America/Puerto_Rico" "America/Regina" "America/Santiago" "America/Sao_Paulo" "America/St_Johns" "America/Tijuana" "Asia/Almaty" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Chongqing" "Asia/Colombo" "Asia/Dhaka" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuwait" "Asia/Magadan" "Asia/Muscat" "Asia/Novosibirsk" "Asia/Rangoon" "Asia/Riyadh" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Cape_Verde" "Atlantic/South_Georgia" "Australia/Adelaide" "Australia/Brisbane" "Australia/Darwin" "Australia/Hobart" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/UTC" "Europe/Amsterdam" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Copenhagen" "Europe/Dublin" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Madrid" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Sarajevo" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Majuro" "Pacific/Midway" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Port_Moresby" "Pacific/Tongatapu" Timezone |
accountId | string Parent account Id |
object (Branding) Branding information | |
Array of objects (OrganizationContact) | |
createdAt | string <date-time> When the object was created within Pipe17 |
object (InternalInfo) Internal info | |
isHoldingOrg | boolean Marks organization as holding, i.e. parent org with no access to business objects. |
logoUrl | string Logo URL |
monitoringEnabled | boolean Allows the internal pipe 17 folks to enable/disable monitoring on the internal app (default - false) |
orgKey | string Organization this object belong to |
orgMode | string (OrganizationMode) Enum: "sandbox" "production" "internal" "demo" Organization Mode |
Array of objects (OrganizationSetting) Organization level settings | |
status | string (OrganizationStatus) Enum: "pending" "active" "disabled" Organization Account Status |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "accountId": "string",
- "branding": {
- "copyright": "string",
- "logoUrl": "string",
- "privacyUrl": "string"
}, - "isHoldingOrg": true,
- "status": "pending",
- "address": {
- "address1": "string",
- "city": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "zipCodeOrPostalCode": "string",
- "address2": "string",
- "company": "string",
- "stateOrProvince": "string"
}, - "email": "string",
- "name": "string",
- "phone": "string",
- "tier": "free",
- "timeZone": "Africa/Algiers",
- "contacts": [
- {
- "name": "string",
- "type": "Emergency",
- "additionalEmails": [
- "string"
], - "email": "string",
- "integrationId": "string",
- "phone": "string",
- "phone2": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "logoUrl": "string",
- "monitoringEnabled": true,
- "orgMode": "sandbox",
- "settings": [
- {
- "path": "string",
- "type": "string",
- "value": { }
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
OrgKey required | string orgKey to cleanup |
orgModes required | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Only cleanup entities assigned this orgModes |
entityTypes | Array of strings (EntityName) Items Enum: "accounts" "arrivals" "automations" "automation_rules" "automation_runs" "changelog" "connectors" "customers" "contacts" "entity_filters" "exceptions" "fulfillments" "functions" "inventory" "inventoryrules" "invoices" "labels" "locations" "lookup_objects" "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" Only cleanup entities of these types |
hardDelete | boolean Use hard delete for data cleanup |
{- "orgModes": [
- "sandbox"
], - "entityTypes": [
- "accounts"
], - "hardDelete": true
}
{- "code": 200,
- "success": true
}
ownerMode | string Enum: "primary" "owner" "both" |
required | object (OrganizationAddress) |
email required | string Organization Contact email |
name required | string Organization Name |
phone required | string Organization Contact Phone |
tier required | string (OrganizationServiceTier) Enum: "free" "basic" "enterprise" Organization Service Tier |
timeZone required | string (Timezone) Enum: "Africa/Algiers" "Africa/Cairo" "Africa/Casablanca" "Africa/Harare" "Africa/Johannesburg" "Africa/Monrovia" "Africa/Nairobi" "America/Argentina/Buenos_Aires" "America/Bogota" "America/Caracas" "America/Chicago" "America/Chihuahua" "America/Denver" "America/Godthab" "America/Guatemala" "America/Guyana" "America/Halifax" "America/Indiana/Indianapolis" "America/Juneau" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Mazatlan" "America/Mexico_City" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Phoenix" "America/Puerto_Rico" "America/Regina" "America/Santiago" "America/Sao_Paulo" "America/St_Johns" "America/Tijuana" "Asia/Almaty" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Chongqing" "Asia/Colombo" "Asia/Dhaka" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuwait" "Asia/Magadan" "Asia/Muscat" "Asia/Novosibirsk" "Asia/Rangoon" "Asia/Riyadh" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Cape_Verde" "Atlantic/South_Georgia" "Australia/Adelaide" "Australia/Brisbane" "Australia/Darwin" "Australia/Hobart" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/UTC" "Europe/Amsterdam" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Copenhagen" "Europe/Dublin" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Madrid" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Sarajevo" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Majuro" "Pacific/Midway" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Port_Moresby" "Pacific/Tongatapu" Timezone |
Array of objects (OrganizationContact) | |
object (InternalInfo) Internal info | |
logoUrl | string Logo URL |
monitoringEnabled | boolean Allows the internal pipe 17 folks to enable/disable monitoring on the internal app (default - false) |
orgMode | string (OrganizationMode) Enum: "sandbox" "production" "internal" "demo" Organization Mode |
Array of objects (OrganizationSetting) Organization level settings |
{- "address": {
- "address1": "string",
- "city": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "zipCodeOrPostalCode": "string",
- "address2": "string",
- "company": "string",
- "stateOrProvince": "string"
}, - "email": "string",
- "name": "string",
- "phone": "string",
- "tier": "free",
- "timeZone": "Africa/Algiers",
- "contacts": [
- {
- "name": "string",
- "type": "Emergency",
- "additionalEmails": [
- "string"
], - "email": "string",
- "integrationId": "string",
- "phone": "string",
- "phone2": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "logoUrl": "string",
- "monitoringEnabled": true,
- "orgMode": "sandbox",
- "settings": [
- {
- "path": "string",
- "type": "string",
- "value": { }
}
]
}
{- "code": 200,
- "success": true,
- "organization": {
- "accountId": "string",
- "branding": {
- "copyright": "string",
- "logoUrl": "string",
- "privacyUrl": "string"
}, - "isHoldingOrg": true,
- "status": "pending",
- "address": {
- "address1": "string",
- "city": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "zipCodeOrPostalCode": "string",
- "address2": "string",
- "company": "string",
- "stateOrProvince": "string"
}, - "email": "string",
- "name": "string",
- "phone": "string",
- "tier": "free",
- "timeZone": "Africa/Algiers",
- "contacts": [
- {
- "name": "string",
- "type": "Emergency",
- "additionalEmails": [
- "string"
], - "email": "string",
- "integrationId": "string",
- "phone": "string",
- "phone2": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "logoUrl": "string",
- "monitoringEnabled": true,
- "orgMode": "sandbox",
- "settings": [
- {
- "path": "string",
- "type": "string",
- "value": { }
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
OrgKey required | string orgKey to detach |
{ }
{- "code": 200,
- "success": true
}
OrganizationId required | string Organization Id to fetch |
{- "code": 200,
- "success": true,
- "organization": {
- "accountId": "string",
- "branding": {
- "copyright": "string",
- "logoUrl": "string",
- "privacyUrl": "string"
}, - "isHoldingOrg": true,
- "status": "pending",
- "address": {
- "address1": "string",
- "city": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "zipCodeOrPostalCode": "string",
- "address2": "string",
- "company": "string",
- "stateOrProvince": "string"
}, - "email": "string",
- "name": "string",
- "phone": "string",
- "tier": "free",
- "timeZone": "Africa/Algiers",
- "contacts": [
- {
- "name": "string",
- "type": "Emergency",
- "additionalEmails": [
- "string"
], - "email": "string",
- "integrationId": "string",
- "phone": "string",
- "phone2": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "logoUrl": "string",
- "monitoringEnabled": true,
- "orgMode": "sandbox",
- "settings": [
- {
- "path": "string",
- "type": "string",
- "value": { }
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
accountId | Array of strings Organizations by list of accountId |
count | integer <int32> Default: 100 Return at most this many organizations |
deleted | boolean Fetch only soft-deleted organizations (ignore status) |
string Organizations by email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) | |
keys | string Default: "orgKey,accountId,name,tier,status,isHoldingOrg,createdAt,updatedAt" Return these top-level fields |
name | string Organizations by name (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
order | string Default: "createdAt" Sort by these top-level fields |
orgKey | Array of strings Organizations by list of orgKey |
orgMode | Array of strings (OrganizationMode) Items Enum: "sandbox" "production" "internal" "demo" Organizations by list of modes |
pagination | string Value: "disabled" Exclude pagination info from the response |
phone | string Organizations by phone (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) |
since | string <date-time> Organizations created after this date-time |
skip | integer <int32> Default: 0 Skip this many organizations |
status | Array of strings (OrganizationStatus) Items Enum: "pending" "active" "disabled" Organizations by list of statuses |
until | string <date-time> Organizations created before this date-time |
updatedSince | string <date-time> Organizations updated after this date-time |
updatedUntil | string <date-time> Organizations 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",
- "accountId": [
- "string"
], - "deleted": true,
- "email": "string",
- "name": "string",
- "orgKey": [
- "string"
], - "orgMode": [
- "sandbox"
], - "phone": "string",
- "status": [
- "pending"
], - "keys": "string",
- "order": "string"
}, - "organizations": [
- {
- "accountId": "string",
- "branding": {
- "copyright": "string",
- "logoUrl": "string",
- "privacyUrl": "string"
}, - "isHoldingOrg": true,
- "status": "pending",
- "address": {
- "address1": "string",
- "city": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "zipCodeOrPostalCode": "string",
- "address2": "string",
- "company": "string",
- "stateOrProvince": "string"
}, - "email": "string",
- "name": "string",
- "phone": "string",
- "tier": "free",
- "timeZone": "Africa/Algiers",
- "contacts": [
- {
- "name": "string",
- "type": "Emergency",
- "additionalEmails": [
- "string"
], - "email": "string",
- "integrationId": "string",
- "phone": "string",
- "phone2": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "logoUrl": "string",
- "monitoringEnabled": true,
- "orgMode": "sandbox",
- "settings": [
- {
- "path": "string",
- "type": "string",
- "value": { }
}
], - "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
}
}
OrgKey required | string orgKey to move |
accountId required | string Target account ID |
{- "accountId": "string"
}
{- "code": 200,
- "success": true
}
OrgKey required | string orgKey to switch |
orgMode required | string (OrganizationMode) Enum: "sandbox" "production" "internal" "demo" Organization Mode |
{- "orgMode": "sandbox"
}
{- "code": 200,
- "success": true
}
OrganizationId required | string Organization Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
object (OrganizationUpdateAddress) | |
object (Branding) Branding information | |
Array of objects or null (OrganizationContact) | |
string Organization Contact email | |
object (InternalInfo) Internal info | |
isHoldingOrg | boolean Marks organization as holding, i.e. parent org with no access to business objects. |
logoUrl | string Logo URL |
monitoringEnabled | boolean or null Allows the internal pipe 17 folks to enable/disable monitoring on the internal app |
name | string Organization Name |
phone | string Organization Contact Phone |
Array of objects (OrganizationSetting) Organization level settings | |
status | string (OrganizationStatus) Enum: "pending" "active" "disabled" Organization Account Status |
tier | string (OrganizationServiceTier) Enum: "free" "basic" "enterprise" Organization Service Tier |
timeZone | string (Timezone) Enum: "Africa/Algiers" "Africa/Cairo" "Africa/Casablanca" "Africa/Harare" "Africa/Johannesburg" "Africa/Monrovia" "Africa/Nairobi" "America/Argentina/Buenos_Aires" "America/Bogota" "America/Caracas" "America/Chicago" "America/Chihuahua" "America/Denver" "America/Godthab" "America/Guatemala" "America/Guyana" "America/Halifax" "America/Indiana/Indianapolis" "America/Juneau" "America/La_Paz" "America/Lima" "America/Los_Angeles" "America/Mazatlan" "America/Mexico_City" "America/Monterrey" "America/Montevideo" "America/New_York" "America/Phoenix" "America/Puerto_Rico" "America/Regina" "America/Santiago" "America/Sao_Paulo" "America/St_Johns" "America/Tijuana" "Asia/Almaty" "Asia/Baghdad" "Asia/Baku" "Asia/Bangkok" "Asia/Chongqing" "Asia/Colombo" "Asia/Dhaka" "Asia/Hong_Kong" "Asia/Irkutsk" "Asia/Jakarta" "Asia/Jerusalem" "Asia/Kabul" "Asia/Kamchatka" "Asia/Karachi" "Asia/Kathmandu" "Asia/Kolkata" "Asia/Krasnoyarsk" "Asia/Kuala_Lumpur" "Asia/Kuwait" "Asia/Magadan" "Asia/Muscat" "Asia/Novosibirsk" "Asia/Rangoon" "Asia/Riyadh" "Asia/Seoul" "Asia/Shanghai" "Asia/Singapore" "Asia/Srednekolymsk" "Asia/Taipei" "Asia/Tashkent" "Asia/Tbilisi" "Asia/Tehran" "Asia/Tokyo" "Asia/Ulaanbaatar" "Asia/Urumqi" "Asia/Vladivostok" "Asia/Yakutsk" "Asia/Yekaterinburg" "Asia/Yerevan" "Atlantic/Azores" "Atlantic/Cape_Verde" "Atlantic/South_Georgia" "Australia/Adelaide" "Australia/Brisbane" "Australia/Darwin" "Australia/Hobart" "Australia/Melbourne" "Australia/Perth" "Australia/Sydney" "Etc/UTC" "Europe/Amsterdam" "Europe/Athens" "Europe/Belgrade" "Europe/Berlin" "Europe/Bratislava" "Europe/Brussels" "Europe/Bucharest" "Europe/Budapest" "Europe/Copenhagen" "Europe/Dublin" "Europe/Helsinki" "Europe/Istanbul" "Europe/Kaliningrad" "Europe/Kiev" "Europe/Lisbon" "Europe/Ljubljana" "Europe/London" "Europe/Madrid" "Europe/Minsk" "Europe/Moscow" "Europe/Paris" "Europe/Prague" "Europe/Riga" "Europe/Rome" "Europe/Samara" "Europe/Sarajevo" "Europe/Skopje" "Europe/Sofia" "Europe/Stockholm" "Europe/Tallinn" "Europe/Vienna" "Europe/Vilnius" "Europe/Volgograd" "Europe/Warsaw" "Europe/Zagreb" "Europe/Zurich" "Pacific/Apia" "Pacific/Auckland" "Pacific/Chatham" "Pacific/Fakaofo" "Pacific/Fiji" "Pacific/Guadalcanal" "Pacific/Guam" "Pacific/Honolulu" "Pacific/Majuro" "Pacific/Midway" "Pacific/Noumea" "Pacific/Pago_Pago" "Pacific/Port_Moresby" "Pacific/Tongatapu" Timezone |
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "branding": {
- "copyright": "string",
- "logoUrl": "string",
- "privacyUrl": "string"
}, - "contacts": [
- {
- "name": "string",
- "type": "Emergency",
- "additionalEmails": [
- "string"
], - "email": "string",
- "integrationId": "string",
- "phone": "string",
- "phone2": "string"
}
], - "email": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isHoldingOrg": true,
- "logoUrl": "string",
- "monitoringEnabled": true,
- "name": "string",
- "phone": "string",
- "settings": [
- {
- "path": "string",
- "type": "string",
- "value": { }
}
], - "status": "pending",
- "tier": "free",
- "timeZone": "Africa/Algiers"
}
{- "code": 200,
- "success": true,
- "organization": {
- "accountId": "string",
- "branding": {
- "copyright": "string",
- "logoUrl": "string",
- "privacyUrl": "string"
}, - "isHoldingOrg": true,
- "status": "pending",
- "address": {
- "address1": "string",
- "city": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "zipCodeOrPostalCode": "string",
- "address2": "string",
- "company": "string",
- "stateOrProvince": "string"
}, - "email": "string",
- "name": "string",
- "phone": "string",
- "tier": "free",
- "timeZone": "Africa/Algiers",
- "contacts": [
- {
- "name": "string",
- "type": "Emergency",
- "additionalEmails": [
- "string"
], - "email": "string",
- "integrationId": "string",
- "phone": "string",
- "phone2": "string"
}
], - "internal": {
- "property1": { },
- "property2": { }
}, - "logoUrl": "string",
- "monitoringEnabled": true,
- "orgMode": "sandbox",
- "settings": [
- {
- "path": "string",
- "type": "string",
- "value": { }
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
activeUntil required | string <date-time> (PricingActiveUntil) When the plan is active until in the pricing catalog, if date is in the past, the plan is a legacy plan |
annualAmount required | number <float> Payment, USD, when paying annualy |
excess required | number <float> USD, per order, for orders over included number |
included required | number <int32> Number of orders included in plan per year |
monthlyAmount required | number <float> Payment, USD, when paying monthly |
name required | string Name of pricing Plan |
rank required | number <float> Rank of pricing plan, higher has more features |
sources required | Array of strings (PricingSources) Items Enum: "app" "shopify" "shopify-mcf" Plan is available through these sources |
api | boolean If true, plan includes use of API |
bundles | boolean If true, plan includes use of bundles |
categories | Array of strings |
createdAt | string <date-time> When the object was created within Pipe17 |
cutOver | number when exceeding this number of orders in a year, recommend higher ranked plan |
description | string Pricing plan description |
includedMonthly | number <int32> Number of orders included in plan per month |
object (InternalInfo) Internal info | |
max3pl | number Number of fulfillment integrations allowed in plan |
maxERP | number Number of ERP integrations allowed in plan |
maxIntg | number Number of integrations allowed in plan |
maxSub | number Number of secondary organizations allowed in plan |
orgKey | string Organization this object belong to |
poto | boolean If true, plan includes use Purchase / Transfer orders |
pricingId | string Pricing ID |
routing | boolean If true, plan includes order routing |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "pricingId": "string",
- "activeUntil": "2019-08-24T14:15:22Z",
- "annualAmount": 0,
- "excess": 0,
- "included": 0,
- "monthlyAmount": 0,
- "name": "string",
- "rank": 0,
- "sources": [
- "app"
], - "api": true,
- "bundles": true,
- "categories": [
- "string"
], - "cutOver": 0,
- "description": "string",
- "includedMonthly": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "max3pl": 0,
- "maxERP": 0,
- "maxIntg": 0,
- "maxSub": 0,
- "poto": true,
- "routing": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
PricingId required | string Id or |
{- "code": 200,
- "success": true,
- "Pricing": {
- "pricingId": "string",
- "activeUntil": "2019-08-24T14:15:22Z",
- "annualAmount": 0,
- "excess": 0,
- "included": 0,
- "monthlyAmount": 0,
- "name": "string",
- "rank": 0,
- "sources": [
- "app"
], - "api": true,
- "bundles": true,
- "categories": [
- "string"
], - "cutOver": 0,
- "description": "string",
- "includedMonthly": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "max3pl": 0,
- "maxERP": 0,
- "maxIntg": 0,
- "maxSub": 0,
- "poto": true,
- "routing": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
active | boolean Pricing plans that are active |
api | boolean Pricing plans allowing use of API |
bundles | boolean Pricing plans allowing use of bundles |
categories | Array of strings Pricing plans allowing use of all of these connector categories |
count | integer <int32> Default: 100 Return at most this many pricing plans |
keys | string Default: "pricingId,name,description,rank,monthlyAmount,annualAmount,included,includedMonthly,excess,cutOver,max3pl,maxERP,maxIntg,maxSub,routing,bundles,api,poto,categories,activeUntil,sources,createdAt,updatedAt" Return these top-level fields |
min3pl | integer <int32> Default: 0 Pricing plans allowing at least this many 3pl integrations |
minIncluded | integer <int32> Default: 0 Pricing plans including at least this many orders a year |
order | string Default: "createdAt" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
poto | boolean Pricing plans allowing use of Purchase / Transfer orders |
routing | boolean Pricing plans allowing use of order routing |
since | string <date-time> Pricing plans created after this date-time |
skip | integer <int32> Default: 0 Skip this many pricing plans |
sources | Array of strings (PricingSources) Items Enum: "app" "shopify" "shopify-mcf" Pricing plans available through these billing sources |
until | string <date-time> Pricing plans created before this date-time |
updatedSince | string <date-time> Pricing plans updated after this date-time |
updatedUntil | string <date-time> Pricing plans updated before this date-time |
{- "code": 200,
- "success": true,
- "Pricing": [
- {
- "pricingId": "string",
- "activeUntil": "2019-08-24T14:15:22Z",
- "annualAmount": 0,
- "excess": 0,
- "included": 0,
- "monthlyAmount": 0,
- "name": "string",
- "rank": 0,
- "sources": [
- "app"
], - "api": true,
- "bundles": true,
- "categories": [
- "string"
], - "cutOver": 0,
- "description": "string",
- "includedMonthly": 0,
- "internal": {
- "property1": { },
- "property2": { }
}, - "max3pl": 0,
- "maxERP": 0,
- "maxIntg": 0,
- "maxSub": 0,
- "poto": true,
- "routing": true,
- "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",
- "api": true,
- "bundles": true,
- "categories": [
- "string"
], - "included": 0,
- "min3pl": 0,
- "poto": true,
- "routing": true,
- "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
name required | string Role Name |
createdAt | string <date-time> When the object was created within Pipe17 |
description | string Role's description |
object (InternalInfo) Internal info | |
isPublic | boolean Global role indicator |
object (Methods) Access Methods Allowed | |
orgKey | string Organization this object belong to |
roleId | string Role ID |
status | string (RoleStatus) Enum: "active" "disabled" Role status |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "roleId": "string",
- "status": "active",
- "name": "string",
- "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
name required | string Role Name |
description | string Role's description |
object (InternalInfo) Internal info | |
isPublic | boolean Global role indicator |
object (Methods) Access Methods Allowed |
{- "name": "string",
- "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}
}
{- "code": 200,
- "success": true,
- "role": {
- "roleId": "string",
- "status": "active",
- "name": "string",
- "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
RoleId required | string Role Id to fetch |
{- "code": 200,
- "success": true,
- "role": {
- "roleId": "string",
- "status": "active",
- "name": "string",
- "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "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 roles |
keys | string Default: "isPublic,roleId,name,status,createdAt,updatedAt,orgKey" Return these top-level fields |
name | string Roles 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 |
roleId | Array of strings Roles by list of roleId |
since | string <date-time> Roles created after this date-time |
skip | integer <int32> Default: 0 Skip this many roles |
status | Array of strings (RoleStatus) Items Enum: "active" "disabled" Roles by list of statuses |
until | string <date-time> Roles created before this date-time |
updatedSince | string <date-time> Roles updated after this date-time |
updatedUntil | string <date-time> Roles 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",
- "name": "string",
- "roleId": [
- "string"
], - "status": [
- "active"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "roles": [
- {
- "roleId": "string",
- "status": "active",
- "name": "string",
- "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
Uniqueness constraints within organization:
RoleId required | string Role Id to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
description | string Role's description |
object (InternalInfo) Internal info | |
object (MethodsUpdateData) Access Methods Allowed | |
name | string Role Name |
status | string (RoleStatus) Enum: "active" "disabled" Role status |
{- "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "name": "string",
- "status": "active"
}
{- "code": 200,
- "success": true,
- "role": {
- "roleId": "string",
- "status": "active",
- "name": "string",
- "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "isPublic": true,
- "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
email required | string User email |
name required | string User Name |
roles required | Array of strings User role names/ids |
object (UserAddress) | |
blockedFeatures | Array of strings |
createdAt | string <date-time> When the object was created within Pipe17 |
description | string User Description |
object (InternalInfo) Internal info | |
object (UserLoginInfo) | |
object (Methods) Access Methods Allowed | |
orgKey | string Organization this object belong to |
phone | string User Phone |
status | string (UserStatus) Enum: "pending" "active" "disabled" User Status |
timeZone | string User Time Zone |
updatedAt | string <date-time> When the object was updated within Pipe17 |
userId | string User ID |
{- "loginInfo": {
- "lastIPAddress": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "loginsCount": 0
}, - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "status": "pending",
- "userId": "string",
- "email": "string",
- "name": "string",
- "roles": [
- "string"
], - "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "blockedFeatures": [
- "string"
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "phone": "string",
- "timeZone": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Uniqueness constraints within organization:
email required | string User email |
name required | string User Name |
password required | string User password |
roles required | Array of strings User role names/ids |
object (UserAddress) | |
blockedFeatures | Array of strings |
description | string User Description |
object (InternalInfo) Internal info | |
phone | string User Phone |
timeZone | string User Time Zone |
{- "email": "string",
- "name": "string",
- "roles": [
- "string"
], - "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "blockedFeatures": [
- "string"
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "phone": "string",
- "timeZone": "string",
- "password": "string"
}
{- "code": 200,
- "success": true,
- "user": {
- "loginInfo": {
- "lastIPAddress": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "loginsCount": 0
}, - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "status": "pending",
- "userId": "string",
- "email": "string",
- "name": "string",
- "roles": [
- "string"
], - "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "blockedFeatures": [
- "string"
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "phone": "string",
- "timeZone": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
{- "code": 200,
- "success": true,
- "user": {
- "loginInfo": {
- "lastIPAddress": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "loginsCount": 0
}, - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "status": "pending",
- "userId": "string",
- "email": "string",
- "name": "string",
- "roles": [
- "string"
], - "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "blockedFeatures": [
- "string"
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "phone": "string",
- "timeZone": "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 users |
string Users by email (strings "/{pattern}/" and "/{pattern}/i" are interpreted as regexps) | |
keys | string Default: "userId,address,description,name,email,phone,roles,status,timeZone,createdAt,updatedAt,orgKey" Return these top-level fields |
name | string Users 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 |
roles | Array of strings Users by list of role names or/and role ids |
since | string <date-time> Users created after this date-time |
skip | integer <int32> Default: 0 Skip this many users |
status | Array of strings (UserStatus) Items Enum: "pending" "active" "disabled" Users by list of statuses |
until | string <date-time> Users created before this date-time |
updatedSince | string <date-time> Users updated after this date-time |
updatedUntil | string <date-time> Users updated before this date-time |
userId | Array of strings Users by list of userId |
{- "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",
- "email": "string",
- "name": "string",
- "organizations": "string",
- "status": [
- "pending"
], - "userId": [
- "string"
], - "keys": "string",
- "order": "string"
}, - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}, - "users": [
- {
- "loginInfo": {
- "lastIPAddress": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "loginsCount": 0
}, - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "status": "pending",
- "userId": "string",
- "email": "string",
- "name": "string",
- "roles": [
- "string"
], - "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "blockedFeatures": [
- "string"
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "phone": "string",
- "timeZone": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
UserId required | string |
{ }
{- "code": 200,
- "success": true,
- "user": {
- "loginInfo": {
- "lastIPAddress": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "loginsCount": 0
}, - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "status": "pending",
- "userId": "string",
- "email": "string",
- "name": "string",
- "roles": [
- "string"
], - "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "blockedFeatures": [
- "string"
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "phone": "string",
- "timeZone": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
UserId required | string |
{ }
{- "code": 200,
- "success": true,
- "user": {
- "loginInfo": {
- "lastIPAddress": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "loginsCount": 0
}, - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "status": "pending",
- "userId": "string",
- "email": "string",
- "name": "string",
- "roles": [
- "string"
], - "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "blockedFeatures": [
- "string"
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "phone": "string",
- "timeZone": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
Uniqueness constraints within organization:
UserId required | string User ID to update |
keys | string Default: "" Comma-separated fields to be returned ("*" - all) |
object (UserAddress) | |
blockedFeatures | Array of strings or null |
description | string User Description |
object (InternalInfo) Internal info | |
name | string User Name |
password | string User password |
phone | string User Phone |
roles | Array of strings User role names/ids |
status | string Enum: "active" "disabled" |
timeZone | string User Time Zone |
{- "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "blockedFeatures": [
- "string"
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "name": "string",
- "password": "string",
- "phone": "string",
- "roles": [
- "string"
], - "status": "active",
- "timeZone": "string"
}
{- "code": 200,
- "success": true,
- "user": {
- "loginInfo": {
- "lastIPAddress": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "loginsCount": 0
}, - "methods": {
- "account_payment": "string",
- "accounts": "string",
- "apikey": "string",
- "arrivals": "string",
- "automation_rules": "string",
- "automation_runs": "string",
- "automations": "string",
- "catalog_products": "string",
- "catalogs": "string",
- "changelog": "string",
- "connectors": "string",
- "contacts": "string",
- "convert": "c",
- "customers": "string",
- "entity_filters": "string",
- "entity_schemas": "string",
- "events": "string",
- "exception_categories": "string",
- "exception_filters": "string",
- "exceptions": "string",
- "fulfillments": "string",
- "functions": "string",
- "integration_actions": "string",
- "integration_state": "string",
- "integrations": "string",
- "inventory": "string",
- "inventoryrules": "string",
- "invoices": "string",
- "jobs": "string",
- "labels": "string",
- "locations": "string",
- "lookup_objects": "string",
- "mappings": "string",
- "notes": "string",
- "order_routing_runs": "string",
- "order_routings": "string",
- "orders": "string",
- "organizations": "string",
- "pricing": "string",
- "privacy": "string",
- "products": "string",
- "purchases": "string",
- "receipts": "string",
- "references": "string",
- "refunds": "string",
- "returns": "string",
- "roles": "string",
- "routings": "string",
- "shipment_boxes": "string",
- "shipments": "string",
- "shipping_methods": "string",
- "statement_transactions": "string",
- "statements": "string",
- "suppliers": "string",
- "trackings": "string",
- "transfers": "string",
- "usagedata": "string",
- "usageplans": "string",
- "users": "string",
- "vendor_schemas": "string",
- "webhooks": "string"
}, - "status": "pending",
- "userId": "string",
- "email": "string",
- "name": "string",
- "roles": [
- "string"
], - "address": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "firstName": "string",
- "lastName": "string",
- "stateOrProvince": "string",
- "zipCodeOrPostalCode": "string"
}, - "blockedFeatures": [
- "string"
], - "description": "string",
- "internal": {
- "property1": { },
- "property2": { }
}, - "phone": "string",
- "timeZone": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
body required | string Body of javascript function. The function signature - |
name required | string Name of the function |
createdAt | string <date-time> When the object was created within Pipe17 |
functionId | string Function ID |
isPublic | boolean Public access indicator (default - false) |
orgKey | string Organization this object belong to |
updatedAt | string <date-time> When the object was updated within Pipe17 |
{- "functionId": "string",
- "body": "string",
- "name": "string",
- "isPublic": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
body required | string Body of javascript function. The function signature - |
name required | string Name of the function |
isPublic | boolean Public access indicator (default - false) |
[- {
- "body": "string",
- "name": "string",
- "isPublic": true
}
]
{- "code": 200,
- "success": true,
- "functions": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "function": {
- "functionId": "string",
- "body": "string",
- "name": "string",
- "isPublic": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "message": "string",
- "status": "submitted"
}
]
}
FunctionId required | string The |
{- "code": 200,
- "success": true
}
FunctionId required | string The |
{- "code": 200,
- "success": true,
- "function": {
- "functionId": "string",
- "body": "string",
- "name": "string",
- "isPublic": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
FunctionId required | string The |
input | object The conversion input (- any value) |
{- "input": { }
}
{- "code": 200,
- "success": true,
- "input": { },
- "value": { }
}
body | string Select by |
count | integer <int32> Default: 100 Return at most this many functions |
functionId | Array of strings Select by |
isPublic | boolean The |
keys | string Default: "functionId,name,isPublic,body,createdAt,updatedAt,orgKey" Return these top-level fields |
name | Array of strings Select by |
order | string Default: "name,isPublic" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Select functions created after this date-time |
skip | integer <int32> Default: 0 Skip this many functions |
until | string <date-time> Select functions created before this date-time |
updatedSince | string <date-time> Select functions updated after this date-time |
updatedUntil | string <date-time> Select functions 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",
- "keys": "string",
- "order": "string",
- "body": "string",
- "functionId": [
- "string"
], - "isPublic": true,
- "name": [
- "string"
]
}, - "functions": [
- {
- "functionId": "string",
- "body": "string",
- "name": "string",
- "isPublic": true,
- "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
}
}
FunctionId required | string The |
keys | string Default: "" Fields of the updated object that should be returned (- comma separated string, |
body | string Body of javascript function. The function signature - |
name | string Name of the function |
{- "body": "string",
- "name": "string"
}
{- "code": 200,
- "success": true,
- "function": {
- "functionId": "string",
- "body": "string",
- "name": "string",
- "isPublic": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
required | object |
source required | object Source object to convert |
{- "rules": {
- "mappings": [
- {
- "enabled": true,
- "name": "string",
- "source": "string",
- "target": "string",
- "default": { },
- "desc": "string",
- "lookup": { },
- "missing": { },
- "options": "normal",
- "readme": "string",
- "require": true,
- "type": "string"
}
], - "mappingId": "string"
}, - "source": { }
}
{- "message": "string",
- "result": {
- "status": 200,
- "body": { }
}
}
required | object |
source required | object Source object to convert |
{- "rules": {
- "mappings": [
- {
- "enabled": true,
- "name": "string",
- "source": "string",
- "target": "string",
- "default": { },
- "desc": "string",
- "lookup": { },
- "missing": { },
- "options": "normal",
- "readme": "string",
- "require": true,
- "type": "string"
}
], - "mappingUuid": "string"
}, - "source": { }
}
{- "code": 200,
- "success": true,
- "info": { },
- "message": "string",
- "result": {
- "status": [
- 200
], - "body": { }
}
}
Provides an API for creating and maintaining a collection of abstract dictionaries intended for use either only within an individual organization (- "private dictionaries") or by all organizations (- "public dictionaries").
Dictionary is represented as a collection of "lookup objects".
Field lookupType
of a lookup object identifies the dictionary to which this object belongs (- understand this as the name of the dictionary).
The boolean field isPublic
indicates whether the dictionary is publicly available or not.
To search a specified dictionary by an input string (- lookupKey
), the API provides the lookup
method.
If the search in private dictionary fails, an attempt is made to find the matching object in the public dictionary of the same name.
expression required | string Expression representing the lookup keys ( |
expressionType required | string (LookupObjectExpressionType) Enum: "literal" "regexp" "function" Type of the lookup keys expression (-
|
lookupType required | string Type of the lookup object |
createdAt | string <date-time> When the object was created within Pipe17 |
hidden | boolean Set the true to exclude the object from the responses to the "List Lookup Objects" queries (- the true value can only be applied to public objects). |
isPublic | boolean Public object indicator (default - false) |
lookupId | string Lookup Object ID |
orgKey | string Organization this object belong to |
updatedAt | string <date-time> When the object was updated within Pipe17 |
value | object Lookup object value (- any type).
It should be undefined in requests if |
{- "lookupId": "string",
- "expression": "string",
- "expressionType": "literal",
- "lookupType": "string",
- "hidden": true,
- "isPublic": true,
- "value": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
expression required | string Expression representing the lookup keys ( |
expressionType required | string (LookupObjectExpressionType) Enum: "literal" "regexp" "function" Type of the lookup keys expression (-
|
lookupType required | string Type of the lookup object |
hidden | boolean Set the true to exclude the object from the responses to the "List Lookup Objects" queries (- the true value can only be applied to public objects). |
isPublic | boolean Public object indicator (default - false) |
value | object Lookup object value (- any type).
It should be undefined in requests if |
[- {
- "expression": "string",
- "expressionType": "literal",
- "lookupType": "string",
- "hidden": true,
- "isPublic": true,
- "value": { }
}
]
{- "code": 200,
- "success": true,
- "lookupObjects": [
- {
- "conflict": { },
- "errors": [
- "string"
], - "lookupObject": {
- "lookupId": "string",
- "expression": "string",
- "expressionType": "literal",
- "lookupType": "string",
- "hidden": true,
- "isPublic": true,
- "value": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "message": "string",
- "status": "submitted"
}
]
}
LookupId required | string Lookup Object ID |
{- "code": 200,
- "success": true,
- "lookupObject": {
- "lookupId": "string",
- "expression": "string",
- "expressionType": "literal",
- "lookupType": "string",
- "hidden": true,
- "isPublic": true,
- "value": { },
- "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 |
expression | Array of strings Select by |
expressionType | Array of strings Select by |
isPublic | boolean The |
keys | string Default: "lookupId,lookupType,isPublic,expression,expressionType,value,createdAt,updatedAt,orgKey" Return these top-level fields |
lookupId | Array of strings Select by |
lookupType | Array of strings Select by |
order | string Default: "orgKey,lookupType,expressionType,expression" Sort by these top-level fields |
pagination | string Value: "disabled" Exclude pagination info from the response |
since | string <date-time> Select objects created after this date-time (- ignored if the |
skip | integer <int32> Default: 0 Skip this many objects |
types | boolean Set the true to return only |
until | string <date-time> Select objects created before this date-time (- ignored if the |
updatedSince | string <date-time> Select objects updated after this date-time (- ignored if the |
updatedUntil | string <date-time> Select objects updated before this date-time (- ignored if the |
{- "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",
- "keys": "string",
- "order": "string",
- "expression": [
- "string"
], - "expressionType": [
- "string"
], - "isPublic": true,
- "lookupId": [
- "string"
], - "lookupType": [
- "string"
], - "types": true
}, - "lookupObjects": [
- {
- "lookupId": "string",
- "expression": "string",
- "expressionType": "literal",
- "lookupType": "string",
- "hidden": true,
- "isPublic": true,
- "value": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "lookupTypes": [
- {
- "lookupType": "string",
- "objectCount": 0,
- "publicObjectCount": 0
}
], - "pagination": {
- "first": true,
- "last": true,
- "outOfBounds": true,
- "pageIndex": 0,
- "pageSize": 0,
- "pages": 0,
- "total": 0
}
}
Looks up an object matching to given string (- lookupKey
) in the organization specific
subcollection of lookup objects of specified type (- LookupType
). If the organization's own
object is not found, a lookup is performed for the matching public object (obj.isPublic
).
In any case, the lookup among literal objects (obj.expressionType=="literal"
, exact match to the lookup key)
precedes the lookup among the objects that support regular expression matching (obj.expressionType=="regexp"
).
The functional lookup object (obj.expressionType=="function"
) is the last chance when neither a literal object nor a regexp one is found.
LookupType required | string Type of the lookup objects |
isPublic | boolean The |
keys | string Default: "lookupId,value" Fields of the found object (if it is) that should be returned (- comma separated string, |
lookupKey required | string Lookup key (- any string) |
{- "code": 200,
- "success": true,
- "lookupKey": "string",
- "lookupObject": {
- "lookupId": "string",
- "expression": "string",
- "expressionType": "literal",
- "lookupType": "string",
- "hidden": true,
- "isPublic": true,
- "value": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
LookupId required | string Lookup Object ID |
keys | string Default: "" Fields of the updated object that should be returned (- comma separated string, |
expression | string Expression representing the lookup keys ( |
expressionType | string (LookupObjectExpressionType) Enum: "literal" "regexp" "function" Type of the lookup keys expression (-
|
hidden | boolean Set the true to exclude the object from the responses to the "List Lookup Objects" queries (- the true value can only be applied to public objects). |
lookupType | string Type of the lookup object |
value | object or null Lookup object value (- any type).
Setting this field is not supported if the resulting |
{- "expression": "string",
- "expressionType": "literal",
- "hidden": true,
- "lookupType": "string",
- "value": { }
}
{- "code": 200,
- "success": true,
- "lookupObject": {
- "lookupId": "string",
- "expression": "string",
- "expressionType": "literal",
- "lookupType": "string",
- "hidden": true,
- "isPublic": true,
- "value": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "orgKey": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
field required | string (EntityFieldRef) Enum: "orders.orderSource" "products.sku" "products.integration" "products.vendor" Entity field reference, in "entityType.fieldPath" format |
{- "code": 200,
- "success": true,
- "values": [
- null
], - "filters": {
- "field": "orders.orderSource"
}
}