UpdateOutbound¶
Use this API to update outbound, the update is identified by outBoundNo.
POST /openapi/fulfillment/outbound/v1/update
Request Body¶
Parameter | Type | Required | Length | Description |
---|---|---|---|---|
outboundNo |
string |
true |
50 | Identifiers of inbound |
outboundSource |
string |
true |
20 | Distinguish outbound 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 |
orderDetails |
object[] |
true |
/ | Details of the sku to be stocked See OrderDetail |
logisticName |
string |
false |
100 | Logistics provider name |
faceSheetPdfPath |
string |
false |
1000 | Logistics label pdf link address (required when the recipient name and recipient address are empty) |
trackingNumber |
string |
false |
64 | Logistics tracking number |
OrderDetail¶
Name | Type | Required | Length | Description |
---|---|---|---|---|
itemSku |
string |
true | 512 | Item SKU |
requestQuantity |
int |
true | / | Inbound quantity |
packageId |
string |
false | 45 | Package Id (multiple SKUs need to pass the same packageId when combining packages) |
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 '{
"outboundNo": "test_openapi_20221027-1613168543328111",
"outboundSource": "HAOMA_ERP",
"faceSheetPdfPath": "",
"warehouseCode": "WH0007",
"trackingNumber": "161316",
"logisticName": "test data",
"orderDetails": [
{
"itemSku": "textM7",
"requestQuantity": 2
}
]
}' \
"{Ginee Host}/openapi/fulfillment/outbound/v1/update"
Success
{
"code": "SUCCESS",
"message": "OK",
"data": null,
"extra": null,
"transactionId": "19d607ea5d78852a"
}
Failure
{
"code": "PARAMETER_ERROR",
"message": "Parameter is invalid: Parameter should not be empty: outboundNo ",
"data": null,
"extra": null
}