Ga naar de inhoud
agovena.
agovena.
Aan de slag
Community

API-overzicht

Bekijk creditnota’s van de klant

Kies een handeling voor het request, responsestructuur, toegangsregels en implementatiebron.

LezenGeauthenticeerd

GET/api/v1/credit-notes

Bekijk creditnota’s van de klant

Sanctum-sessie of bearer-token. Vereiste bearer-bevoegdheid: credit_notes.read

Verzoek
VeldInRegel
pageQuerystringOptioneel paginanummer; standaard 1. Geen per_page- of sort-override.

Geen requestbody.

cURL
curl --request GET "https://shop.example.test/api/v1/credit-notes" \
  --header 'Accept: application/json' \
  --header "Authorization: Bearer $API_TOKEN" \
  --get \
  --data-urlencode 'page=1'
Antwoord200
Succes: 200

Responsestructuur (notatie, geen opgenomen antwoord)

schema
{ data: CreditNote[], links, meta }

Volledig responseschema

Gebruikelijke fouten
HTTP-statusBetekenis
401unauthenticated: ontbrekende of ongeldige authenticatie.
403unauthorized, insufficient_scope of ip_not_allowed: controleer klantcontext, bevoegdheid en token-IP-beleid.
429rate_limited: wacht voor een nieuwe poging, vooral bij schrijfverzoeken.
Foutstructuur en globale aandachtspunten

Doorzoek de documentatie

Zoek handleidingen, commando’s en API-endpoints

Waar ben je naar op zoek?

Documentatie