Listings

List listings

These are the listings of SA Inventory. The SP-API proxy of Amazon stays at /api/v1/listings/items.

get/api/v1/sa/inventory/listings

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/listings
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-Api-Key

Query parameters

filter[status][eq]string
Example:draft

Keeps the listings of one status: draft, pending, active, error or inactive.

filter[channel][eq]'amazon' | 'walmart' | 'shopify' | 'ebay'

Keeps the listings of one sales channel.

filter[batch_id][eq]string

Keeps the listings that one create call made.

filter[marketplace_id][eq]string
Example:ATVPDKIKX0DER

The marketplace of the channel, as the answer writes it.

searchstring

A term the list looks for. Each list names the columns it reads.

sortstring
Example:-created_at

The column to order by: created_at, listed_at, price, sku, status. 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.

pageinteger
Example:1

The page to read. It starts at 1.

per_pageinteger
Example:25

The rows a page carries. The maximum is 200.

Response

One page of the listings

Example response

{
  "data": [
    {
      "id": 91,
      "team_id": 123,
      "sku_id": 812,
      "channel": "amazon",
      "marketplace_id": "ATVPDKIKX0DER",
      "sku": "WS-2026-B0019MQM64",
      "identifier": "B0019MQM64",
      "price": 24.99,
      "currency": "USD",
      "condition": "new",
      "fulfillment_type": "fba",
      "status": "draft",
      "sku_record": {
        "id": 2395,
        "sku": "SA-5XLB-G2YZ",
        "asin": "B0012RR7SS",
        "fnsku": "X0055JLULF",
        "internal_product_id": "P-XE83ALLW04",
        "internal_product": {
          "id": "P-XE83ALLW04"
        }
      }
    }
  ],
  "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.