GetStockMovement - Open-API

This endpoint allows you to retrieve inventory movement records for specified SKUs across various regional warehouses.
Key Features:

Timeframe Limitation: This endpoint supports querying inventory movement data for the past year only.

Date Range Restriction: Each query is limited to a date range of 7 days.
For a complete list of regional warehouses, we recommend using the getServiceList API.

该接口支持获取指定 SKU 在各个区域仓内的库存流水变动记录。
主要功能：

时间限制：此接口仅支持查询过去一年的库存流水数据。

日期范围限制：每次查询的起止时间范围限制在 7 天内。
有关区域仓的完整列表，建议您使用 getServiceList API。

Request

Header Params

clientKey

string

required

clientKey

Example:

bd1d1971-d0db-11ea-b4a1-00505694c27b

vAuthorization

string

required

vAuthorization

Access-Token

string

required

Access-Token

Example:

Body Params application/json

apiVersion

string

optional

data

object (stock movement request info)

optional

endTime

string

optional

OCH return stock movement that happened before this endTime.
If null, OCH take the API call time as end time.
Format: date + time zone, UTC ISO8601，ex：2018by-11-28T20:09:57+0800
Duration between endTime and startTime should be less than 7days

mfSkuList

array[object (stockReq) {1}]

optional

3PP is allowed querying inventory movements by a SKU list or by a time slot., GUID of SKU on OCH platform which is generated by OCH and responded to 3PP when register SKU.

startTime

string

optional

OCH return stock movement that happened since this startTime.
Format: date + time zone, UTC ISO8601，ex：2018-11-28T20:09:57+0800
startTime can not be one years ago.

messageId

string

optional

timestamp

integer <int64>

optional

Example

{
    "apiVersion": "string",
    "data": {
        "endTime": "2024-07-20T10:10:10+0800",
        "mfSkuList": [
            {
                "mfSkuId": "OC0000012220012"
            }
        ],
        "startTime": "2024-07-13T10:10:10+0800"
    },
    "messageId": "string",
    "timestamp": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

data

array[object (stockRes) {5}]

optional

mfSkuId

string

required

GUID of SKU on the OCH platform, which is generated by OCH and responded to 3PP when registering SKU.

remarks

string

optional

remarks

sellerSkuId

string

optional

sellerSkuId

serviceRegionList

array[object (ExternalServiceRegionDTO) {2}]

optional

Every single SKU could have stock in different serviceRegion.

snapshotTime

string

optional

SnapshotTime format: date + time zone, UTC ISO8601 ，ex：2018-11-28T20:09:57:001+0800

errors

array[object (CommonVendorResponseErrorMsgDto) {3}]

optional

code

string

optional

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

Examples

ExceptionSuccess

{
    "code": 3,
    "errors": [
        {
            "code": "400007",
            "message": "startTime 字段格式必须为：yyyy-MM-dd'T'HH:mm:ssZ！"
        }
    ],
    "message": "参数错误",
    "messageId": "string"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found