PriceRuleShippingLineEntitlements

Version 2019-04

The shipping lines to which the price rule applies to.

Required access

read_price_rules access scope

Show definition
"""
The shipping lines to which the price rule applies to.
"""
type PriceRuleShippingLineEntitlements {
  """
  The codes for the countries to which the price rule applies to.
  """
  countryCodes: [CountryCode!]!
  """
  Whether the price rule is applicable to countries that have not been defined in the shop's shipping zones.
  """
  includeRestOfWorld: Boolean!
  """
  Whether the price rule applies to all shipping lines.
  """
  targetAllShippingLines: Boolean!
}

Fields

countryCodes ([CountryCode!]!)

The codes for the countries to which the price rule applies to.

includeRestOfWorld (Boolean!)

Whether the price rule is applicable to countries that have not been defined in the shop's shipping zones.

targetAllShippingLines (Boolean!)

Whether the price rule applies to all shipping lines.

Version 2019-07 (Latest)

The shipping lines to which the price rule applies to.

Required access

read_price_rules access scope

Show definition
"""
The shipping lines to which the price rule applies to.
"""
type PriceRuleShippingLineEntitlements {
  """
  The codes for the countries to which the price rule applies to.
  """
  countryCodes: [CountryCode!]!
  """
  Whether the price rule is applicable to countries that have not been defined in the shop's shipping zones.
  """
  includeRestOfWorld: Boolean!
  """
  Whether the price rule applies to all shipping lines.
  """
  targetAllShippingLines: Boolean!
}

Fields

countryCodes ([CountryCode!]!)

The codes for the countries to which the price rule applies to.

includeRestOfWorld (Boolean!)

Whether the price rule is applicable to countries that have not been defined in the shop's shipping zones.

targetAllShippingLines (Boolean!)

Whether the price rule applies to all shipping lines.

Version 2019-10 (Release candidate)

The shipping lines to which the price rule applies to.

Required access

read_price_rules access scope

Show definition
"""
The shipping lines to which the price rule applies to.
"""
type PriceRuleShippingLineEntitlements {
  """
  The codes for the countries to which the price rule applies to.
  """
  countryCodes: [CountryCode!]!
  """
  Whether the price rule is applicable to countries that have not been defined in the shop's shipping zones.
  """
  includeRestOfWorld: Boolean!
  """
  Whether the price rule applies to all shipping lines.
  """
  targetAllShippingLines: Boolean!
}

Fields

countryCodes ([CountryCode!]!)

The codes for the countries to which the price rule applies to.

includeRestOfWorld (Boolean!)

Whether the price rule is applicable to countries that have not been defined in the shop's shipping zones.

targetAllShippingLines (Boolean!)

Whether the price rule applies to all shipping lines.

Sign up for a Partner account to get started.

Sign up