GetOrderLogistics¶
Use this api to get the logistics information corresponding to the order.
POST /openapi/order/logistics/list
Request Parameters¶
Parameter | Type | Required | Description |
---|---|---|---|
orderId |
string |
true |
Order id in Ginee |
Response Parameters¶
Name | Type | Description |
---|---|---|
logisticsDeliveryType |
string |
The logistics delivery type to which the order belongs, see Logistics Delivery Type |
logisticsProviderName |
string |
The logistics provider name to which the order belongs |
logisticsTrackingNumber |
string |
The delivery tracking number of the order |
addressList |
object [] |
Please refer addressList for details |
trackingNoRequired |
string |
trackingNo requirements for order |
addressList¶
Name | Type | Description |
---|---|---|
addressId |
string |
addressId |
address |
string |
address |
pickupTimeList |
object [] |
Please refer pickupTimeList for details |
pickupTimeList¶
Name | Type | Description |
---|---|---|
pickupTimeId |
string |
pickupTimeId |
timeText |
string |
timeText |
Request Example¶
Example
curl -X POST \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
-d '{
"orderId": "SO5F6BFC765908010001E1DD83"
}' \
"{Ginee Host}/openapi/order/logistics/list
Success
{
"code": "SUCCESS",
"message": "OK",
"data": [{
"logisticsDeliveryType": "PICK_UP",
"logisticsProviderName": "Anteraja Reguler",
"logisticsTrackingNumber": "",
"addressList": [{
"addressId": "26403738",
"address": "address_new",
"pickupTimeList": [{
"pickupTimeId": "1649754000_3",
"timeText": "18:00:00-20:00:00 12-04-2022"
},
{
"pickupTimeId": "1649840400_1",
"timeText": "10:00:00-14:00:00 13-04-2022"
},
{
"pickupTimeId": "1649840400_2",
"timeText": "14:00:00-18:00:00 13-04-2022"
},
{
"pickupTimeId": "1649840400_3",
"timeText": "18:00:00-20:00:00 13-04-2022"
}
]
}],
"trackingNoRequired": false
}],
"extra": null,
"transactionId": "d601a8f22b398688",
"pricingStrategy": "PAY"
}
Failure
{
"code": "CHANNEL_NOT_SUPPORT",
"message": "This order operation channel does not support",
"data": "SO5F6BFC765908010001E1DD83",
"extra": null,
"pricingStrategy": "FREE"
}
Note
You need to check the code
to see if the operation was successful. If failed, see message
for detail reason.