Retrieve Merchant - Automate.ax

square.retrieveMerchant retrieves the Merchant object for the given merchant_id.

Example

automations/square-retrieve-merchant.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Retrieve Square Merchant", () => {
  onDashboardRun({ title: "Retrieve Square Merchant" })

  square.retrieveMerchant({
    merchantId: "merchant_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires MERCHANT_PROFILE_READ.

Field	Type	Required	Default	Description
`merchantId`	`string`	Yes	—	The ID of the merchant to retrieve. If the string `me` is supplied as the ID, then retrieve the merchant that is currently accessible to this call.

Use the official RetrieveMerchant reference for provider field semantics and limits.

Output

Returns the official Square.GetMerchantResponse response as a codec-safe object. Square integer money amounts remain bigint values.