younifyd
Menu

sellingPlanGroups

Retrieves a paginated list of SellingPlanGroup objects that belong to the app making the API call.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the sellingPlanGroups action (under Selling).
  3. Fill in the fields below, then reference the result from later steps as {{sellingplangroups.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
query SellingPlanGroups($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: SellingPlanGroupSortKeys, $query: String) {
  sellingPlanGroups(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        appId
        createdAt
        description
        id
        merchantCode
        name
        options
        position
        productsCount
        summary
      }
    }
    nodes {
      appId
      createdAt
      description
      id
      merchantCode
      name
      options
      position
      productsCount {
        count
        precision
      }
      summary
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofCREATED_ATIDNAMEUPDATED_AT

querystring

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`<br/> - `query=title:green hoodie` | | app_id | id | | - `CURRENT`<br/> - `ALL`<br/> - `* (numeric app ID)` | `CURRENT` | | category | string | A comma-separated list of categories. | - `SUBSCRIPTION`<br/> - `PRE_ORDER`<br/> - `TRY_BEFORE_YOU_BUY`<br/> - `OTHER` | | created_at | time | | delivery_frequency | string | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | name | 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).

json
{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "CREATED_AT",
  "query": "string"
}

Response

Read the result with {{sellingplangroups.response.data.data.sellingPlanGroups}}. If the API returns errors, the step fails and they are at {{sellingplangroups.response.data.errors}}.

edgesarray<object>
cursorobject
nodeobject
nodesarray<object>
appIdobject
createdAtobject
descriptionobject
idobject
merchantCodeobject
nameobject
optionsobject
positionobject
productsCountobject
summaryobject
pageInfoobject
endCursorstring
hasNextPageboolean
hasPreviousPageboolean
startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.