selling
Retrieves a paginated list of
objects that belong to the app making the API call. Selling plan groups are
selling methods like subscriptions, preorders, or other purchase options that
merchants offer to customers.
Each group has one or more
objects that define specific billing and delivery schedules, pricing
adjustments, and policies. Use the query
argument to search by name or filter results by other criteria.
Learn more about building selling plans.
SellingPlanGroupConnection arguments
- after (String)
- before (String)
- first (Int)
- last (Int)
- query (String)
- reverse (Boolean)
- sortKey (SellingPlanGroupSortKeys)
- 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 hoodieapp_id id -
-
-category string A comma-separated list of categories. -
-
-
-created_at time delivery_frequency string id id Filter by idrange.- id:1234
-id:>=1234
-id:<=1234name string percentage_off float You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). - Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Selling
Key Plan Group 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 ([SellingPlanGroupEdge!]!)
- nodes ([SellingPlanGroup!]!)
- pageInfo (PageInfo!)
- Anchor to edgesedges•[Selling
Plan Group 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•[Selling
Plan Group!]! non-null A list of nodes that are contained in SellingPlanGroupEdge. 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.