Cash Drawer
Requires access scope.
A cash drawer for cash management.
Anchor to FieldsFields
- balance (MoneyV2!)
- cashActivities (CashActivityConnection!)
- id (ID!)
- location (Location!)
- name (String!)
- netSales (MoneyV2!)
- pointOfSaleDevices (PointOfSaleDeviceConnection)
- totalAdjustments (MoneyV2!)
- totalDiscrepancies (MoneyV2!)
- totalRefunds (MoneyV2!)
- totalSales (MoneyV2!)
- Anchor to balancebalance•Money
V2! non-null The current balance in the cash drawer.
- Anchor to cashActivitiescash•Cash
Activities Activity Connection! non-null The activities on the cash drawer.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Cash
Key Activities Sort Keys 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 staffMemberIdstaff•ID
Member Id Filter activities by staff member.
Arguments
- •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 netSalesnet•Money
Sales V2! non-null The net sales for this cash drawer.
- Anchor to dateRangedate•Cash
Range Drawer Date Range Input! required The date and time range for filtering net sales.
Arguments
- Anchor to pointOfSaleDevicespoint•Point
Of Sale Devices Of Sale Device Connection The Point of Sale devices assigned to this cash drawer.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
Arguments
- Anchor to totalAdjustmentstotal•Money
Adjustments V2! non-null The total adjustments for this cash drawer.
- Anchor to dateRangedate•Cash
Range Drawer Date Range Input! required The date and time range for filtering adjustments.
Arguments
- Anchor to totalDiscrepanciestotal•Money
Discrepancies V2! non-null The total discrepancies for this cash drawer.
- Anchor to dateRangedate•Cash
Range Drawer Date Range Input! required The date and time range for filtering discrepancies.
Arguments
- Anchor to totalRefundstotal•Money
Refunds V2! non-null The total refunds for this cash drawer.
- Anchor to dateRangedate•Cash
Range Drawer Date Range Input! required The date and time range for filtering refunds.
Arguments
- Anchor to totalSalestotal•Money
Sales V2! non-null The total sales for this cash drawer.
- Anchor to dateRangedate•Cash
Range Drawer Date Range Input! required The date and time range for filtering sales.
Arguments
Anchor to QueriesQueries
- cashDrawer (CashDrawer)
- cashDrawers (CashDrawerConnection!)
- •query
Returns a
resource by ID.- •ID!required
The ID of the
to return.
Arguments
- •ID!
- •query
A list of cash drawers in the shop.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- 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.
Arguments
Anchor to MutationsMutations
- cashDrawerCreate (CashDrawerCreatePayload)
- cashDrawerFindOrCreate (CashDrawerFindOrCreatePayload)
- cashDrawerUpdate (CashDrawerUpdatePayload)
- •mutation
Creates a cash drawer in a provided location.
- Anchor to locationIdlocation•ID!
Id required The location the cash drawer is located in.
- Anchor to namename•String!required
The name of the cash drawer.
Arguments
- •mutation
Finds or creates a cash drawer for cash management. Also ensures the provided device is assigned to the drawer.
- Anchor to locationIdlocation•ID!
Id required The location the cash drawer is located in.
- Anchor to namename•String!required
The name of the cash drawer.
- Anchor to pointOfSaleDeviceIdpoint•ID!
Of Sale Device Id required The point of sale device to assign to the cash drawer.
Arguments
- •mutation
Updates a cash drawer.
- •ID!required
The ID of the cash drawer to update.
- Anchor to inputinput•Cash
Drawer Update Input! required The input fields for updating a cash drawer.
Arguments
- •ID!