Inventory Query

POST

/v1/inventory/getInventory

Request

Header Params

x-api-key

string

required

Example:

abc123(认证信息)

Content-Type

string

required

Example:

application/json

Body Params application/json

skus

array[string]

required

SKU

Example

{
    "skus": [
        "string"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/v1/inventory/getInventory' \
--header 'x-api-key: abc123(认证信息)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "skus": [
        "string"
    ]
}'

Responses

🟢200成功

application/json

Body

code

string

required

Return Code 200 is successful

message

string

required

Return message

data

array [object {9}]

required

Return data

warehouseCode

string

optional

Warehouse Code

lineName

string

optional

Program Name

sku

string

optional

Product SKU

inventoryType

integer

optional

Inventory Type: 0 Saleable 1 Unsaleable

inventoryAvailable

integer

optional

Available Inventory

inventoryReserved

integer

optional

Reserved Inventory

inventoryTransport

string

optional

In-transit Inventory

inventoryCurrent

string

optional

Current Total Inventory

updatedAt

string

optional

Latest Update Time

Example

{
  "statusCode": 200,
  "status": 0,
  "code": 200,
  "message": "查询成功",
  "data": [
    {
      "warehouseCode": "HF_CA_US",
      "lineName": "Klineo",
      "sku": "K150002Y",
      "inventoryType": 0,
      "inventoryAvailable": 0,
      "inventoryReserved": 0,
      "inventoryTransport": 0,
      "inventoryCurrent": 0,
      "updatedAt": "2017-03-24 02:19:56"
    },
    {
      "warehouseCode": "accessory2go",
      "lineName": "Klineo",
      "sku": "K150002Y",
      "inventoryType": 1,
      "inventoryAvailable": 0,
      "inventoryReserved": 0,
      "inventoryTransport": 0,
      "inventoryCurrent": 0,
      "updatedAt": "2017-09-05 08:07:54"
    },
    {
      "warehouseCode": "accessory2go",
      "lineName": "Klineo",
      "sku": "K150002Y",
      "inventoryType": 0,
      "inventoryAvailable": 0,
      "inventoryReserved": 0,
      "inventoryTransport": 0,
      "inventoryCurrent": 0,
      "updatedAt": "2019-10-31 09:16:37"
    }
  ]
}

Modified at 2023-12-07 22:21:58

Batch Inventory Query

Batch Query of Inventory Age