# Order Status

## Overview

These requests allow you to get order status information and an image of your order status page widget with a single HTTPS request.

You can retrieve the current status of an order using set parameters (for example: order number, tracking number, and carrier) through these APIs and get a visual representation of your order status page to display on customer-facing platforms.

## Get Order Status Updates

You can retrieve the latest status updates for an order (for example: to display on your order status page) using the `v4/track/orders/info` endpoint.

## Order Status Information

> 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.\ <br>

```json
{"openapi":"3.1.0","info":{"title":"parcelLab API","version":"v4"},"security":[{"OAuth2 Authentication":[]},{"HeaderToken":[]},{}],"components":{"securitySchemes":{"OAuth2 Authentication":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"HeaderToken":{"type":"http","scheme":"bearer","bearerFormat":"Parcellab-API-Token base64(account_id:token)","description":"Send `Authorization: Parcellab-API-Token <encoded-token>`.\n\n`<encoded-token>` = `base64(account_id:token)` as provided in the portal."}},"schemas":{"OrderInfo":{"properties":{"order_number":{"title":"Order Number","type":"string"},"client_key":{"description":"Name of the client (e.g. brand), as configured in account setup.","title":"Client Key","type":"string"},"order_date":{"description":"Date of the order","format":"date-time","title":"Order Date","type":"string"},"recipient_name":{"description":"Name of the recipient","title":"Recipient Name","type":"string"},"recipient_email":{"description":"Email of the recipient","title":"Recipient Email","type":"string"},"destination_country_iso3":{"description":"ISO 3166-1 alpha-3 country code of the destination country","pattern":"^\\w{3}$","title":"Destination Country Iso3","type":"string"},"trackings":{"items":{"$ref":"#/components/schemas/TrackingInfo"},"title":"Trackings","type":"array"}},"required":["order_number","trackings"],"title":"OrderInfo","type":"object"},"TrackingInfo":{"description":"Tracking info returned by Backend order endpoints for bots and apps\n\nNote the different fields than the normal tracking schema","properties":{"tracking_number":{"description":"Tracking number of the shipment","title":"Tracking Number","type":"string"},"courier_info":{"$ref":"#/components/schemas/Courier","description":"Details about the courier","title":"Courier Info"},"last_delivery_status":{"$ref":"#/components/schemas/LastDeliveryStatus","description":"Last delivery status","title":"Last Delivery Status"},"delivery_location":{"description":"Delivery Location (in single line representation for display","title":"Delivery Location","type":"string"},"is_delayed":{"default":false,"description":"Whether a delay of this delivery has been detected by parcelLab.","title":"Is Delayed","type":"boolean"},"is_exception":{"default":false,"description":"Whether an escalated problem has been detected by parcelLab.","title":"Is Exception","type":"boolean"},"is_return":{"default":false,"description":"Is the shipment a return","title":"Is Return","type":"boolean"},"action_box":{"anyOf":[{"discriminator":{"mapping":{"next-action":"#/components/schemas/NextActionActionBox","order-processed":"#/components/schemas/NextActionActionBox","pickup-location":"#/components/schemas/PickupLocationActionBox","pickup-location-unknown":"#/components/schemas/NextActionActionBox","prediction":"#/components/schemas/PredictionActionBox","returned":"#/components/schemas/ReturnedActionBox","vote-courier":"#/components/schemas/NextActionActionBox"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/PickupLocationActionBox"},{"$ref":"#/components/schemas/PredictionActionBox"},{"$ref":"#/components/schemas/ReturnedActionBox"},{"$ref":"#/components/schemas/NextActionActionBox"}]},{"type":"null"}],"default":null,"title":"Action Box"},"recipient_name":{"title":"Recipient Name","type":"string"},"recipient_email":{"title":"Recipient Email","type":"string"},"destination_country_iso3":{"pattern":"^\\w{3}$","title":"Destination Country Iso3","type":"string"},"recipient_postal_code":{"description":"Postal code","title":"Recipient Postal Code","type":"string"},"identifiers_consignment":{"description":"Consignment identifier","title":"Identifiers Consignment","type":"string"},"warehouse":{"description":"Warehouse identifier or name, if provided by retailer","title":"Warehouse","type":"string"},"shipping_address":{"anyOf":[{"$ref":"#/components/schemas/AddressInfo"},{"$ref":"#/components/schemas/Empty"}],"description":"Shipping address","title":"Shipping Address"},"articles":{"description":"List of articles in the shipment, if provided by retailer","items":{"$ref":"#/components/schemas/ArticleInfo"},"title":"Articles","type":"array"},"additional_attributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"$ref":"#/components/schemas/Empty"}],"description":"Any additional (custom) attributes (need to be whitelisted by parcelLab for exposure in this endpoint)","title":"Additional Attributes"},"announced_delivery_date":{"description":"Delivery date announced to the customer (based on data provided by the retailer or, if activated, parcelLab EDD service)","format":"date","title":"Announced Delivery Date","type":"string"},"announced_delivery_date_min":{"description":"Minimum delivery date announced to the customer (based on data provided by the retailer or, if activated, parcelLab EDD service)","format":"date","title":"Announced Delivery Date Min","type":"string"},"pod_identifier":{"description":"URL of the POD identifier as link to parcellab CDN","title":"Pod Identifier","type":"string"},"pod_signature":{"description":"Signature name, if provided by the courier","title":"Pod Signature","type":"string"},"pod_date":{"description":"Date of POD","format":"date","title":"Pod Date","type":"string"},"timezone":{"description":"Timezone as provided by retailer","title":"Timezone","type":"string"},"reporting_info":{"$ref":"#/components/schemas/ReportingInfo","description":"Additional reporting information for tracking"},"supports_live_refresh":{"description":"Whether the tracking supports live refresh","title":"Supports Live Refresh","type":"boolean"},"checkpoints":{"description":"List of (known) checkpoints of the shipment","items":{"$ref":"#/components/schemas/Checkpoint"},"title":"Checkpoints","type":"array"}},"required":["tracking_number","reporting_info"],"title":"TrackingInfo","type":"object"},"Courier":{"properties":{"courier":{"description":"The courier code (for example: dhl-germany).","title":"Courier","type":"string"},"courier_name":{"description":"The display name of the courier (for example: DHL).","title":"Courier Name","type":"string"},"courier_tracking_url":{"description":"The URL of the courier's own tracking page.","title":"Courier Tracking Url","type":"string"},"courier_reroute_url":{"description":"The URL of the courier's own tracking page in case the recipient reroutes the order.","title":"Courier Reroute Url","type":"string"},"last_mile_courier":{"description":"Final courier handling the parcel.","title":"Last Mile Courier","type":"string"},"last_mile_courier_name":{"description":"Display name of the final courier handling the parcel.","title":"Last Mile Courier Name","type":"string"}},"required":["courier","courier_name"],"title":"Courier","type":"object"},"LastDeliveryStatus":{"properties":{"step":{"title":"Step","type":"integer"},"status_code":{"description":"The applicable parcelLab status code.","title":"Status Code","type":"string"},"status_text":{"default":"","description":"A short description of the current status of the delivery.","title":"Status Text","type":"string"},"status_details":{"default":"","description":"A detailed description of the current status of the delivery.","title":"Status Details","type":"string"},"lifecycle_status":{"allOf":[{"$ref":"#/components/schemas/LifecycleStatusEnum"}],"description":"The lifecycle status of the delivery.","title":"Lifecycle Status"},"delivery_extra_info":{"description":"Relevant extra information extracted from the couriers status update","title":"Delivery Extra Info","type":"string"},"exception_type":{"description":"Type of exception, in case the checkpoint is an exception","title":"Exception Type","type":"string"},"event_timestamp":{"format":"date-time","title":"Event Timestamp","type":"string"},"next_action":{"title":"Next Action","type":"string"},"icon_hint":{"title":"Icon Hint","type":"string"}},"required":["step","status_code","icon_hint"],"title":"LastDeliveryStatus","type":"object"},"LifecycleStatusEnum":{"enum":["Pending","Transit","Customs","LastMile","ReadyToCollect","Delivered","SentBack","Returned","Failed","Cancelled"],"type":"string"},"PickupLocationActionBox":{"properties":{"type":{"const":"pickup-location","default":"pickup-location","title":"Type","type":"string"},"label":{"title":"Label","type":"string"},"label_communication":{"title":"Label Communication","type":"string"},"label_caption":{"title":"Label Caption","type":"string"},"address":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/Address"}],"description":"Address string","title":"Address"},"opening_hours":{"description":"Opening hours of pickup location, if known","items":{"$ref":"#/components/schemas/OpeningHourInfo"},"title":"Opening Hours","type":"array"},"raw":{"anyOf":[{"$ref":"#/components/schemas/Raw"},{"type":"null"}],"default":null,"description":"Raw opening hours information"}},"title":"PickupLocationActionBox","type":"object"},"Address":{"properties":{"address":{"title":"Address","type":"string"},"courier":{"title":"Courier","type":"string"},"delivery_location":{"title":"Delivery Location","type":"string"}},"required":["address","courier","delivery_location"],"title":"Address","type":"object"},"OpeningHourInfo":{"properties":{"day":{"allOf":[{"$ref":"#/components/schemas/DayEnum"}],"description":"Day","title":"Day"},"open":{"description":"Opening time","format":"time","title":"Open","type":"string"},"close":{"description":"Closing time","format":"time","title":"Close","type":"string"}},"required":["day","open","close"],"title":"OpeningHourInfo","type":"object"},"DayEnum":{"enum":["mon","tue","wed","thu","fri","sat","sun"],"type":"string"},"Raw":{"properties":{"earliest_date":{"format":"date","title":"Earliest Date","type":"string"},"latest_date":{"format":"date","title":"Latest Date","type":"string"},"has_time":{"title":"Has Time","type":"boolean"},"earliest_time":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Earliest Time"},"latest_time":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Latest Time"}},"required":["has_time"],"title":"Raw","type":"object"},"PredictionActionBox":{"properties":{"type":{"const":"prediction","default":"prediction","title":"Type","type":"string"},"label":{"title":"Label","type":"string"},"label_communication":{"title":"Label Communication","type":"string"},"label_caption":{"title":"Label Caption","type":"string"},"day_of_month":{"description":"Day of the month (e.g. 22)","title":"Day Of Month","type":"string"},"week_day":{"description":"Day of the week (e.g. Monday)","title":"Week Day","type":"string"},"month":{"description":"Month (e.g. January)","title":"Month","type":"string"},"prediction_caption":{"description":"Explanatory text (e.g. 'The estimated delivery date is calculated by UPS and assumes no pick up, transport, regulatory clearance or delivery delays.'","title":"Prediction Caption","type":"string"},"raw":{"$ref":"#/components/schemas/Raw","description":"Raw prediction information"}},"title":"PredictionActionBox","type":"object"},"ReturnedActionBox":{"properties":{"type":{"const":"returned","default":"returned","title":"Type","type":"string"},"label":{"title":"Label","type":"string"},"label_communication":{"title":"Label Communication","type":"string"},"label_caption":{"title":"Label Caption","type":"string"},"reason":{"title":"Reason","type":"string"},"returned_date":{"format":"date","title":"Returned Date","type":"string"}},"title":"ReturnedActionBox","type":"object"},"NextActionActionBox":{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/NextActionActionBoxTypeEnum"}],"title":"Type"},"label":{"title":"Label","type":"string"},"label_communication":{"title":"Label Communication","type":"string"},"label_caption":{"title":"Label Caption","type":"string"}},"required":["type"],"title":"NextActionActionBox","type":"object"},"NextActionActionBoxTypeEnum":{"enum":["next-action","pickup-location-unknown","order-processed","vote-courier"],"type":"string"},"AddressInfo":{"properties":{"first_name":{"title":"First Name","type":"string"},"last_name":{"title":"Last Name","type":"string"},"company_name":{"title":"Company Name, if any","type":"string"},"address_line":{"description":"Address line, e.g. street and house number, or PO Box","maxLength":256,"minLength":1,"title":"Address Line","type":"string"},"address_line_extra":{"description":"Additional address line, e.g. apartment number or company name","title":"Additional Address Line","type":"string"},"postal_code":{"maxLength":10,"minLength":2,"title":"Postal Code","type":"string"},"city":{"description":"City name (min-length of 1 due to logographic languages)","maxLength":40,"minLength":1,"title":"City","type":"string"},"country_iso3":{"description":"ISO 3166-1 alpha-3 code of country","pattern":"^\\w{3}$","title":"Country ISO3","type":"string"},"region_code":{"description":"Region code, e.g. state or province code (ISO 3166-2), if available","maxLength":25,"minLength":1,"title":"Region Code","type":"string"},"phone":{"description":"Phone number related to this address, if any","maxLength":30,"title":"Phone","type":"string"}},"required":["address_line","postal_code","city","country_iso3"],"title":"Address","type":"object"},"Empty":{"additionalProperties":false,"properties":{},"title":"Empty","type":"object"},"ArticleInfo":{"additionalProperties":true,"properties":{"version":{"$ref":"#/components/schemas/LineItemVersionEnum","description":"Optional. Omit this key unless absolutely intended. The standard value is `v2`. If you send `version`, send `v2`.","title":"Version"},"line_item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Retailer ID of the line item","title":"Line Item ID"},"product_id":{"description":"Parent product identifier in the retailer's system (shared across variants).","title":"Product ID","type":"string"},"variant_id":{"description":"SKU/variant identifier; prefer for matching when available since parent product IDs are reused across variants.","title":"Variant ID","type":"string"},"sku":{"description":"Stock Keeping Unit of the line item","title":"SKU","type":"string"},"barcode":{"description":"Barcode associated with the line item variant or product","title":"Barcode","type":"string"},"order_item_id":{"description":"Line Item ID in the order (preferred when provided)","title":"Order Line Item ID","type":"string"},"article_name":{"description":"Name of the article","title":"Article Name","type":"string"},"article_category":{"description":"Category of the article","title":"Article Category","type":"string"},"article_store_url":{"description":"URL to the article in the store","title":"Article Store URL","type":"string"},"article_image_url":{"description":"URL to the image of the article","title":"Article Image URL","type":"string"},"article_brand":{"description":"Brand of the article (reference only)","title":"Article Brand","type":"string"},"size":{"description":"Size of the article (reference only)","title":"Size","type":"string"},"color":{"description":"Color of the article (reference only)","title":"Color","type":"string"},"width":{"description":"Width of the article (in millimeters)","title":"Width","type":"number"},"height":{"description":"Height of the article (in millimeters)","title":"Height","type":"number"},"length":{"description":"Length of the article (in millimeters)","title":"Length","type":"number"},"length_unit":{"const":"cm","default":"cm","title":"Length Unit","type":"string"},"weight":{"description":"Weight of the article (in grams, kg, lbs, or oz)","title":"Weight","type":"number"},"weight_unit":{"allOf":[{"$ref":"#/components/schemas/WeightUnitEnum"}],"default":"g","title":"Weight Unit"},"unit_price":{"description":"Paid unit price of the article (post-discount)","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Unit Price","type":"string"},"unit_price_original":{"description":"Original unit price of the article (pre-discount)","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Original Unit Price","type":"string"},"quantity":{"description":"Unit quantity of the article","title":"Quantity","type":"integer"},"amount_invoiced":{"description":"Paid line total amount for this line item (post-discount)","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Amount Invoiced","type":"string"},"tax_amount":{"description":"Total tax amount for this line item (regardless of taxesIncluded)","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Tax Amount","type":"string"},"harmonized_system_code":{"description":"HS/HTS code for customs classification","title":"Harmonized System Code","type":"string"},"origin_country_iso3":{"description":"ISO 3166-1 alpha-3 code of articles country of origin, might be required based on shipment regulations","pattern":"^\\w{3}$","title":"Origin Country ISO3","type":"string"},"is_bulky":{"default":false,"description":"If the article is bulky","title":"Is Bulky","type":"boolean"},"tags":{"description":"Tags for the line item, e.g. 'category:home-apparel', or 'customergroup:vip'","items":{"type":"string"},"title":"Tags","type":"array"},"bundle":{"anyOf":[{"$ref":"#/components/schemas/BundleInfo"},{"type":"null"}],"default":null,"description":"Bundle relationship metadata when the item is part of a bundle.","title":"Bundle Info"},"additional_attributes":{"description":"Additional attributes for this line item","items":{"$ref":"#/components/schemas/AdditionalAttribute"},"title":"Additional Attributes","type":"array"}},"title":"Line Item","type":"object"},"LineItemVersionEnum":{"enum":["v1","v2"],"title":"LineItemVersionEnum","type":"string"},"WeightUnitEnum":{"enum":["kg","g","lbs","oz"],"type":"string"},"BundleInfo":{"additionalProperties":true,"properties":{"group_id":{"description":"Bundle group identifier in the retailer's system.","title":"Bundle Group ID","type":"string"},"role":{"$ref":"#/components/schemas/BundleRoleEnum","description":"Whether this line item represents a bundle parent or a bundle component.","title":"Bundle Role"},"return_policy":{"$ref":"#/components/schemas/BundleReturnPolicyEnum","default":"components_only","description":"Which lines in this bundle group are selectable for return.","title":"Bundle Return Policy"},"parent_product_id":{"description":"Parent bundle product identifier in the retailer's system.","title":"Bundle Parent Product ID","type":"string"},"parent_variant_id":{"description":"Parent bundle variant identifier in the retailer's system.","title":"Bundle Parent Variant ID","type":"string"},"parent_sku":{"description":"Parent bundle SKU, if available.","title":"Bundle Parent SKU","type":"string"},"parent_title":{"description":"Display title for the bundle parent, if available.","title":"Bundle Parent Title","type":"string"},"parent_quantity":{"description":"Quantity of the bundle parent purchased in the order.","title":"Bundle Parent Quantity","type":"integer"},"component_quantity_per_parent":{"description":"Component quantity per single bundle parent (if determinable).","title":"Bundle Component Quantity Per Parent","type":"integer"},"allocation_method":{"$ref":"#/components/schemas/BundleAllocationMethodEnum","default":"none","description":"How pricing was allocated to bundle components.","title":"Bundle Allocation Method"},"allocated_unit_price":{"description":"Snapshot of allocated component unit price (if derived from bundle totals).","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Allocated Unit Price","type":"string"},"allocated_amount_invoiced":{"description":"Snapshot of allocated component invoiced amount (if derived from bundle totals).","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Allocated Amount Invoiced","type":"string"}},"required":["group_id","role"],"title":"Bundle Info","type":"object"},"BundleRoleEnum":{"enum":["parent","component"],"title":"BundleRoleEnum","type":"string"},"BundleReturnPolicyEnum":{"enum":["parent_only","components_only","parent_and_components"],"title":"BundleReturnPolicyEnum","type":"string"},"BundleAllocationMethodEnum":{"enum":["none","component_price","msrp_ratio","equal"],"title":"BundleAllocationMethodEnum","type":"string"},"AdditionalAttribute":{"properties":{"key":{"description":"The key of the additional attribute","title":"Key","type":"string"},"value":{"default":null,"description":"The value of the additional attribute","title":"Value"}},"required":["key"],"title":"AdditionalAttribute","type":"object"},"ReportingInfo":{"properties":{"is_forgotten":{"title":"Is Forgotten","type":"boolean"},"is_delayed":{"title":"Is Delayed","type":"boolean"},"has_failed_attempt":{"title":"Has Failed Attempt","type":"boolean"},"is_delayed_dispatch":{"title":"Is Delayed Dispatch","type":"boolean"},"is_returned":{"title":"Is Returned","type":"boolean"},"is_customer_promise_exceeded":{"title":"Is Customer Promise Exceeded","type":"boolean"},"trending_late_probability":{"description":"The probability of a delay, if trending delay service is activated on account","title":"Trending Late Probability","type":"number"},"trending_late_status":{"allOf":[{"$ref":"#/components/schemas/TrendingLateStatusEnum"}],"title":"Trending Late Status"},"contacted_with_messages":{"description":"Messages (or webhooks) sent for tracking","items":{"type":"string"},"title":"Contacted With Messages","type":"array"},"exception_messages":{"items":{"type":"string"},"title":"Exception Messages","type":"array"},"in_transit_date":{"format":"date-time","title":"In Transit Date","type":"string"},"pickup_date":{"format":"date-time","title":"Pickup Date","type":"string"},"courier_dropoff_date":{"format":"date-time","title":"Courier Dropoff Date","type":"string"},"delivery_date":{"format":"date-time","title":"Delivery Date","type":"string"},"returned_date":{"format":"date-time","title":"Returned Date","type":"string"}},"title":"ReportingInfo","type":"object"},"TrendingLateStatusEnum":{"enum":["normal","warning","delayed"],"type":"string"},"Checkpoint":{"properties":{"step":{"title":"Step","type":"integer"},"courier":{"title":"Courier","type":"string"},"status_code":{"description":"The applicable parcelLab status code.","title":"Status Code","type":"string"},"event_timestamp":{"format":"date-time","title":"Event Timestamp","type":"string"},"status_text":{"description":"A short description of the current status of the delivery.","title":"Status Text","type":"string"},"status_details":{"description":"A detailed description of the current status of the delivery.","title":"Status Details","type":"string"},"is_hidden":{"description":"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.","title":"Is Hidden","type":"boolean"},"location":{"description":"The location of the checkpoint if available; ","title":"Location","type":"string"},"delivery_location_type":{"allOf":[{"$ref":"#/components/schemas/DeliveryLocationTypeEnum"}],"title":"Delivery Location Type"},"delivery_extra_info":{"description":"Relevant extra information extracted from the couriers status update","title":"Delivery Extra Info","type":"string"},"estimated_delivery_date":{"$ref":"#/components/schemas/EstimatedDeliveryDate","description":"The estimated delivery data, if available with the checkoint","title":"Estimated Delivery Date"},"exception_type":{"description":"Type of exception, in case the checkpoint is an exception","title":"Exception Type","type":"string"},"next_action":{"description":"Expected next status of the delivery","title":"Next Action","type":"string"}},"required":["step","status_code","event_timestamp","status_text","status_details","is_hidden"],"title":"Checkpoint","type":"object"},"DeliveryLocationTypeEnum":{"enum":["ParcelShop","ParcelLocker","Neighbor","Postbox","HomeDeposit","LastMileCarrier","Doorstep","Notified","Unknown","Reception"],"type":"string"},"EstimatedDeliveryDate":{"properties":{"start_date":{"format":"date","title":"Start Date","type":"string"},"end_date":{"format":"date","title":"End Date","type":"string"},"start_time":{"format":"time","title":"Start Time","type":"string"},"end_time":{"format":"time","title":"End Time","type":"string"}},"required":["start_date"],"title":"EstimatedDeliveryDate","type":"object"},"Error400Response":{"type":"object","properties":{"type":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/GenericErrorItem"}}},"required":["errors","type"]},"GenericErrorItem":{"type":"object","properties":{"code":{"type":"string"},"detail":{"type":"string"},"attr":{"type":["string","null"]}},"required":["code","detail"]},"Error404":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/ErrorCode404Enum"},"detail":{"type":"string"},"attr":{"type":["string","null"]}},"required":["attr","code","detail"]},"ErrorCode404Enum":{"enum":["not_found"],"type":"string","description":"* `not_found` - Not Found"}}},"paths":{"/v4/track/orders/info/":{"get":{"operationId":"track_orders_info_retrieve","description":"Retrieves order status information (trackings, checkpoints, and reporting info), typically for customer-facing use cases like an order status page.\n\nOrders can be looked up using one of the following primary identifier sets.\n\nPrimary lookup methods:\n\n1.  **Order Number**: Requires `order_number` and `account`. Optionally, `client` (Client Key).\n2.  **External Order ID**: Requires `external_order_id` and `account`.\n3.  **External Reference**: Requires `external_reference` and `account`. Note: uniqueness of external references is not ensured by the system.\n4.  **Tracking Number**: Requires `tracking_number` and `courier`. Optionally, `account`\n5.  **Customer Number**: Requires `customer_number`  and `account`.\n6.  **Recipient Email**: Requires `recipient_email` and `account`.\n\nAll lookups can also include these optional parameters:\n\n*   `postal_code`: Recipient's postal code.\n*   `recipient_email`: Recipient's email (for secondary verification/filtering).\n*   `lang`: Language for the response content.\n*   `s`: HMAC signature for secure access.\n*   `live_refresh`: Boolean to force a live data refresh from carriers.\n*   `show_returns`: Boolean to include return shipments associated with the order.\n\n","summary":"Order Status Information","parameters":[{"in":"query","name":"account","schema":{"type":"integer"},"description":"Account of order (if lookup by order number)"},{"in":"query","name":"client_key","schema":{"type":"string","minLength":1},"description":"Client key of order (if lookup by client key)"},{"in":"query","name":"courier","schema":{"type":"string","minLength":1},"description":"Courier of order (if lookup by courier/tracking number)"},{"in":"query","name":"customer_number","schema":{"type":"string","minLength":1},"description":"Customer number of order (if lookup by customer number)"},{"in":"query","name":"external_order_id","schema":{"type":"string","format":"uuid"},"description":"External ID of order (if lookup by external ID)"},{"in":"query","name":"external_reference","schema":{"type":"string","minLength":1},"description":"External reference of tracking (if lookup by external reference)"},{"in":"query","name":"lang","schema":{"type":"string","minLength":1,"default":"en"},"description":"Language of order status information (falls back to trackings language and 'en' as last choice)"},{"in":"query","name":"live_refresh","schema":{"type":"boolean"},"description":"Perform an inline (live) refresh to the carrier API if applicable."},{"in":"query","name":"order_number","schema":{"type":"string","minLength":1},"description":"Order number to lookup (if lookup by order number)"},{"in":"query","name":"recipient_email","schema":{"type":"string","format":"email","minLength":1},"description":"Recipient email of order (if no API token is provided, determines level of information access in accordance with your account setup)"},{"in":"query","name":"recipient_postal_code","schema":{"type":"string","minLength":1},"description":"Recipient postal code of order (if no API token is provided, determines level of information access in accordance with your account setup)"},{"in":"query","name":"s","schema":{"type":"string","minLength":1},"description":"Security hash of tracking (if no API token is provided, determines level of information access in accordance with your account setup)"},{"in":"query","name":"show_returns","schema":{"type":"boolean"},"description":"Include return shipments associated with the order."},{"in":"query","name":"single_tracking","schema":{"type":"boolean","default":false},"description":"Only return tracking data that matches the provided tracking number and courier"},{"in":"query","name":"tracking_id","schema":{"type":"string","minLength":1},"description":"ID of tracking (if lookup by tracking ID)"},{"in":"query","name":"tracking_number","schema":{"type":"string","minLength":1},"description":"Tracking number of order (if lookup by courier/tracking number)"}],"tags":["Order"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderInfo"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400Response"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404"}}},"description":""}}}}}}
```

## Get Order Status Widget

You can retrieve the order status page widget as an image for displaying order status information using the `v4/track/orders/info-widget` endpoint.

## Order Status Widget

> Retrieves order status widget as image

```json
{"openapi":"3.1.0","info":{"title":"parcelLab API","version":"v4"},"security":[{"OAuth2 Authentication":[]},{"HeaderToken":[]},{}],"components":{"securitySchemes":{"OAuth2 Authentication":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"HeaderToken":{"type":"http","scheme":"bearer","bearerFormat":"Parcellab-API-Token base64(account_id:token)","description":"Send `Authorization: Parcellab-API-Token <encoded-token>`.\n\n`<encoded-token>` = `base64(account_id:token)` as provided in the portal."}},"schemas":{"Error400Response":{"type":"object","properties":{"type":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/GenericErrorItem"}}},"required":["errors","type"]},"GenericErrorItem":{"type":"object","properties":{"code":{"type":"string"},"detail":{"type":"string"},"attr":{"type":["string","null"]}},"required":["code","detail"]},"Error404":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/ErrorCode404Enum"},"detail":{"type":"string"},"attr":{"type":["string","null"]}},"required":["attr","code","detail"]},"ErrorCode404Enum":{"enum":["not_found"],"type":"string","description":"* `not_found` - Not Found"}}},"paths":{"/v4/track/orders/info-widget/":{"get":{"operationId":"track_orders_info_widget_retrieve","description":"Retrieves order status widget as image","summary":"Order Status Widget","parameters":[{"in":"query","name":"account","schema":{"type":"integer"},"description":"Account of order (if lookup by order number)"},{"in":"query","name":"client_key","schema":{"type":"string","minLength":1},"description":"Client key of order (if lookup by client key)"},{"in":"query","name":"courier","schema":{"type":"string","minLength":1},"description":"Courier of order (if lookup by courier/tracking number)"},{"in":"query","name":"customer_number","schema":{"type":"string","minLength":1},"description":"Customer number of order (if lookup by customer number)"},{"in":"query","name":"external_order_id","schema":{"type":"string","format":"uuid"},"description":"External ID of order (if lookup by external ID)"},{"in":"query","name":"external_reference","schema":{"type":"string","minLength":1},"description":"External reference of tracking (if lookup by external reference)"},{"in":"query","name":"lang","schema":{"type":"string","minLength":1,"default":"en"},"description":"Language of order status information (falls back to trackings language and 'en' as last choice)"},{"in":"query","name":"live_refresh","schema":{"type":"boolean"},"description":"Perform an inline (live) refresh to the carrier API if applicable."},{"in":"query","name":"order_number","schema":{"type":"string","minLength":1},"description":"Order number to lookup (if lookup by order number)"},{"in":"query","name":"recipient_email","schema":{"type":"string","format":"email","minLength":1},"description":"Recipient email of order (if no API token is provided, determines level of information access in accordance with your account setup)"},{"in":"query","name":"recipient_postal_code","schema":{"type":"string","minLength":1},"description":"Recipient postal code of order (if no API token is provided, determines level of information access in accordance with your account setup)"},{"in":"query","name":"s","schema":{"type":"string","minLength":1},"description":"Security hash of tracking (if no API token is provided, determines level of information access in accordance with your account setup)"},{"in":"query","name":"show_returns","schema":{"type":"boolean"},"description":"Include return shipments associated with the order."},{"in":"query","name":"single_tracking","schema":{"type":"boolean","default":false},"description":"Only return tracking data that matches the provided tracking number and courier"},{"in":"query","name":"tracking_id","schema":{"type":"string","minLength":1},"description":"ID of tracking (if lookup by tracking ID)"},{"in":"query","name":"tracking_number","schema":{"type":"string","minLength":1},"description":"Tracking number of order (if lookup by courier/tracking number)"}],"tags":["Order"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string","format":"binary"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400Response"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404"}}},"description":""}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.parcellab.com/docs/developers/status-updates/order-status.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.