Skip to main content
GET
Retrieve order

Authorizations

X-Api-Key
string
header
required

Path Parameters

order_id
integer
required

Response

Successful retrieval

order_id
string
required

Unique order identifier, auto-generated by Parcel Tracer (e.g. '11').

reference_id
string
required

Reference ID of the order, for internal tracking by the shop.

is_critical
boolean
required

Mark the order as critical for prioritized handling (subject to the delivery company load and availability)

is_exchange
boolean
required

('Require pickup of a return package upon delivery.\n', 'This option is only applicable when workflow is STANDARD')

workflow
enum<string>
required

Order workflow: STANDARD or RETURN.

  • STANDARD - STANDARD
  • RETURN - RETURN
Available options:
STANDARD,
RETURN
merchant_location
integer
required

("Unique identifier of the merchant's location.\n", 'This identifier should correspond to one of the pickup locations visible on the pickup locations page on Parcel Tracer.')

customer
object
required

Customer object for the order.

customer_location
object
required

Customer location for delivery or pickup.

cod
string[][]
required

Total amount to be collected upon delivery (or upon return). Example: [['USD', '123.5']]

Required array length: 2 elements
number_of_packages
integer
required

('Number of packages in the order.\n', 'Should be greater than or equal to 1.')

description
string
required

Optional description of the order contents.

notes
string
required

Extra notes about the order, visible to delivery company, carriers and customers.

payment_state
enum<string>
required

Payment state of the order.

  • UNPAID - UNPAID
  • PENDING_PAYMENT_BY_DRIVER - PENDING_PAYMENT_BY_DRIVER
  • PAID_BY_DRIVER - PAID_BY_DRIVER
  • PENDING_PAYMENT_TO_MERCHANT - PENDING_PAYMENT_TO_MERCHANT
  • PAID_TO_MERCHANT - PAID_TO_MERCHANT
Available options:
UNPAID,
PENDING_PAYMENT_BY_DRIVER,
PAID_BY_DRIVER,
PENDING_PAYMENT_TO_MERCHANT,
PAID_TO_MERCHANT

Publicly accessible link to track the order's delivery journey.

order_url
string<uri>
required

Link to the order in the merchant's Parcel Tracer dashboard.

delivery_state
string
required

Current delivery state of the order. One of: CREATED, PICKUP_REQUESTED, PICKUP_ASSIGNED, SCANNED_FOR_PICKUP, PICKED_UP, AT_WAREHOUSE, DELIVERY_ASSIGNED, SCANNED_FOR_DELIVERY, PICKED_UP_FOR_DELIVERY, IN_TRANSIT, DELIVERED, AWAITING_RETURN, CANCELLED, DELIVERED_AT_WAREHOUSE.

statestamps
object[]
required

Chronological history of the order's delivery and payment states.

delivery_fee
string[][]

Total amount charged for the delivery operation. Required only if workflow is STANDARD. Example: [['USD', '123.5']]

Required array length: 2 elements
return_reason
string

Applicable if the order is a return. Reason for the return.

merchant_invoice
integer | null

Identifier of the merchant invoice this order was billed on, or null if not yet invoiced.

integration_items
object[]

Structured line items from an integrated platform (e.g. Shopify/WooCommerce).

source_url
string

Link back to the order on the originating platform.