Catalog

Square Catalog API

Sync catalog data with Square through Apideck's unified API. One integration, instant access.

In Apideck, this resource is called Items (API: items)

Supported Operations for Square Catalog

Full CRUD support available through our unified API

list

get

create

update

delete

Supported Fields

12 fields

Fields available for Square Catalog

idnamedescriptionabbreviationproduct_typepresent_at_all_locationsavailable_for_pickupavailable_onlinevariationsmodifier_groupsversiondeleted

API Model Preview

Sample response structure for catalog

{
  "id": "12345",
  "name": "Example Name",
  "description": "Example Description",
  "abbreviation": "string",
  "product_type": "standard",
  "present_at_all_locations": [
    {
      "id": "12345"
    }
  ],
  "available_for_pickup": "string",
  "available_online": "string",
  "variations": "string",
  "modifier_groups": "string",
  "version": "string",
  "deleted": "string"
}

Quick Start Example

Start syncing Square catalog in minutes

Node.js

import { Apideck } from '@apideck/unify'

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY,
  appId: 'YOUR_APP_ID',
  consumerId: 'YOUR_CONSUMER_ID'
})

// List catalog from Square
const result = await apideck.pos.items.list({
  serviceId: 'square'
})

for await (const page of result) {
  console.log(page)
}
// Returns unified catalog data

View full SDK documentation