API Explorer
You are viewing an old version of the API

Search catalog objects

Searches for CatalogObject of any types against supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query expressions,

This (SearchCatalogObjects) endpoint differs from the SearchCatalogItems endpoint in the following aspects:

  • SearchCatalogItems can only search for items or item variations, whereas SearchCatalogObjects can search for any type of catalog objects.

Open in API Reference

Sign In

Body

string
string
boolean
boolean
integer
string [ ]
CatalogQuery
Request
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
curl https://connect.squareupsandbox.com/v2/catalog/search \
  -X POST \
  -H 'Square-Version: 2020-09-23' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'
Response
// No response received yet.

Share Feedback

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