MEmerchkit

List a product's references, with positions

The key-scoped reference view: { <attribute-key>: { total, has_more, items: [{id, type, label, position}] } }. Forward list references return the same complete membership that embeds in attributes, plus explicit position. INVERSE references — which never embed in attributes because they are unbounded — are readable ONLY here: pass ?attribute=<key> and page with limit/offset (or traverse from the other side with filter[<forward-key>]=<id>).

Scope: read:products.

get/products/{id}/references

Request

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

Query parameters

attributestring

A reference attribute key. Required to read an inverse reference; omit for all forward reference keys.

limitinteger

Rows per page, 1 to 200. Defaults to 50.

Larger pages mean fewer round-trips. 200 is also the cap on in operator value lists, so refetching a full page of IDs with filter[id][in]=... always fits in one call.

offsetinteger

Rows to skip. Zero-based. Echoed back in pagination.offset.

Page forward by adding limit each time. Stop when pagination.has_more is false rather than comparing counts. Default order is created_at ascending, which keeps long sweeps stable: new rows land at the end instead of shifting pages you have not read yet.

Response

References grouped by attribute key.

dataobject

Changes

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