0

ListOrderCustomAttributeDefinitions

by
Published Oct 17, 2025

Lists the order-related [custom attribute definitions]($m/CustomAttributeDefinition) that belong to a Square seller account.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * ListOrderCustomAttributeDefinitions
7
 * Lists the order-related [custom attribute definitions]($m/CustomAttributeDefinition) that belong to a Square seller account.
8
 */
9
export async function main(
10
  auth: Square,
11
  visibility_filter: "ALL" | "READ" | "READ_WRITE" | undefined,
12
  cursor: string | undefined,
13
  limit: string | undefined,
14
) {
15
  const url = new URL(
16
    `https://connect.squareup.com/v2/orders/custom-attribute-definitions`,
17
  );
18
  for (const [k, v] of [
19
    ["visibility_filter", visibility_filter],
20
    ["cursor", cursor],
21
    ["limit", limit],
22
  ]) {
23
    if (v !== undefined && v !== "" && k !== undefined) {
24
      url.searchParams.append(k, v);
25
    }
26
  }
27
  const response = await fetch(url, {
28
    method: "GET",
29
    headers: {
30
      Authorization: "Bearer " + auth.token,
31
    },
32
    body: undefined,
33
  });
34
  if (!response.ok) {
35
    const text = await response.text();
36
    throw new Error(`${response.status} ${text}`);
37
  }
38
  return await response.json();
39
}
40