Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The unique identifier of the order.

Example:

"669883e4bb5d6ab047c1c334"

Response

200 - application/json

Successfully fetched a order.

name
string
required

The unique identifier of the order.

Example:

"orders/669a8cba6af86466a42de2fe"

createTime
string<date-time>
required

The timestamp when the order was created.

Example:

"2024-07-17T21:32:52.478Z"

updateTime
string<date-time>
required

The timestamp when the order was last updated.

Example:

"2024-07-17T21:32:52.478Z"

status
enum<string>
required

The current status of the order.

Available options:
NEW,
CONFIRMED,
READY,
IN_PROGRESS,
CANCELLED,
DELIVERED,
RETURN
Example:

"NEW"

recipient
object
required

Details of the recipient of the order.

contentDescription
string
required

A description of the package content.

Required string length: 3 - 128
Example:

"Shoes"

notes
string
required

A detailed description of the contents of this package and additional information.

Required string length: 3 - 2048
Example:

"1 Pair of Reebok Nano, Size 8, Color Black"

sellingPriceCents
number
required

The order selling price, just for reporting purposes.

Example:

1430000

cashOnDeliveryRequestCents
number
required

The amount to be collected on delivery in cents.

Required range: x >= 0
Example:

8900000

customerReliability
enum<string>
required

The reliability of the customer.

Available options:
RELIABLE,
MODERATE,
UNRELIABLE,
NO_ORDERS
Example:

"RELIABLE"

customerBehavior
object
required
fulfiller
string
required

The entity responsible for fulfilling (shipping) the order.

Example:

"every"

shipment
string

The unique identifier for the associated shipment.

Example:

"shipments/669986bb4ae1239d5a92cdff"

referenceId
string

The ID of the order in the external system that created it, like Shopify order name.

Example:

"4012"

referenceGid
string

The global identifier of the order in the external system, like Shopify order GID.

Example:

"93240958723"

referenceUrl
string<uri>

The URL to the order in the external system, like Shopify order URL.

Example:

"https://mystore.com/order/1234567890"

paymentMethods
string[]

Payment methods used for this order.

Example: