Skip to main content

POST Inventory Search

Inventory Search Shop Required scope: seller.product.basic Retrieve inventory information for multiple products or SKUs. Note:

  • Searches can be based on either product IDs or SKU IDs, not both at the same time.
  • 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. Version 202309

POST/product/202309/inventory/search

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop

Body

PropertiesTypeDescription
product_ids[]stringA list of product IDs used to search for inventory information.Max IDs: 100
sku_ids[]stringA list of SKU IDs used to search for inventory information.Max IDs: 600Note: If both sku_ids and product_ids are passed, sku_ids will take precedence.

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

Error Code

View common error codes

| Code | Message | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 12019008 | Product id is invalid | | 12019015 | The number of SKU exceed the limit | | 12019022 | SKU must contain a valid warehouse. | | 12019112 | seller id is invalid | | 12019114 | Seller has no permission | | 12019120 | The number of provided product IDs exceeds the limit. |

Is this content helpful?Helpful

Not Helpful

PreviousNext