List Sales Order Documents

SecurityAPIKeyHeader

Request

path Parameters

order_id

required

string (Order Id)

query Parameters

page	integer (Page) >= 1 Default: 1
limit	integer (Limit) [ 1 .. 200 ] Default: 50

Responses

200

Successful Response

Response Schema: application/json

required	Array of objects (Data)
count required	integer (Count) Number of the items within the 'data' array.
total_count	integer (Total Count) Number of items in the entire result set. Value is always >= count. Inclusion depends on the underlying result set.
required	object (PaginationLinks)

400

Validation Error

get/sales-orders/{order_id}/documents

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"data": [{"id": "string",
"filename": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"description": "string",
"type": "OTHER",
"created_by_user_id": "string",
"url": "string"
}
],
"count": 0,
"total_count": 0,
"links": {"next": "http://example.com",
"prev": "http://example.com",
"first": "http://example.com",
"last": "http://example.com"
}
}