Skip to main content
Anchor to cashTrackingSession

cashTrackingSession

query

Returns a CashTrackingSession resource by ID.

Anchor to Arguments

Arguments

Anchor to idid
•ID!
required

The ID of the CashTrackingSession to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CashTrackingSessionCashTrackingSession
•CashTrackingSession

Tracks the balance in a cash drawer for a point of sale device over the course of a shift.

Anchor to adjustmentsadjustments
•CashTrackingAdjustmentConnection!
non-null

The adjustments made to the cash drawer during this session.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•AdjustmentsSortKeys
Default:TIME

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 cashTrackingEnabledcashTrackingEnabled
•Boolean!
non-null

Whether this session is tracking cash payments.

Anchor to cashTransactionscashTransactions
•OrderTransactionConnection!
non-null

The cash transactions made during this session.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•CashTrackingSessionTransactionsSortKeys
Default:PROCESSED_AT

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 queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to kind
•string
Anchor to processed_at
•time
Anchor to closingBalanceclosingBalance
•MoneyV2

The counted cash balance when the session was closed.

Anchor to closingNoteclosingNote
•String

The note entered when the session was closed.

Anchor to closingStaffMemberclosingStaffMember
•StaffMember

The user who closed the session.

Anchor to closingTimeclosingTime
•DateTime

When the session was closed.

Anchor to expectedBalanceexpectedBalance
•MoneyV2!
non-null

The expected balance at the end of the session or the expected current balance for sessions that are still open.

Anchor to expectedClosingBalanceexpectedClosingBalance
•MoneyV2

The amount that was expected to be in the cash drawer at the end of the session, calculated after the session was closed.

Anchor to expectedOpeningBalanceexpectedOpeningBalance
•MoneyV2

The amount expected to be in the cash drawer based on the previous session.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to locationlocation
•Location

The location of the point of sale device during this session.

Anchor to netCashSalesnetCashSales
•MoneyV2!
non-null

The net cash sales made for the duration of this cash tracking session.

Anchor to openingBalanceopeningBalance
•MoneyV2!
non-null

The counted cash balance when the session was opened.

Anchor to openingNoteopeningNote
•String

The note entered when the session was opened.

Anchor to openingStaffMemberopeningStaffMember
•StaffMember

The user who opened the session.

Anchor to openingTimeopeningTime
•DateTime!
non-null

When the session was opened.

Anchor to registerNameregisterName
•String!
non-null

The register name for the point of sale device that this session is tracking cash for.

Anchor to totalAdjustmentstotalAdjustments
•MoneyV2

The sum of all adjustments made during the session, excluding the final adjustment.

Anchor to totalCashRefundstotalCashRefunds
•MoneyV2!
non-null

The sum of all cash refunds for the duration of this cash tracking session.

Anchor to totalCashSalestotalCashSales
•MoneyV2!
non-null

The sum of all cash sales for the duration of this cash tracking session.

Anchor to totalDiscrepancytotalDiscrepancy
•MoneyV2

The total discrepancy for the session including starting and ending.

Was this section helpful?