SearchWarehouse¶

Use this api to search warehouses.

POST /openapi/warehouse/v1/search

Request Parameters¶

Parameter	Type	Required	Description
`warehouseName`	`string`	`false`	Warehouse name
`warehouseStatus`	`string`	`false`	Default null, please refer to Warehouse Status for details
`page`	`integer`	`true`	page no, greater than or equal to 0
`size`	`integer`	`true`	page size, greater than 0, less than 500

Response Parameters¶

Name	Type	Description
`id`	`string`	Warehouse id in Ginee
`userId`	`string`	UserId in Ginee
`code`	`string`	Warehouse code
`name`	`string`	Warehouse name
`areaId`	`string`	Area id
`address`	`string`	Warehouse detailed address
`status`	`string`	Warehouse status,please refer to Warehouse Status for details
`type`	`string`	Warehouse type,please refer to Warehouse Type for details
`provider`	`string`	Warehouse provider,please refer to Warehouse Provider for details
`isDefault`	`boolean`	Default warehouse
`externalId`	`string`	Third party warehouse id
`enableCalibrate`	`boolean`	Whether to enable inventory calibration
`createDatetime`	`datetime`	Warehouse create time on Ginee
`updateDatetime`	`datetime`	Warehouse update time on Ginee
`page`	`long`	The current page
`size`	`long`	size
`total`	`long`	The total number of

Request Example¶

Example

curl --location --request POST '{Ginee Host}/openapi/warehouse/v1/search' \
    --header 'Content-Type: application/json' \
    --header 'X-Advai-Country: ID' \
    --header 'Authorization: 2aedf7919e5e6cb4:UH5nmZ7Qqd18Nr1sqLgDjA/1qjPfDR7/rzRvRtHTM8s=' \
    --data-raw '{
    "warehouseCode":"001",
    "warehouseName":"DefaultWarehouse",
    "warehouseStatus":"ENABLE",
    "warehouseType":"MY_WAREHOUSE"
}'

Success

{
    "code": "SUCCESS",
    "message": "成功",
    "data": {
        "page": 0,
        "size": 10,
        "total": 25,
        "content": [
            {
                "id": "WW61C56948652205000113CD6D",
                "userId": "U5DDCC5369BD1160001ADD698",
                "code": "4c3e3492-1fc8-7a45-0e3b001",
                "name": "威海威速仓库[6]+test003",
                "areaId": null,
                "address": "测试地址002",
                "status": "ENABLE",
                "type": "THIRD_PARTY_WAREHOUSE",
                "provider": "YILIAN",
                "isDefault": null,
                "externalId": "test003+4c3e3492-1fc8-7a45-0e3b-39ffa8c67db1",
                "enableCalibrate": false,
                "createDatetime": "2021-12-24T06:31:36Z",
                "updateDatetime": "2022-01-23T16:29:47Z"
            },
            {
                "id": "WW61C56948652205000113CD6B",
                "userId": "U5DDCC5369BD1160001ADD698",
                "code": "77cec004-6416-5192-b472-39ff42bc82e2+test003",
                "name": "演示仓库[5]+test003",
                "areaId": null,
                "address": "",
                "status": "ENABLE",
                "type": "THIRD_PARTY_WAREHOUSE",
                "provider": "YILIAN",
                "isDefault": null,
                "externalId": "test003+77cec004-6416-5192-b472-39ff42bc82e2",
                "enableCalibrate": false,
                "createDatetime": "2021-12-24T06:31:36Z",
                "updateDatetime": "2021-12-24T06:31:36Z"
            }
        ]
    },
    "extra": null,
    "pricingStrategy": "PAY"
}