Skip to main content
GET
Get catalog details
Required scopes: accounts—my:ro

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Path Parameters

catalog_id
string<uuid>
required

The catalog ID.

Response

The catalog's details.

status
enum<string>
required

The current catalog status.

  • created — the catalog exists, but no file has been uploaded to it.
  • indexing — an import is pending or being processed.
  • ready — the first import finished, successfully or not; the status stays ready regardless of later uploads.
Available options:
created,
indexing,
ready
product_count
integer
required

The number of products indexed in the catalog.