Skip to main content
GET
Query Order
Query order information. You can query by either:
  • uniqueRequestId — the identifier used when creating orders, returns all orders for that batch
  • orderNos — a comma-separated list of order numbers to query

Authorizations

Authorization
string
header
required

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

Query Parameters

uniqueRequestId
string
required

Unique request ID of the order to query

orderNos
string[]

List only of order numbers to query(comma-separated)

Response

OK

id
string
required

ID of the order in the Pod ERP system

orderNo
string
required

Order number, note that this is different from the customerOrderNo provided by the customer, and is used for internal tracking within the Pod ERP system

recipient
object
required
product
object
required
shipping
object
required
status
enum<string>
required

Order status

Available options:
CREATED,
CANCELLED,
COMPLETED,
SPLIT,
PROCESSING,
FAILED,
TRACKING_NOT_FOUND,
TRACKING_PRE_ADVICE_RECEIVED,
TRACKING_PICKED_UP,
TRACKING_IN_TRANSIT,
TRACKING_ARRIVED_DESTINATION_COUNTRY,
TRACKING_IN_CUSTOMS,
TRACKING_CUSTOMS_CLEARED,
TRACKING_ARRIVED_FOR_PICKUP,
TRACKING_OUT_FOR_DELIVERY,
TRACKING_DELIVERY_FAILED,
TRACKING_DELIVERED,
TRACKING_EXCEPTION,
TRACKING_RETURNED,
TRACKING_CANCELLED,
TRACKING_UNKNOWN
source
enum<string>
required

Order source

Available options:
OPENAPI
remark
string
required

Order remark

customerOrderNo
string
required

Customer order number

createdAt
string
required

Order creation time(milliseconds since epoch)

updatedAt
string
required

Order last update time(milliseconds since epoch)

trackingNo
string

Tracking number

waybillStatus
enum<string>

Waybill status, if the order has a waybill

Available options:
CREATED,
PENDING,
COMPLETED,
FAILED,
CANCELLED,
INTERCEPTED
failedReason
string

Reason for order failure(if applicable)