younifyd
Menu

cashDrawers

Query cash drawers — supports a search `query`, `sortKey`, and cursor paging.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the cashDrawers action (under Cash).
  3. Fill in the fields below, then reference the result from later steps as {{cashdrawers.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 CashDrawers($first: Int, $after: String, $last: Int, $before: String, $query: String) {
  cashDrawers(
    first: $first
    after: $after
    last: $last
    before: $before
    query: $query
  ) {
    edges {
      cursor
      node {
        balance
        id
        location
        name
      }
    }
    nodes {
      balance {
        amount
        currencyCode
      }
      id
      location {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      name
    }
    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).

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` | | location_id | id | 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",
  "query": "string"
}

Response

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

edgesarray<object>
cursorobject
nodeobject
nodesarray<object>
balanceobject
idobject
locationobject
nameobject
pageInfoobject
endCursorstring
hasNextPageboolean
hasPreviousPageboolean
startCursorstring

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