Skip to content


Use this API to get inventory detail,You can enter a filter to get the specified inventory data.This is a paging interface that returns 1000 pieces of data from the first page by default

POST /openapi/fulfillment/inventory/v1/page

Request Body

Parameter Type Required Length Description
warehouseCode string true 20 The warehouse code from Ginee WMS
itemSkuList string[] false 20 List of item Sku
page int false 20 Current page number: positive number, starting from 1, default is 1
size int false 20 Default is 1000

Response Body

Name Type Description
code string SUCCESS | ERROR
message string The status code detailed explanation.
data object Please refer to Response Data for details
extra string An exception message (should be empty most of the time).
transactionId string An unique string identifier for each request.
pricingStrategy string Shows you whether this api call will be charged by Ginee, currently all APIs are FREE even though this tag is PAY.

Response Data

Name Type Description
content object[] List of successes See Inventory
total int Total number of eligible records
size int Page size
page int Current page


Name Type Description
itemSku string Identifiers of Item SKU (Case-sensitive)
itemName string Item's name
totalStock int Total number of stocks
availableStock int Number of available stock
occupyStock int Number of occupy stock
defectiveStock int Number of defective stock

Request Example


curl -X POST  \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
-d '{
        "itemSkuList": [],
        "warehouseCode": "WH0005",
        "page": 1,
        "size": 1
    }' \
"{Ginee Host}/openapi/fulfillment/inventory/v1/page"


    "code": "SUCCESS",
    "message": "OK",
    "data": {
        "page": 1,
        "size": 1,
        "total": 13,
        "content": [
                "itemSku": "DP11",
                "itemName": "Ralph Beaks the Internet Disney Princess-Elsa",
                "totalStock": 8090.0,
                "availableStock": 8090.0,
                "occupyStock": 0.0,
                "defectiveStock": null
    "extra": null,
    "transactionId": "19d607ea5d78852a"


    "code": "PARAMETER_ERROR",
    "message": "Parameter is invalid: Parameter should not be empty: warehouseCode ",
    "data": null,
    "extra": null