Skip to main content
GET
/
orders
/
{order_id}
Retrieve order
curl --request GET \
  --url https://api.parceltracer.com/v1/external/orders/{order_id}/ \
  --header 'X-Api-Key: <api-key>'
{
  "order_id": "179",
  "reference_id": "123",
  "is_exchange": "false",
  "workflow": "STANDARD",
  "tracking_link": "https://prod.parceltracer.app/tracking/xxxxxxx-yyyyyy",
  "is_critical": "true",
  "merchant_location": 1,
  "cod": [
    [
      "LBP",
      "2000.00"
    ],
    [
      "USD",
      "50.50"
    ]
  ],
  "number_of_packages": 1,
  "description": "",
  "notes": "",
  "return_reason": "",
  "delivery_state": "CREATED",
  "payment_state": "UNPAID",
  "merchant_invoice": null,
  "customer": {
    "id": 9707,
    "name": "Joelle",
    "phone_number": "+96131234567",
    "secondary_phone_number": null,
    "email": ""
  },
  "customer_location": {
    "id": 9689,
    "area": {
      "id": 55,
      "name_en": "Balde",
      "name_ar": "بلدي",
      "lat": 34.56076,
      "long": 36.14491,
      "district": "Akkar",
      "maps_link": "http://maps.google.com/maps?q=34.56076,36.14491"
    },
    "directions": ""
  }
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
order_id
integer
required

Response

Successful retrieval

​
order_id
integer
required

Unique order identifier.

​
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
​
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.