Kakaclo Api Docs
  • Welcome!
  • Quick Start
  • Release Notes
    • 2023-08 Add API token refresh function, logistics channel to add Express
    • 2023-07 product api increase supplierLevel info
    • 2023-06 Order Automatic Split interface changes
    • 2023-04 Product CountryAndWarehouse interface changes
    • 2023-04 Order V1 Version And Order V2 Version
    • 2022-12 Order V2 Version
  • API Usage
    • API Endpoint
    • Rate Limits
  • Admin API
    • Product
      • Category
      • Products
      • CountryAndWarehouse
      • Stock
      • Product API pull suggestion
    • Order V1(Outdated)
      • Logistics Channel
      • Order
      • Query Order
        • Orders Status Json Response
      • Refund Order
      • Query ReFund
    • Order V2
      • Logistics Channel
      • Order
      • Query Order
        • Orders Status Json Response
      • Refund Order
      • Query ReFund
      • Automatic Split Logistics Channel
    • Custom Product
      • Get Design Category Name List
      • Get Design Model List
      • Get Design Model Detail
      • Get Custom Designed List
      • Get Custom Designed Detail
      • Create designed product orders and get order list
      • Get KakaClo pod-designer address
      • Save POD Designed Product
    • Payment
      • Query Balance
Powered by GitBook
On this page
  • Request parameter
  • Response parameter
  • Query stock
  • get product stock
  1. Admin API
  2. Product

Stock

PreviousCountryAndWarehouseNextProduct API pull suggestion

Last updated 2 years ago

This interface is to query sku inventory. The same sku may belong to different repositories.

Request parameter

Parameter name
Type
Remark

skus

String

Commodity SKU code collections, specify the commodity SKU code query, each time a maximum of 30, Three options are required. for example: FSZW03961_Y_S_NUB,FSZW03961_Y_XL_NUB

warehouseCode

String

warehouse code. for example: G007

dateStartTime

String

Inventory update start time, one of the three is required. for example: 2022-03-25T04:00:30Z

dateEndTime

String

Inventory update end time, one of the three is required. for example: 2022-03-26T04:00:30Z

pageNumber

Number

Page number, when querying according to the update time, PageNumber is required and greater than 0. for example: 1

When querying according to skus, sku is required, and other parameters are optional, for example:

When querying based on the update time, either dateStartTime and dateEndTime are required, pageNumber is required, and other parameters are optional, for example:

Response parameter

Parameter name
Type
Remark

sku

String

product unique code, for example: FSZW03961_Y_S_NUB

qty

Number

Inventory quantity, for example: 20

countryCode

String

Country code of the country where the warehouse is located, for example: CN_S

warehouseCode

String

warehouse code, for example: G007

total

Number

The total number of query results(The total number of list data for paging query), for example: 1000

pageNumber

Number

page number, for example: 1

pageSize

Number

Quantity per page, for example: 30

The countryCode and warehouseCode fields are reserved fields, and developers do not need to pay attention to the use of these two fields.

Response Example

{
    "code": 10000,
    "data": {
        "total": 1,
        "pageNumber": 1,
        "pageSize": 30,
        "list": [
            {
                "warehouseStockList": [
                    {
                        "countryCode": "CN_N",
                        "qty": 45,
                        "warehouseCode": "G006"
                    },
                    {
                        "countryCode": "CN_S",
                        "qty": 20,
                        "warehouseCode": "G007"
                    }
                ],
                "sku": "FSZW03961_Y_XL_NUB"
            }
        ]
    },
    "message": "Success!"
}

Query stock

get product stock

GET /openapi/v1/product/stocks

Query Parameters

Name
Type
Description

skus*

String

Commodity SKU code collections, specify the commodity SKU code query, each time a maximum of 30, Three options are required. for example:

FSZW03961_Y_S_NUB,FSZW03961_Y_XL_NUB

warehouseCode

String

warehouse code. for example: G007

dateStartTime*

String

Inventory update start time, one of the three is required. for example: 2022-03-25T04:00:30Z

dateEndTime*

String

Inventory update end time, one of the three is required. for example: 2022-03-26T04:00:30Z

pageNumber

Number

Page number, when querying according to the update time, PageNumber is required and greater than 0. for example: 1

{
    "code": 10000,
    "data": {
        "total": 2,
        "pageNumber": 1,
        "pageSize": 30,
        "list": [
            {
                "warehouseStockList": [
                    {
                        "countryCode": "CN_N",
                        "qty": 45,
                        "warehouseCode": "G006"
                    },
                    {
                        "countryCode": "CN_S",
                        "qty": 20,
                        "warehouseCode": "G007"
                    }
                ],
                "sku": "FSZW03961_Y_S_NUB"
            },
            {
                "warehouseStockList": [
                    {
                        "countryCode": "CN_N",
                        "qty": 45,
                        "warehouseCode": "G006"
                    },
                    {
                        "countryCode": "CN_S",
                        "qty": 20,
                        "warehouseCode": "G007"
                    }
                ],
                "sku": "FSZW03961_Y_XL_NUB"
            }
        ]
    },
    "message": "Success!"
}
{
    // Response
}
https://developer.kakaclo.com/openapi/v1/product/stocks?skus=FSZW03961_Y_S_NUB
https://developer.kakaclo.com/openapi/v1/product/stocks?dateStartTime=2022-08-01T00:00:00Z&pageNumber=1&dateEndTime=2022-08-02T00:00:00Z