cashDrawerFindOrCreate

Finds or creates a cash drawer for cash management. Also ensures the provided device is assigned to the drawer.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the cashDrawerFindOrCreate action (under Cash).
Fill in the fields below, then reference the result from later steps as {{cashdrawerfindorcreate.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 CashDrawerFindOrCreate($locationId: ID!, $name: String!, $pointOfSaleDeviceId: ID!) {
  cashDrawerFindOrCreate(
    locationId: $locationId
    name: $name
    pointOfSaleDeviceId: $pointOfSaleDeviceId
  ) {
    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
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

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

locationIdstringrequired

The location the cash drawer is located in.

namestringrequired

The name of the cash drawer.

pointOfSaleDeviceIdstringrequired

The point of sale device to assign to the cash drawer.

json

{
  "locationId": "string",
  "name": "string",
  "pointOfSaleDeviceId": "string"
}

Response

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

cashDrawerobject

balanceobject2 fields

idstring

locationobject21 fields

namestring

userErrorsarray<object>

codeobject

fieldobject

messageobject

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

Was this page helpful?