Skip to content

ShippingOrder

Use this api to ship the order.

POST /openapi/order/v2/shipping

Request Parameters

Parameter Type Required Description
orderId string true Order id in Ginee
deliveryType string true Logistics deliveryType, see Logistics Delivery Type
pickupTimeId string false pickupTimeId in Ginee, When the channel is [SHOPEE_ID, TIKTOK_ID] and deliveryType is PICK_UP, this parameter cannot be empty, see Order Logistics. note: tiktok can be empty
addressId string false addressId in Ginee, When the channel is [SHOPEE_ID, TIKTOK_ID] and deliveryType is PICK_UP, this parameter cannot be empty, see Order Logistics. note: tiktok can be empty
shipmentProvider string false shipment provider, When deliveryType is DROP_OFF, this parameter cannot be empty
trackingNo string false trackingNo

Response Parameters

Name Type Description
taskId string Order taskId

Request Example

Example

curl -X POST  \
-H "X-Advai-Country: ID" \
-H "Authorization: {Your Access Key} + ':' + signature" \
-H "Content-Type: application/json" \
-d '{
        "orderId":"SO6125178AF4428A0001DABC8F",
        "deliveryType":"DROP_OFF",
        "pickupTimeId":"1630054800_4",
        "addressId":"26403738",
        "shipmentProvider":"ceshi",
        "trackingNo":"123"

    }' \
"{Ginee Host}/openapi/order/v2/shipping

Success

   {
       "code":"SUCCESS",
       "message":"OK",
       "data": "SO6125178AF4428A0001DABC8F",
       "extra":null,
       "transactionId":"f49f370af5805764"
   }

Failure

{
     "taskId":"f49f370af5805764"
}

Note

Changes in order status will be notified to you via webhook