API / Order
Use case / Order
Use case / Customer portal

Order Status

Changed on

Order status endpoint. Provides information on the status of the order

get/v1/orders/order/{order_id}/status

Request

  • Base URL: https://api.qargo.com
  • URL: https://api.qargo.com/v1/orders/order/{order_id}/status
  • Auth: OAuth 2 (client credentials, token URL /v1/auth/token)

Path parameters

order_idstring uuid required

Response

Successful Response

customer_reference_numberstring nullable
planning_instructionsstring nullable

Additional freeform instructions for the planner.

neutral_order_type'NO_NEUTRAL_ORDER' | 'MASK_DELIVERY' | 'MASK_PICKUP' nullable

Neutral order

custom_fieldsobject nullable

User defined additional fields for this order.

contact_emailsstring[] nullable

List of contact emails to notify about the order

is_consignment_info_validatedboolean nullable

Flag indicating all consignment information is validated. Customers can only set this to true; only planners (or API/internal callers) can revert it.

recurring_route_namestring nullable

Name of the recurring route, used to match the order to an order template.

order_identifierstring nullable

Identifier of the order when created from an external source

idstring uuid required

Unique identifier for order

created_by_userstring nullable

User who created the order

created_timestampstring date-time nullable

Timestamp of creation

quote_namestring nullable

Name of the quote

statusstring nullable

Status of the order

Changes

  • 325a23dfeda6Revision changes
    • warning

      added the new NON_OWNED enum value to the /// response property for the response status

    • warning

      added the new NON_OWNED enum value to the ///////// response property for the response status

    • warning

      added the new SHUNT enum value to the /// response property for the response status

    • warning

      added the new SHUNT enum value to the ///////// response property for the response status

  • eab927a3fb47Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property ////// to the response with the status