Available Shipping Lines

post

https://{subdomain}.myshoplaza.com/openapi/2025-06/shipping-lines/available-lines

Retrieves available shipping options for the specified order and address.

This Available Shipping Lines API endpoint will retrieves available shipping options for the specified order and address.

This API is especially useful for:

calculate shipping costs
get available delivery methods during checkout or order management.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Body Parameters

Parameter	Type	Required	Description	Example
`order_id`	string	Yes	Unique identifier for the order	`"123123123"`
`country_code`	string	Yes	ISO 3166-1 alpha-2 country code	`"US"`
`province_code`	string	No	Province or state code	`"CA"`
`zip`	string	No	ZIP or postal code	`"90001"`

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Description	Example
`code`	string	Error code	`"success"`
`message`	string	Error message	`"Operation successful"`
`data`	object	Response data container	-
`data.shipping_lines`	array of objects	List of available shipping lines	-

Shipping Line Object Structure

Parameter	Type	Description	Example
`delivery_method`	int32	Delivery method type (1: express delivery, 2: local delivery)	`1`
`desc`	string	Description of the shipping line	`"Standard shipping 3-5 business days"`
`id`	string	Unique identifier for the shipping line	`"shp_123456789"`
`location_id`	string	Location identifier	`""`
`name`	string	Name of the shipping line	`"Standard Shipping"`
`plan_code`	string	Plan code	`"standard_plan"`
`shipping_price`	string	Shipping price (as string to preserve precision)	`"9.99"`
`support_cod`	int32	Whether cash on delivery is supported (0 or 1)	`1`
`invalid_products`	array of strings	List of invalid product identifiers	`["prod_123", "prod_456"]`
`message`	string	Reason for third-party billing failure	`"Service unavailable in this area"`
`state`	string	Business state code: Business state code: success (successful), empty_plan (no matching plan for country/province), empty_shipping_plan (matching conditions not met), invalid_product (product removed)	`"success"`

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

Language

Credentials

Header

URL

Click Try It! to start a request and see the response here!