You are viewing an old version of the API
Delete catalog object

Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response

Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a CatalogItem will also delete all of its CatalogItemVariation children.

Required permissions ITEMS_WRITE

Path Parameters

Name Description
object_id
string

Required

The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations).

Response Fields

Name Description
deleted_at
string

The database timestamp of this deletion in RFC 3339 format, e.g., 2016-09-04T23:59:33.123Z.

deleted_object_ids
string [ ]

The IDs of all catalog objects deleted by this request. Multiple IDs may be returned when associated objects are also deleted, for example a catalog item variation will be deleted (and its ID included in this field) when its parent catalog item is deleted.

errors
Error [ ]

Information on any errors encountered.

Examples

You are viewing an old version of the API
DELETE /v2/catalog/object/{object_id}
cURL
  • cURL
  • Ruby
  • Python
curl https://connect.squareup.com/v2/catalog/object/{object_id} \
  -X DELETE \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN'
Response JSON
{
  "deleted_object_ids": [
    "7SB3ZQYJ5GDMVFL7JK46JCHT",
    "KQLFFHA6K6J3YQAQAWDQAL57"
  ],
  "deleted_at": "2016-11-16T22:25:24.878Z"
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?