Inventory Search

POST

/product/202309/inventory/search

Retrieve inventory information for multiple products or SKUs. Note:

• If both sku_ids and product_ids are passed, sku_ids takes precedence and product_ids is ignored.
• Passing product IDs returns the inventory information of all SKUs under the specified products.
• Passing SKU IDs returns the inventory information for the specified SKUs.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body

Media typeapplication/json

object

product_ids

A list of product IDs used to search for inventory information. Max IDs: 100

Array<string>

sku_ids

A list of SKU IDs used to search for inventory information. Max IDs: 600

Note: If both sku_ids and product_ids are passed, sku_ids will take precedence.

Array<string>

Example

{
  "product_ids": [
    "1729592969712207008"
  ],
  "sku_ids": [
    "1729388324987897824"
  ]
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

inventory

Inventory information for the requested products or SKUs.

Array<object>

object

product_id

The ID of the requested product.

string

skus

The list of requested SKUs.

Array<object>

object

id

The SKU ID generated by TikTok Shop.

string

seller_sku

An internal code/name for managing SKUs, not visible to buyers.

string

total_available_quantity

The total number of units available for ordering across all warehouses. It is the sum of the warehouse_inventory.available_quantity values in all warehouses.

integer format: int64

total_committed_quantity

The total number of units reserved by existing customer orders across all warehouses (and therefore not available for ordering). It is the sum of the warehouse_inventory.committed_quantity values in all warehouses.

integer format: int64

warehouse_inventory

SKU warehouse inventory information.

Array<object>

object

warehouse_id

The ID of the warehouse where the SKU is stored. Retrieve details of the warehouse from the Get Warehouse List API.

string

available_quantity

The total number of units available for ordering in this warehouse. This is equivalent to the inventory.quantity value returned in the Get Product API.

integer format: int64

committed_quantity

The total number of units reserved by existing customer orders in this warehouse (and therefore not available for ordering).

integer format: int64

total_available_inventory_distribution

The distribution of the total available inventory for the SKU across different channels.

object

campaign_inventory

Inventory that is allocated to a specific campaign.

Array<object>

object

quantity

The number of units allocated.

integer format: int64

campaign_name

The name of the associated campaign.

string

creator_inventory

Inventory that is allocated to TikTok creators.

Array<object>

object

quantity

The number of units allocated.

integer format: int64

creator_name

The name of the associated TikTok creator.

string

in_shop_inventory

The remaining inventory available for the shop after deducting those allocated for campaigns and creators.

object

quantity

The number of units allocated.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "inventory": [
      {
        "product_id": "1729592969712207008",
        "skus": [
          {
            "id": "1729388324987897824",
            "seller_sku": "Color-Red-XM01",
            "total_available_quantity": 100,
            "total_committed_quantity": 10,
            "warehouse_inventory": [
              {
                "warehouse_id": "7054915283043174149",
                "available_quantity": 100,
                "committed_quantity": 10
              }
            ],
            "total_available_inventory_distribution": {
              "campaign_inventory": [
                {
                  "quantity": 30,
                  "campaign_name": "Big Sale"
                }
              ],
              "creator_inventory": [
                {
                  "quantity": 20,
                  "creator_name": "py001"
                }
              ],
              "in_shop_inventory": {
                "quantity": 50
              }
            }
          }
        ]
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}