The shipping method object

A comprehensive list of the shipping method resource's attributes and relationships

A shipping method object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/shipping_methods endpoint.

Fields

FieldTypeDescription

type

string

shipping_methods

id

string

The shipping method unique identifier

links.self

string

The shipping method endpoint URL

attributes.name

string

The shipping method's name.

attributes.scheme

string

The shipping method's scheme. One of 'flat', 'weight_tiered', or 'external'.

attributes.currency_code

string

The international 3-letter currency code as defined by the ISO 4217 standard.

attributes.external_prices_url

string

The URL used to overwrite prices by an external source.

attributes.price_amount_cents

integer

The price of this shipping method, in cents.

attributes.price_amount_float

float

The price of this shipping method, float.

attributes.formatted_price_amount

string

The price of this shipping method, formatted.

attributes.free_over_amount_cents

integer

Apply free shipping if the order amount is over this value, in cents.

attributes.free_over_amount_float

float

Apply free shipping if the order amount is over this value, float.

attributes.formatted_free_over_amount

string

Apply free shipping if the order amount is over this value, formatted.

attributes.use_subtotal

boolean

Send this attribute if you want to compare the free over amount with order's subtotal (excluding discounts, if any).

attributes.price_amount_for_shipment_cents

integer

The calculated price (zero or price amount) when associated to a shipment, in cents.

attributes.price_amount_for_shipment_float

float

The calculated price (zero or price amount) when associated to a shipment, float.

attributes.formatted_price_amount_for_shipment

string

The calculated price (zero or price amount) when associated to a shipment, formatted.

attributes.min_weight

float

The minimum weight for which this shipping method is available.

attributes.max_weight

float

The maximum weight for which this shipping method is available.

attributes.unit_of_weight

string

The unit of weight. One of 'gr', 'oz', or 'lb'.

attributes._disable

boolean

Send this attribute if you want to mark this resource as disabled.

attributes._enable

boolean

Send this attribute if you want to mark this resource as enabled.

attributes.disabled_at

datetime

Time at which this resource was disabled.

attributes.circuit_state

string

The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.

attributes.circuit_failure_count

integer

The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback.

attributes._reset_circuit

boolean

Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.market

object

The associated market.

relationships.shipping_zone

object

The shipping zone that is used to match the order shipping address.

relationships.shipping_category

object

The shipping category for which this shipping method is available.

relationships.stock_location

object

The stock location for which this shipping method is available.

relationships.delivery_lead_time_for_shipment

object

The delivery lead time for the associated shipment.

relationships.shipping_method_tiers

array

The associated shipping method tiers (meaningful when billing_scheme != 'flat').

relationships.shipping_weight_tiers

array

The associated shipping weight tiers (meaningful when billing_scheme != 'flat').

relationships.attachments

array

The associated attachments.

relationships.versions

array

The associated changes.

meta.mode

string

The resource environment (can be one of test or live)

Last updated