Get product type

Get the full details of a specific product type referring to its ID.

Access scopes

Requires the following access scope: read_catalog

Response

A JSON object with the following fields:

FieldTypeDescription
idnumberProduct class internal unique ID. Class with ID 0 is the default 'General' type assigned to all products by default
namestringProduct type name. Empty for the "General" type
googleTaxonomystringGoogle taxonomy associated with this type
attributesArray<Attribute>Product type attributes

Attribute

FieldTypeDescription
idnumberAttribute internal unique ID
namestringAttribute title. Product attribute with an empty name field will also be returned
nameTranslated<Translations>Available translations for product attribute name
typestringAttribute type. There are user-defined attributes, general attributes and special 'price per unit' attributes. The 'type' field contains one of the following: CUSTOM, UPC, BRAND, GENDER, AGE_GROUP, COLOR, SIZE, PRICE_PER_UNIT, UNITS_IN_PRODUCT. Attributes of type PRICE_PER_UNIT and UNITS_IN_PRODUCT are only returned if price per unit feature is enabled.
showstringDefines if an attribute is visible on a product page. Supported values: NOTSHOW, DESCR, PRICE. The value PRICE = DESCR. For public tokens, NOTSHOW attributes are not returned

Translations

FieldTypeDescription
<ISO_LANG_CODE>stringTranslations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings

Errors

In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description

HTTP codes

HTTP StatusMeaning
400Request parameters are malformed
404Product type is not found
415Unsupported content-type: expected application/json or text/json
500Cannot retrieve the product type info because of an error on the server

Error response body (optional)

FieldTypeDescription
errorMessagestringError message
Language
Click Try It! to start a request and see the response here!