List purchase orders
Lists the purchase orders of the team.
Request
- Base URL: https://app.sellerassistant.app (the document declares no server; this is the origin it was published from)
- URL: https://app.sellerassistant.app/api/v1/sa/inventory/purchase-orders
- Auth: one of:
- API key in query parameter api_key
- API key in header X-Api-Key
Query parameters
Keeps the orders of one status: draft, sent, completed or cancelled.
Keeps the orders of one supplier.
Keeps the orders the team created over the last days.
include=items adds the items of every order of the page, and it reads them only when you ask. It adds the first 100 items of every order, by id. The count of the items is always there as items_count, and /purchase-orders/{id}/items serves them all as a page of its own.
A term the list looks for. Each list names the columns it reads.
The column to order by: created_at, order_date, po_id, status, total_price, items_count, supplier_name, profit_roi. A minus sign in front of the name orders from the highest down. Without a sort the order is -created_at. Another name answers 400.
The page to read. It starts at 1.
The rows a page carries. The maximum is 200.
Response
One page of the purchase orders
Example response
{
"data": [
{
"id": 42,
"po_id": "PO-2026-018",
"status": "draft",
"supplier_id": 5,
"marketplace_id": "ATVPDKIKX0DER",
"prep_center_id": 3,
"order_date": "2026-09-14",
"currency": "USD",
"items_count": 12,
"subtotal": 1240,
"total_price": 1380.5,
"supplier": {
"id": 5,
"name": "Acme Wholesale",
"currency": "USD"
},
"items": [
{
"id": 4471,
"purchase_order_id": 42,
"internal_product_id": "P-5XK1S0NQNO",
"asin": "B0019MQM64",
"unit_cost": 9.5,
"unit_count": 12,
"total_cost": 114
}
]
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total": 137,
"last_page": 6
},
"trial_limit": {
"max_rows": 25,
"total": 137,
"code": "trial_list_limited",
"message": "The trial shows only the first rows of a list. Subscribe to see all rows.",
"subscribe_url": "https://app.sellerassistant.app/subscription"
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.