---
title: "Order Status Information"
method: GET
path: "/v4/track/orders/info/"
tags: ["Order"]
---

# Order Status Information

`GET /v4/track/orders/info/`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
  - none

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.

## Query parameters

- `account` integer
- `client_key` string
- `courier` string
- `customer_number` string
- `external_order_id` string, uuid
- `external_reference` string
- `lang` string
- `live_refresh` boolean
- `order_number` string
- `recipient_email` string, email
- `recipient_postal_code` string
- `s` string
- `show_returns` boolean
- `single_tracking` boolean
- `tracking_id` string
- `tracking_number` string

## Response `200`

- OrderInfo
  - `order_number` string, required
  - `returns_portal_url` string: Resolved URL for starting a return for this order.
  - `client_key` string: Name of the client (e.g. brand), as configured in account setup.
  - `order_date` string, date-time: Date of the order
  - `recipient_name` string: Name of the recipient
  - `recipient_email` string: Email of the recipient
  - `destination_country_iso3` string: ISO 3166-1 alpha-3 country code of the destination country
  - `trackings` TrackingInfo[], required
    - `tracking_number` string, required: Tracking number of the shipment
    - `courier_info` Courier
      - `courier` string, required: The courier code (for example: dhl-germany).
      - `courier_name` string, required: The display name of the courier (for example: DHL).
      - `courier_tracking_url` string: The URL of the courier's own tracking page.
      - `hide_tracking_url` boolean: Whether links to the courier tracking page should be hidden.
      - `tracking_url_label` string: Localized label for the courier tracking link.
      - `courier_reroute_url` string: The URL of the courier's own tracking page in case the recipient reroutes the order.
      - `reroute_url_label_short` string: Short localized label for the courier rerouting link.
      - `reroute_url_label_long` string: Long localized label for the courier rerouting link.
      - `reroute_url_label_info` string: Additional localized information for the rerouting link.
      - `last_mile_courier` string: Final courier handling the parcel.
      - `last_mile_courier_name` string: Display name of the final courier handling the parcel.
      - `color_scheme` CourierColorScheme
        - `primary` string: Primary courier brand color.
        - `secondary` string: Secondary courier brand color.
        - `logo_url` string: URL of the courier logo.
    - `last_delivery_status` LastDeliveryStatus
      - `step` integer, required
      - `status_code` string, required: The applicable parcelLab status code.
      - `status_text` string: A short description of the current status of the delivery.
      - `status_details` string: A detailed description of the current status of the delivery.
      - `lifecycle_status` 'Pending' | 'Transit' | 'Customs' | 'LastMile' | 'ReadyToCollect' | 'Delivered' | 'SentBack' | 'Returned' | 'Failed' | 'Cancelled'
      - `delivery_extra_info` string: Relevant extra information extracted from the couriers status update
      - `exception_type` string: Type of exception, in case the checkpoint is an exception
      - `event_timestamp` string, date-time
      - `next_action` string
      - `icon_hint` string, required
    - `delivery_location` string: Delivery Location (in single line representation for display
    - `is_delayed` boolean: Whether a delay of this delivery has been detected by parcelLab.
    - `is_exception` boolean: Whether an escalated problem has been detected by parcelLab.
    - `is_return` boolean: Is the shipment a return
    - `has_multiple_shipments` boolean
    - `is_sms_opt_in` boolean: Whether this tracking already has an SMS opt-in phone number.
    - `sms_optin_consent_text` string: Secure SMS opt-in consent copy returned by backend.
    - `action_box` union
      - PickupLocationActionBox
        - `type` 'pickup-location'
        - `label` string
        - `label_communication` string
        - `label_caption` string
        - `address` union: Address string
          - string
          - Address
            - `address` string, required
            - `courier` string, required
            - `delivery_location` string, required
        - `opening_hours` OpeningHourInfo[]: Opening hours of pickup location, if known
          - `day` 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun', required
          - `open` string, time, required: Opening time
          - `close` string, time, required: Closing time
        - `raw` Raw
          - `earliest_date` string, date
          - `latest_date` string, date
          - `has_time` boolean, required
          - `earliest_time` string, nullable
          - `latest_time` string, nullable
      - PredictionActionBox
        - `type` 'prediction'
        - `label` string
        - `label_communication` string
        - `label_caption` string
        - `day_of_month` string: Day of the month (e.g. 22)
        - `day_of_month_min` string: Day of the month at the start of the delivery window
        - `week_day` string: Day of the week (e.g. Monday)
        - `week_day_min` string: Day of the week at the start of the delivery window
        - `month` string: Month (e.g. January)
        - `month_min` string: Month at the start of the delivery window
        - `prediction_caption` string: Explanatory text (e.g. 'The estimated delivery date is calculated by UPS and assumes no pick up, transport, regulatory clearance or delivery delays.'
        - `raw` Raw
          - `earliest_date` string, date
          - `latest_date` string, date
          - `has_time` boolean, required
          - `earliest_time` string, nullable
          - `latest_time` string, nullable
      - ReturnedActionBox
        - `type` 'returned'
        - `label` string
        - `label_communication` string
        - `label_caption` string
        - `reason` string
        - `returned_date` string, date
      - NextActionActionBox
        - `type` 'next-action' | 'pickup-location-unknown' | 'order-processed' | 'vote-courier', required
        - `label` string
        - `label_communication` string
        - `label_caption` string
    - `recipient_name` string
    - `recipient_email` string
    - `recipient_phone` string
    - `destination_country_iso3` string
    - `recipient_postal_code` string: Postal code
    - `identifiers_consignment` string: Consignment identifier
    - `order_external_reference` string: External order identifier from the source platform (e.g. the Shopify order id)
    - `warehouse` string: Warehouse identifier or name, if provided by retailer
    - `shipping_address` union: Shipping address
      - AddressInfo
        - `first_name` string
        - `last_name` string
        - `company_name` string
        - `address_line` string, required: Address line, e.g. street and house number, or PO Box
        - `address_line_extra` string: Additional address line, e.g. apartment number or company name
        - `postal_code` string, required
        - `city` string, required: City name (min-length of 1 due to logographic languages)
        - `country_iso3` string, required: ISO 3166-1 alpha-3 code of country
        - `region_code` string: Region code, e.g. state or province code (ISO 3166-2), if available
        - `phone` string: Phone number related to this address, if any
      - Empty
    - `articles` ArticleInfo[]: List of articles in the shipment, if provided by retailer
      - `version` 'v1' | 'v2'
      - `line_item_id` string, nullable: Retailer ID of the line item
      - `product_id` string: Parent product identifier in the retailer's system (shared across variants).
      - `variant_id` string: SKU/variant identifier; prefer for matching when available since parent product IDs are reused across variants.
      - `sku` string: Stock Keeping Unit of the line item
      - `barcode` string: Barcode associated with the line item variant or product
      - `order_item_id` string: Line Item ID in the order (preferred when provided)
      - `article_name` string: Name of the article
      - `article_description` string: Description of the article
      - `article_category` string: Category of the article
      - `article_store_url` string: URL to the article in the store
      - `article_image_url` string: URL to the image of the article
      - `article_brand` string: Brand of the article (reference only)
      - `size` string: Size of the article (reference only)
      - `color` string: Color of the article (reference only)
      - `width` number: Width of the article (in millimeters)
      - `height` number: Height of the article (in millimeters)
      - `length` number: Length of the article (in millimeters)
      - `length_unit` 'cm'
      - `weight` number: Weight of the article (in grams, kg, lbs, or oz)
      - `weight_unit` 'kg' | 'g' | 'lbs' | 'oz'
      - `unit_price` string: Paid unit price of the article (post-discount)
      - `unit_price_original` string: Original unit price of the article (pre-discount)
      - `quantity` integer: Unit quantity of the article
      - `amount_invoiced` string: Paid line total amount for this line item (post-discount)
      - `tax_amount` string: Total tax amount for this line item (regardless of taxesIncluded)
      - `harmonized_system_code` string: HS/HTS code for customs classification
      - `origin_country_iso3` string: ISO 3166-1 alpha-3 code of articles country of origin, might be required based on shipment regulations
      - `is_bulky` boolean: If the article is bulky
      - `tags` string[]: Tags for the line item, e.g. 'category:home-apparel', or 'customergroup:vip'
      - `bundle` BundleInfo
        - `group_id` string, required: Bundle group identifier in the retailer's system.
        - `role` 'parent' | 'component', required
        - `return_policy` 'parent_only' | 'components_only' | 'parent_and_components'
        - `parent_product_id` string: Parent bundle product identifier in the retailer's system.
        - `parent_variant_id` string: Parent bundle variant identifier in the retailer's system.
        - `parent_sku` string: Parent bundle SKU, if available.
        - `parent_title` string: Display title for the bundle parent, if available.
        - `parent_quantity` integer: Quantity of the bundle parent purchased in the order.
        - `component_quantity_per_parent` integer: Component quantity per single bundle parent (if determinable).
        - `selection_mode` 'individual' | 'group_on_first_pick'
        - `allocation_method` 'none' | 'component_price' | 'msrp_ratio' | 'equal'
        - `allocated_unit_price` string: Snapshot of allocated component unit price (if derived from bundle totals).
        - `allocated_amount_invoiced` string: Snapshot of allocated component invoiced amount (if derived from bundle totals).
      - `additional_attributes` AdditionalAttribute[]: Additional attributes for this line item
        - `key` string, required: The key of the additional attribute
        - `value` unknown
      - `currency` string: ISO 4217 currency of the article price
    - `articles_order` ArticleInfo[]: List of articles in the complete order, if provided by retailer
      - `version` 'v1' | 'v2'
      - `line_item_id` string, nullable: Retailer ID of the line item
      - `product_id` string: Parent product identifier in the retailer's system (shared across variants).
      - `variant_id` string: SKU/variant identifier; prefer for matching when available since parent product IDs are reused across variants.
      - `sku` string: Stock Keeping Unit of the line item
      - `barcode` string: Barcode associated with the line item variant or product
      - `order_item_id` string: Line Item ID in the order (preferred when provided)
      - `article_name` string: Name of the article
      - `article_description` string: Description of the article
      - `article_category` string: Category of the article
      - `article_store_url` string: URL to the article in the store
      - `article_image_url` string: URL to the image of the article
      - `article_brand` string: Brand of the article (reference only)
      - `size` string: Size of the article (reference only)
      - `color` string: Color of the article (reference only)
      - `width` number: Width of the article (in millimeters)
      - `height` number: Height of the article (in millimeters)
      - `length` number: Length of the article (in millimeters)
      - `length_unit` 'cm'
      - `weight` number: Weight of the article (in grams, kg, lbs, or oz)
      - `weight_unit` 'kg' | 'g' | 'lbs' | 'oz'
      - `unit_price` string: Paid unit price of the article (post-discount)
      - `unit_price_original` string: Original unit price of the article (pre-discount)
      - `quantity` integer: Unit quantity of the article
      - `amount_invoiced` string: Paid line total amount for this line item (post-discount)
      - `tax_amount` string: Total tax amount for this line item (regardless of taxesIncluded)
      - `harmonized_system_code` string: HS/HTS code for customs classification
      - `origin_country_iso3` string: ISO 3166-1 alpha-3 code of articles country of origin, might be required based on shipment regulations
      - `is_bulky` boolean: If the article is bulky
      - `tags` string[]: Tags for the line item, e.g. 'category:home-apparel', or 'customergroup:vip'
      - `bundle` BundleInfo
        - `group_id` string, required: Bundle group identifier in the retailer's system.
        - `role` 'parent' | 'component', required
        - `return_policy` 'parent_only' | 'components_only' | 'parent_and_components'
        - `parent_product_id` string: Parent bundle product identifier in the retailer's system.
        - `parent_variant_id` string: Parent bundle variant identifier in the retailer's system.
        - `parent_sku` string: Parent bundle SKU, if available.
        - `parent_title` string: Display title for the bundle parent, if available.
        - `parent_quantity` integer: Quantity of the bundle parent purchased in the order.
        - `component_quantity_per_parent` integer: Component quantity per single bundle parent (if determinable).
        - `selection_mode` 'individual' | 'group_on_first_pick'
        - `allocation_method` 'none' | 'component_price' | 'msrp_ratio' | 'equal'
        - `allocated_unit_price` string: Snapshot of allocated component unit price (if derived from bundle totals).
        - `allocated_amount_invoiced` string: Snapshot of allocated component invoiced amount (if derived from bundle totals).
      - `additional_attributes` AdditionalAttribute[]: Additional attributes for this line item
        - `key` string, required: The key of the additional attribute
        - `value` unknown
      - `currency` string: ISO 4217 currency of the article price
    - `additional_attributes` union: Any additional (custom) attributes (need to be whitelisted by parcelLab for exposure in this endpoint)
      - object
      - Empty
    - `announced_delivery_date` string, date: Delivery date announced to the customer (based on data provided by the retailer or, if activated, parcelLab EDD service)
    - `announced_delivery_date_min` string, date: Minimum delivery date announced to the customer (based on data provided by the retailer or, if activated, parcelLab EDD service)
    - `pod_identifier` string: URL of the POD identifier as link to parcellab CDN
    - `pod_signature` string: Signature name, if provided by the courier
    - `pod_date` string, date: Date of POD
    - `timezone` string: Timezone as provided by retailer
    - `reporting_info` ReportingInfo, required
      - `is_forgotten` boolean
      - `is_delayed` boolean
      - `has_failed_attempt` boolean
      - `is_delayed_dispatch` boolean
      - `is_returned` boolean
      - `is_customer_promise_exceeded` boolean
      - `trending_late_probability` number: The probability of a delay, if trending delay service is activated on account
      - `trending_late_status` 'normal' | 'warning' | 'delayed'
      - `contacted_with_messages` string[]: Messages (or webhooks) sent for tracking
      - `exception_messages` string[]
      - `in_transit_date` string, date-time
      - `pickup_date` string, date-time
      - `courier_dropoff_date` string, date-time
      - `delivery_date` string, date-time
      - `returned_date` string, date-time
    - `supports_live_refresh` boolean: Whether the tracking supports live refresh
    - `checkpoints` Checkpoint[]: List of (known) checkpoints of the shipment
      - `step` integer, required
      - `courier` string
      - `status_code` string, required: The applicable parcelLab status code.
      - `event_timestamp` string, date-time, required
      - `status_text` string, required: A short description of the current status of the delivery.
      - `status_details` string, required: A detailed description of the current status of the delivery.
      - `is_hidden` boolean, required: Whether the checkpoint has been marked as unclear by parcelLab. Note: Checkpoints provided by the courier which are unclear and do not help the recipient to understand the current status of the delivery are automatically filtered.
      - `location` string: The location of the checkpoint if available;
      - `delivery_location_type` 'ParcelShop' | 'ParcelLocker' | 'Store' | 'Neighbor' | 'Postbox' | 'HomeDeposit' | 'LastMileCarrier' | 'Doorstep' | 'Notified' | 'Unknown' | 'Reception'
      - `delivery_extra_info` string: Relevant extra information extracted from the couriers status update
      - `estimated_delivery_date` EstimatedDeliveryDate
        - `start_date` string, date, required
        - `end_date` string, date
        - `start_time` string, time
        - `end_time` string, time
      - `exception_type` string: Type of exception, in case the checkpoint is an exception
      - `next_action` string: Expected next status of the delivery

## Other responses

- `400`
- `404`

## Changes

- **2026-11-03** `84524f38b6c9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/parcellab/apis/parcellab-api/changes/v4/track/orders/info/get.md)

---

[API](https://skmtc.dev/parcellab/apis/parcellab-api.md) - [All operations](https://skmtc.dev/parcellab/apis/parcellab-api/llms.txt) - [OpenAPI document](https://skmtc.dev/parcellab/apis/parcellab-api/revisions/84524f38b6c9?raw)