Sign in
API / Order
Use case / Order
Use case / Customer portal

Order Status

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

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

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.

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

Changed in 1 of the 3 revisions of this API.46

  • 3b65f5aa84a646See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added