Docs

REST API + MCP — alles gedocumenteerd.

OpenAPI 3.1-spec, 16 tools, AVG-webhooks, limieten per plan. De referentie voor het integreren van PackMate.

OpenAPI-spec Snelstart

Snelstart

Vijf minuten tot eerste request

Van install tot je eerste geauthenticeerde API-call. Werkt voor REST en MCP.

1
Installeer PackMate op Shopify
Klik «Installeer» in App Store. PackMate werkt op elk plan, je kunt starten in Free.
2
Genereer API-key
Instellingen → API & MCP → Genereer. Prefix pm_live_ of pm_test_ voor sandbox.
```
pm_live_4f3a8b9c2d1e...
```
3
Eerste request
Gebruik curl of een HTTP-client. Header X-API-Key authenticeert elke request.
```
curl https://packmate.shop/api/v1/health \
  -H 'X-API-Key: pm_live_…'
```
4
Volgende: MCP
Voor AI werkt dezelfde key voor de MCP-server. Zie /ai voor Claude / ChatGPT.

Authenticatie

API-keys, scopes, rotatie

PackMate gebruikt API-keys met X-API-Key header. SHA-256 gehashed, scoped op shop, rotatie in één klik.

Key-formaat

Twee prefixes: pm_live_ productie, pm_test_ sandbox. Body 32 tekens base62.

pm_live_4f3a8b9c2d1e7f6a5b4c3d2e1f0a9b8c

Header-formaat

Stuur key in X-API-Key. Bearer in Authorization ook geaccepteerd.

X-API-Key: pm_live_…
# of
Authorization: Bearer pm_live_…

Rotatie

Genereer nieuwe key, wissel, trek oude in. Tot 5 actieve keys per shop.

DELETE /api/v1/keys/:key_id
Response: 204 No Content

Scopes

Keys default full read+write. Scoped keys op roadmap.

scope: read_only | label_only | full

Rate limits

Limieten schalen met je plan

Per-minuut en burst-limieten. Bursts gladgestreken door token bucket. Custom plannen onderhandelen.

Plan	Req / min	Burst	Gelijktijdig
Free	60	120	5
Basic	120	240	10
Pro	300	600	25
Business	600	1200	50
Custom	neg.	neg.	neg.

Veeg om meer te zien

Bij limiet krijg je 429 met Retry-After header. De header geeft aan hoeveel seconden te wachten.

Foutcodes

Wat het betekent als iets faalt

Standaard HTTP-semantiek met PackMate-specifieke fout-bodies. Elke fout bevat code en bericht.

Code	Betekenis	Actie
`400`	Bad request — body of query mismatch	Controleer requestvorm tegen OpenAPI-spec.
`401`	Niet geautoriseerd — API-key ontbreekt of ongeldig	Stuur X-API-Key header met geldige pm_live_ key.
`402`	Betaling vereist — plan-limiet bereikt	Upgrade of wacht op volgende cyclus. Bulk-Reconciliation na upgrade.
`403`	Verboden — functie buiten je plan	Alleen query_carrier_rates is plan-gated (Custom).
`404`	Niet gevonden — bron bestaat niet	Verifieer ID. Bestelling mogelijk nog niet gesynchroniseerd.
`422`	Onverwerkbaar — semantische validatie mislukt	Lees error.message — typisch ontbrekende afmetingen.
`429`	Te veel requests — limiet bereikt	Back-off via Retry-After header.
`500`	Interne fout — bug aan onze kant	Retry één keer, dan email naar support@packmate.shop met request_id.
`503`	Service onbeschikbaar — onderhoud of DB	Retry met exponentiële backoff. Status op status.packmate.shop.

Veeg om meer te zien

Client-fout (4xx)Server-fout (5xx)

Webhooks

AVG + lifecycle webhooks

PackMate registreert zes Shopify-webhooks. Vier AVG-verplicht, twee operationeel. Ondertekend met HMAC-SHA256.

customers/redactVerplicht

Klant vraagt verwijdering. PackMate anonimiseert binnen 30 dagen.

customers/data_requestVerplicht

Klant vraagt export. PackMate compileert binnen 30 dagen.

shop/redactVerplicht

Shopify stuurt dit ongeveer 48 uur na het verwijderen. PackMate wist dan alle gegevens van de winkel uit zijn database.

app/uninstalledVerplicht

De app is verwijderd. PackMate markeert de winkel als verwijderd, trekt de API-sleutels in en beëindigt het abonnement. De gegevens worden gewist met shop/redact.

products/updateOptioneel

Product gewijzigd — PackMate ververst gecachte afmetingen.

app/scopes_updateOptioneel

Scopes gewijzigd — PackMate vraagt re-autorisatie.

Alle webhooks ondertekend met HMAC-SHA256 met je app-secret. Verifieer X-Shopify-Hmac-SHA256.

Klaar om te integreren? Genereer een key.

Installeer, genereer key, voer eerste request uit — in minder dan vijf minuten.

Get early access MCP-gids