API reference
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
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' or 'weight_tiered'.
attributes.currency_code
string
The international 3-letter currency code as defined by the ISO 4217 standard.
attributes._disable
boolean
Send this attribute if you want to mark the shipping method as disabled.
attributes._enable
boolean
Send this attribute if you want to mark the shipping method as enabled.
attributes.disabled_at
datetime
Time at which the shipping method was disabled.
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.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.
Copy link