getShippingResult

Use this api to get shipping results.

POST /openapi/order/v1/get-shipping-result

Request Parameters

Parameter	Type	Required	Description
taskId	String	true	task id,The data field returned by the MoveReadyToShipped endpoint

Response Parameters

Name	Type	Description
taskId	String	Task Id
complete	Boolean	Whether the shipping task is completed, true or fase, if false, please continue the query
detailList	Array(ShippingResultDetail)	Shipping results for each order

ShippingResultDetail

Name	Type	Description
orderId	String	Ginee order id
status	String	Shipping Status，values:WAIT,PROCESSING,FAILED,SUCCESS
errorMessage	String	Reasons for shipping failure

Request Example

Example

curl -X POST  \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
-d '{
      "taskId":"OOT63886DDE6B2F0700016C742F"
    }' \
"{Ginee Host}/openapi/order/v1/get-shipping-result

Success

   {
       "code": "SUCCESS",
       "message": "OK",
       "data": {
           "taskId": "OOT63886DDE6B2F0700016C742F",
           "complete": true,
           "detailList": [
               {
                   "orderId": "SO63808F33590801000166A2ED",
                   "status": "SUCCESS",
                   "errorMessage": ""
               },
               {
                   "orderId": "SO63808F33590801000166A2ED",
                   "status": "SUCCESS",
                   "errorMessage": ""
               }
           ]
       },
       "extra": null,
       "pricingStrategy": "PAY"
   }

Failure

{
    "code": "SUCCESS",
    "message": "OK",
    "data": {
        "taskId": "OOT63886DDE6B2F0700016C742F",
        "complete": true,
        "detailList": [
            {
                "orderId": "SO63808F33590801000166A2ED",
                "status": "FAILED",
                "errorMessage": "There Are Error From Ext Service"
            },
            {
                "orderId": "SO63808F33590801000166A2ED",
                "status": "FAILED",
                "errorMessage": "There Are Error From Ext Service"
            }
        ]
    },
    "extra": null,
    "pricingStrategy": "PAY"
}

Note

You need to check the code to see if the operation was successful. If failed, see message for detail reason.