List Purchase 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/purchase-orders/{order_id}/documents
Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "count": 0,
  • "total_count": 0,
  • "links": {}
}
Copyright © Shipwell 2024. All right reserved.