Skip to content

Statuses

View as Markdown

A Status is one of the fixed states a resource can be in, such as ACTIVE. Resources that carry a status - products or categories, for instance - reference it by its IRI:

{ "status": "/api/statuses/ACTIVE" }

This is a read-only reference resource: list the statuses to discover the valid values.

PropertyTypeRequiredDescription
descriptionstring-
detailsstring-

All requests require an OAuth 2.0 bearer token:

Authorization: Bearer <token>

This resource is read-only - it has no create, update or delete operations.