This is an outline of all the currently supported Zentail API actions.
Please review or have your developers review this document and submit any feedback you may have. We’re always open to working together on new endpoints and functionality. Please let us know if you have any feedback.
URL |
---|
https://api.zentail.com/v1 |
Returns very detailed information about a sales order including accounting data, tracking/package data, line items for all sales orders that match the search criteria provided. Results are sorted by the lastUpdateTs from oldest to newest.
Name | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
string | If provided, only orders with a last updated timestamp greater than or equal to the one provided (inclusive) will be included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
array | If provided, only orders with the given status will be included. Possible Values: PENDING_PAYMENT, PENDING, PARTIALLY_SHIPPED, SHIPPED, CANCELLED, RETURNED, REFUNDED OR RETURN_REQUESTED | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
array | If provided, only orders with the given Channel Order Ids will be included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string | If provided, only orders with a timestamp greater than or equal to the one provided (inclusive) will be included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Show More |
curl --request GET \ --url https://api.zentail.com/v1/salesOrder \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json'
{- "results": [
- {
- "orderNumber": "string",
- "status": "PENDING",
- "cancellationReason": "string",
- "channel": "string",
- "channelLabel": "string",
- "channelOrderId": "string",
- "channelOrderReferenceNumber": "string",
- "customer_notes": "string",
- "marketplaceId": "string",
- "customerName": "string",
- "customerEmail": "string",
- "orderTs": "2019-08-24T14:15:22Z",
- "lastUpdatedTs": "2019-08-24T14:15:22Z",
- "requestedServiceLevel": "string",
- "standardServiceLevel": "Standard",
- "shipBy": "2019-08-24T14:15:22Z",
- "accounting": {
- "payment": 0,
- "channelTax": 0,
- "resellerCommission": 0,
- "shippingCost": 0,
- "itemCost": 0,
- "totalCost": 0,
- "revenue": 0,
- "profit": 0,
- "margin": 0,
- "itemPrice": 0,
- "shippingPrice": 0,
- "refund": 0
}, - "shippingAddress": {
- "name": "string",
- "company": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "state": "string",
- "postalCode": "string",
- "phone": "string",
- "email": "string",
- "countryCode": "US",
- "type": "string"
}, - "billingAddress": {
- "name": "string",
- "company": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "state": "string",
- "postalCode": "string",
- "phone": "string",
- "email": "string",
- "countryCode": "US",
- "type": "string"
}, - "packages": [
- {
- "packageId": 0,
- "carrier": "string",
- "serviceLevel": "string",
- "cost": 0,
- "tracking": "string",
- "shippedTs": "2019-08-24",
- "rma": "string",
- "labelUrl": "string",
- "packageWeight": 0,
- "packageWeightUom": "string",
- "packageHeight": 0,
- "packageWidth": 0,
- "packageLength": 0,
- "products": [
- {
- "sku": "string",
- "lineItemId": "string",
- "quantity": 0
}
]
}
], - "products": [
- {
- "lineItemId": "string",
- "status": "PENDING",
- "requestedTitle": "string",
- "requestedSku": "string",
- "SKU": "string",
- "mpn": "string",
- "standard_product_id": "string",
- "title": "string",
- "quantity": 0,
- "routing_info": [
- {
- "warehouseId": 0,
- "warehouseUniqueId": "string",
- "quantity": 0,
- "assembledQuantity": 0,
- "kitComponents": [
- {
- "SKU": "string",
- "componentQuantity": 0
}
]
}
], - "cancelQuantity": "string",
- "shippedQuantity": "string",
- "unitPrice": 0,
- "cost": 0,
- "totalWeight": 0,
- "refund": "string",
- "refundReason": "string",
- "giftWrapMessage": "string",
- "giftWrapLevel": "string",
- "earliestShipBy": "2019-08-24T14:15:22Z",
- "latestShipBy": "2019-08-24T14:15:22Z",
- "earliestDeliverBy": "2019-08-24T14:15:22Z",
- "latestDeliverBy": "2019-08-24T14:15:22Z",
- "requestedServiceLevel": "string"
}
], - "returnOrders": [
- {
- "returnOrderId": 0,
- "channelReturnId": "string",
- "requestTs": "2019-08-24T14:15:22Z",
- "returnItems": [
- {
- "returnOrderItemId": 0,
- "SKU": "string",
- "quantity": 0,
- "originalQuantity": 0,
- "refundAmount": 0
}
]
}
], - "fba": true,
- "prime": true,
- "businessOrder": true
}
],
}
Returns very detailed information about a sales order including accounting data, tracking/package data, line items for the sales order with the given Zentail Order Number
Status | Description |
---|---|
200 success | Success |
Show common responses |
Name | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
string* | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string* | Default: PENDING Possible Values: PENDING_PAYMENT, PENDING, PARTIALLY_SHIPPED, SHIPPED, CANCELLED, RETURNED, REFUNDED OR RETURN_REQUESTED | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string* | If the order is | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string* | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Show More |
curl --request GET \ --url https://api.zentail.com/v1/salesOrder/%7BorderNumber%7D \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json'
{- "orderNumber": "string",
- "status": "PENDING",
- "cancellationReason": "string",
- "channel": "string",
- "channelLabel": "string",
- "channelOrderId": "string",
- "channelOrderReferenceNumber": "string",
- "customer_notes": "string",
- "marketplaceId": "string",
- "customerName": "string",
- "customerEmail": "string",
- "orderTs": "2019-08-24T14:15:22Z",
- "lastUpdatedTs": "2019-08-24T14:15:22Z",
- "requestedServiceLevel": "string",
- "standardServiceLevel": "Standard",
- "shipBy": "2019-08-24T14:15:22Z",
- "accounting": {
- "payment": 0,
- "channelTax": 0,
- "resellerCommission": 0,
- "shippingCost": 0,
- "itemCost": 0,
- "totalCost": 0,
- "revenue": 0,
- "profit": 0,
- "margin": 0,
- "itemPrice": 0,
- "shippingPrice": 0,
- "refund": 0
}, - "shippingAddress": {
- "name": "string",
- "company": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "state": "string",
- "postalCode": "string",
- "phone": "string",
- "email": "string",
- "countryCode": "US",
- "type": "string"
}, - "billingAddress": {
- "name": "string",
- "company": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "city": "string",
- "state": "string",
- "postalCode": "string",
- "phone": "string",
- "email": "string",
- "countryCode": "US",
- "type": "string"
}, - "packages": [
- {
- "packageId": 0,
- "carrier": "string",
- "serviceLevel": "string",
- "cost": 0,
- "tracking": "string",
- "shippedTs": "2019-08-24",
- "rma": "string",
- "labelUrl": "string",
- "packageWeight": 0,
- "packageWeightUom": "string",
- "packageHeight": 0,
- "packageWidth": 0,
- "packageLength": 0,
- "products": [
- {
- "sku": "string",
- "lineItemId": "string",
- "quantity": 0
}
]
}
], - "products": [
- {
- "lineItemId": "string",
- "status": "PENDING",
- "requestedTitle": "string",
- "requestedSku": "string",
- "SKU": "string",
- "mpn": "string",
- "standard_product_id": "string",
- "title": "string",
- "quantity": 0,
- "routing_info": [
- {
- "warehouseId": 0,
- "warehouseUniqueId": "string",
- "quantity": 0,
- "assembledQuantity": 0,
- "kitComponents": [
- {
- "SKU": "string",
- "componentQuantity": 0
}
]
}
], - "cancelQuantity": "string",
- "shippedQuantity": "string",
- "unitPrice": 0,
- "cost": 0,
- "totalWeight": 0,
- "refund": "string",
- "refundReason": "string",
- "giftWrapMessage": "string",
- "giftWrapLevel": "string",
- "earliestShipBy": "2019-08-24T14:15:22Z",
- "latestShipBy": "2019-08-24T14:15:22Z",
- "earliestDeliverBy": "2019-08-24T14:15:22Z",
- "latestDeliverBy": "2019-08-24T14:15:22Z",
- "requestedServiceLevel": "string"
}
], - "returnOrders": [
- {
- "returnOrderId": 0,
- "channelReturnId": "string",
- "requestTs": "2019-08-24T14:15:22Z",
- "returnItems": [
- {
- "returnOrderItemId": 0,
- "SKU": "string",
- "quantity": 0,
- "originalQuantity": 0,
- "refundAmount": 0
}
]
}
], - "fba": true,
- "prime": true,
- "businessOrder": true
}
Place all of the package details in a JSON object in the body of the request.
curl --request POST \ --url https://api.zentail.com/v1/salesOrder/shipments \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json' \ --data '{"packages":[{"orderNumber":0,"fulfillmentPackageId":"string","warehouseId":0,"warehouseUniqueId":"string","tracking":"string","carrier":"string","service_level":"string","weight":0,"height":0,"length":0,"width":0,"cost":0,"products":[{"sku":"string","quantity":0}],"shippedTs":{},"shippedFrom":{"name":"string","company":"string","addressLine1":"string","addressLine2":"string","city":"string","state":"string","postalCode":"string","phone":"string","email":"string","countryCode":"US","type":"string"},"shippedTo":{"name":"string","company":"string","addressLine1":"string","addressLine2":"string","city":"string","state":"string","postalCode":"string","phone":"string","email":"string","countryCode":"US","type":"string"}}]}'
Returns a list of all Warehouses associated with this account. Warehouse IDs should be used when updating inventory using the API.
If the canUpdateInventory
field is false
you cannot use that warehouse to update inventory through the API. This is normally caused by warehouses that are managed by other inventory integrations, such as FBA or another third party logistics company.
curl --request GET \ --url https://api.zentail.com/v1/warehouses \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json'
{- "results": [
- {
- "warehouseId": 0,
- "warehouseUniqueId": "string",
- "canUpdateInventory": true,
- "name": "string"
}
]
}
Returns the ID, name, and address of the warehouse requested.
Status | Description |
---|---|
200 success | Success |
Show common responses |
curl --request GET \ --url https://api.zentail.com/v1/warehouse/%7Bid%7D \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json'