ShippingLine object

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

On this page

Fields

  • carrierIdentifier ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
  • code ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A reference to the shipping method.
  • custom ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the shipping line is custom or not.
  • deliveryCategory ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The general classification of the delivery method.
  • discountAllocations ([[DiscountAllocation!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/discountallocation))
    The discounts that have been allocated to the shipping line.
  • discountedPriceSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The pre-tax shipping price with discounts applied.
  • id ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • originalPriceSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The pre-tax shipping price without any discounts applied.
  • phone ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The phone number at the shipping address.
  • requestedFulfillmentService ([FulfillmentService](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentservice))
    The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.
  • shippingRateHandle ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.
  • source ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Returns the rate source for the shipping line.
  • taxLines ([[TaxLine!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/taxline))
    The TaxLine objects connected to this shipping line.
  • title ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Returns the title of the shipping line.

Types that return ShippingLine

  • [CalculatedDraftOrder.shippingLine](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculateddraftorder#shippingline-2021-01)
  • [DraftOrder.shippingLine](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorder#shippingline-2021-01)
  • [Order.shippingLine](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#shippingline-2021-01)
  • [Order.shippingLines](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#shippinglines-2021-01)

Deprecated fields

Show/Hide

  • discountedPrice ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2)) DEPRECATED
    The pre-tax shipping price with discounts applied.
    Deprecation warning
    Use discountedPriceSet instead
  • originalPrice ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2)) DEPRECATED
    The pre-tax shipping price without any discounts applied.
    Deprecation warning
    Use originalPriceSet instead
  • price ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01)) DEPRECATED
    Returns the price of the shipping line.
    Deprecation warning
    Use originalPriceSet instead

An auto-generated type for paginating through multiple ShippingLines.

On this page

Fields

  • edges ([[ShippingLineEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/shippingline))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
    Information to aid in pagination.

An auto-generated type which holds one ShippingLine and a cursor during pagination.

On this page

Fields

  • cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([ShippingLine!](https://shopify.dev/docs/admin-api/graphql/reference/orders/shippingline))
    The item at the end of ShippingLineEdge.

Types that return ShippingLineEdge

  • [ShippingLineConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/orders/shippingline#edges-2021-01)