---
title: "List purchase orders"
method: GET
path: "/api/v1/sa/inventory/purchase-orders"
tags: ["Purchase Orders"]
---

# List purchase orders

`GET /api/v1/sa/inventory/purchase-orders`

## 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`

Lists the purchase orders of the team.

## Query parameters

- `filter[status][eq]` string
- `filter[supplier_id][eq]` integer
- `filter[days][eq]` integer
- `include` string
- `search` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

One page of the purchase orders

- object
  - `data` PurchaseOrder[]
    - `id` integer: The id of the purchase order.
    - `po_id` string, nullable: The name a person gave the order.
    - `status` string, nullable
    - `supplier_id` integer
    - `marketplace_id` string, nullable
    - `prep_center_id` integer, nullable: The warehouse the goods go to.
    - `user_id` integer, nullable
    - `order_date` string, date, nullable
    - `currency` string, nullable: The currency of the supplier.
    - `items_count` integer
    - `subtotal` number, float, nullable: The sum of the items. Null means not known, which is not the same as zero.
    - `shipping_cost` number, float, nullable
    - `taxes` number, float, nullable
    - `misc_expenses` number, float, nullable
    - `total_price` number, float, nullable
    - `estimated_revenue` number, float, nullable
    - `estimated_profit` number, float, nullable
    - `supplier` object: The supplier of the order. Every answer of the v1 carries it.
      - `id` integer: The id of the document.
      - `name` string
      - `currency` string, nullable
    - `items` PurchaseOrderItem[]: The items of the order. It is present only with `include=items`, and it carries the first 100 items, by id. `items_count` reports the real number, and `/purchase-orders/{id}/items` serves them all as a page.
      - `id` integer
      - `purchase_order_id` integer
      - `internal_product_id` string, nullable: The inventory product the line points at. It is the same id the matches and the history of a product use.
      - `title` string, nullable
      - `image_url` string, nullable
      - `asin` string, nullable
      - `upc` string, nullable
      - `ean` string, nullable
      - `sku` string, nullable
      - `identifier` string, nullable
      - `unit_cost` number, float, nullable: Null means not known, which is not the same as zero.
      - `unit_count` integer
      - `total_cost` number, float, nullable
      - `selling_price` number, float, nullable
      - `profit_fba` number, float, nullable
      - `profit_marketplace_id` string, nullable
      - `profit_calculated_at` string, date-time, nullable
      - `created_at` string, date-time, nullable
      - `updated_at` string, date-time, nullable
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
  - `meta` object
    - `pagination` ApiV1Pagination: The page the answer carries. Every list of the v1 answers it under `meta`.
      - `page` integer: The schemas every endpoint of the public API v1 shares. The envelope is the same on every endpoint, so it lives here once. An endpoint points at it with a `$ref`, and the generated collection stays small and consistent. The parameters live in ApiV1Parameters, not here. swagger-php drops the class level `OA\Schema` attributes of a class that also carries a class level `OA\Parameter`, so the two kinds need two classes. This class holds no code. swagger-php reads the attributes, and nothing calls it.
      - `per_page` integer
      - `total` integer
      - `last_page` integer
    - `trial_limit` ApiV1TrialLimit: Present only on trial, when the trial hides rows of the list. The trial shows the first rows of a list, and the pagination counts only these rows.
      - `max_rows` integer: The number of rows that the trial shows.
      - `total` integer, nullable: The true number of rows in the list. It is null for a list that does not count its rows.
      - `code` string
      - `message` string
      - `subscribe_url` string, uri

## Other responses

- `400`: Bad request - validation failed or invalid parameters
- `403`: Access denied - insufficient permissions, invalid API key, or the API request limit is used up (`public_api_key_limit`)
- `429`: Too many requests - rate limit exceeded

---

[API](https://skmtc.dev/sellerassistant/apis/seller-assistant-public-api.md) · [All operations](https://skmtc.dev/sellerassistant/apis/seller-assistant-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sellerassistant/apis/seller-assistant-public-api/revisions/5b3ecdbcadb6?raw)