DiscountAutomaticBxgy

Version 2019-04

An automatic BXGY discount.

Show definition
"""
An automatic BXGY discount.
"""
type DiscountAutomaticBxgy implements HasEvents & Node {
  """
  The date and time when the discount was created.
  """
  createdAt: DateTime!
  """
  The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.
  """
  customerBuys: DiscountCustomerBuys!
  """
  The qualifying items in an order, the quantity of each one, and the total value of the discount.
  """
  customerGets: DiscountCustomerGets!
  """
  The date and time when the discount ends. For open-ended discounts, use `null`.
  """
  endsAt: DateTime
  """
  The paginated list of events associated with the host subject.
  """
  events(
    """
    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
    """
    Supported filter parameters:
     - `comments`
     - `created_at`
     - `subject_type`
     - `verb`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: EventSortKeys = ID
  ): EventConnection!
  """
  A legacy unique identifier for the discount.
  """
  id: ID!
  """
  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 number of times that the discount has been used.
  """
  usageCount: Int!
  """
  The maximum number of times that the discount can be applied to an order.
  """
  usesPerOrderLimit: Int
}

Implements

Connections

events (EventConnection!)

The paginated list of events associated with the host subject.

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.

query ( String )

Supported filter parameters:

  • comments
  • created_at
  • subject_type
  • verb

See the detailed search syntax.

reverse ( Boolean )

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

sortKey ( EventSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

createdAt (DateTime!)

The date and time when the discount was created.

customerBuys (DiscountCustomerBuys!)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

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

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.

usageCount (Int!)

The number of times that the discount has been used.

usesPerOrderLimit (Int)

The maximum number of times that the discount can be applied to an order.

Deprecated fields

Show/Hide
id (ID!) deprecated

A legacy unique identifier for the discount.

Deprecation warning

Use DiscountAutomaticNode.id instead.

Version 2019-07 (Latest)

An automatic BXGY discount.

Show definition
"""
An automatic BXGY discount.
"""
type DiscountAutomaticBxgy implements HasEvents & Node {
  """
  The date and time when the discount was created.
  """
  createdAt: DateTime!
  """
  The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.
  """
  customerBuys: DiscountCustomerBuys!
  """
  The qualifying items in an order, the quantity of each one, and the total value of the discount.
  """
  customerGets: DiscountCustomerGets!
  """
  The date and time when the discount ends. For open-ended discounts, use `null`.
  """
  endsAt: DateTime
  """
  The paginated list of events associated with the host subject.
  """
  events(
    """
    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
    """
    Supported filter parameters:
     - `comments`
     - `created_at`
     - `subject_type`
     - `verb`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: EventSortKeys = ID
  ): EventConnection!
  """
  A legacy unique identifier for the discount.
  """
  id: ID!
  """
  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 number of times that the discount has been used.
  """
  usageCount: Int!
  """
  The maximum number of times that the discount can be applied to an order.
  """
  usesPerOrderLimit: Int
}

Implements

Connections

events (EventConnection!)

The paginated list of events associated with the host subject.

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.

query ( String )

Supported filter parameters:

  • comments
  • created_at
  • subject_type
  • verb

See the detailed search syntax.

reverse ( Boolean )

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

sortKey ( EventSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

createdAt (DateTime!)

The date and time when the discount was created.

customerBuys (DiscountCustomerBuys!)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

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

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.

usageCount (Int!)

The number of times that the discount has been used.

usesPerOrderLimit (Int)

The maximum number of times that the discount can be applied to an order.

Deprecated fields

Show/Hide
id (ID!) deprecated

A legacy unique identifier for the discount.

Deprecation warning

Use DiscountAutomaticNode.id instead.

Version 2019-10 (Release candidate)

An automatic BXGY discount.

Show definition
"""
An automatic BXGY discount.
"""
type DiscountAutomaticBxgy implements HasEvents & Node {
  """
  The date and time when the discount was created.
  """
  createdAt: DateTime!
  """
  The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.
  """
  customerBuys: DiscountCustomerBuys!
  """
  The qualifying items in an order, the quantity of each one, and the total value of the discount.
  """
  customerGets: DiscountCustomerGets!
  """
  The date and time when the discount ends. For open-ended discounts, use `null`.
  """
  endsAt: DateTime
  """
  The paginated list of events associated with the host subject.
  """
  events(
    """
    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
    """
    Supported filter parameters:
     - `comments`
     - `created_at`
     - `subject_type`
     - `verb`
    See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax).
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: EventSortKeys = ID
  ): EventConnection!
  """
  A legacy unique identifier for the discount.
  """
  id: ID!
  """
  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 number of times that the discount has been used.
  """
  usageCount: Int!
  """
  The maximum number of times that the discount can be applied to an order.
  """
  usesPerOrderLimit: Int
}

Implements

Connections

events (EventConnection!)

The paginated list of events associated with the host subject.

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.

query ( String )

Supported filter parameters:

  • comments
  • created_at
  • subject_type
  • verb

See the detailed search syntax.

reverse ( Boolean )

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

sortKey ( EventSortKeys )

Sort the underlying list by the given key.
Default value: true

Fields

createdAt (DateTime!)

The date and time when the discount was created.

customerBuys (DiscountCustomerBuys!)

The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

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

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.

usageCount (Int!)

The number of times that the discount has been used.

usesPerOrderLimit (Int)

The maximum number of times that the discount can be applied to an order.

Deprecated fields

Show/Hide
id (ID!) deprecated

A legacy unique identifier for the discount.

Deprecation warning

Use DiscountAutomaticNode.id instead.

Sign up for a Partner account to get started.

Sign up