SP-API FBA Inventory

Get inventory summaries

Proxy to https://developer-docs.amazon.com/sp-api/reference/getinventorysummaries. Amazon seller account integration is required to make this request. You can do it here.

get/api/v1/sp-api/fba/inventory/v1/summaries

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/sp-api/fba/inventory/v1/summaries
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-Api-Key

Query parameters

The granularity type for the inventory aggregation level. Allowed values: Marketplace.

The granularity ID for the inventory aggregation level. When granularityType is Marketplace, specify the marketplaceId. Defaults to the marketplaceId if not provided.

true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).

A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API.

A comma-delimited list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.

A single seller SKU used for querying the specified seller SKU inventory summaries.

String token returned in the response of your previous request. The string token will expire 30 seconds after being created.

Amazon marketplace domain. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.

Amazon marketplace id. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. See all options here.

Response

Successful response

Example response

{
  "payload": {
    "granularity": {
      "granularityType": "Marketplace",
      "granularityId": "ATVPDKIKX0DER"
    },
    "inventorySummaries": [
      {
        "asin": "B00U26V4VQ",
        "fnSku": "X0000000XX",
        "sellerSku": "SKU-12345",
        "condition": "New Item",
        "inventoryDetails": {
          "fulfillableQuantity": 100,
          "inboundWorkingQuantity": 25,
          "inboundShippedQuantity": 15,
          "inboundReceivingQuantity": 10,
          "reservedQuantity": {
            "totalReservedQuantity": 20,
            "pendingCustomerOrderQuantity": 15,
            "pendingTransshipmentQuantity": 3,
            "fcProcessingQuantity": 2
          },
          "researchingQuantity": {
            "totalResearchingQuantity": 5,
            "researchingQuantityBreakdown": [
              {
                "name": "researching_quantity_short_term",
                "quantity": 3
              }
            ]
          },
          "unfulfillableQuantity": {
            "totalUnfulfillableQuantity": 8,
            "customerDamagedQuantity": 2,
            "warehouseDamagedQuantity": 3,
            "distributorDamagedQuantity": 1,
            "carrierDamagedQuantity": 1,
            "defectiveQuantity": 1
          }
        },
        "lastUpdatedTime": "2023-01-15T12:30:45Z",
        "productName": "Samsung QLED TV 82-inch",
        "totalQuantity": 150
      }
    ]
  },
  "pagination": {
    "nextToken": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234",
    "previousToken": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d"
  }
}

Changes