Object Index
You are viewing an old version of the API
CatalogIdMapping
Object Index
You are viewing an old version of the API
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 sumbitted and the object created, a permanent server-generated ID is assigned to the new object. The permanent ID is unique across the Square catalog.
Properties
| Name | Description |
|---|---|
client_object_id
|
The client-supplied temporary |
object_id
|
The permanent ID for the CatalogObject created by the server. |