Configuration APIProduct Categories

Get a product category

Requires the PRODUCT_CATEGORY.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdOrReferencestringRequiredDefaults to
The ID or reference of the resource.

Headers

x-platform-idstringOptional
Platform ID.

Response

OK
namestringformat: "^.*$"0-256 characters
referencestringformat: "^\S+$"0-256 characters
object_typestring or nullRead-only
idstring or nullRead-only
descriptionstring or nullformat: "^.*$"0-256 characters
tax_categoryenum or null
The default tax category applied to the products in the product category.
Allowed values:
display_orderinteger or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error