Choose a version:

ShippingLine

object

Represents the shipping details that the customer chose for their order.

Anchor to FieldsFields

Anchor to carrierIdentifiercarrierIdentifier •String: A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
Anchor to codecode •String: A reference to the shipping method.
Anchor to currentDiscountedPriceSetcurrentDiscountedPriceSet •MoneyBag!non-null: The current shipping price after applying refunds, after applying discounts. If the parent `order.taxesIncluded`` field is true, then this price includes taxes. Otherwise, this field is the pre-tax price.
Anchor to customcustom •Boolean!non-null: Whether the shipping line is custom or not.
Anchor to deliveryCategorydeliveryCategory •String: The general classification of the delivery method.
Anchor to discountAllocationsdiscountAllocations •[DiscountAllocation!]!non-null: The discounts that have been allocated to the shipping line.
Anchor to discountedPriceSetdiscountedPriceSet •MoneyBag!non-null: The shipping price after applying discounts. If the parent order.taxesIncluded field is true, then this price includes taxes. If not, it's the pre-tax price. As of API version 2024-07, this will be calculated including cart level discounts, such as the free shipping discount.
Anchor to idid •ID: A globally-unique ID.
Anchor to isRemovedisRemoved •Boolean!non-null: Whether the shipping line has been removed.
Anchor to originalPriceSetoriginalPriceSet •MoneyBag!non-null: The pre-tax shipping price without any discounts applied.
Anchor to phonephone •String: The phone number at the shipping address.
Anchor to shippingRateHandleshippingRateHandle •String: A unique identifier for the shipping rate. The format can change without notice and isn't meant to be shown to users.
Anchor to sourcesource •String: Returns the rate source for the shipping line.
Anchor to taxLinestaxLines •[TaxLine!]!non-null: The TaxLine objects connected to this shipping line.
Anchor to titletitle •String!non-null: Returns the title of the shipping line.

Deprecated fields

Anchor to discountedPricediscountedPrice •MoneyV2!non-nullDeprecated
Anchor to originalPriceoriginalPrice •MoneyV2!non-nullDeprecated
Anchor to priceprice •Money!non-nullDeprecated
Anchor to requestedFulfillmentServicerequestedFulfillmentService •FulfillmentServiceDeprecated

Was this section helpful?