OrdersPurchase orders
Get Many Purchase Orders
Get multiple purchase orders with filtering, searching, and pagination
Authorization
api_key x-access-token<token>
In: header
Query Parameters
page?number
Page number for pagination
Format
doubleDefault
0limit?number
Number of items per page
Format
doubleDefault
20search?string
Search term to filter purchase orders by name
Default
""order_by?string
Field to order results by
Default
"created_at"Value in
- "expected_at"
- "updated_at"
- "created_at"
order?string
Sort order - "asc" or "desc"
Value in
- "asc"
- "desc"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/purchase-orders"{ "data": [ { "purchase_order_number": "string", "receiving_started_at": "2019-08-24T14:15:22Z", "shipped_at": "2019-08-24T14:15:22Z", "expected_at": "2019-08-24T14:15:22Z", "shipping": 0.1, "discount": 0.1, "name": "string", "tracking_number": "string", "inventory_status": "UNRECEIVED", "order_status": "PENDING", "warehouse_note": "string", "warehouse_name": "string", "warehouse_id": "string", "vendor_name": "string", "vendor_id": "string", "merchant_team_name": "string", "merchant_team_id": "string", "fulfiller_team_name": "string", "fulfiller_team_id": "string", "currency": "string", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "id": "string" } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}