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

Get Order Import Status

Changed on

Get the status of an order import

get/v1/orders/order/upload/{upload_id}

Request

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

Path parameters

upload_idstring uuid required

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

  • 6abdfcd1a541Revision changes
    • info

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

    • info

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