pointOfSaleDevicePaymentSessions

A list of point of sale device payment sessions in the shop. Cash management data is returned only for locations with a POS Pro subscription.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the pointOfSaleDevicePaymentSessions action (under Point).
Fill in the fields below, then reference the result from later steps as {{pointofsaledevicepaymentsessions.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 PointOfSaleDevicePaymentSessions($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: PointOfSaleDevicePaymentSessionSortKeys, $query: String) {
  pointOfSaleDevicePaymentSessions(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        cashCountedAtClose
        cashCountedAtOpen
        cashDrawer
        closingAdjustment
        closingBalance
        closingNote
        closingStaffMember
        closingTime
        currency
        expectedCashAtClose
        expectedCashAtOpen
        id
        location
        netCashSales
        netSales
        openingNote
        openingStaffMember
        openingTime
        pointOfSaleDevice
        status
        totalAdjustments
        totalCashRefunds
        totalCashSales
        totalDiscrepancy
        totalRefunds
        totalSales
        totalsReady
      }
    }
    nodes {
      cashCountedAtClose {
        amount
        currencyCode
      }
      cashCountedAtOpen {
        amount
        currencyCode
      }
      cashDrawer {
        balance
        id
        location
        name
      }
      closingAdjustment {
        amount
        currencyCode
      }
      closingBalance {
        amount
        currencyCode
      }
      closingNote
      closingStaffMember {
        accountType
        active
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
        privateData
      }
      closingTime
      currency
      expectedCashAtClose {
        amount
        currencyCode
      }
      expectedCashAtOpen {
        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
      }
      netSales {
        amount
        currencyCode
      }
      openingNote
      openingStaffMember {
        accountType
        active
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
        privateData
      }
      openingTime
      pointOfSaleDevice {
        activePaymentSession
        cashDrawer
        id
      }
      status
      totalAdjustments {
        amount
        currencyCode
      }
      totalCashRefunds {
        amount
        currencyCode
      }
      totalCashSales {
        amount
        currencyCode
      }
      totalDiscrepancy {
        amount
        currencyCode
      }
      totalRefunds {
        amount
        currencyCode
      }
      totalSales {
        amount
        currencyCode
      }
      totalsReady
    }
    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 by the given key.

One ofCLOSING_TIMEIDOPENING_TIME

querystring

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

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

cashCountedAtCloseobject

cashCountedAtOpenobject

cashDrawerobject

closingAdjustmentobject

closingBalanceobject

closingNoteobject

closingStaffMemberobject

closingTimeobject

currencyobject

expectedCashAtCloseobject

expectedCashAtOpenobject

idobject

locationobject

netCashSalesobject

netSalesobject

openingNoteobject

openingStaffMemberobject

openingTimeobject

pointOfSaleDeviceobject

statusobject

totalAdjustmentsobject

totalCashRefundsobject

totalCashSalesobject

totalDiscrepancyobject

totalRefundsobject

totalSalesobject

totalsReadyobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?