younifyd
Menu

pointOfSaleDevicePaymentSession

Lookup a point of sale device payment session by ID.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the pointOfSaleDevicePaymentSession action (under Point).
  3. Fill in the fields below, then reference the result from later steps as {{pointofsaledevicepaymentsession.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 PointOfSaleDevicePaymentSession($id: ID!) {
  pointOfSaleDevicePaymentSession(id: $id) {
    cashCountedAtClose {
      amount
      currencyCode
    }
    cashCountedAtOpen {
      amount
      currencyCode
    }
    cashDrawer {
      balance {
        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
      }
      name
    }
    closingAdjustment {
      amount
      currencyCode
    }
    closingBalance {
      amount
      currencyCode
    }
    closingNote
    closingStaffMember {
      accountType
      active
      email
      exists
      firstName
      id
      initials
      isShopOwner
      lastName
      locale
      name
      phone
      privateData {
        accountSettingsUrl
        createdAt
        permissions
      }
    }
    closingTime
    currency
    expectedCashAtClose {
      amount
      currencyCode
    }
    expectedCashAtOpen {
      amount
      currencyCode
    }
    id
    location {
      activatable
      address {
        address1
        address2
        city
        country
        countryCode
        formatted
        latitude
        longitude
        phone
        province
        provinceCode
        zip
      }
      addressVerified
      createdAt
      deactivatable
      deactivatedAt
      deletable
      fulfillmentService {
        callbackUrl
        fulfillmentOrdersOptIn
        handle
        id
        inventoryManagement
        location
        requiresShippingMethod
        serviceName
        trackingSupport
        type
      }
      fulfillsOnlineOrders
      hasActiveInventory
      hasUnfulfilledOrders
      id
      isActive
      isFulfillmentService
      isPrimary
      legacyResourceId
      localPickupSettingsV2 {
        instructions
        pickupTime
      }
      name
      shipsInventory
      suggestedAddresses {
        address1
        address2
        city
        country
        countryCode
        formatted
        province
        provinceCode
        zip
      }
      updatedAt
    }
    netCashSales {
      amount
      currencyCode
    }
    netSales {
      amount
      currencyCode
    }
    openingNote
    openingStaffMember {
      accountType
      active
      email
      exists
      firstName
      id
      initials
      isShopOwner
      lastName
      locale
      name
      phone
      privateData {
        accountSettingsUrl
        createdAt
        permissions
      }
    }
    openingTime
    pointOfSaleDevice {
      activePaymentSession
      cashDrawer {
        balance
        id
        location
        name
      }
      id
    }
    status
    totalAdjustments {
      amount
      currencyCode
    }
    totalCashRefunds {
      amount
      currencyCode
    }
    totalCashSales {
      amount
      currencyCode
    }
    totalDiscrepancy {
      amount
      currencyCode
    }
    totalRefunds {
      amount
      currencyCode
    }
    totalSales {
      amount
      currencyCode
    }
    totalsReady
  }
}

Variables

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

idstringrequired

The ID of the point of sale device payment session.

json
{
  "id": "string"
}

Response

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

cashCountedAtCloseobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

cashCountedAtOpenobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

cashDrawerobject
balanceobject2 fields
idstring
locationobject21 fields
namestring
closingAdjustmentobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

closingBalanceobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

closingNotestring
closingStaffMemberobject
accountTypestring

One ofREGULARRESTRICTEDINVITEDREQUESTEDCOLLABORATORCOLLABORATOR_TEAM_MEMBERSAMLINVITED_STORE_OWNER

activeboolean
emailstring
existsboolean
firstNamestring
idstring
initialsarray<object>
isShopOwnerboolean
lastNamestring
localestring
namestring
phonestring
privateDataobject3 fields
closingTimestring
currencystring
expectedCashAtCloseobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

expectedCashAtOpenobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

idstring
locationobject
activatableboolean
addressobject12 fields
addressVerifiedboolean
createdAtstring
deactivatableboolean
deactivatedAtstring
deletableboolean
fulfillmentServiceobject10 fields
fulfillsOnlineOrdersboolean
hasActiveInventoryboolean
hasUnfulfilledOrdersboolean
idstring
isActiveboolean
isFulfillmentServiceboolean
isPrimaryboolean
legacyResourceIdstring
localPickupSettingsV2object2 fields
namestring
shipsInventoryboolean
suggestedAddressesarray<object>
updatedAtstring
netCashSalesobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

netSalesobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

openingNotestring
openingStaffMemberobject
accountTypestring

One ofREGULARRESTRICTEDINVITEDREQUESTEDCOLLABORATORCOLLABORATOR_TEAM_MEMBERSAMLINVITED_STORE_OWNER

activeboolean
emailstring
existsboolean
firstNamestring
idstring
initialsarray<object>
isShopOwnerboolean
lastNamestring
localestring
namestring
phonestring
privateDataobject3 fields
openingTimestring
pointOfSaleDeviceobject
activePaymentSessionobject

Recursive reference to PointOfSaleDevicePaymentSession, not further expanded.

cashDrawerobject4 fields
idstring
statusstring

One ofOPENCLOSED

totalAdjustmentsobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

totalCashRefundsobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

totalCashSalesobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

totalDiscrepancyobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

totalRefundsobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

totalSalesobject
amountstring
currencyCodestring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

totalsReadyboolean

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