Square icon

Square

Consume Square API

Catalog → Batch Upsert

AI-generated

Overview

The node performs a batch upsert operation on the Square Catalog resource. It allows users to create or update multiple catalog objects in batches within a single API call. This is useful for efficiently managing large sets of catalog items, such as products or services, by sending them in grouped batches to avoid multiple individual requests.

Use Case Examples

  1. A retailer updating prices and details of multiple products in their Square catalog at once.
  2. A business adding new items and updating existing ones in their service catalog in bulk.

Properties

Name Meaning
Idempotency Key A unique key to ensure this batch operation is only applied once, preventing duplicate processing.
Batches A JSON array of batches containing catalog objects to create or update. Each batch includes objects with their type, ID, and associated data.

Output

JSON

  • idempotency_key - The unique key used to ensure the batch operation is idempotent.
  • batches - The array of batches processed, each containing catalog objects that were created or updated.

Dependencies

  • Requires Square API credentials for authentication.

Troubleshooting

  • Ensure the 'Batches' input is valid JSON; otherwise, the node throws an error indicating invalid JSON format.
  • The 'Idempotency Key' must be unique per batch operation to avoid duplicate processing.
  • If the API request fails, check the error message returned by the Square API for details, such as invalid object IDs or permission issues.

Links

Discussion