GetShippingParameter

Use this API to obtain the parameters required for shipping, including the delivery method (depending on the Ginee OMS configuration), the logistics provider, the logistic number, the address of the pickup method and the pickup time ID options, depending on the e-commerce marketplace requirements.

POST /openapi/logistics/v1/get-shipping-parameter

Request Parameters

Parameter	Type	Required	Description
orderId	string	true	Order id in Ginee

Response Parameters

Name	Type	Description
deliveryType	string	Type of logistics delivery, see Logistics Delivery Type, Depending on the configuration in Ginee OMS, it is recommended to ship according to the delivery method returned, if it has not been configured in Ginee OMS, this field may be empty and you can choose the desired delivery method to ship
logisticsTrackingNumber	string	The delivery tracking number of the order
logistics	object[]	refer logistic for details
addresses	object[]	refer addresses for details

logistic

Name	Type	Description
logisticsDeliveryType	string	Type of logistics delivery
logisticDetailList	object[]	refer logisticDetail for details

logisticDetail

Name	Type	Description
logisticsProviderId	string	Id of logistics provider
logisticsProviderName	string	Name of logistics provider

addresses

Name	Type	Description
addressId	string	Address id
address	string	address
pickupTimeList	object[]	Please refer pickupTimeList for details

pickupTimeList

Name	Type	Description
pickupTimeId	string	Pickup time id
timeText	string	Time text

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/logistics/v1/get_shipping_parameter

Success

{
    "code":"SUCCESS",
    "message":"成功",
    "data":{
        "deliveryType":"PICK_UP",
        "logisticsTrackingNumber":"JX1856727210",
        "invoiceNumber":"T1601030200",
        "logistics":[
            {
                "logisticsDeliveryType":"PICK_UP",
                "logisticDetailList":[
                    {
                        "logisticsProviderId":101,
                        "logisticsProviderName":"J&T Express_ID"
                    },
                    {
                        "logisticsProviderId":102,
                        "logisticsProviderName":"Ninja Van ID Express"
                    }
                ]
            },
            {
                "logisticsDeliveryType":"DROP_OFF",
                "logisticDetailList":[
                    {
                        "logisticsProviderId":103,
                        "logisticsProviderName":"VNPost Tiết Kiệm"
                    },
                    {
                        "logisticsProviderId":104,
                        "logisticsProviderName":"XDE Logistics"
                    }
                ]
            },
            {
                "logisticsDeliveryType":"MANUAL_SHIP",
                "logisticDetailList":[
                    {
                        "logisticsProviderId":105,
                        "logisticsProviderName":"Thailand Post - EMS"
                    },
                    {
                        "logisticsProviderId":106,
                        "logisticsProviderName":"Viettel Post"
                    }
                ]
            }
        ],
        "addresses":[
            {
                "addressId":"251",
                "address":"6701 INTERSTATE 30",
                "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"
                    }
                ]
            },
            {
                "addressId":"253",
                "address":"Duri H1 INTERSTATE 007",
                "pickupTimeList":[
                    {
                        "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"
                    }
                ]
            }
        ]
    },
    "extra":null,
    "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.