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

DiscountAutomaticBasic object

Version unstable

An automatic basic discount.

Required access

Apps must have read_discounts access scope.

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.

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

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

Mutations for DiscountAutomaticBasic

Deprecated fields

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2021-04 (Release candidate)

An automatic basic discount.

Required access

Apps must have read_discounts access scope.

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.

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

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

Mutations for DiscountAutomaticBasic

Deprecated fields

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2021-01 (Latest)

An automatic basic discount.

Required access

Apps must have read_discounts access scope.

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.

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

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

Mutations for DiscountAutomaticBasic

Deprecated fields

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2020-10

An automatic basic discount.

Required access

Apps must have read_discounts access scope.

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.

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

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

Mutations for DiscountAutomaticBasic

Deprecated fields

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2020-07

An automatic basic discount.

Required access

Apps must have read_discounts access scope.

Fields

  • createdAt (DateTime!)

    The date and time when the discount was created.

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

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

Mutations for DiscountAutomaticBasic

Deprecated fields

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2020-04

An automatic basic discount.

Required access

Apps must have read_discounts access scope.

Fields

  • createdAt (DateTime!)

    The date and time when the discount was created.

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

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

Mutations for DiscountAutomaticBasic

Deprecated fields

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2020-01 (Unsupported)

An automatic basic discount.

Required access

Apps must have read_discounts access scope.

Fields

  • createdAt (DateTime!)

    The date and time when the discount was created.

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

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

Mutations for DiscountAutomaticBasic

Deprecated fields

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2019-10 (Unsupported)

An automatic basic discount.

Required access

Apps must have read_discounts access scope.

Fields

  • createdAt (DateTime!)

    The date and time when the discount was created.

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

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

Mutations for DiscountAutomaticBasic

Deprecated fields

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2019-07 (Unsupported)

An automatic basic discount.

Required access

Apps must have read_discounts access scope.

Fields

  • createdAt (DateTime!)

    The date and time when the discount was created.

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

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

Mutations for DiscountAutomaticBasic

Deprecated fields

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead

Version 2019-04 (Unsupported)

An automatic basic discount.

Required access

Apps must have read_discounts access scope.

Fields

  • createdAt (DateTime!)

    The date and time when the discount was created.

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

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

Mutations for DiscountAutomaticBasic

Deprecated fields

  • usageCount (Int!) deprecated

    The number of times that the discount has been used.

    Deprecation warning

    Use asyncUsageCount instead