Point
Requires access scope.
Tracks the payment activity for a point of sale device.
Anchor to FieldsFields
- cashActivities (CashActivityConnection!)
- cashCountedAtClose (MoneyV2)
- cashCountedAtOpen (MoneyV2!)
- cashDrawer (CashDrawer!)
- closingAdjustment (MoneyV2)
- closingBalance (MoneyV2)
- closingNote (String)
- closingStaffMember (StaffMember)
- closingTime (DateTime)
- currency (String!)
- expectedCashAtClose (MoneyV2)
- expectedCashAtOpen (MoneyV2!)
- id (ID!)
- location (Location!)
- netCashSales (MoneyV2!)
- netSales (MoneyV2!)
- openingNote (String)
- openingStaffMember (StaffMember!)
- openingTime (DateTime!)
- pointOfSaleDevice (PointOfSaleDevice!)
- status (PointOfSaleDevicePaymentSessionStatus!)
- totalAdjustments (MoneyV2!)
- totalCashRefunds (MoneyV2!)
- totalCashSales (MoneyV2!)
- totalDiscrepancy (MoneyV2!)
- totalRefunds (MoneyV2!)
- totalSales (MoneyV2!)
- totalsReady (Boolean!)
- Anchor to cashActivitiescash•Cash
Activities Activity Connection! non-null The activities on the point of sale device payment session.
- 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 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
- Anchor to cashCountedAtClosecash•Money
Counted At Close V2 The cash that was physically counted when the point of sale device payment session was closed.
- Anchor to cashCountedAtOpencash•Money
Counted At Open V2! non-null The cash that was physically counted when the point of sale device payment session was opened.
- Anchor to cashDrawercash•Cash
Drawer Drawer! non-null The cash drawer associated with the point of sale device payment session. The session's sales andcash tracking activity will affect the cash drawer's balance.
- Anchor to closingAdjustmentclosing•Money
Adjustment V2 The amount that the cash drawer balance was adjusted when the session was closed.
- Anchor to closingBalanceclosing•Money
Balance V2 The counted balance of the cash drawer when the point of sale device payment session was closed.
- Anchor to closingNoteclosing•String
Note The note associated with the point of sale device payment session closing.
- Anchor to closingStaffMemberclosing•Staff
Staff Member Member The staff member who closed the point of sale device payment session.
- Anchor to closingTimeclosing•Date
Time Time The time the point of sale device payment session was closed.
- Anchor to currencycurrency•String!non-null
The currency of the point of sale device payment session.
- Anchor to expectedCashAtCloseexpected•Money
Cash At Close V2 The expected cash when the point of sale device payment session was closed.
- Anchor to expectedCashAtOpenexpected•Money
Cash At Open V2! non-null The expected balance of the cash drawer when the point of sale device payment session was opened.
- •ID!non-null
A globally-unique ID.
- Anchor to locationlocation•Location!non-null
The location associated with the point of sale device payment session. The session's sales and cash tracking activity will contribute to the location's totals.
- Anchor to netCashSalesnet•Money
Cash Sales V2! non-null The net cash sales for the point of sale device payment session.
- Anchor to netSalesnet•Money
Sales V2! non-null The net sales for the duration of this session.
- Anchor to openingNoteopening•String
Note The note associated with the point of sale device payment session opening.
- Anchor to openingStaffMemberopening•Staff
Staff Member Member! non-null The staff member who opened the point of sale device payment session.
- Anchor to openingTimeopening•Date
Time Time! non-null The time the point of sale device payment session was opened.
- Anchor to pointOfSaleDevicepoint•Point
Of Sale Device Of Sale Device! non-null The point of sale device.
- Anchor to statusstatus•Point
Of Sale Device Payment Session Status! non-null Whether the point of sale device payment session is open. Payments can't be processed or refunded during a closed session, and the cash drawer balance can't be adjusted or corrected.
- Anchor to totalAdjustmentstotal•Money
Adjustments V2! non-null The total adjustments for the point of sale device payment session.
- Anchor to totalCashRefundstotal•Money
Cash Refunds V2! non-null The total cash refunds for the point of sale device payment session.
- Anchor to totalCashSalestotal•Money
Cash Sales V2! non-null The total cash sales for the point of sale device payment session.
- Anchor to totalDiscrepancytotal•Money
Discrepancy V2! non-null The total discrepancy for the point of sale device payment session.
- Anchor to totalRefundstotal•Money
Refunds V2! non-null The sum of all refunds for the duration of this session.
- Anchor to totalSalestotal•Money
Sales V2! non-null The sum of all sales for the duration of this session.
- Anchor to totalsReadytotals•Boolean!
Ready non-null Whether the point of sale device payment session totals are ready.
Anchor to QueriesQueries
- pointOfSaleDevicePaymentSession (PointOfSaleDevicePaymentSession)
- pointOfSaleDevicePaymentSessions (PointOfSaleDevicePaymentSessionConnection!)
- •query
Lookup a point of sale device payment session by ID.
- •ID!required
The ID of the point of sale device payment session.
Arguments
- •ID!
- •query
A list of point of sale device payment sessions 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 reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Point
Key Of Sale Device Payment Session Sort Keys Default:ID 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.
Arguments
Anchor to MutationsMutations
- pointOfSaleDevicePaymentSessionAdjust (PointOfSaleDevicePaymentSessionAdjustPayload)
- pointOfSaleDevicePaymentSessionClose (PointOfSaleDevicePaymentSessionClosePayload)
- pointOfSaleDevicePaymentSessionCount (PointOfSaleDevicePaymentSessionCountPayload)
- pointOfSaleDevicePaymentSessionOpen (PointOfSaleDevicePaymentSessionOpenPayload)
- •mutation
Adds an adjustment to a point of sale device payment session.
- Anchor to pointOfSaleDevicePaymentSessionIdpoint•ID!
Of Sale Device Payment Session Id required The point of sale device payment session to be adjusted.
- Anchor to cashcash•Money
Input! required The amount of cash being added or removed.
- Anchor to staffMemberIdstaff•ID!
Member Id required The staff member who made the adjustment.
- Anchor to reasonCodeIdreason•ID
Code Id The reason code for the adjustment.
- Anchor to notenote•String
The note entered when the adjustment was made.
- Anchor to timetime•Date
Time The time when the adjustment was made. Defaults to the current time.
Arguments
- •mutation
Closes a point of sale device payment session.
- Anchor to pointOfSaleDevicePaymentSessionIdpoint•ID!
Of Sale Device Payment Session Id required The point of sale device payment session to be closed.
- Anchor to balancebalance•Money
Input! required The counted cash drawer balance when the session was closed.
- Anchor to staffMemberIdstaff•ID!
Member Id required The staff member who closed the session.
- Anchor to timetime•Date
Time When the session was closed. Defaults to the current time.
- Anchor to reasonCodeIdreason•ID
Code Id The reason code for closing the session.
- Anchor to notenote•String
The note entered when the session was closed.
Arguments
- •mutation
Records a mid-session cash count for a point of sale device payment session.
- Anchor to pointOfSaleDevicePaymentSessionIdpoint•ID!
Of Sale Device Payment Session Id required The point of sale device payment session to record a count for.
- Anchor to balancebalance•Money
Input! required The counted cash drawer balance.
- Anchor to staffMemberIdstaff•ID!
Member Id required The staff member who performed the count.
- Anchor to timetime•Date
Time When the count was performed. Defaults to the current time.
- Anchor to reasonCodeIdreason•ID
Code Id The reason code for the count.
- Anchor to notenote•String
The note entered when the count was performed.
Arguments
- •mutation
Opens a point of sale device payment session.
- Anchor to pointOfSaleDeviceIdpoint•ID!
Of Sale Device Id required The point of sale device to which this session belongs.
- Anchor to balancebalance•Money
Input The counted cash drawer balance when the session was opened.
- Anchor to staffMemberIdstaff•ID!
Member Id required The staff member who opened the session.
- Anchor to timetime•Date
Time The time the session was opened. Defaults to the current time.
- Anchor to reasonCodeIdreason•ID
Code Id The reason code for the session opening.
- Anchor to notenote•String
The note entered when the session was opened.
Arguments