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

List Order Documents

Changed on

Fetch documents for an order. This includes consignment documents

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

Request

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

Path parameters

order_idstring uuid required

Response

Successful Response

idstring uuid required

Unique identifier of the document

namestring required

Name of the document

typestring required

Type of the document

download_urlstring

Relative URL from the base URL to download the document

subject_typestring required

Linked subject of the document

content_typestring nullable

Content type of the document

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