PAparcellab
Order

Order Status Information

Changed on

Retrieves order status information (trackings, checkpoints, and reporting info), typically for customer-facing use cases like an order status page.

Orders can be looked up using one of the following primary identifier sets.

Primary lookup methods:

  1. Order Number: Requires order_number and account. Optionally, client (Client Key).
  2. External Order ID: Requires external_order_id and account.
  3. External Reference: Requires external_reference and account. Note: uniqueness of external references is not ensured by the system.
  4. Tracking Number: Requires tracking_number and courier. Optionally, account
  5. Customer Number: Requires customer_number and account.
  6. Recipient Email: Requires recipient_email and account.

All lookups can also include these optional parameters:

  • postal_code: Recipient's postal code.
  • recipient_email: Recipient's email (for secondary verification/filtering).
  • lang: Language for the response content.
  • s: HMAC signature for secure access.
  • live_refresh: Boolean to force a live data refresh from carriers.
  • show_returns: Boolean to include return shipments associated with the order.
get/v4/track/orders/info/

Request

  • The document declares no server URL.
  • Auth
    • API key in header Authorization
    • or HTTP bearer
    • or none

Query parameters

accountinteger

Account of order (if lookup by order number)

client_keystring

Client key of order (if lookup by client key)

courierstring

Courier of order (if lookup by courier/tracking number)

customer_numberstring

Customer number of order (if lookup by customer number)

external_order_idstring uuid

External ID of order (if lookup by external ID)

external_referencestring

External reference of tracking (if lookup by external reference)

langstring

Language of order status information (falls back to trackings language and 'en' as last choice)

live_refreshboolean

Perform an inline (live) refresh to the carrier API if applicable.

order_numberstring

Order number to lookup (if lookup by order number)

recipient_emailstring email

Recipient email of order (if no API token is provided, determines level of information access in accordance with your account setup)

recipient_postal_codestring

Recipient postal code of order (if no API token is provided, determines level of information access in accordance with your account setup)

sstring

Security hash of tracking (if no API token is provided, determines level of information access in accordance with your account setup)

show_returnsboolean

Include return shipments associated with the order.

single_trackingboolean

Only return tracking data that matches the provided tracking number and courier

tracking_idstring

ID of tracking (if lookup by tracking ID)

tracking_numberstring

Tracking number of order (if lookup by courier/tracking number)

Response

order_numberstring required
returns_portal_urlstring

Resolved URL for starting a return for this order.

client_keystring

Name of the client (e.g. brand), as configured in account setup.

order_datestring date-time

Date of the order

recipient_namestring

Name of the recipient

recipient_emailstring

Email of the recipient

destination_country_iso3string

ISO 3166-1 alpha-3 country code of the destination country

Example response

{
  "trackings": [
    {
      "articles": [
        {
          "article_name": "Blue T-Shirt",
          "line_item_id": "ITEM-001",
          "product_id": "PROD-123",
          "quantity": 2,
          "sku": "TSHIRT-BLUE-M"
        }
      ],
      "articles_order": [
        {
          "article_name": "Blue T-Shirt",
          "line_item_id": "ITEM-001",
          "product_id": "PROD-123",
          "quantity": 2,
          "sku": "TSHIRT-BLUE-M"
        }
      ]
    }
  ]
}

Changes