We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

DiscountCodeFreeShipping

Version 2019-07 (Latest)

A free shipping code discount.

Show definition
"""
A free shipping code discount.
"""
type DiscountCodeFreeShipping {
  """
  Whether the discount can be applied only once per customer.
  """
  appliesOncePerCustomer: Boolean!
  """
  The number of times that the discount has been used.
  """
  asyncUsageCount: Int!
  """
  The number of redeem codes for the discount.
  """
  codeCount: Int!
  """
  A list of redeem codes for the discount.
  """
  codes(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): DiscountRedeemCodeConnection!
  """
  The date and time when the discount was created.
  """
  createdAt: DateTime!
  """
  The customers that can use the discount.
  """
  customerSelection: DiscountCustomerSelection!
  """
  A shipping destination that qualifies for the discount.
  """
  destinationSelection: DiscountShippingDestinationSelection!
  """
  The date and time when the discount ends. For open-ended discounts, use `null`.
  """
  endsAt: DateTime
  """
  The minimum subtotal or quantity that's required for the discount to be applied.
  """
  minimumRequirement: DiscountMinimumRequirement
  """
  A short summary of the discount.
  """
  shortSummary: String!
  """
  The date and time when the discount starts.
  """
  startsAt: DateTime!
  """
  The status of the discount.
  """
  status: DiscountStatus!
  """
  A detailed summary of the discount.
  """
  summary: String!
  """
  The title of the discount.
  """
  title: String!
  """
  The maximum number of times the code discount can be used.
  """
  usageLimit: Int
}

Connections

codes (DiscountRedeemCodeConnection!)

A list of redeem codes for the discount.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

Fields

appliesOncePerCustomer (Boolean!)

Whether the discount can be applied only once per customer.

asyncUsageCount (Int!)

The number of times that the discount has been used.

codeCount (Int!)

The number of redeem codes for the discount.

createdAt (DateTime!)

The date and time when the discount was created.

customerSelection (DiscountCustomerSelection!)

The customers that can use the discount.

destinationSelection (DiscountShippingDestinationSelection!)

A shipping destination that qualifies for the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirement)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of the discount.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

usageLimit (Int)

The maximum number of times the code discount can be used.

Version 2019-10 (Release candidate)

A free shipping code discount.

Show definition
"""
A free shipping code discount.
"""
type DiscountCodeFreeShipping {
  """
  Whether the discount can be applied only once per customer.
  """
  appliesOncePerCustomer: Boolean!
  """
  The number of times that the discount has been used.
  """
  asyncUsageCount: Int!
  """
  The number of redeem codes for the discount.
  """
  codeCount: Int!
  """
  A list of redeem codes for the discount.
  """
  codes(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): DiscountRedeemCodeConnection!
  """
  The date and time when the discount was created.
  """
  createdAt: DateTime!
  """
  The customers that can use the discount.
  """
  customerSelection: DiscountCustomerSelection!
  """
  A shipping destination that qualifies for the discount.
  """
  destinationSelection: DiscountShippingDestinationSelection!
  """
  The date and time when the discount ends. For open-ended discounts, use `null`.
  """
  endsAt: DateTime
  """
  The minimum subtotal or quantity that's required for the discount to be applied.
  """
  minimumRequirement: DiscountMinimumRequirement
  """
  A short summary of the discount.
  """
  shortSummary: String!
  """
  The date and time when the discount starts.
  """
  startsAt: DateTime!
  """
  The status of the discount.
  """
  status: DiscountStatus!
  """
  A detailed summary of the discount.
  """
  summary: String!
  """
  The title of the discount.
  """
  title: String!
  """
  The maximum number of times the code discount can be used.
  """
  usageLimit: Int
}

Connections

codes (DiscountRedeemCodeConnection!)

A list of redeem codes for the discount.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: true

Fields

appliesOncePerCustomer (Boolean!)

Whether the discount can be applied only once per customer.

asyncUsageCount (Int!)

The number of times that the discount has been used.

codeCount (Int!)

The number of redeem codes for the discount.

createdAt (DateTime!)

The date and time when the discount was created.

customerSelection (DiscountCustomerSelection!)

The customers that can use the discount.

destinationSelection (DiscountShippingDestinationSelection!)

A shipping destination that qualifies for the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirement)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of the discount.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

usageLimit (Int)

The maximum number of times the code discount can be used.

Sign up for a Partner account to get started.

Sign up