Zentail API (v1)

Welcome to the Zentail API

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.

Server

URL
https://api.zentail.com/v1

Authentication

zentail_auth

Security Scheme Type	API Key
Header parameter name:	AUTHORIZATION

SalesOrder

Retrieve detailed Sales Order information for a list of orders

get/salesOrder

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.

Query Parameters

Name	Description
lastUpdatedTs string	lastUpdatedTs If provided, only orders with a last updated timestamp greater than or equal to the one provided (inclusive) will be included.
status array	status 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
channelOrderIds array	channelOrderIds If provided, only orders with the given Channel Order Ids will be included.
orderTs string	orderTs If provided, only orders with a timestamp greater than or equal to the one provided (inclusive) will be included.
pageLength integer	pageLength Passing this will return the number of SalesOrder objects specified in pageLength. 100 is the maximum allowed value.
nextToken string	nextToken The link to a requested page in the format of a full URL with the nextToken as a query parameter (all other parameters will be ignored). Use this to request the next page.
warehouseId integer	warehouseId Specifying a Zentail Warehouse Id will only return sales order line items that are routed to the corresponding warehouse.
Show More

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
results array*	results An array of `SalesOrder` results
pagination object*	pagination

Send

curl --request GET \
  --url 'https://api.zentail.com/v1/salesOrder' \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json'

Response

{"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
}
],
"pagination": {"hasNext": true,
"nextToken": "http://example.com"
}
}

Was this section helpful?

Yes No

Get detailed Sales Order information

get/salesOrder/{orderNumber}

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

Path Parameters

Name	Description
orderNumber number*	orderNumber Zentail Order Number

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
orderNumber string*	orderNumber The unique identifier for an order in Zentail
status string*	status Default: PENDING Possible Values: PENDING_PAYMENT, PENDING, PARTIALLY_SHIPPED, SHIPPED, CANCELLED, RETURNED, REFUNDED OR RETURN_REQUESTED
cancellationReason string*	cancellationReason If the order is `CANCELLED` this will provide the reason for the cancellation.
channel string*	channel The name of the sales channel where the order was placed.
channelLabel string*	channelLabel Label for the sales channel in Zentail. Some customers might have multiple instances of the same sales channel. This label is used to distinguish between them.
channelOrderId string*	channelOrderId The unique identifier for the order as provided by the sales channel.
channelOrderReferenceNumber string*	channelOrderReferenceNumber An optional identifier that some sales channels provide in addition to the `channelOrderId`
customer_notes string*	customer_notes Notes provided by the customer that placed the order
marketplaceId string*	marketplaceId An identifier of the marketplace where the order was placed, if the sales channel provides multiple marketplaces.
customerName string*	customerName The name of the customer that placed the order
customerEmail string*	customerEmail The contact email of the customer that placed the order
orderTs string*	orderTs The time that the order was placed. In ISO-8601 format
lastUpdatedTs string*	lastUpdatedTs The time that the order was last updated in Zentail. In ISO-8601 format
requestedServiceLevel string*	requestedServiceLevel The service level that was requested by the sales channel
standardServiceLevel string*	standardServiceLevel The channel's service level after being standardized in Zentail. `Unknown` is returned if the service level is unmapped. `null` is returned if no service level was requested. Possible Values: Standard, Economy, Three Day, Second Day, Next Day, Free Shipping, International Standard, International Economy, International Priority, Freight Standard, Pick Up, Unknown OR null
shipBy string*	shipBy The earliest of the line items' lastestShipBy timestamps. This is a read-only field. In ISO-8601 format.
accounting object*	accounting Information used to help with accounting
shippingAddress object*	shippingAddress
billingAddress object	billingAddress
packages array*	packages The individual packages once the order has been fulfilled
products array*	products The line items that make up the order.
returnOrders array*	returnOrders Details of any return that was issued for this order.
fba boolean*	fba Indicates this is an Amazon order which was fulfilled by automatically FBA. This could be `false` while parts of the order are still routed to FBA if it's a multi-channel FBA order.
prime boolean*	prime Indicates this is a seller-fulfilled prime order.
businessOrder boolean*	businessOrder Indicates this is a business order.
Show More

Send

curl --request GET \
  --url https://api.zentail.com/v1/salesOrder/%7BorderNumber%7D \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json'

Response

{"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
}

Was this section helpful?

Yes No

Create packages to Sales Orders in Zentail

post/salesOrder/shipments

Request body schema

Place all of the package details in a JSON object in the body of the request.

Name	Description
packages array*	packages

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
orderDetails array*	orderDetails
errors array*	errors

Send

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"}}]}'

Was this section helpful?

Yes No

Warehouse

Retrieve a list of all Warehouses

get/warehouses

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.

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
results array*	results

Send

curl --request GET \
  --url https://api.zentail.com/v1/warehouses \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json'

Response

{"results": [{"warehouseId": 0,
"warehouseUniqueId": "string",
"canUpdateInventory": true,
"name": "string"
}
]
}

Was this section helpful?

Yes No

Warehouse name and address information

get/warehouse/{id}

Returns the ID, name, and address of the warehouse requested.

Path Parameters

Name	Description
id number*	id Warehouse ID

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
warehouse_id number*	warehouse_id A unique identifier for this warehouse, should be used when updating inventory through the API.
warehouseUniqueId string*	warehouseUniqueId Unique identifier for the warehouse as recognized by the application.
name string*	name
address object*	address

Send

curl --request GET \
  --url https://api.zentail.com/v1/warehouse/%7Bid%7D \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json'

Was this section helpful?

Yes No