catalog-id-mapping.md

Catalog Id Mapping

A mapping between a temporary client-supplied ID and a permanent server-generated ID.

When calling UpsertCatalogObject or BatchUpsertCatalogObjects to create a CatalogObject instance, you can supply a temporary ID for the to-be-created object, especially when the object is to be referenced elsewhere in the same request body. This temporary ID can be any string unique within the call, but must be prefixed by "#".

After the request is submitted and the object created, a permanent server-generated ID is assigned to the new object. The permanent ID is unique across the Square catalog.

Structure

CatalogIdMapping

Fields

Name	Type	Tags	Description
clientObjectId	string | undefined	Optional	The client-supplied temporary #-prefixed ID for a new CatalogObject.
objectId	string | undefined	Optional	The permanent ID for the CatalogObject created by the server.

Example (as JSON)

{
  "client_object_id": null,
  "object_id": null
}