GetWarehouseInventory¶

Use this api to get the inventory information of the specified warehouse.

GET /openapi/warehouse-inventory/v1/sku/get

Request Parameters¶

Parameter	Type	Required	Description
`id`	`string`	`true`	Warehouse inventory id

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 GET '{Ginee Host}/openapi/warehouse-inventory/v1/sku/get?id=WI61EFAB237D560D0001A43BEA' \
--header 'Authorization: 2aedf7919e5e6cb4:S0sSLI9RSK/Vw6t3MpDm7pCgD+Vze0/9fu4W0PaX/iE=' \
--header 'X-Advai-Country: ID' \
--header 'Content-Type: application/json' \

Success

{
"code": "SUCCESS",
"message": "成功",
"data": {
    "warehouseInventory": {
        "id": "WI61EFAB237D560D0001A43BEA",
        "userId": "U1484411281229213696",
        "masterVariationId": "MV61EFA5CF6522050001174701",
        "warehouseId": "WW61EA663F9B9717000127DAD5",
        "transportStock": 0,
        "warehouseStock": 0,
        "spareStock": 0,
        "promotionStock": 0,
        "lockedStock": 0,
        "availableStock": 0,
        "safetyStock": 0,
        "safetyAlert": false,
        "pricingMethod": "MW",
        "averagePurchasePrice": 0.000000,
        "currencyCode": "IDR",
        "type": "NORMAL",
        "pushStatus": "NO_NEED",
        "failReason": "",
        "enableStatus": "REGISTER_WAREHOUSE",
        "createDatetime": "2022-01-25T07:47:47Z",
        "updateDatetime": "2022-01-25T07:47:47Z"
    },
    "channelVariationCount": 0,
    "masterVariation": {
        "id": "MV61EFA5CF6522050001174701",
        "masterProductId": "MP61EFA5CF65220500011746FF",
        "masterSku": "GENIE75-4",
        "name": "测试描述测试描述测试描述v-Avocado",
        "variationName": "Avocado",
        "image": "https://cf.shopee.co.id/file/d4b40275531b960396683070543fcdce",
        "tagList": []
    },
    "warehouse": {
        "id": "WW61EA663F9B9717000127DAD5",
        "userId": "U1484411281229213696",
        "code": "001",
        "name": "DefaultWarehouse",
        "areaId": "",
        "address": "",
        "status": "ENABLE",
        "type": "MY_WAREHOUSE",
        "provider": "GINEE_LOCAL",
        "externalId": "",
        "enableCalibrate": false,
        "createDatetime": "2022-01-21T07:52:32Z",
        "updateDatetime": "2022-01-21T07:52:32Z"
    }
},
"extra": null,
"pricingStrategy": "PAY"
}