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
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The shipping method unique identifier |
links.self |
| The shipping method endpoint URL |
attributes._disable |
| Send this attribute if you want to mark this resource as disabled. |
attributes._enable |
| Send this attribute if you want to mark this resource as enabled. |
attributes._reset_circuit |
| Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. |
attributes.circuit_failure_count |
| The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. |
attributes.circuit_state |
| 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.created_at |
| Time at which the resource was created. |
attributes.currency_code |
| The international 3-letter currency code as defined by the ISO 4217 standard. |
attributes.disabled_at |
| Time at which this resource was disabled. |
attributes.external_prices_url |
| The URL used to overwrite prices by an external source. |
attributes.formatted_free_over_amount |
| Apply free shipping if the order amount is over this value, formatted. |
attributes.formatted_price_amount |
| The price of this shipping method, formatted. |
attributes.formatted_price_amount_for_shipment |
| The calculated price (zero or price amount) when associated to a shipment, formatted. |
attributes.free_over_amount_cents |
| Apply free shipping if the order amount is over this value, in cents. |
attributes.free_over_amount_float |
| Apply free shipping if the order amount is over this value, float. |
attributes.max_weight |
| The maximum weight for which this shipping method is available. |
attributes.metadata |
| 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. |
attributes.min_weight |
| The minimum weight for which this shipping method is available. |
attributes.name |
| The shipping method's name. |
attributes.price_amount_cents |
| The price of this shipping method, in cents. |
attributes.price_amount_float |
| The price of this shipping method, float. |
attributes.price_amount_for_shipment_cents |
| The calculated price (zero or price amount) when associated to a shipment, in cents. |
attributes.price_amount_for_shipment_float |
| The calculated price (zero or price amount) when associated to a shipment, float. |
attributes.reference |
| 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 |
| Any identifier of the third party system that defines the reference code. |
attributes.scheme |
| The shipping method's scheme. One of 'flat', 'weight_tiered', or 'external'. |
attributes.unit_of_weight |
| The unit of weight. One of 'gr', 'oz', or 'lb'. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.use_subtotal |
| Send this attribute if you want to compare the free over amount with order's subtotal (excluding discounts, if any). |
relationships.attachments |
| The associated attachments. |
relationships.delivery_lead_time_for_shipment |
| The delivery lead time for the associated shipment. |
relationships.market |
| The associated market. |
relationships.shipping_category |
| The shipping category for which this shipping method is available. |
relationships.shipping_method_tiers |
| The associated shipping method tiers (meaningful when billing_scheme != 'flat'). |
relationships.shipping_weight_tiers |
| The associated shipping weight tiers (meaningful when billing_scheme != 'flat'). |
relationships.shipping_zone |
| The shipping zone that is used to match the order shipping address. |
relationships.stock_location |
| The stock location for which this shipping method is available. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated