StockSnapshot v2 - Open-API

This endpoint allows you to retrieve the inventory quantities for specified SKUs across different regional warehouses, categorized by their various statuses.
Enhancements from v1:
Supports pagination, enabling you to return the complete set of SKUs.
Parameters:
SKUList: At least one SKU must be provided in this parameter.
Response:
The response includes inventory data for the following regional warehouses:

AU (Sydney warehouse)

AU-MEL (Melbourne warehouse)

US-East

UE-South

US-West
For a complete list of available services, we recommend using the getServiceList API.

该 Snapshot v2接口支持获取各个SKU在各个区域仓内的、不同状态的库存数量。
接口对比 v1，支持分页查询，可以返回全量的 SKU 。
入参中， SKUList 中至少有一个入参必填。
返回的区域仓包括：UK,DE,AU(澳洲的悉尼仓),AU-MEL(澳洲的墨尔本仓),US-East,UE-South,US-West 等，建议您通过"getServiceList" API获取最新数据

Request

Header Params

clientKey

string

required

clientKey

vAuthorization

string

required

vAuthorization

Access-Token

string

required

Access-Token

Body Params application/json

apiVersion

string

optional

data

object

optional

pageNumber

integer <int32>

optional

The page number of request

pageSize

integer <int32>

optional

The max number of the each page can't exceed 200

serviceRegionList

array [object {1}]

optional

skuList

array [object {1}]

optional

messageId

string

optional

timestamp

integer <int64>

optional

Example

{
  "data": {
    "pageNumber": 1,
    "pageSize": 200,
    "skuList": [],
    "serviceRegionList": [
      {
        "serviceRegion": "DE"
      }
    ]
  },
  "messageId": "1d217396-2565-4c87-a009-19c96dbb616f",
  "timestamp": "1701315629000"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

data

object (stock v2Res)

optional

hasNextPage

boolean

optional

whether have the next page

Example:

false

pageNumber

integer <int32>

optional

The page number of request

pageSize

integer <int32>

optional

The amount of data on the current page

skuList

array[object (sku inventory) {10}]

optional

If this field is null, OC returns all the SKUs' inventory snapshot of the request time.

totalPage

integer <int32>

optional

The total number of pages according to the request result

errors

array[object (CommonVendorResponseErrorMsgDto) {3}]

optional

code

string

optional

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

Example

{
  "code": 0,
  "data": {
    "SKUList": [
      {
        "MFSKUID": "OCxxx",
        "inTransit": 0,
        "received": 0,
        "available": 10,
        "reservedAllocated": 0,
        "reservedHold": 0,
        "reservedVAS": 0,
        "serviceRegion": "DE",
        "suspend": 0,
        "unfulfillable": 0
      },
      {
        "MFSKUID": "OCxxx",
        "inTransit": 0,
        "received": 0,
        "available": 0,
        "reservedAllocated": 0,
        "reservedHold": 10,
        "reservedVAS": 0,
        "serviceRegion": "DE",
        "suspend": 0,
        "unfulfillable": 0
      },
      {
        "MFSKUID": "OCxxx",
        "inTransit": 0,
        "received": 0,
        "available": 0,
        "reservedAllocated": 10,
        "reservedHold": 0,
        "reservedVAS": 0,
        "serviceRegion": "DE",
        "suspend": 0,
        "unfulfillable": 0
      }
    ],
    "hasNextPage": true,
    "pageNumber": 1,
    "pageSize": 200,
    "totalPage": 9
  },
  "message": "成功",
  "messageId": "1d217396-2565-4c87-a009-19c96dbb616f"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found