0

BatchRetrieveCatalogObjects

by
Published Oct 17, 2025

Returns a set of objects based on the provided ID. Each [CatalogItem]($m/CatalogItem) returned in the set includes all of its child information including: all of its [CatalogItemVariation]($m/CatalogItemVariation) objects, references to its [CatalogModifierList]($m/CatalogModifierList) objects, and the ids of any [CatalogTax]($m/CatalogTax) objects that apply to it.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * BatchRetrieveCatalogObjects
7
 * Returns a set of objects based on the provided ID.
8
Each [CatalogItem]($m/CatalogItem) returned in the set includes all of its
9
child information including: all of its
10
[CatalogItemVariation]($m/CatalogItemVariation) objects, references to
11
its [CatalogModifierList]($m/CatalogModifierList) objects, and the ids of
12
any [CatalogTax]($m/CatalogTax) objects that apply to it.
13
 */
14
export async function main(
15
  auth: Square,
16
  body: {
17
    object_ids: string[];
18
    include_related_objects?: false | true;
19
    catalog_version?: number;
20
    include_deleted_objects?: false | true;
21
    include_category_path_to_root?: false | true;
22
  },
23
) {
24
  const url = new URL(`https://connect.squareup.com/v2/catalog/batch-retrieve`);
25

26
  const response = await fetch(url, {
27
    method: "POST",
28
    headers: {
29
      "Content-Type": "application/json",
30
      Authorization: "Bearer " + auth.token,
31
    },
32
    body: JSON.stringify(body),
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