Skip to content

BindWarehouse

Use this API to bind warehouse. After the binding is complete, you can push items, outbound orders and inbound orders and other operations

POST /openapi/fulfillment/warehouse/v1/bind

Request Body

Parameter Type Required Length Description
bindSource int true 20 Distinguish request bind from different OMS's.Please refer to Bind Source for details
warehouseCodes string[] true / The warehouse code from Ginee WMS

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
successList object[] List of successes See BindResultDetail
failureList object[] List of failures See BindResultDetail

BindResultDetail

Name Type Description
warehouseCode string The warehouse code from Ginee WMS
message string Reasons for binding failure

Request Example

Example

curl -X POST  \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
-d '{
        "bindErpSource":1,
        "warehouseCodes":[
            "WH0004","WH0007qqq"
        ]
    }' \
"{Ginee Host}/openapi/fulfillment/warehouse/v1/bind"

Success

{
    "code": "SUCCESS",
    "message": "OK",
    "data": {
        "successList": [
            {
                "warehouseCode": "WH0004",
                "message": null
            }
        ],
        "failureList": [
            {
                "warehouseCode": "WH0007qqq",
                "message": "Warehouse binding failed, the warehouse information was not queried"
            }
        ]
    },
    "extra": null,
    "transactionId": "19d607ea5d78852a"
}

Failure

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