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 |
This endpoint is restricted to developers who have registered an application with Zentail. Please refer to our guide on building a sales channel integration to learn more about the registration process and how to use the listing endpoint.
Name | Description |
---|---|
string | If provided, only returns listings with an updated TS greater than the provided timestamp |
array | If provided, only listings with the given skus will be included. |
integer | Passing this will return the number of Listings specified, otherwise defaults to 25. |
string | Passing this will return the next page of a previous call (all other parameters will be ignored). You can find nextToken in the response from a previous GET listings call. |
curl --request GET \ --url https://api.zentail.com/v1/listing \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json'
{- "results": [
- {
- "id": "string",
- "sku": "string",
- "title": "string",
- "description": "string",
- "tags": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "pivot_attributes": [
- "string"
], - "primary_image": {
- "url": "string",
- "hash": "string"
}, - "category": "string",
- "cpsia_warnings": {
- "choking hazard balloon": false,
- "choking hazard contains a marble": false,
- "choking hazard contains a small ball": false,
- "choking hazard is a marble": false,
- "choking hazard is a small ball": false,
- "choking hazard small parts": false
}, - "prop65": {
- "required": false,
- "type": "alcoholic_beverage",
- "chemicals": [
- "butyl_benzyl_phthalate_bbp_d"
]
}, - "variants": [
- {
- "sku": "string",
- "available_inventory": 0,
- "pricing": {
- "current_selling_price": 0,
- "msrp": 0,
- "map": 0,
- "pricing": 0
}, - "primary_image": {
- "url": "string",
- "hash": "string"
}, - "images": [
- {
- "url": "string",
- "hash": "string"
}
], - "standard_identifier": "string",
- "standard_identifier_type": "UPC",
- "brand": "string",
- "manufacturer": "string",
- "model_number": "string",
- "condition": "New",
- "condition_description": "string",
- "listing_data": [
- {
- "attribute": "string",
- "value": "string"
}
]
}
]
}
],
}
This endpoint is restricted to developers who have registered an application with Zentail. Please refer to our guide on building a sales channel integration to learn more about the registration process and how to use the listing endpoint.
Status | Description |
---|---|
200 success | Success |
Show common responses |
curl --request GET \ --url https://api.zentail.com/v1/listing/%7Blistingid%7D \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json'
This endpoint is restricted to developers who have registered an application with Zentail. Please refer to our guide on building a sales channel integration to learn more about the registration process and how to use the listing endpoint.
Name | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
string* | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string* | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string* | Possible Values: PUBLISHED, UNPUBLISHED OR SUPPRESSED | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string* | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Show More |
curl --request POST \ --url https://api.zentail.com/v1/listing/status \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json' \ --data '{"listing_id":"string","sku":"string","status":"PUBLISHED","listing_url":"string","errors":[{"severity":"string","classification":"other","affected_attributes":["string"],"error":"other","message":"string"}]}'
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
}
],
}
Use this endpoint to create new Sales orders in Zentail. Once the order is in our system, you can use Zentail to manage the status and any future changes.
In order to create custom orders in Zentail, you will need to associate them with a Custom Order Integration. Each account will automatically create one when you create your first custom order.
This default integration will be used if the integration ID is not provided.
In order to retrieve the integration ID for each custom store, you can use the GET /customStores
endpoint.
These Custom Order Integrations are really just placeholders and do not technically integrate with any external channels.
You can control how the order is handled in Zential by setting the status
value. Most new orders should be in either PENDING_PAYMENT
or PENDING
. See the table below for each status and what it means.
Currently the API only supports one status per order. Individual line items may have different statuses after the order is created by performing various actions in the Zentail UI.
Status | Explanation | Action |
---|---|---|
PENDING_PAYMENT | An order that has not yet had a verified payment. | Zentail will try to reserve the inventory for up to 30 days but not actually fulfill the order or purchase labels |
PENDING | A new order ready for fulfillment. | Zentail will route this order to a warehouse or warehouses and send a fulfillment order where applicable. |
SHIPPED | An order that has already been shipped. | Zentail will not take any action on an already shipped custom order. |
CANCELLED | An order that has been cancelled. | For new custom orders, Zentail will not take any action. |
RETURNED | An order that has been successfully returned. | None |
REFUNDED | An order that has been refunded. | None |
RETURN_REQUESTED | An order for which a return has been requested but not yet complete. | None |
Place all of the order details in a JSON object in the body of the request.
Name | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
string* | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string | Default: [object Object] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Show More |
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 POST \ --url https://api.zentail.com/v1/salesOrder \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json' \ --data '{"channelOrderId":"string","integrationId":0,"orderTs":{},"customer_notes":"string","customerName":"string","customerEmail":"string","customerPhone":"string","marketplaceId":"string","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"},"payment":0,"totalTax":0,"resellerCommission":0,"requestedServiceLevel":"string","status":"PENDING","products":[{"lineItemId":"string","SKU":"string","title":"string","quantity":0,"unitPrice":0,"tax":0,"shippingPrice":0,"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"}]}'
{- "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
}
Name | Description |
---|---|
string* | Reason for cancellation. Validation for reasons can be found at https://developer.zentail.com/pages/cancelReasons.html |
array* | Provide a list of items to cancel |
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 POST \ --url https://api.zentail.com/v1/salesOrder/cancel/%7BorderNumber%7D \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json' \ --data '{"reason":"string","products":[{"lineItemId":"string","cancelQuantity":0,"restockQuantities":[{"warehouseId":0,"quantity":0}]}]}'
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 POST \ --url https://api.zentail.com/v1/salesOrder/markPaid/%7BorderNumber%7D \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json'