code Discount Nodes
Requires Apps must have access scope.
Returns a list of code-based discounts.
DiscountCodeNodeConnection arguments
- after (String)
- before (String)
- first (Int)
- last (Int)
- query (String)
- reverse (Boolean)
- savedSearchId (ID)
- sortKey (CodeDiscountSortKeys)
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators.
name type description acceptable_values default_value example_use default string Filter by a case-insensitive search of multiple fields in a document. - query=Bob Norman
-query=title:green hoodiecombines_with string Filter by the discount classes that you can use in combination with [Shopify discount types](https://help.shopify.com/manual/discounts/discount-types). -
-
-| | combines_with.product_discounts_with_tags_on_same_cart_line | string | Filter by a combines with tag applied to discounts on the same cart line. Supports multiple tags separated by commas (e.g., combines_with.product_discounts_with_tags_on_same_cart_line:priority,exclusive). | | | -
-| | created_at | time | Filter by the date and time when the discount was created. | | | -
-
-| | discount_type | string | Filter by the discount type. | -app
-bogo
-
-
-percentage| | -| | ends_at | time | Filter by the date and time when the discount expires and is no longer available for customer use. | | | -
-
-| | id | id | Filter byidrange. | | | -id:1234
-id:>=1234
-id:<=1234| | starts_at | time | Filter by the date and time, in the shop's timezone, when the discount becomes active and is available for customer use. | | | -
-
-| | status | string | Filter by the status of the discount. | -activeexpired
-scheduled| | -status:scheduled| | tag | string | Filter by a tag applied to the discount. | | | -tag:loyalty
-tag:clearance| | times_used | integer | Filter by the number of times the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times.
This value is updated asynchronously. As a result, it might be different than the actual usage count. | | | -
-| | title | string | Filter by the discount name that displays to customers. | | | -title:Black Friday Sale| | type | string | Filter by the discount type. | -all
-
-app
-bxgy
-
-
-percentage| | -type:percentage| | updated_at | time | Filter by the date and time when the discount was last updated. | | | -
-
-| You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to savedSearchIdsaved•ID
Search Id The ID of a saved search. The search’s query string is used as the query argument.
- Anchor to sortKeysort•Code
Key Discount Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Anchor to Possible returnsPossible returns
- edges ([DiscountCodeNodeEdge!]!)
- nodes ([DiscountCodeNode!]!)
- pageInfo (PageInfo!)
- Anchor to edgesedges•[Discount
Code Node Edge!]! non-null The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
- Anchor to nodesnodes•[Discount
Code Node!]! non-null A list of nodes that are contained in DiscountCodeNodeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
- Anchor to pageInfopage•Page
Info Info! non-null An object that’s used to retrieve cursor information about the current page.