Get widget config definitions

GET

/merchants/{merchantCode}/shops/{shopCode}/widgetConfigDefinitions

const url = 'https://cms.shopgate.io/v1/merchants/example/shops/example/widgetConfigDefinitions?limit=100&offset=0';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://cms.shopgate.io/v1/merchants/example/shops/example/widgetConfigDefinitions?limit=100&offset=0'

Returns the list of available widgets and their configuration schemas for the specified shop and locale.

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

shopCode

required

string

<= 255 characters

Query Parameters

localeCode

string

<= 5 characters

Locale code to change the language of the name, descriptions, properties and media

limit

integer

default: 100 >= 1 <= 100

The limit of entries of one page

offset

integer

The offset where to start the page

Responses

200

Widget config definitions

application/json

object

meta

required

object

limit

number

offset

number

totalItemCount

number

widgetConfigDefinitions

required

object

Example

{
  "meta": {
    "limit": 10,
    "offset": 0,
    "totalItemCount": 1
  }
}

404

Resource not found

application/json

object

statusCode

number

code

required

string

message

required

string

Example

{
  "code": "NotFound",
  "message": "Merchant not found"
}