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

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

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

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