Retrieve Merchant Custom Attribute - Automate.ax

square.retrieveMerchantCustomAttribute retrieves a custom attribute associated with a merchant.

Example

automations/square-retrieve-merchant-custom-attribute.automation.ts

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

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

  square.retrieveMerchantCustomAttribute({
    merchantId: "merchant_id",
    key: "key",
    withDefinition: true,
    version: 1,
  })
})

Inputs

Every input accepts a compatible signal. It requires MERCHANT_PROFILE_READ.

Field	Type	Required	Default	Description
`merchantId`	`string`	Yes	—	The ID of the target merchant.
`key`	`string`	Yes	—	The key of the custom attribute to retrieve. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.
`withDefinition`	`boolean \| null`	No	`false`	Indicates whether to return the custom attribute definition in the `definition` field of the custom attribute. Set this parameter to `true` to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is `false`.
`version`	`number \| null`	No	—	The current version of the custom attribute, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a `BAD_REQUEST` error.

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

Output

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