Get available shipping lines

POST 
/openapi/2025-06/shipping-lines/available-lines

Retrieves available shipping options for the specified order and address.

Request

application/json

Body

Bodyrequired

order_idstringrequired

Order ID

country_codestringrequired

Country code

province_codestring
Province/state code. Pass ALL to match all provinces (default behavior for most countries).
GB (United Kingdom) special handling: Because shipping costs vary significantly across England (GB-ENG), Scotland (GB-SCT), Wales (GB-WLS), and Northern Ireland (GB-NIR), an empty value will not match any shipping zone. You must either:
• Pass a specific province code (e.g. GB-ENG), or
• Pass ALL, or
• Provide zip instead — the system will automatically derive the province from the postal code prefix
zipstring

Zip/postal code. For GB addresses, the system uses the postal code prefix to automatically derive the province code when province_code is not provided.

Example

{
  "order_id": "string",
  "country_code": "string",
  "province_code": "string",
  "zip": "string"
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

shipping_lines object[]

List of available shipping lines

Array [

delivery_methodint32

Delivery method type (1: express delivery, 2: local delivery)

descstring

Description of the shipping line

idstring

Shipping line ID

location_idstring

Location identifier

namestring

Name of the shipping line

plan_codestring

Plan code

shipping_pricestring

Shipping price (as string to preserve precision)

support_codint32

Whether cash on delivery is supported (0 or 1)

]

invalid_productsstring[]

List of invalid product identifiers

messagestring

Reason for third-party billing failure

statestring

Business state code: success (successful), empty_plan (no matching plan for country/province), empty_shipping_plan (matching conditions not met), invalid_product (product removed)

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "shipping_lines": [
      {
        "delivery_method": 0,
        "desc": "string",
        "id": "string",
        "location_id": "string",
        "name": "string",
        "plan_code": "string",
        "shipping_price": "string",
        "support_cod": 0
      }
    ],
    "invalid_products": [
      "string"
    ],
    "message": "string",
    "state": "string"
  }
}