API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

ShippingLine object

Version unstable

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

Fields

carrierIdentifier (String)

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

code (String)

A reference to the shipping method.

custom (Boolean!)

Whether the shipping line is custom or not.

deliveryCategory (String)

The general classification of the delivery method.

discountAllocations ([DiscountAllocation!]!)

The discounts that have been allocated to the shipping line.

discountedPriceSet (MoneyBag!)

The pre-tax shipping price with discounts applied.

id (ID)

Globally unique identifier.

originalPriceSet (MoneyBag!)

The pre-tax shipping price without any discounts applied.

phone (String)

The phone number at the shipping address.

requestedFulfillmentService (FulfillmentService)

The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.

shippingRateHandle (String)

A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.

source (String)

Returns the rate source for the shipping line.

taxLines ([TaxLine!]!)

The TaxLine objects connected to this shipping line.

title (String!)

Returns the title of the shipping line.

Types that return ShippingLine

Deprecated fields

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

Version unstable

Fields

edges ([ShippingLineEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Types that return ShippingLine

Version unstable

Fields

cursor (String!)

A cursor for use in pagination.

node (ShippingLine!)

The item at the end of ShippingLineEdge.

Types that return ShippingLine

Version 2021-01 (Release candidate)

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

Fields

carrierIdentifier (String)

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

code (String)

A reference to the shipping method.

custom (Boolean!)

Whether the shipping line is custom or not.

deliveryCategory (String)

The general classification of the delivery method.

discountAllocations ([DiscountAllocation!]!)

The discounts that have been allocated to the shipping line.

discountedPriceSet (MoneyBag!)

The pre-tax shipping price with discounts applied.

id (ID)

Globally unique identifier.

originalPriceSet (MoneyBag!)

The pre-tax shipping price without any discounts applied.

phone (String)

The phone number at the shipping address.

requestedFulfillmentService (FulfillmentService)

The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.

shippingRateHandle (String)

A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.

source (String)

Returns the rate source for the shipping line.

taxLines ([TaxLine!]!)

The TaxLine objects connected to this shipping line.

title (String!)

Returns the title of the shipping line.

Types that return ShippingLine

Deprecated fields

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

Version 2021-01 (Release candidate)

On this page

Fields

edges ([ShippingLineEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2021-01 (Release candidate)

Fields

cursor (String!)

A cursor for use in pagination.

node (ShippingLine!)

The item at the end of ShippingLineEdge.

Types that return ShippingLineEdge

Version 2020-10 (Latest)

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

Fields

carrierIdentifier (String)

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

code (String)

A reference to the shipping method.

custom (Boolean!)

Whether the shipping line is custom or not.

deliveryCategory (String)

The general classification of the delivery method.

discountAllocations ([DiscountAllocation!]!)

The discounts that have been allocated to the shipping line.

discountedPriceSet (MoneyBag!)

The pre-tax shipping price with discounts applied.

id (ID)

Globally unique identifier.

originalPriceSet (MoneyBag!)

The pre-tax shipping price without any discounts applied.

phone (String)

The phone number at the shipping address.

requestedFulfillmentService (FulfillmentService)

The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.

shippingRateHandle (String)

A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.

source (String)

Returns the rate source for the shipping line.

taxLines ([TaxLine!]!)

The TaxLine objects connected to this shipping line.

title (String!)

Returns the title of the shipping line.

Types that return ShippingLine

Deprecated fields

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

Version 2020-10 (Latest)

On this page

Fields

edges ([ShippingLineEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-10 (Latest)

Fields

cursor (String!)

A cursor for use in pagination.

node (ShippingLine!)

The item at the end of ShippingLineEdge.

Types that return ShippingLineEdge

Version 2020-07

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

Fields

carrierIdentifier (String)

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

code (String)

A reference to the shipping method.

custom (Boolean!)

Whether the shipping line is custom or not.

deliveryCategory (String)

The general classification of the delivery method.

discountAllocations ([DiscountAllocation!]!)

The discounts that have been allocated to the shipping line.

discountedPriceSet (MoneyBag!)

The pre-tax shipping price with discounts applied.

id (ID)

Globally unique identifier.

originalPriceSet (MoneyBag!)

The pre-tax shipping price without any discounts applied.

phone (String)

The phone number at the shipping address.

requestedFulfillmentService (FulfillmentService)

The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.

shippingRateHandle (String)

A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.

source (String)

Returns the rate source for the shipping line.

taxLines ([TaxLine!]!)

The TaxLine objects connected to this shipping line.

title (String!)

Returns the title of the shipping line.

Types that return ShippingLine

Deprecated fields

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

Version 2020-04

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

Fields

carrierIdentifier (String)

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

code (String)

A reference to the shipping method.

custom (Boolean!)

Whether the shipping line is custom or not.

deliveryCategory (String)

The general classification of the delivery method.

discountAllocations ([DiscountAllocation!]!)

The discounts that have been allocated to the shipping line.

discountedPriceSet (MoneyBag!)

The pre-tax shipping price with discounts applied.

id (ID)

Globally unique identifier.

originalPriceSet (MoneyBag!)

The pre-tax shipping price without any discounts applied.

phone (String)

The phone number at the shipping address.

requestedFulfillmentService (FulfillmentService)

The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.

shippingRateHandle (String)

A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.

source (String)

Returns the rate source for the shipping line.

taxLines ([TaxLine!]!)

The TaxLine objects connected to this shipping line.

title (String!)

Returns the title of the shipping line.

Types that return ShippingLine

Deprecated fields

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

Version 2020-01

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

Fields

carrierIdentifier (String)

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

code (String)

A reference to the shipping method.

custom (Boolean!)

Whether the shipping line is custom or not.

deliveryCategory (String)

The general classification of the delivery method.

discountAllocations ([DiscountAllocation!]!)

The discounts that have been allocated to the shipping line.

discountedPriceSet (MoneyBag!)

The pre-tax shipping price with discounts applied.

id (ID)

Globally unique identifier.

originalPriceSet (MoneyBag!)

The pre-tax shipping price without any discounts applied.

phone (String)

The phone number at the shipping address.

requestedFulfillmentService (FulfillmentService)

The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.

shippingRateHandle (String)

A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.

source (String)

Returns the rate source for the shipping line.

taxLines ([TaxLine!]!)

The TaxLine objects connected to this shipping line.

title (String!)

Returns the title of the shipping line.

Types that return ShippingLine

Deprecated fields

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

Version 2019-10 (Unsupported)

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

Fields

carrierIdentifier (String)

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

code (String)

A reference to the shipping method.

custom (Boolean!)

Whether the shipping line is custom or not.

deliveryCategory (String)

The general classification of the delivery method.

discountAllocations ([DiscountAllocation!]!)

The discounts that have been allocated to the shipping line.

discountedPriceSet (MoneyBag!)

The pre-tax shipping price with discounts applied.

id (ID)

Globally unique identifier.

originalPriceSet (MoneyBag!)

The pre-tax shipping price without any discounts applied.

phone (String)

The phone number at the shipping address.

requestedFulfillmentService (FulfillmentService)

The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.

shippingRateHandle (String)

A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.

source (String)

Returns the rate source for the shipping line.

taxLines ([TaxLine!]!)

The TaxLine objects connected to this shipping line.

title (String!)

Returns the title of the shipping line.

Types that return ShippingLine

Deprecated fields

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

Version 2019-07 (Unsupported)

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

Fields

carrierIdentifier (String)

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

code (String)

A reference to the shipping method.

custom (Boolean!)

Whether the shipping line is custom or not.

deliveryCategory (String)

The general classification of the delivery method.

discountAllocations ([DiscountAllocation!]!)

The discounts that have been allocated to the shipping line.

discountedPriceSet (MoneyBag!)

The pre-tax shipping price with discounts applied.

id (ID)

Globally unique identifier.

originalPriceSet (MoneyBag!)

The pre-tax shipping price without any discounts applied.

phone (String)

The phone number at the shipping address.

requestedFulfillmentService (FulfillmentService)

The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.

shippingRateHandle (String)

A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.

source (String)

Returns the rate source for the shipping line.

taxLines ([TaxLine!]!)

The TaxLine objects connected to this shipping line.

title (String!)

Returns the title of the shipping line.

Types that return ShippingLine

Deprecated fields

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

Version 2019-04 (Unsupported)

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

Fields

carrierIdentifier (String)

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

code (String)

A reference to the shipping method.

custom (Boolean!)

Whether the shipping line is custom or not.

deliveryCategory (String)

The general classification of the delivery method.

discountAllocations ([DiscountAllocation!]!)

The discounts that have been allocated to the shipping line.

discountedPriceSet (MoneyBag!)

The pre-tax shipping price with discounts applied.

id (ID)

Globally unique identifier.

originalPriceSet (MoneyBag!)

The pre-tax shipping price without any discounts applied.

phone (String)

The phone number at the shipping address.

requestedFulfillmentService (FulfillmentService)

The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.

shippingRateHandle (String)

A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.

source (String)

Returns the rate source for the shipping line.

taxLines ([TaxLine!]!)

The TaxLine objects connected to this shipping line.

title (String!)

Returns the title of the shipping line.

Types that return ShippingLine

Deprecated fields

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