Mat ShelfOpen console

Consumer API · v1

Mat Shelf consumer API

Supplier reference facts and inventory observations for store connectors. Store titles, prices, publication, SEO, and media choices remain store-owned.

OpenAPI schemaLive health

Authenticate

Send the store credential only as Authorization: Bearer <store token>. Tokens are never query parameters. Every response and acknowledgement is scoped to that credential’s store.

Read catalogue safely

  1. Request GET /v1/catalogue?limit=100.
  2. Keep the response at value and send it on every later page, with next.after.
  3. Apply the complete snapshot, acknowledge at, then read /v1/changes?after=at in order.

Entity identity is the UUID, not the SKU. SKU aliases are exact recorded values. Multiple lookup results need human mapping; do not choose the first.

Inventory meaning

freshness is calculated when served. stale and unknown must not be treated as fresh. indexed_stock is an indexed supplier observation; only salable_stock represents reservation-aware verification.

Acknowledge

POST /v1/ack only after a complete page is applied. Cursors cannot regress or move beyond what this store received. A failed page cannot advance the cursor. Keep customer and order data out of acknowledgement details.