Skip to main content
Anchor to cashDrawer

cashDrawer

query

Requires read_cash_tracking access scope.

Returns a CashDrawer resource by ID.

Anchor to Arguments

Arguments

Anchor to idid
•ID!
required

The ID of the CashDrawer to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CashDrawerCashDrawer
•CashDrawer

A cash drawer for cash management.

Anchor to balancebalance
•MoneyV2!
non-null

The current balance in the cash drawer.

Anchor to cashActivitiescashActivities
•CashActivityConnection!
non-null

The activities on the cash drawer.

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
•CashActivitiesSortKeys
Default:TIME

Sort the underlying list by the given key.

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 type
•string
Anchor to staffMemberIdstaffMemberId
•ID

Filter activities by staff member.

Anchor to idid
•ID!
non-null

A unique ID for the cash drawer.

Anchor to locationlocation
•Location!
non-null

The location of the cash drawer.

Anchor to namename
•String!
non-null

The name of the cash drawer.

Anchor to netSalesnetSales
•MoneyV2!
non-null

The net sales for this cash drawer.

Arguments

Anchor to dateRangedateRange
•CashDrawerDateRangeInput!
required

The date and time range for filtering net sales.

Anchor to pointOfSaleDevicespointOfSaleDevices
•PointOfSaleDeviceConnection

The Point of Sale devices assigned to this cash drawer.

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 totalAdjustmentstotalAdjustments
•MoneyV2!
non-null

The total adjustments for this cash drawer.

Arguments

Anchor to dateRangedateRange
•CashDrawerDateRangeInput!
required

The date and time range for filtering adjustments.

Anchor to totalDiscrepanciestotalDiscrepancies
•MoneyV2!
non-null

The total discrepancies for this cash drawer.

Arguments

Anchor to dateRangedateRange
•CashDrawerDateRangeInput!
required

The date and time range for filtering discrepancies.

Anchor to totalRefundstotalRefunds
•MoneyV2!
non-null

The total refunds for this cash drawer.

Arguments

Anchor to dateRangedateRange
•CashDrawerDateRangeInput!
required

The date and time range for filtering refunds.

Anchor to totalSalestotalSales
•MoneyV2!
non-null

The total sales for this cash drawer.

Arguments

Anchor to dateRangedateRange
•CashDrawerDateRangeInput!
required

The date and time range for filtering sales.

Was this section helpful?