checkoutAndAccountsConfigurations

Query checkout and accounts configurations — supports a search `query`, `sortKey`, and cursor paging.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the checkoutAndAccountsConfigurations action (under Checkout).
Fill in the fields below, then reference the result from later steps as {{checkoutandaccountsconfigurations.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 CheckoutAndAccountsConfigurations($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: CheckoutAndAccountsConfigurationsGraphQLSortKeys, $query: String) {
  checkoutAndAccountsConfigurations(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        branding
        createdAt
        editedAt
        id
        isPublished
        name
        overrides
        updatedAt
      }
    }
    nodes {
      branding {
        components
        designTokens
        surfaces
      }
      createdAt
      editedAt
      id
      isPublished
      name
      overrides {
        branding
        createdAt
        editedAt
        id
        name
        updatedAt
      }
      updatedAt
    }
    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_ATEDITED_ATIDIS_PUBLISHED

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | is_published | boolean | | one_page_checkout_enabled | boolean | | typ_osp_pages_enabled | boolean | 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 {{checkoutandaccountsconfigurations.response.data.data.checkoutAndAccountsConfigurations}}. If the API returns errors, the step fails and they are at {{checkoutandaccountsconfigurations.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

brandingobject

createdAtobject

editedAtobject

idobject

isPublishedobject

nameobject

overridesobject

updatedAtobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?