PAparcellab
Order

Order Status Widget

Changed on

Retrieves order status widget as image

get/v4/track/orders/info-widget/

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

string binary required

Changes