get

/shipping/zones/{zone_id}/methods

Returns a list of Shipping Methods in a zone. Default sorting is by shipping-method id, from lowest to highest.

Authorization

apiKey - X-Auth-Token

Request Parameters

1 Path Parameter
2 Headers

Responses

2 Examples
Schema
array[object]
id
integer

Shipping-method ID. READ-ONLY

1 validation
name
string

Display name for shipping method.

1 validation
type
string
3 validations
settings
object

Depends on the shipping-method type. See the supported settings object.

enabled
boolean

Whether or not this shipping-zone method is enabled.

1 validation
handling_fees
object

fixed_surcharge: flat-rate handling fee applied to shipping cost.

percentage_surcharge: percentage handling fee applied to shipping cost

2 validations
is_fallback
boolean

Whether or not this shipping zone is the fallback if all others are not valid for the order.

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
zone_id
$$.env
1 variable not set
store_hash
X-Auth-Token