0

ListGiftCards

by
Published Oct 17, 2025

Lists all gift cards. You can specify optional filters to retrieve a subset of the gift cards. Results are sorted by `created_at` in ascending order.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * ListGiftCards
7
 * Lists all gift cards. You can specify optional filters to retrieve 
8
a subset of the gift cards. Results are sorted by `created_at` in ascending order.
9
 */
10
export async function main(
11
  auth: Square,
12
  type: string | undefined,
13
  state: string | undefined,
14
  limit: string | undefined,
15
  cursor: string | undefined,
16
  customer_id: string | undefined,
17
) {
18
  const url = new URL(`https://connect.squareup.com/v2/gift-cards`);
19
  for (const [k, v] of [
20
    ["type", type],
21
    ["state", state],
22
    ["limit", limit],
23
    ["cursor", cursor],
24
    ["customer_id", customer_id],
25
  ]) {
26
    if (v !== undefined && v !== "" && k !== undefined) {
27
      url.searchParams.append(k, v);
28
    }
29
  }
30
  const response = await fetch(url, {
31
    method: "GET",
32
    headers: {
33
      Authorization: "Bearer " + auth.token,
34
    },
35
    body: undefined,
36
  });
37
  if (!response.ok) {
38
    const text = await response.text();
39
    throw new Error(`${response.status} ${text}`);
40
  }
41
  return await response.json();
42
}
43