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

DiscountAutomaticBxgy object

Version unstable

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

Fields

  • asyncUsageCount (Int!)

    The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.

  • 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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2021-07 (Release candidate)

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

Fields

  • asyncUsageCount (Int!)

    The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.

  • 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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2021-04 (Latest)

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

Fields

  • asyncUsageCount (Int!)

    The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.

  • 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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2021-01

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

Fields

  • asyncUsageCount (Int!)

    The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.

  • 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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2020-10

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

Fields

  • asyncUsageCount (Int!)

    The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.

  • 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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2020-07

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2020-04

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2020-01 (Unsupported)

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2019-10 (Unsupported)

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2019-07 (Unsupported)

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2019-04 (Unsupported)

An automatic BXGY discount.

Required access

Apps must have read_discounts access scope.

Connections

  • events (EventConnection!)

    The paginated list of events associated with the host subject.

    Argument Description
    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 for more information about using filters.

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

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.

  • usesPerOrderLimit (Int)

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

Mutations for DiscountAutomaticBxgy

Implements

Deprecated fields

  • id (ID!) deprecated

    A legacy unique identifier for the discount.

    Deprecation warning

    Use DiscountAutomaticNode.id instead.

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead