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

Import Order

Changed on

Create or update orders in Qargo. See the "Transport order creation & status" section for more info.

post/v1/orders/order/upload

Request

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

Request body

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.

operation'CREATE' | 'UPDATE' | 'DELETE' required
order_identifierstring required

Identifier of the order when created from an external source

input_sourcestring nullable

Source of this order input

order_status'QUOTE' | 'TO_PLAN'

Response

Successful Response

upload_idstring uuid required

Unique identifier for the order import

upload_status'TODO' | 'IN_PROGRESS' | 'READY_TO_UPSERT' | 'UPSERT_IN_PROGRESS' | 'COMPLETED' | 'ERROR' | 'SKIPPED' | 'DUPLICATE' required
upload_urlstring required

URL to check the status of the order import, e.g. /v1/orders/order/upload/{upload_id}

order_idstring uuid nullable

Unique identifier for the order, only available when it's an update to an existing order

order_urlstring nullable

URL to check the status of the order, e.g. /v1/orders/order/{order_id}, only available when it's update to an existing order

Changes

  • 325a23dfeda6Revision changes
    • info

      added the new NON_OWNED enum value to the request property ///

    • info

      added the new SHUNT enum value to the request property ///

  • eab927a3fb47Revision changes
    • info

      added the new optional request property