0

RetrieveMerchantCustomAttributeDefinition

by
Published Oct 17, 2025

Retrieves a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account. To retrieve a custom attribute definition created by another application, the `visibility` setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * RetrieveMerchantCustomAttributeDefinition
7
 * Retrieves a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
8
To retrieve a custom attribute definition created by another application, the `visibility`
9
setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
10
 */
11
export async function main(
12
  auth: Square,
13
  key: string,
14
  version: string | undefined,
15
) {
16
  const url = new URL(
17
    `https://connect.squareup.com/v2/merchants/custom-attribute-definitions/${key}`,
18
  );
19
  for (const [k, v] of [["version", version]]) {
20
    if (v !== undefined && v !== "" && k !== undefined) {
21
      url.searchParams.append(k, v);
22
    }
23
  }
24
  const response = await fetch(url, {
25
    method: "GET",
26
    headers: {
27
      Authorization: "Bearer " + auth.token,
28
    },
29
    body: undefined,
30
  });
31
  if (!response.ok) {
32
    const text = await response.text();
33
    throw new Error(`${response.status} ${text}`);
34
  }
35
  return await response.json();
36
}
37