ShippingMethod Object

Description

Shipping method option. Static policy methods carry name and total only; methods quoted live by the shipping service (Sendcloud/Shippo) also fill the carrier fields.

Declaration

type ShippingMethod {
    name: String
    total: Float
    rateId: String
    provider: String
    carrier: String
    service: String
    currency: String
    estimatedDays: Int
    servicePointRequired: Boolean
    contractId: Int
}

Fields

Name	Type	Description
name	String	Name of the shipping method (e.g., "Standard Shipping", "Express Delivery").
total	Float	Total cost for this shipping method.
rateId	String	Provider rate identifier — Shippo rate object id or Sendcloud shipping option code.
provider	String	Aggregator the quote came from. Valid values are "sendcloud" or "shippo".
carrier	String	Carrier name (e.g. "PostNL", "Colissimo").
service	String	Service level name (e.g. "Standard", "Express").
currency	String	ISO 4217 currency of the quoted price.
estimatedDays	Int	Estimated delivery time in days.
servicePointRequired	Boolean	Whether this option requires delivery to a service point.
contractId	Int	Sendcloud contract identifier required when purchasing the label.