pointOfSaleDevicePaymentSessionClose

Closes a point of sale device payment session.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the pointOfSaleDevicePaymentSessionClose action (under Point).
Fill in the fields below, then reference the result from later steps as {{pointofsaledevicepaymentsessionclose.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation PointOfSaleDevicePaymentSessionClose($pointOfSaleDevicePaymentSessionId: ID!, $balance: MoneyInput!, $staffMemberId: ID!, $time: DateTime, $reasonCodeId: ID, $note: String) {
  pointOfSaleDevicePaymentSessionClose(
    pointOfSaleDevicePaymentSessionId: $pointOfSaleDevicePaymentSessionId
    balance: $balance
    staffMemberId: $staffMemberId
    time: $time
    reasonCodeId: $reasonCodeId
    note: $note
  ) {
    pointOfSaleDevicePaymentSession {
      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
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

pointOfSaleDevicePaymentSessionIdstringrequired

The point of sale device payment session to be closed.

balanceobjectrequired

The counted cash drawer balance when the session was closed.

amountstringrequired

currencyCodestringrequired

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

staffMemberIdstringrequired

The staff member who closed the session.

timestring

When the session was closed. Defaults to the current time.

reasonCodeIdstring

The reason code for closing the session.

notestring

The note entered when the session was closed.

json

{
  "pointOfSaleDevicePaymentSessionId": "string",
  "balance": {
    "amount": "string",
    "currencyCode": "USD"
  },
  "staffMemberId": "string",
  "time": "string",
  "reasonCodeId": "string",
  "note": "string"
}

Response

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

pointOfSaleDevicePaymentSessionobject

cashCountedAtCloseobject2 fields

cashCountedAtOpenobject2 fields

cashDrawerobject4 fields

closingAdjustmentobject2 fields

closingBalanceobject2 fields

closingNotestring

closingStaffMemberobject13 fields

closingTimestring

currencystring

expectedCashAtCloseobject2 fields

expectedCashAtOpenobject2 fields

idstring

locationobject21 fields

netCashSalesobject2 fields

netSalesobject2 fields

openingNotestring

openingStaffMemberobject13 fields

openingTimestring

pointOfSaleDeviceobject3 fields

statusstring

One ofOPENCLOSED

totalAdjustmentsobject2 fields

totalCashRefundsobject2 fields

totalCashSalesobject2 fields

totalDiscrepancyobject2 fields

totalRefundsobject2 fields

totalSalesobject2 fields

totalsReadyboolean

userErrorsarray<object>

codeobject

fieldobject

messageobject

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

Was this page helpful?