Disse konseptene gjelder på tvers av alle endepunkter i APIet.
ID-format
Alle ressurser identifiseres med UUID-er på formatet 7c2dd4c3-6d42-4d93-a4be-6f69a9ab1f3b.
Paginering
Alle liste-endepunkter støtter paginering via query-parametere:
| Parameter | Standard | Beskrivelse |
|---|---|---|
page | 0 | Sidenummer (0-basert) |
size | 100 | Antall elementer per side |
Eksempel: GET /api/v2/products?page=0&size=50
Responsen har alltid følgende format:
{ "content": [...], "totalElements": 1234, "totalPages": 25, "size": 50, "number": 0 }
Hold size under et fornuftig nivå (f.eks. ≤ 500) for å unngå tunge responser. Merk at relasjonslistene har lavere standard sidestørrelse (size=20).
Sortering
Bruk sort-parameteret, gjerne flere ganger:
?sort=id,asc– enkel sortering?sort=name:nb,asc&sort=id,desc– flerspråklig sortering med sekundærsortering
For flerspråklige felter som name og description må du oppgi språkkode (f.eks. nb eller en). Tilgjengelige språk hentes fra /api/v2/languages.
Flerspråklig innhold
Felter med tekstinnhold returneres og sendes inn som en liste med oversettelser:
{ "name": [ { "languageCode": "nb", "value": "Produktnavn" }, { "languageCode": "en", "value": "Product name" } ] }
Send én eller flere språkvarianter i request-kroppen ved skriving.
Partial update (PATCH)
PATCH-endepunkter støtter selektiv oppdatering – kun feltene du sender inn oppdateres. Felt du utelater forblir uendret. Bruk PUT der det eksplisitt er angitt (f.eks. upsert av enkeltattributt).
Bulk-operasjoner
Der det finnes bulk-endepunkter bør disse foretrekkes fremfor mange enkelt-kall. For eksempel /api/v2/products/{productId}/attributes/bulk for å sette mange attributter på ett produkt – langt mer effektivt enn å kalle én og én.
Slettet innhold
FEED bruker soft-delete. Slettede ressurser returneres ikke i API-listene, men de er ikke permanent fjernet fra systemet.