MEmerchkit

List attribute definitions (schema discovery)

The schema of an entity type: every attribute key, its data type, whether it is writable (formulas/inverse references are not), and the parsed acceptable_values for selects. Call this FIRST and cache it — entity attributes maps are sparse, so this is the canonical "what fields exist" answer. Optionally scope to a channel.

Scope: read:attributes.

get/attributes

Request

  • Base URL
    https://www.merchkit.com/api/v1
  • Auth
    HTTP bearer

Query parameters

type'product' | 'image' | 'vendor' | 'category' | 'source'

The entity type to describe.

channelstring

Restrict to one channel's attributes.

Response

Attribute definitions (not paginated).

Example response

{
  "data": [
    {
      "id": "a3d81c22-5f6e-4b09-8d17-c40a92e5b613",
      "key": "material",
      "name": "Material",
      "entity_type": "product",
      "data_type": "single_select_list",
      "channel": null,
      "is_primary": false,
      "writable": true,
      "acceptable_values": [
        "White Oak",
        "Smoked Oak",
        "Walnut"
      ],
      "default_value": null,
      "formula_expression": null
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.