Get recently used product swatches

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

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 object with the following fields:

Name
Type
Description

colors

array of objects colors

List of the SWATCHES product options recently used by the store owner. It is formed from the products with the SWATCHES option and sorted by the update time.

colors

Name
Type
Description

name

string

Name of the SWATCHES product option. This name should describe the color, for example, "Red" or "Dark Green".

hexCode

string

HEX code that defines what color must be displayed when a user selects the related product SWATCHES option, for example: ["#fff000"].

translations

Available translations for the SWATCHES option name.

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.

Last updated

Was this helpful?