ZEzentail
SalesOrder

Get detailed Sales Order information

Returns very detailed information about a sales order including accounting data, tracking/package data, line items for the sales order with the given Zentail Order Number

get/salesOrder/{orderNumber}

Request

  • Base URL
    https://api.zentail.com/v1
  • Auth
    API key in header AUTHORIZATION

Path parameters

orderNumbernumber required

Zentail Order Number

Response

Success

orderNumberstring

The unique identifier for an order in Zentail

status'PENDING_PAYMENT' | 'PENDING' | 'PARTIALLY_SHIPPED' | 'SHIPPED' | 'CANCELLED' | 'RETURNED' | 'REFUNDED' | 'RETURN_REQUESTED'
cancellationReasonstring

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

channelstring

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

channelLabelstring

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.

channelOrderIdstring

The unique identifier for the order as provided by the sales channel.

channelOrderReferenceNumberstring

An optional identifier that some sales channels provide in addition to the channelOrderId

customer_notesstring

Notes provided by the customer that placed the order

marketplaceIdstring

An identifier of the marketplace where the order was placed, if the sales channel provides multiple marketplaces.

customerNamestring

The name of the customer that placed the order

customerEmailstring

The contact email of the customer that placed the order

orderTsstring date-time

The time that the order was placed. In ISO-8601 format

lastUpdatedTsstring date-time

The time that the order was last updated in Zentail. In ISO-8601 format

requestedServiceLevelstring

The service level that was requested by the sales channel

standardServiceLevel'Standard' | 'Economy' | 'Three Day' | 'Second Day' | 'Next Day' | 'Free Shipping' | 'International Standard' | 'International Economy' | 'International Priority' | 'Freight Standard' | 'Pick Up' | 'Unknown'

The channel's service level after being standardized in Zentail. Unknown is returned if a Standard Service level can't be determined.

shipBystring date-time

The earliest of the line items' lastestShipBy timestamps. This is a read-only field. In ISO-8601 format.

fbaboolean

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.

channelWillFulfillboolean

Whether the sales channel, rather than a merchant warehouse, is expected to fulfill this order.

primeboolean

Indicates this is a seller-fulfilled prime order.

businessOrderboolean

Indicates this is a business order.

Changes

No recorded changes to this operation across all 1 revision of this API.