Search product types

GET https://app.ecwid.com/api/v3/{storeId}/classes

Request and response example

Request:

GET /api/v3/1003/classes HTTP/1.1
Host: app.ecwid.com
Authorization: Bearer secret_token

Response:

[
  {
    "id": 0,
    "attributes": [
      {
        "id": 139165261,
        "name": "Units in product",
        "type": "UNITS_IN_PRODUCT",
        "show": "DESCR"
      },
      {
        "id": 82991001,
        "name": "Price per unit",
        "type": "PRICE_PER_UNIT",
        "show": "PRICE"
      },
      {
        "id": 201437969,
        "name": "UPC",
        "type": "UPC",
        "show": "DESCR"
      },
      {
        "id": 201437970,
        "name": "Brand",
        "type": "BRAND",
        "show": "DESCR"
      }
    ]
  }
]

Required access scopes

Your app must have the following access scopes to make this request: read_catalog

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.

Headers

The Authorization header is required.

Header	Format	Description
Authorization	Bearer secret_ab***cd	Access token of the application.

Response JSON

A JSON array of objects with the following fields:

Field	Type	Description
id	number	Internal unique ID of the product type. By default, all products get the "General" type which ID is 0.
name	string	Product type name. Empty for the "General" type.
googleTaxonomy	string	Google taxonomy associated with the type.
attributes	array of objects attributes	Product attributes assigned to this product type.

attributes

Field	Type	Description
id	number	Internal unique ID of the product attribute.
name	string	Attribute title visible on the storefront if it has some value for the product.
nameTranslated	object translations	Available translations for product attribute name.
type	string	Type of the attribute that defines its functionality. One of: 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 available if the price-per-unit feature is enabled.
show	string	Defines if an attribute is visible on product pages. One of: NOTSHOW DESCR PRICE. The value PRICE = DESCR. Request can use public tokens, but NOTSHOW attributes won't be returned in that case.

translations

Object with text field translations in the "lang": "text" format, where the "lang" is an ISO 639-1 language code. For example:

{
    "en": "Sample text",
    "nl": "Voorbeeldtekst"
}

Translations are available for all active store languages. Only the default language translations are returned if no other translations are provided for the field. Find active store languages with GET /profile request > languages > enabledLanguages.