Skip to content

CreateInbound

Use this api to create inbound order.

POST /openapi/fulfillment/inbound/v1/create

Request Body

Parameter Type Required Length Description
inboundNo string true 50 Identifiers of inbound
inboundSource string true 20 Distinguish inbound orders from different OMS's.Please refer to OMS Channel for details
warehouseCode string true 20 The GineeWms warehouse code for which the binding relationship has been created
skuDetails object[] true / Details of the sku to be stocked See skuDetail Info
channel string false 45 Please refer to Ginee Channel for details
trackingNumber string false 64 Logistics tracking number
logisticName string false 100 Logistics provider name
recipientName string false 512 Name of the recipient of the order
channelRefundOrderNo string false 128 Return order number of the order
channelOriginOrderNo string false 128 Original order number of the order
refundFlag boolean false / Whether it is a return order.Default is false
remark string false 500 Remarks of the inbound order

skuDetail

Name Type Length Description
itemSku string 512 Item SKU
requestQuantity int / Inbound quantity

Response Body

Name Type Description
code string SUCCESS | ERROR
message string The status code detailed explanation.
data object No data returned will be null.
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.

Request Example

Example

curl -X POST  \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
-d '{
        "inboundNo": "testopenapi-003",         
        "warehouseCode": "WH0009",
        "inboundSource":"YICANG_ERP",
        "skuDetails": [{
            "itemSku":"Random 1",
            "requestNum":900
        }],
        "trackingNumber": "commodo",
        "recipienName": "motiy",
        "channelRefundOrderNo": "cupidatat id esse",
        "refundFlag": false
    }' \
"{Ginee Host}/openapi/fulfillment/inbound/v1/create"

Success

{
    "code": "SUCCESS",
    "message": "OK",
    "data": null,
    "extra": null,
    "transactionId": "19d607ea5d78852a"
}

Failure

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