ListWarehouseInventory

Use this api to search warehouse sku information.

POST /openapi/warehouse-inventory/v1/sku/list

Request Parameters

Parameter	Type	Required	Description
size	integer	false	Page size, default is 50, max page entries should be less than 50
page	integer	false	Page number, default 0
masterSkuList	array(string)	false	Array of master sku
warehouseId	string	true	Warehouse id
stockStatus	stockStatus	false	Stock status, please refer to StockStatus for details
idList	array(string)	false	Array of Warehouse inventory id
masterVariationIdList	array(string)	false	Array of master variation id
name	string	false	Product name，fuzzy matching

StockStatus

Parameter	Type	Description
STATUS_SHORTAGE	string	Shortage
STATUS_ALERT	string	Alter
STATUS_MINUS	string	Minus
STATUS_NON_INBOUND	string	Not inbound

Response Parameters

Name	Type	Description
warehouseInventory	WarehouseInventoryVO	Warehouse inventory info, please refer to WarehouseInventoryVO for details
pushStatus	string	Push status
channelVariationCount	int	Channel variation count
masterVariation	MasterVariationVO	Master variation object, please refer to MasterVariationVO for details
shelfInventoryList	array(ShelfInventoryVO)	Array of object, please refer to ShelfInventoryVO for details
warehouse	WarehouseVO	Warehouse info, please refer to WarehouseVO for details

WarehouseInventoryVO

Name	Type	Description
id	string	Warehouse inventory id
userId	string	User id
masterVariationId	string	Master variation id
warehouseId	string	Warehouse id
transportStock	Long	Transport stock
warehouseStock	Long	Warehouse stock
spareStock	Long	Spare stock
promotionStock	Long	Promotion stock
lockedStock	Long	Locked stock
availableStock	Long	Available stock
safetyStock	Long	Safety stock
safetyAlert	Boolean	Safety alert
pricingMethod	string	Pricing method
averagePurchasePrice	BigDecimal	Average purchase price
currencyCode	string	Currency code
type	string	Type of warehouse inventory
pushStatus	string	Push status
failReason	string	Fail reason
enableStatus	string	Enable status
createDatetime	datetime	Create date and time
updateDatetime	datetime	Update date and time

MasterVariationVO

Name	Type	Description
id	string	Master variation id
masterProductId	string	Master product id
masterSku	string	Master sku
name	string	Name of master product
variationName	string	Name of master variation
image	string	Image
tagList	array(Tag)	Array of Tag, please refer to Tag for details

Tag

Name	Type	Description
id	Long	Tag id
name	string	Tag name

ShelfInventoryVO

Name	Type	Description
id	string	Shelf inventory id
userId	string	User id
warehouseInventoryId	string	Warehouse inventory id
transportStock	Long	Transport stock
warehouseStock	Long	Warehouse stock
spareStock	Long	Spare stock
lockedStock	Long	Locked stock
availableStock	Long	Available stock
purchasePrice	BigDecimal	Purchase price
type	string	Shelf Inventory Type,Please refer to Shelf Inventory Type for details
warehouseShelfId	string	Warehouse shelf id
warehouseShelfCode	string	Warehouse shelf code
sourceId	string	Source id
promotionId	string	Promotion id
createDatetime	datetime	Create date and time
updateDatetime	datetime	Update date and time

WarehouseVO

Name	Type	Description
id	string	Warehouse id
userId	string	User id
code	string	Warehouse code
name	string	Warehouse name
areaId	string	Area id
address	string	Address
status	string	Status, ENABLE, DISABLE
type	string	Type, please refer to WarehouseType for details
provider	string	Provide of third party
isDefault	boolean	Default warehouse
externalId	string	External id, if use third party, it will be the id of third party
enableCalibrate	boolean	Enable calibrate, if use third party and this value is true, Ginee will calibrate stock automatically
createDatetime	datetime	Create date and time
updateDatetime	datetime	Update date and time

WarehouseType

Name	Type	Description
MY_WAREHOUSE	string	My warehouse
MY_STORE	string	My store
THIRD_PARTY_WAREHOUSE	string	Third party warehouse

Request Example

Example

curl --location --request POST '{Ginee Host}/openapi/warehouse-inventory/v1/sku/list' \
--header 'Authorization: {Your Access Key} + ':' + signature' \
--header 'X-Advai-Country: ID' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page":0,
    "size":50,
    "warehouseId":"WW635660264CEDFD0001D9D605"
}'

Success

{
    "code":"SUCCESS",
    "message":"OK",
    "data":{
        "page":0,
        "size":100,
        "total":261,
        "content":[
            {
                "warehouseInventory":{
                    "id":"WI6358CEC2DC0E820001207FC2",
                    "userId":"U1518483350455578624",
                    "masterVariationId":"MV6358AF2C4CEDFD0001724BDD",
                    "warehouseId":"WW635660264CEDFD0001D9D605",
                    "transportStock":0,
                    "warehouseStock":4,
                    "spareStock":0,
                    "promotionStock":0,
                    "lockedStock":0,
                    "availableStock":4,
                    "safetyStock":0,
                    "safetyAlert":false,
                    "pricingMethod":"MW",
                    "averagePurchasePrice":0,
                    "currencyCode":"IDR",
                    "type":"NORMAL",
                    "pushStatus":"NO_NEED",
                    "failReason":"",
                    "enableStatus":"NORMAL",
                    "createDatetime":"2022-10-26T06:08:02Z",
                    "updateDatetime":"2023-09-21T01:50:31Z"
                },
                "pushStatus":null,
                "channelVariationCount":3,
                "masterVariation":{
                    "id":"MV6358AF2C4CEDFD0001724BDD",
                    "masterProductId":"MP6358AF2C4CEDFD0001724BDC",
                    "masterSku":"SKSPHMS1S002",
                    "name":"Roti Paratha Spring Home TYJ Plain 325 Gr",
                    "variationName":"-",
                    "image":"https://ecs7.tokopedia.net/img/cache/700/VqbcmM/2022/10/22/a6e64428-36ec-4265-a8ba-ccc03d671a1a.jpg",
                    "tagList":[

                    ]
                },
                "shelfInventoryList":[
                    {
                        "id":"SI6358CEC2DC0E820001207FC3",
                        "userId":"U1518483350455578624",
                        "warehouseInventoryId":"WI6358CEC2DC0E820001207FC2",
                        "transportStock":0,
                        "warehouseStock":4,
                        "spareStock":0,
                        "lockedStock":0,
                        "availableStock":4,
                        "purchasePrice":0,
                        "type":"NORMAL",
                        "warehouseShelfId":"WS635660264CEDFD0001D9D606",
                        "warehouseShelfCode":"",
                        "sourceId":"",
                        "promotionId":"",
                        "createDatetime":"2022-10-26T06:08:02Z",
                        "updateDatetime":"2023-09-21T01:50:31Z"
                    }
                ],
                "warehouse":{
                    "id":"WW635660264CEDFD0001D9D605",
                    "userId":"U1518483350455578624",
                    "code":"FFDPK001",
                    "name":"Fresh factory Depok",
                    "areaId":"",
                    "address":"Jl. Margonda Raya, Depok, Kec. Pancoran Mas, Kota Depok, Jawa Barat 16431",
                    "status":"ENABLE",
                    "type":"MY_WAREHOUSE",
                    "provider":"GINEE_LOCAL",
                    "isDefault":null,
                    "externalId":"",
                    "enableCalibrate":false,
                    "createDatetime":"2022-10-24T09:51:34Z",
                    "updateDatetime":"2022-11-17T04:00:17Z"
                }
            },
            {
                "warehouseInventory":{
                    "id":"WI6358CEC3DC0E820001207FEE",
                    "userId":"U1518483350455578624",
                    "masterVariationId":"MV6358AF2D4CEDFD0001724D6E",
                    "warehouseId":"WW635660264CEDFD0001D9D605",
                    "transportStock":0,
                    "warehouseStock":1,
                    "spareStock":0,
                    "promotionStock":0,
                    "lockedStock":0,
                    "availableStock":1,
                    "safetyStock":0,
                    "safetyAlert":false,
                    "pricingMethod":"MW",
                    "averagePurchasePrice":0,
                    "currencyCode":"IDR",
                    "type":"NORMAL",
                    "pushStatus":"NO_NEED",
                    "failReason":"",
                    "enableStatus":"NORMAL",
                    "createDatetime":"2022-10-26T06:08:03Z",
                    "updateDatetime":"2023-09-21T01:50:31Z"
                },
                "pushStatus":null,
                "channelVariationCount":3,
                "masterVariation":{
                    "id":"MV6358AF2D4CEDFD0001724D6E",
                    "masterProductId":"MP6358AF2D4CEDFD0001724D6D",
                    "masterSku":"SKBEGMS2S004",
                    "name":"Bega Keju Cheese Smokey BBQ Slices 200 gr",
                    "variationName":"-",
                    "image":"https://ecs7.tokopedia.net/img/cache/700/VqbcmM/2022/10/21/80ac6e12-9de9-4eaf-95e3-cb014b4445a1.jpg",
                    "tagList":[

                    ]
                },
                "shelfInventoryList":[
                    {
                        "id":"SI6358CEC3DC0E820001207FEF",
                        "userId":"U1518483350455578624",
                        "warehouseInventoryId":"WI6358CEC3DC0E820001207FEE",
                        "transportStock":0,
                        "warehouseStock":1,
                        "spareStock":0,
                        "lockedStock":0,
                        "availableStock":1,
                        "purchasePrice":0,
                        "type":"NORMAL",
                        "warehouseShelfId":"WS635660264CEDFD0001D9D606",
                        "warehouseShelfCode":"",
                        "sourceId":"",
                        "promotionId":"",
                        "createDatetime":"2022-10-26T06:08:03Z",
                        "updateDatetime":"2023-09-21T01:50:31Z"
                    }
                ],
                "warehouse":{
                    "id":"WW635660264CEDFD0001D9D605",
                    "userId":"U1518483350455578624",
                    "code":"FFDPK001",
                    "name":"Fresh factory Depok",
                    "areaId":"",
                    "address":"Jl. Margonda Raya, Depok, Kec. Pancoran Mas, Kota Depok, Jawa Barat 16431",
                    "status":"ENABLE",
                    "type":"MY_WAREHOUSE",
                    "provider":"GINEE_LOCAL",
                    "isDefault":null,
                    "externalId":"",
                    "enableCalibrate":false,
                    "createDatetime":"2022-10-24T09:51:34Z",
                    "updateDatetime":"2022-11-17T04:00:17Z"
                }
            }
        ]
    }
}