# The shipping method object 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** | `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.**tax\_code** | `string` | The freight tax identifier code, specific for a particular tax calculator. | | 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.**shared\_secret** | `string` | The shared secret used to sign the external request payload. | | attributes.**external\_includes** | `array` | List of related resources that will be included in the request to the external callback. Please do consult the documentation to check on which resource the includes are related (i.e. the order) and the defaults in case no list is provided. | | attributes.**\_add\_tags** | `string` | Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels. | | attributes.**\_remove\_tags** | `string` | Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. 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.**notifications** | `array` | The associated notifications. | | relationships.**events** | `array` | The associated events. | | relationships.**tags** | `array` | The associated tags. Cannot be passed by sales channels. | | relationships.**versions** | `array` | The associated changes. | | relationships.**event\_stores** | `array` | The associated event stores. | | meta.**mode** | `string` | The resource environment (can be one of `test` or `live`) |