Menu
businessEntity
Fetch a single business entity by its ID.
Use it in a workflow
- Add a step and choose the Shopify connector.
- Pick the businessEntity action (under Business).
- Fill in the fields below, then reference the result from later steps as
{{businessentity.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.
query BusinessEntity($id: ID) {
businessEntity(id: $id) {
address {
address1
address2
city
countryCode
province
zip
}
archived
companyName
displayName
id
legalEntityId
primary
shopifyPaymentsAccount {
accountOpenerName
activated
balance {
amount
currencyCode
}
chargeStatementDescriptor
chargeStatementDescriptors {
default
prefix
}
country
defaultCurrency
id
onboardable
payoutSchedule {
interval
monthlyAnchor
weeklyAnchor
}
payoutStatementDescriptor
}
}
}
Variables
Pass these as a JSON object in the step's Variables field.
{
"id": "string"
}
Response
Read the result with {{businessentity.response.data.data.businessEntity}}. If the API returns errors, the step fails and they are at {{businessentity.response.data.errors}}.
Need more? See the Shopify guide for connection setup and behaviour shared by every action.
Was this page helpful?