cashTrackingSessions

Returns a shop's cash tracking sessions for locations with a POS Pro subscription. Tip: To query for cash tracking sessions in bulk, you can perform a bulk operation.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the cashTrackingSessions action (under Cash).
Fill in the fields below, then reference the result from later steps as {{cashtrackingsessions.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 CashTrackingSessions($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: CashTrackingSessionsSortKeys, $query: String) {
  cashTrackingSessions(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        cashTrackingEnabled
        closingBalance
        closingNote
        closingStaffMember
        closingTime
        expectedBalance
        expectedClosingBalance
        expectedOpeningBalance
        id
        location
        netCashSales
        openingBalance
        openingNote
        openingStaffMember
        openingTime
        registerName
        totalAdjustments
        totalCashRefunds
        totalCashSales
        totalDiscrepancy
      }
    }
    nodes {
      cashTrackingEnabled
      closingBalance {
        amount
        currencyCode
      }
      closingNote
      closingStaffMember {
        accountType
        active
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
        privateData
      }
      closingTime
      expectedBalance {
        amount
        currencyCode
      }
      expectedClosingBalance {
        amount
        currencyCode
      }
      expectedOpeningBalance {
        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
      }
      netCashSales {
        amount
        currencyCode
      }
      openingBalance {
        amount
        currencyCode
      }
      openingNote
      openingStaffMember {
        accountType
        active
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
        privateData
      }
      openingTime
      registerName
      totalAdjustments {
        amount
        currencyCode
      }
      totalCashRefunds {
        amount
        currencyCode
      }
      totalCashSales {
        amount
        currencyCode
      }
      totalDiscrepancy {
        amount
        currencyCode
      }
    }
    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 ofCLOSING_TIME_ASCCLOSING_TIME_DESCIDOPENING_TIME_ASCOPENING_TIME_DESCTOTAL_DISCREPANCY_ASCTOTAL_DISCREPANCY_DESC

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | closing_time | time | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | location_id | id | | opening_time | time | | point_of_sale_device_ids | string | | status | string | 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": "CLOSING_TIME_ASC",
  "query": "string"
}

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

cashTrackingEnabledobject

closingBalanceobject

closingNoteobject

closingStaffMemberobject

closingTimeobject

expectedBalanceobject

expectedClosingBalanceobject

expectedOpeningBalanceobject

idobject

locationobject

netCashSalesobject

openingBalanceobject

openingNoteobject

openingStaffMemberobject

openingTimeobject

registerNameobject

totalAdjustmentsobject

totalCashRefundsobject

totalCashSalesobject

totalDiscrepancyobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?