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

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

NameDescription
lastUpdatedTs
string

If provided, only orders with a last updated timestamp greater than or equal to the one provided (inclusive) will be included.

status
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
channelOrderIds
array

If provided, only orders with the given Channel Order Ids will be included.

orderTs
string

If provided, only orders with a timestamp greater than or equal to the one provided (inclusive) will be included.

Show More

Responses

StatusDescription
200 successSuccess
Show common responses
Response Schema
NameDescription
results
array*

An array of SalesOrder results

pagination
object*
cURL
Send
curl --request GET \ --url 'https://api.zentail.com/v1/salesOrder' \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json'
Response
{
  • "results": [
    ],
  • "pagination": {}
}
Was this section helpful?
Yes No

Get detailed Sales Order information

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

NameDescription
orderNumber
number*

Zentail Order Number

Responses

StatusDescription
200 successSuccess
Show common responses
Response Schema
NameDescription
orderNumber
string*

The unique identifier for an order in Zentail

status
string*
Default: PENDING
Possible Values: PENDING_PAYMENT, PENDING, PARTIALLY_SHIPPED, SHIPPED, CANCELLED, RETURNED, REFUNDED OR RETURN_REQUESTED
cancellationReason
string*

If the order is CANCELLED this will provide the reason for the cancellation.

channel
string*

The name of the sales channel where the order was placed.

Show More
cURL
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": {
    },
  • "shippingAddress": {
    },
  • "billingAddress": {
    },
  • "packages": [
    ],
  • "products": [
    ],
  • "returnOrders": [
    ],
  • "fba": true,
  • "prime": true,
  • "businessOrder": true
}
Was this section helpful?
Yes No

Create packages to Sales Orders in Zentail

Request body schema

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

NameDescription
packages
array*

Responses

StatusDescription
200 successSuccess
Show common responses
Response Schema
NameDescription
orderDetails
array*
errors
array*
cURL
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

Returns a list of all Warehouses associated with this account. Warehouse IDs should be used when updating inventory using the API.


Responses

StatusDescription
200 successSuccess
Show common responses
Response Schema
NameDescription
results
array*
cURL
Send
curl --request GET \ --url https://api.zentail.com/v1/warehouses \ --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \ --header 'content-type: application/json'
Response
{
  • "results": [
    ]
}
Was this section helpful?
Yes No

Warehouse name and address information

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

Path Parameters

NameDescription
id
number*

Warehouse ID

Responses

StatusDescription
200 successSuccess
Show common responses
Response Schema
NameDescription
warehouse_id
number*

A unique identifier for this warehouse, should be used when updating inventory through the API.

warehouseUniqueId
string*

Unique identifier for the warehouse as recognized by the application.

name
string*
address
object*
cURL
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