DiscountCodeBasic object
A basic code discount.
Required access
Apps must have read_discounts
access scope.
On this page
Connections
-
codes (
DiscountRedeemCodeConnection!
)A list of redeem codes for the discount.
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:
times_used
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(DiscountCodeSortKeys
)Sort the underlying list by the given key.
Default value:ID
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.
-
customerGets (
DiscountCustomerGets!
)The qualifying items in an order, the quantity of each one, and the total value of the discount.
-
customerSelection (
DiscountCustomerSelection!
)The customers that can use the discount.
-
endsAt (
DateTime
)The date and time when the discount ends. For open-ended discounts, use
null
. -
hasTimelineComment (
Boolean!
)Indicates whether there are any timeline comments on the discount.
-
minimumRequirement (
DiscountMinimumRequirement
)The minimum subtotal or quantity that's required for the discount to be applied.
-
recurringCycleLimit (
Int
)The number of times a discount applies on recurring purchases (subscriptions).
-
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.
-
totalSales (
MoneyV2
)The total sales from orders where the discount was used.
-
usageLimit (
Int
)The maximum number of times that the discount can be used.
Mutations for DiscountCodeBasic
-
Creates a basic code discount.
-
Updates a basic code discount.
A basic code discount.
Required access
Apps must have read_discounts
access scope.
On this page
Connections
-
codes (
DiscountRedeemCodeConnection!
)A list of redeem codes for the discount.
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:
times_used
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(DiscountCodeSortKeys
)Sort the underlying list by the given key.
Default value:ID
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.
-
customerGets (
DiscountCustomerGets!
)The qualifying items in an order, the quantity of each one, and the total value of the discount.
-
customerSelection (
DiscountCustomerSelection!
)The customers that can use the discount.
-
endsAt (
DateTime
)The date and time when the discount ends. For open-ended discounts, use
null
. -
hasTimelineComment (
Boolean!
)Indicates whether there are any timeline comments on the discount.
-
minimumRequirement (
DiscountMinimumRequirement
)The minimum subtotal or quantity that's required for the discount to be applied.
-
recurringCycleLimit (
Int
)The number of times a discount applies on recurring purchases (subscriptions).
-
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.
-
totalSales (
MoneyV2
)The total sales from orders where the discount was used.
-
usageLimit (
Int
)The maximum number of times that the discount can be used.
Mutations for DiscountCodeBasic
-
Creates a basic code discount.
-
Updates a basic code discount.
A basic code discount.
Required access
Apps must have read_discounts
access scope.
On this page
Connections
-
codes (
DiscountRedeemCodeConnection!
)A list of redeem codes for the discount.
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:
times_used
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(DiscountCodeSortKeys
)Sort the underlying list by the given key.
Default value:ID
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.
-
customerGets (
DiscountCustomerGets!
)The qualifying items in an order, the quantity of each one, and the total value of the discount.
-
customerSelection (
DiscountCustomerSelection!
)The customers that can use the discount.
-
endsAt (
DateTime
)The date and time when the discount ends. For open-ended discounts, use
null
. -
hasTimelineComment (
Boolean!
)Indicates whether there are any timeline comments on the discount.
-
minimumRequirement (
DiscountMinimumRequirement
)The minimum subtotal or quantity that's required for the discount to be applied.
-
recurringCycleLimit (
Int
)The number of times a discount applies on recurring purchases (subscriptions).
-
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.
-
totalSales (
MoneyV2
)The total sales from orders where the discount was used.
-
usageLimit (
Int
)The maximum number of times that the discount can be used.
Mutations for DiscountCodeBasic
-
Creates a basic code discount.
-
Updates a basic code discount.
A basic code discount.
Required access
Apps must have read_discounts
access scope.
On this page
Connections
-
codes (
DiscountRedeemCodeConnection!
)A list of redeem codes for the discount.
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:
times_used
See the detailed search syntax for more information about using filters.
reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
savedSearchId
(ID
)ID of an existing saved search. The search’s query string is used as the query argument.
sortKey
(DiscountCodeSortKeys
)Sort the underlying list by the given key.
Default value:ID
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.
-
customerGets (
DiscountCustomerGets!
)The qualifying items in an order, the quantity of each one, and the total value of the discount.
-
customerSelection (
DiscountCustomerSelection!
)The customers that can use the discount.
-
endsAt (
DateTime
)The date and time when the discount ends. For open-ended discounts, use
null
. -
hasTimelineComment (
Boolean!
)Indicates whether there are any timeline comments on the discount.
-
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.
-
totalSales (
MoneyV2
)The total sales from orders where the discount was used.
-
usageLimit (
Int
)The maximum number of times that the discount can be used.
Mutations for DiscountCodeBasic
-
Creates a basic code discount.
-
Updates a basic code discount.
A basic code discount.
Required access
Apps must have read_discounts
access scope.
On this page
Connections
-
codes (
DiscountRedeemCodeConnection!
)A list of redeem codes for the discount.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
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.
-
customerGets (
DiscountCustomerGets!
)The qualifying items in an order, the quantity of each one, and the total value of the discount.
-
customerSelection (
DiscountCustomerSelection!
)The customers that can use 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 that the discount can be used.
Mutations for DiscountCodeBasic
-
Creates a basic code discount.
-
Updates a basic code discount.
A basic code discount.
Required access
Apps must have read_discounts
access scope.
On this page
Connections
-
codes (
DiscountRedeemCodeConnection!
)A list of redeem codes for the discount.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
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.
-
customerGets (
DiscountCustomerGets!
)The qualifying items in an order, the quantity of each one, and the total value of the discount.
-
customerSelection (
DiscountCustomerSelection!
)The customers that can use 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 that the discount can be used.
Mutations for DiscountCodeBasic
-
Creates a basic code discount.
-
Updates a basic code discount.
A basic code discount.
Required access
Apps must have read_discounts
access scope.
On this page
Connections
-
codes (
DiscountRedeemCodeConnection!
)A list of redeem codes for the discount.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
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.
-
customerGets (
DiscountCustomerGets!
)The qualifying items in an order, the quantity of each one, and the total value of the discount.
-
customerSelection (
DiscountCustomerSelection!
)The customers that can use 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 that the discount can be used.
Mutations for DiscountCodeBasic
-
Creates a basic code discount.
-
Updates a basic code discount.
A basic code discount.
Required access
Apps must have read_discounts
access scope.
On this page
Connections
-
codes (
DiscountRedeemCodeConnection!
)A list of redeem codes for the discount.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
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.
-
customerGets (
DiscountCustomerGets!
)The qualifying items in an order, the quantity of each one, and the total value of the discount.
-
customerSelection (
DiscountCustomerSelection!
)The customers that can use 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 that the discount can be used.
Mutations for DiscountCodeBasic
-
Creates a basic code discount.
-
Updates a basic code discount.
A basic code discount.
Required access
Apps must have read_discounts
access scope.
On this page
Connections
-
codes (
DiscountRedeemCodeConnection!
)A list of redeem codes for the discount.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
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.
-
customerGets (
DiscountCustomerGets!
)The qualifying items in an order, the quantity of each one, and the total value of the discount.
-
customerSelection (
DiscountCustomerSelection!
)The customers that can use 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 that the discount can be used.
Mutations for DiscountCodeBasic
-
Creates a basic code discount.
-
Updates a basic code discount.
A basic code discount.
Required access
Apps must have read_discounts
access scope.
On this page
Connections
-
codes (
DiscountRedeemCodeConnection!
)A list of redeem codes for the discount.
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.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
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.
-
customerGets (
DiscountCustomerGets!
)The qualifying items in an order, the quantity of each one, and the total value of the discount.
-
customerSelection (
DiscountCustomerSelection!
)The customers that can use 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 that the discount can be used.
Mutations for DiscountCodeBasic
-
Creates a basic code discount.
-
Updates a basic code discount.