Batch Inventory Query - OPEN-API-English

Request

Header Params

x-api-key

string

required

Example:

abc123(认证信息)

Content-Type

string

required

Example:

application/json

Body Params application/json

warehouseCodes

array[string]

required

Warehouse Code

inventoryType

integer

required

Inventory Type 0: Salable Inventory, 1: Non-salable Inventory

page

integer

required

Page Number, e.g., 1

rows

integer

required

The number of rows per page, for example, 10 (default maximum here is 500)

sidx

string

required

Sorting field, can be hardcode 'ID'

sort

string

required

Sorting rules,"asc" ascending, "desc" descending

Example

{
    "warehouseCodes": [
        "string"
    ],
    "inventoryType": 0,
    "page": 0,
    "rows": 0,
    "sidx": "string",
    "sort": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'http://127.0.0.1/v2/inventory/get_inventory_by_page' \
--header 'x-api-key: abc123(认证信息)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "warehouseCodes": [
        "string"
    ],
    "inventoryType": 0,
    "page": 0,
    "rows": 0,
    "sidx": "string",
    "sort": "string"
}'

Responses

🟢200成功

application/json

Body

code

string

required

Return Code 200 is successful

message

string

required

Return message

statusCode

string

required

status

string

required

data

object

required

pageable

object

required

totalElements

number

required

totalPages

number

required

last

boolean

required

first

boolean

required

sort

object

required

numberOfElements

number

required

size

number

required

number

required

empty

boolean

required

content

array [object {9}]

required

Details return for multiple inventory items

Example

{
    "statusCode": 200,
    "status": 0,
    "code": 200,
    "message": "获取库存数据成功",
    "data": {
        "pageable": {
            "draw": 0,
            "offset": 0,
            "pageNumber": 0,
            "pageSize": 5,
            "paged": true,
            "unpaged": false
        },
        "totalElements": 4,
        "totalPages": 1,
        "last": true,
        "first": true,
        "sort": {
            "sorted": true,
            "unsorted": false,
            "empty": false
        },
        "numberOfElements": 4,
        "size": 5,
        "number": 0,
        "empty": false,
        "content": [
            {
                "warehouse_code": "HF_CA_US",
                "product_line_name": "梦百合厚垫",
                "sku": "MIL-10IN-KING",
                "inventory_type": 0,
                "inventory_available": 0,
                "inventory_reserved": 0,
                "inventory_transport": 0,
                "inventory_current": 0,
                "updated_at": "2020-07-01 00:46:05"
            },
            {
                "warehouse_code": "HF_CA_US",
                "product_line_name": "梦百合厚垫",
                "sku": "MIL-10IN-QUEEN",
                "inventory_type": 0,
                "inventory_available": 0,
                "inventory_reserved": 0,
                "inventory_transport": 0,
                "inventory_current": 0,
                "updated_at": "2020-06-12 08:31:58"
            },
            {
                "warehouse_code": "HF_CA_US",
                "product_line_name": "梦百合厚垫",
                "sku": "MIL-10IN-FULL",
                "inventory_type": 0,
                "inventory_available": 0,
                "inventory_reserved": 0,
                "inventory_transport": 0,
                "inventory_current": 0,
                "updated_at": "2020-07-01 00:46:05"
            },
            {
                "warehouse_code": "HF_CA_US",
                "product_line_name": "梦百合电动床",
                "sku": "MIL-ADJ-BED-Q",
                "inventory_type": 0,
                "inventory_available": 0,
                "inventory_reserved": 0,
                "inventory_transport": 0,
                "inventory_current": 0,
                "updated_at": "2020-07-26 17:28:58"
            }
        ]
    }
}