ShippingLine

Version 2019-04 (latest)

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

Show definition

"""
Represents the shipping details that the customer chose for their order.
"""
type ShippingLine {
  """
  Whether the shipping line is custom.
  """
  custom: Boolean!
  """
  The discounts that have been allocated onto the shipping line by discount applications.
  """
  discountAllocations: [DiscountAllocation!]!
  """
  The pre-tax shipping price with discounts applied.
  """
  discountedPrice: MoneyV2!
  """
  The pre-tax shipping price with discounts applied in shop and presentment currencies.
  """
  discountedPriceSet: MoneyBag!
  """
  The pre-tax shipping price without any discounts applied.
  """
  originalPrice: MoneyV2!
  """
  The pre-tax shipping price without any discounts applied in shop and presentment currencies.
  """
  originalPriceSet: MoneyBag!
  """
  Returns the price of the shipping line.
  """
  price: Money!
  """
  Returns the human-readable unique identifier for the shipping line.
  """
  shippingRateHandle: String
  """
  Returns the title of the shipping line.
  """
  title: String!
}

Fields

custom (Boolean!)

Whether the shipping line is custom.

discountAllocations ([DiscountAllocation!]!)

The discounts that have been allocated onto the shipping line by discount applications.

discountedPriceSet (MoneyBag!)

The pre-tax shipping price with discounts applied in shop and presentment currencies.

originalPriceSet (MoneyBag!)

The pre-tax shipping price without any discounts applied in shop and presentment currencies.

shippingRateHandle (String)

Returns the human-readable unique identifier for the shipping line.

title (String!)

Returns the title of the shipping line.

Deprecated fields

Show/Hide
discountedPrice (MoneyV2!) deprecated

The pre-tax shipping price with discounts applied.

Deprecation warning

Use discountedPriceSet instead

originalPrice (MoneyV2!) deprecated

The pre-tax shipping price without any discounts applied.

Deprecation warning

Use originalPriceSet instead

price (Money!) deprecated

Returns the price of the shipping line.

Deprecation warning

Use originalPriceSet instead

Sign up for a Partner account to get started.

Sign up