Logistics Channel

Logistics Channel API provides information like shipping method (channelNameEn), channel code, delivery time, or freight.

Products Properties

Parameter name	Type	Remark
sku	string[64]	sku
quantity	int[16]	quantity must be greater than 0
shipToCountry	string[12]	ship to country,shortcode required.Examples: FR,US
warehouseCode	string[32]	Warehouse code,This value is obtained by calling the CountryAndWarehouse api, and it is not required. If no value is passed or the warehouse is not matched, the G007 warehouse will be used automatically.

Request Properties

{
    "products": [
      {
       "sku": "FSZW06578_P_L_NUB",
       "quantity": 1
      }
    ],
    "shipToCountry": "US"
}

POST /openapi/v2/order/orders/channel

Request Body

Name	Type	Description
shipToCountry*	String	shipping country shortcode required FR,US
products*	Array	Product information

200: OK

{
    "code": 10000,
    "message": "success",
    "data": [
        {
            "channelCode": "WB004",
            "channelNameEn": "PP",
            "estimatedFreight": 4.83,
            "estimatedFreightCurrency": "USD",
            "deliveryTime": "3~5 Business Days"
        },
        {
            "channelCode": "WB001",
            "channelNameEn": "Wb clothing line （general goods ）",
            "estimatedFreight": 3.61,
            "estimatedFreightCurrency": "USD",
            "deliveryTime": "6~10 Business Days"
        }
    ]
}

401: Unauthorized

{
    // Response
}

Response Properties

Parameter name	Type	Remark
channelCode	String	Logistics channel code,This value is used on the channelCode parameter in the Order API
channelNameEn	String	channel name(shipping method)
estimatedFreight	String	Shipping amount
estimatedFreightCurrency	String	USD
deliveryTime	String	For example: 6~10 Business Days
channelType	String	channelType

Response Examples

{
    "code": 10000,
    "message": "success",
    "data": [
        {
            "channelCode": "WB004",
            "channelNameEn": "PP",
            "estimatedFreight": 6.45,
            "estimatedFreightCurrency": "USD",
            "deliveryTime": "3~5 Business Days",
            "channelType": "Standard"
        },
        {
            "channelCode": "WB001",
            "channelNameEn": "Wb clothing line （general goods ）",
            "estimatedFreight": 4.77,
            "estimatedFreightCurrency": "USD",
            "deliveryTime": "6~10 Business Days",
            "channelType": "Expedited"
        }
    ]
}

data is sorted according to "deliveryTime " from small to large, deliveryTime the largest is "Standard Shipping".

"estimatedFreight" is the shipping cost, mainly determined by weight (unit g) and "shipToCountry".The higher the weight, the higher the "estimatedFreight". "weight" is calculated by sku's packageWeight * "quantity"