cashManagementLocationSummary

Summary of cash management data for a location. Data is returned only if the location has a POS Pro subscription.

Use it in a workflow

Query

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

query CashManagementLocationSummary($locationId: ID!, $startDate: Date!, $endDate: Date!) {
  cashManagementLocationSummary(
    locationId: $locationId
    startDate: $startDate
    endDate: $endDate
  ) {
    cashBalanceAtEnd {
      amount
      currencyCode
    }
    cashBalanceAtStart {
      amount
      currencyCode
    }
    netCash {
      amount
      currencyCode
    }
    sessionsClosed
    sessionsOpened
    totalDiscrepancies {
      amount
      currencyCode
    }
  }
}

Variables

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

{
  "locationId": "string",
  "startDate": "string",
  "endDate": "string"
}

Response

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

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