Metafield

Storefront Metafield API endpoints

Endpoints

GET/metafields

Get shop's metafields

GET /metafields

Retrieves a paginated list of shop's metadata.

Query parameters

pageoptionalinteger

Page number for pagination

per_pageoptionalinteger

Entities per page

idsoptionalinteger[]

Filter by metadata by IDs

slugsoptionalstring[]

Filter by metadata by slugs

presetoptionalboolean

Filter by metadata preset

variantoptionalboolean

Filter by metadata variant type

sort[field]optionalstring

Field to sort by. Required whenever any sort key is sent.

Possible values: id, name.

sort[direction]optionalstring

Sort direction; defaults to asc.

Possible values: asc, desc.

Defaults to "asc".

Returnsobject

Successful response

Error responses

422object

A query parameter fails validation. ids or slugs is not an array or repeats a value; an ids entry is not an integer; a slug is longer than 255 characters; preset or variant is not a boolean; sort is not an array, sort.field is missing or not id or name, or sort.direction is not asc or desc; page is below 1; per_page is outside 1-100; or expand is not an array.

curl https://api.subbly.co/storefront/v1/metafields \
  -H 'X-API-KEY: <api-key>'

Response

{
  "pagination": {
    "current_page": 1,
    "last_page": 2,
    "from": 1,
    "to": 1,
    "total": 20
  },
  "data": [
    {
      "id": 1,
      "name": "Color",
      "slug": "color-red",
      "description": "description",
      "unit": "kg",
      "data_type": "single_line_string",
      "preset": true,
      "multiple": true,
      "save_behavior": "customer",
      "editable": true,
      "values": [
        {
          "id": 1,
          "value": "value"
        }
      ]
    }
  ]
}