All Docs

API

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

Import

Queue validation for CSV import

post/import/validation/{importDefinitionId}

This creates a validation for the given import definition. It queues it to be run for the given CSV file. GET /import/validation/results can be used to check the progress and current results.

Path Parameters

Name	Description
importDefinitionId string*	importDefinitionId The import definition ID is an ID that is unique for every definition of a report type and consists of the import type, the integration ID if applicable, and the template ID if applicable. The three parts are joined by semicolons: `<type>:<integration ID>:<template ID>` (e.g. "TemplatelessProduct::", "TemplatedProduct::35", "FullProductData:4:", "Kits::")

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
import_validation_id number*	import_validation_id
supplied_headers array*	supplied_headers
actual_headers array*	actual_headers
first_10_rows array*	first_10_rows

Send

curl --request POST \
  --url https://api.zentail.com/v1/import/validation/%7BimportDefinitionId%7D \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json'

Was this section helpful?

Yes No

Retrieve the results of validation using the validationID

get/import/validation/results/{validationID}

Returns Validation data which contains previews and validation results. This endpoint will return even if the validation is not complete and will give the current results of the validation.

Path Parameters

Name	Description
validationID number*	validationID Validation ID

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
status string*	status
data_rows_processed number*	data_rows_processed
previews array*	previews
validation_result_groups array*	validation_result_groups

Send

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

Was this section helpful?

Yes No

InboundShipment

Inbound shipment info

get/inbound-shipment/{id}

Returns the status, vendor, warehouse, and delivery info associated with the inbound shipment requested.

Path Parameters

Name	Description
id number*	id Inbound shipment ID

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
inbound_shipment_id number*	inbound_shipment_id A unique identifier for this inbound shipment.
status string*	status
vendor_name string*	vendor_name
destination_warehouse_name string*	destination_warehouse_name
shipping_cost number*	shipping_cost
purchase_order_number string*	purchase_order_number
created_ts string*	created_ts
shipped_ts string*	shipped_ts
estimated_delivery_ts string*	estimated_delivery_ts
Show More

Send

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

Was this section helpful?

Yes No

Create inbound shipments in Zentail

post/inbound-shipment

Create an inbound shipment in Zentail from a set of product information. Must include status, vendor name, destination warehouse, and purchase order number.

Request body schema

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

Name	Description
inbound_shipment_products array*	inbound_shipment_products
status string	status The status of the inbound shipment. Possible Values: PENDING, SHIPPED, RECEIVED, PARTIALLY_RECEIVED OR CANCELLED
vendor_name string	vendor_name
destination_warehouse_id integer	destination_warehouse_id
shipping_cost number	shipping_cost
purchase_order_number string	purchase_order_number
Show More

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
inbound_shipment_id number*	inbound_shipment_id A unique identifier for this inbound shipment.
status string*	status
vendor_name string*	vendor_name
destination_warehouse_name string*	destination_warehouse_name
shipping_cost number*	shipping_cost
purchase_order_number string*	purchase_order_number
created_ts string*	created_ts
shipped_ts string*	shipped_ts
estimated_delivery_ts string*	estimated_delivery_ts
Show More

Send

curl --request POST \
  --url https://api.zentail.com/v1/inbound-shipment \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"inbound_shipment_products":[{"product_id":0,"sku":"string","quantity":0,"unit_item_cost":0}],"status":"PENDING","vendor_name":"string","destination_warehouse_id":0,"shipping_cost":0,"purchase_order_number":"string"}'

Was this section helpful?

Yes No

Inbound shipment info

get/inbound-shipment

Returns the status, vendor, warehouse, and delivery info associated with the inbound shipments.

Query Parameters

Name	Description
purchase_order_number string	purchase_order_number If provided, only inbound shipments with the given Purchase Order Number will be included.

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
inbound_shipment_id number*	inbound_shipment_id A unique identifier for this inbound shipment.
status string*	status
vendor_name string*	vendor_name
destination_warehouse_name string*	destination_warehouse_name
shipping_cost number*	shipping_cost
purchase_order_number string*	purchase_order_number
created_ts string*	created_ts
shipped_ts string*	shipped_ts
estimated_delivery_ts string*	estimated_delivery_ts
Show More

Send

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

Was this section helpful?

Yes No

Cancel inbound shipments in Zentail

post/inbound-shipment/{id}/cancel

Cancel inbound shipments in Zentail. Must include the inbound shipment id.

Path Parameters

Name	Description
id number*	id Inbound shipment ID

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
inbound_shipment_id number*	inbound_shipment_id A unique identifier for this inbound shipment.
status string*	status
vendor_name string*	vendor_name
destination_warehouse_name string*	destination_warehouse_name
shipping_cost number*	shipping_cost
purchase_order_number string*	purchase_order_number
created_ts string*	created_ts
shipped_ts string*	shipped_ts
estimated_delivery_ts string*	estimated_delivery_ts
Show More

Send

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

Was this section helpful?

Yes No

Integration

Retrieve a list of Custom Order Integrations

get/customStores

Returns information about all of the integrations which can be used to upload orders into Zentail using the API, file upload or UI.

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/customStores \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json'

Response

{"results": [{"name": "string",
"default": true,
"integrationId": 0
}
]
}

Was this section helpful?

Yes No

Listing

Retrieve a list of listings

get/listing

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.

Query Parameters

Name	Description
lastUpdateTs string	lastUpdateTs If provided, only returns listings with an updated TS greater than the provided timestamp
skus array	skus If provided, only listings with the given skus will be included.
pageLength integer	pageLength Passing this will return the number of Listings specified, otherwise defaults to 25.
nextToken string	nextToken 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.

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
results array*	results
pagination object*	pagination

Send

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

Response

{"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",
"bullet_points": ["string"
],
"listing_data": [{"attribute": "string",
"value": "string"
}
]
}
]
}
],
"pagination": {"hasNext": true,
"nextToken": "http://example.com"
}
}

Was this section helpful?

Yes No

Retrieve a specific listing

get/listing/{listingid}

Path Parameters

Name	Description
listingid string*	listingid Listing ID

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
id string*	id A unique identifier for this listing.
sku string*	sku SKU which references the entire listing
title string*	title A "group-level" title, applies to the entire listing
description string*	description A description which applies to the entire listing
tags string*	tags Tags which can help identify this listing
created_at string*	created_at Timestamp this listing was created at
updated_at string*	updated_at Timestamp this listing was last updated at
pivot_attributes array*	pivot_attributes The list of attributes that the variants in this group should be selectable by
primary_image object*	primary_image
category string*	category The category for this listing on the channel
cpsia_warnings object*	cpsia_warnings
prop65 object*	prop65
variants array*	variants The list of variants. Each item provides variant specific inventory, pricing, and catalog attribute data.
Show More

Send

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

Was this section helpful?

Yes No

Create Listing Statuses

post/listing/status

Request body schema

Name	Description
statuses array*	statuses

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
errors array*	errors

Send

curl --request POST \
  --url https://api.zentail.com/v1/listing/status \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"statuses":[{"listing_id":"string","sku":"string","status":"PUBLISHED","listing_url":"string","errors":[{"severity":"NOTICE","classification":"other","affected_attributes":["string"],"error":"other","message":"string"}]}]}'

Was this section helpful?

Yes No

Inventory

Retrieve total available quantity across warehouses for a SKU

get/simpleInventory/{SKU}

Returns the total quantity of this SKU available in all warehouses

Path Parameters

Name	Description
SKU string*	SKU

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
SKU string*	SKU SKU value is the unique identifier for a product in Zentail.
standardProductId string*	standardProductId Depending on the type defined in standardProductIdType this field contains either the UPC, EAN, ISBN, or GTIN for this product.
active boolean*	active
standardProductIdType string*	standardProductIdType One of UPC, EAN, ISBN or GTIN.
totalAvailableQuantity integer*	totalAvailableQuantity
lastInventoryUpdateTs string*	lastInventoryUpdateTs Timestamp quantity for this product was last updated across all warehouses.
Show More

Send

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

Response

{"SKU": "string",
"standardProductId": "string",
"active": true,
"standardProductIdType": "string",
"totalAvailableQuantity": 0,
"lastInventoryUpdateTs": "2019-08-24T14:15:22Z"
}

Was this section helpful?

Yes No

Retrieve detailed inventory data for a SKU

get/inventory/{SKU}

Returns available quantity for the SKU in all warehouses, and inbound inventory data.

Path Parameters

Name	Description
SKU string*	SKU

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
SKU string*	SKU
active boolean*	active
standardProductId string*	standardProductId Depending on the type defined in standardProductIdType this field contains either the UPC, EAN, ISBN, or GTIN for this product.
standardProductIdType string*	standardProductIdType One of UPC, EAN, ISBN or GTIN.
totalAvailableQuantity integer*	totalAvailableQuantity This is the total quantity across all warehouses that is made available for sale on the marketplaces. This does not include stock committed or reserved for various sales orders.
warehouses array*	warehouses
lastInventoryUpdateTs string*	lastInventoryUpdateTs Timestamp quantity for this product was last updated across all warehouses.
Show More

Send

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

Response

{"SKU": "string",
"active": true,
"standardProductId": "string",
"standardProductIdType": "string",
"totalAvailableQuantity": 0,
"warehouses": [{"warehouseName": "string",
"warehouseUniqueId": "string",
"availableQuantity": 0,
"assembledQuantity": 0,
"inventoryLocations": [{"binLocation": "string",
"quantity": 0
}
],
"updatedTs": "2019-08-24T14:15:22Z",
"inboundShipments": [{"quantity": 0,
"expectedDeliveryDate": "2019-08-24",
"tracking": "string",
"carrier": "string"
}
]
}
],
"lastInventoryUpdateTs": "2019-08-24T14:15:22Z"
}

Was this section helpful?

Yes No

Retrieve detailed inventory data

get/inventory

Retrieve inventory data for SKUs with various filters. One of lastUpdatedTs, skus, warehouses is required to be passed in as a parameters.

Query Parameters

Name	Description
activeOnly boolean	activeOnly
lastUpdatedTs string	lastUpdatedTs Providing lastUpdateTs returns inventory for all SKUs updated after that timestamp.
skus array	skus If a list of SKUs is provided, lastUpdatedTs and warehouses are ignored.
isCaseSensitive boolean	isCaseSensitive If this is true, a case-sensitive match will be used to search for the 'skus' provided. If false, as case-insensitive search will be used. Default value is true. Default: true
warehouses array	warehouses If a list of warehouses is provided, inventory for products with non-zero inventory in those warehouses will be returned.
pageLength integer	pageLength Passing this will return the number of Inventory objects specified, otherwise defaults to 25.
nextToken string	nextToken Passing this will return the next page of a previous call (we will disregard all other parameters provided). You can find nextToken in the response from a previous GET inventory call.
Show More

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
results array*	results
errors array*	errors
pagination object*	pagination

Send

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

Response

{"results": [{"SKU": "string",
"active": true,
"standardProductId": "string",
"standardProductIdType": "string",
"totalAvailableQuantity": 0,
"warehouses": [{"warehouseName": "string",
"warehouseUniqueId": "string",
"availableQuantity": 0,
"assembledQuantity": 0,
"inventoryLocations": [{"binLocation": "string",
"quantity": 0
}
],
"updatedTs": "2019-08-24T14:15:22Z",
"inboundShipments": [{"quantity": 0,
"expectedDeliveryDate": "2019-08-24",
"tracking": "string",
"carrier": "string"
}
]
}
],
"lastInventoryUpdateTs": "2019-08-24T14:15:22Z"
}
],
"errors": ["string"
],
"pagination": {"hasNext": true,
"nextToken": "http://example.com"
}
}

Was this section helpful?

Yes No

Modify, Update inventory data

post/inventory

This call allows updating inventory data for SKUs. If the SKU does not exist in your Zentail account, it will be created and assigned the inventory provided. This works only for warhouses that dont have an integration controlling inventory.

Include only one of quantity, delta_quantity, or onhand_quantity in your request.

Request body schema

Provide the validAsOf timestamp and the items (Up to 50 SKUs per call)

Name	Description
products array*	products
validAsOf string	validAsOf

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Array of

Name	Description
SKU string*	SKU SKU value is the unique identifier for a product in Zentail.
standardProductId string*	standardProductId Depending on the type defined in standardProductIdType this field contains either the UPC, EAN, ISBN, or GTIN for this product.
standardProductIdType string*	standardProductIdType One of UPC, EAN, ISBN or GTIN.
active boolean*	active
totalAvailableQuantity integer*	totalAvailableQuantity This is the total quantity across all warehouses that is made available for sale on the marketplaces. This does not include stock committed or reserved for various sales orders.
lastInventoryUpdateTs string*	lastInventoryUpdateTs
errorMessage string*	errorMessage Contains error message if the inventory has not been processed successfully, else null
Show More

Send

curl --request POST \
  --url https://api.zentail.com/v1/inventory \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"products":[{"SKU":"string","quantity":0,"delta_quantity":0,"onhand_quantity":0,"binLocation":"string","warehouseId":0,"warehouseUniqueId":"string"}],"validAsOf":"2019-08-24T14:15:22Z"}'

Response

[{"SKU": "string",
"standardProductId": "string",
"standardProductIdType": "string",
"active": true,
"totalAvailableQuantity": 0,
"lastInventoryUpdateTs": "2019-08-24T14:15:22Z",
"errorMessage": "string"
}
]

Was this section helpful?

Yes No

Report

Retrieve data for report

get/report/{reportId}

Retrieve report data for the supplied reportId.

Path Parameters

Name	Description
reportId integer*	reportId You can find the reportId in the response to posting a new Report, in a report GET response, or in the import/export UI.

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
reportId integer*	reportId
label string*	label
isExport boolean*	isExport If true, this is an export. Otherwise it's an import.
requestedTs string*	requestedTs Timestamp when the report was requested to be run.
completedTs string*	completedTs Timestamp when the report was completed.
columnTypes array*	columnTypes Array of the column headers in this report.
status string*	status Possible Values: PENDING, PROCESSING, CANCELED OR COMPLETE
totalLines integer*	totalLines Total number of lines processed successfully.
linesSuccessfullyProcessed integer*	linesSuccessfullyProcessed
filePath string*	filePath Path to access the stored file. Use this to download an exported file when it is "COMPLETE"
errorMessage string*	errorMessage Returns an error message if we ran into an error processing the report.
overwriteWithBlank boolean*	overwriteWithBlank For imports only: If set to true, blank values supplied in the upload data will overwrite. NULL is equivalent to false.
createNewProducts boolean*	createNewProducts For imports only: If set to true, if a SKU doesn't exist in zentail we will create one. NULL is equivalent to false.
activeOnly boolean*	activeOnly For exports only: If set to true, export will only include active products.
insertOnly boolean*	insertOnly For imports only: If set to true, report will only fill in blank data on Zentail. Any data that already exists on Zentail will not be overwritten by data in the file.
includeHeader boolean*	includeHeader For exports only: If set to true, export will include a header Default: true
exportForExcel boolean*	exportForExcel For exports only: If set to true, will export as an Excel file.
filter string	filter For exports only: Use this to pass in filters to restrict the products being exported. See how to write a filter formula here.
delimiter string*	delimiter For exports only: We will use this delimiter to separate the data in the export. Default: ,
headersOnly boolean*	headersOnly For exports only: If true, this export will only have header rows.
uploader string*	uploader If this is null, then the report was created by the API.
Show More

Send

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

Response

{"reportId": 0,
"label": "string",
"isExport": false,
"requestedTs": "2019-08-24T14:15:22Z",
"completedTs": "2019-08-24T14:15:22Z",
"columnTypes": ["string"
],
"status": "PENDING",
"totalLines": 0,
"linesSuccessfullyProcessed": 0,
"filePath": "string",
"errorMessage": "string",
"overwriteWithBlank": false,
"createNewProducts": false,
"activeOnly": false,
"insertOnly": false,
"includeHeader": true,
"exportForExcel": false,
"filter": "string",
"delimiter": ",",
"headersOnly": false,
"uploader": "string"
}

Was this section helpful?

Yes No

Retrieve data for report(s)

get/report

This returns a list of Reports (most recent reports first).

Query Parameters

Name	Description
createdTs string	createdTs Passing this will only return reports created after createdTs.
pageLength integer	pageLength Passing this will return the number of Reports specified in pageLength
nextToken string	nextToken Passing this will return the next page of a previous call (we will disregard all other parameters provided). You can find nextToken in the response from a previous GET report call.

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
results array*	results
pagination object*	pagination

Send

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

Response

{"results": [{"reportId": 0,
"label": "string",
"isExport": false,
"requestedTs": "2019-08-24T14:15:22Z",
"completedTs": "2019-08-24T14:15:22Z",
"columnTypes": ["string"
],
"status": "PENDING",
"totalLines": 0,
"linesSuccessfullyProcessed": 0,
"filePath": "string",
"errorMessage": "string",
"overwriteWithBlank": false,
"createNewProducts": false,
"activeOnly": false,
"insertOnly": false,
"includeHeader": true,
"exportForExcel": false,
"filter": "string",
"delimiter": ",",
"headersOnly": false,
"uploader": "string"
}
],
"pagination": {"hasNext": true,
"nextToken": "http://example.com"
}
}

Was this section helpful?

Yes No

Create a report to be processed

post/report

You can use this endpoint to create an import or an export. The parameters used in each case are different so definitely check out the model to see what each parameter is used for. Please note the prefixes 'For exports only:' and 'For imports only:'.

Import

You'll need to build a file that has a header row that describes the contents of the corresponding column. You can find a list of acceptable column headers here. For example, if you were importing a file to set the MSRP for a set of SKUs, the first column header would have to be 'SKU' and the second column header would be 'MSRP'.

Export

If you don't supply any columnTypes in your request, we will include all of the possible columns that can be exported. If you'd like to restrict the number of columns you can pass the column types as an array. You can find a list of acceptable column headers here. For example if you were trying to export the MSRP for SKUs you would send ["SKU", "MSRP"] in the columnType parameter.
You can also use filters to limit the results of a report. You can find find more information on how to build a filter query here

Request body schema

Details of the report to be created

Name	Description
label string*	label Assigns a label to this report.
isExport boolean*	isExport If true, this is an export. Otherwise it's an import.
data string	data For imports only: This should be a csv, xls, xlsx, xslsm, txt, or tsv file encoded in base 64 (e.g. base64_encode(data) in PHP).
extension string*	extension For imports only: This tells us the type of file that was encoded in the data parameter. Default: csv Possible Values: csv, xls, xlsx, xlsm, txt OR tsv
overwriteWithBlank boolean*	overwriteWithBlank For imports only: If set to true, blank values supplied in the upload , data will overwrite.
createNewProducts boolean*	createNewProducts For imports only: If set to true, if a SKU doesn't exist in zentail, we will create one.
columnTypes array	columnTypes For exports only: Use this field to provide the columns you'd like to export. You can find the columns eligible for export at here. If no columns are supplied, all the possible columns will be exported (there are lot!).
delimiter string*	delimiter For exports only: We will use this delimiter to separate the data in the export. Default: ,
activeOnly boolean*	activeOnly For exports only: If set to true, export will only include active products.
insertOnly boolean*	insertOnly For imports only: If set to true, report will only fill in blank data on Zentail. Any data that already exists on Zentail will not be overwritten by data in the file.
includeHeader boolean*	includeHeader For exports only: If set to true, export will include a header Default: true
exportForExcel boolean*	exportForExcel For exports only: If set to true, will export as an Excel file.
filter string	filter For exports only: Use this to pass in filters to restrict the products being exported. See how to write a filter formula here., we will create one.
headersOnly boolean*	headersOnly For exports only: If true, this export will only have header rows.
Show More

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
reportId integer*	reportId
label string*	label
isExport boolean*	isExport If true, this is an export. Otherwise it's an import.
requestedTs string*	requestedTs Timestamp when the report was requested to be run.
completedTs string*	completedTs Timestamp when the report was completed.
columnTypes array*	columnTypes Array of the column headers in this report.
status string*	status Possible Values: PENDING, PROCESSING, CANCELED OR COMPLETE
totalLines integer*	totalLines Total number of lines processed successfully.
linesSuccessfullyProcessed integer*	linesSuccessfullyProcessed
filePath string*	filePath Path to access the stored file. Use this to download an exported file when it is "COMPLETE"
errorMessage string*	errorMessage Returns an error message if we ran into an error processing the report.
overwriteWithBlank boolean*	overwriteWithBlank For imports only: If set to true, blank values supplied in the upload data will overwrite. NULL is equivalent to false.
createNewProducts boolean*	createNewProducts For imports only: If set to true, if a SKU doesn't exist in zentail we will create one. NULL is equivalent to false.
activeOnly boolean*	activeOnly For exports only: If set to true, export will only include active products.
insertOnly boolean*	insertOnly For imports only: If set to true, report will only fill in blank data on Zentail. Any data that already exists on Zentail will not be overwritten by data in the file.
includeHeader boolean*	includeHeader For exports only: If set to true, export will include a header Default: true
exportForExcel boolean*	exportForExcel For exports only: If set to true, will export as an Excel file.
filter string	filter For exports only: Use this to pass in filters to restrict the products being exported. See how to write a filter formula here.
delimiter string*	delimiter For exports only: We will use this delimiter to separate the data in the export. Default: ,
headersOnly boolean*	headersOnly For exports only: If true, this export will only have header rows.
uploader string*	uploader If this is null, then the report was created by the API.
Show More

Send

curl --request POST \
  --url https://api.zentail.com/v1/report \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"label":"string","isExport":false,"data":"string","extension":"csv","overwriteWithBlank":false,"createNewProducts":false,"columnTypes":["string"],"delimiter":",","activeOnly":false,"insertOnly":false,"includeHeader":true,"exportForExcel":false,"filter":"string","headersOnly":false}'

Response

{"reportId": 0,
"label": "string",
"isExport": false,
"requestedTs": "2019-08-24T14:15:22Z",
"completedTs": "2019-08-24T14:15:22Z",
"columnTypes": ["string"
],
"status": "PENDING",
"totalLines": 0,
"linesSuccessfullyProcessed": 0,
"filePath": "string",
"errorMessage": "string",
"overwriteWithBlank": false,
"createNewProducts": false,
"activeOnly": false,
"insertOnly": false,
"includeHeader": true,
"exportForExcel": false,
"filter": "string",
"delimiter": ",",
"headersOnly": false,
"uploader": "string"
}

Was this section helpful?

Yes No

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

Create new Sales Orders in Zentail

post/salesOrder

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.

Integration ID

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.

Order Statuses

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

Request body schema

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

Name	Description
channelOrderId string*	channelOrderId
integrationId number	integrationId
orderTs string	orderTs Default: [object Object]
customer_notes string	customer_notes
customerName string*	customerName
customerEmail string	customerEmail
customerPhone string	customerPhone
marketplaceId string	marketplaceId
shippingAddress object*	shippingAddress
billingAddress object	billingAddress
payment number*	payment
totalTax number	totalTax 0
resellerCommission number	resellerCommission 0
requestedServiceLevel string	requestedServiceLevel
status string*	status Default: PENDING Possible Values: PENDING_PAYMENT, PENDING, SHIPPED, CANCELLED, RETURNED, REFUNDED OR RETURN_REQUESTED
products array*	products
Show More

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

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

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

Cancel Sales Order in Zentail

post/salesOrder/cancel/{orderNumber}

Path Parameters

Name	Description
orderNumber number*	orderNumber Zentail Order Number

Request body schema

Name	Description
reason string*	reason Reason for cancellation. Validation for reasons can be found at https://developer.zentail.com/integrations/sales-channel/cancellations
products array*	products Provide a list of items to cancel

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

Was this section helpful?

Yes No

Mark Order Paid in Zentail

post/salesOrder/markPaid/{orderNumber}

Path Parameters

Name	Description
orderNumber number*	orderNumber Zentail Order Number

Query Parameters

Name	Description
paidTs string	paidTs Timestamp at which the order was paid for, defaults to when the api call is performed Default: [object Object]

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 POST \
  --url 'https://api.zentail.com/v1/salesOrder/markPaid/%7BorderNumber%7D' \
  --header 'AUTHORIZATION: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json'

Was this section helpful?

Yes No

Vendor

Vendor info

get/vendor/{id}

Returns the ID, name, lead time, payment window, notes, and address associated with the vendor requested.

Path Parameters

Name	Description
id number*	id Vendor ID

Responses

Status	Description
200 success	200Success
Show common responses

Response Schema

Name	Description
vendor_id number*	vendor_id A unique identifier for this vendor.
name string*	name
lead_time number*	lead_time
payment_window number*	payment_window
notes string*	notes
address object*	address
Show More

Send

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

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