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

API-overzicht

Plaats een bestelling uit de klantwinkelwagen

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

SchrijvenGeauthenticeerd

POST/api/v1/checkout

Plaats een bestelling uit de klantwinkelwagen

Sanctum-sessie of bearer-token. Vereiste bearer-bevoegdheid: orders.create

Verzoek
VeldInRegel
billingJSON-bodyVerplicht adresobject: name en line1 strings maximaal 255; city maximaal 120; postal_code maximaal 20; country precies 2. Nullable company/line2 maximaal 255, region maximaal 120, phone maximaal 40.
payment_method, discount_codeJSON-bodyNullable strings; elk maximaal 40. Gebruik een beschikbare betaalmethode.
idempotency_keyJSON-bodyNullable string; maximaal 64. Hier alleen via JSON, niet de Idempotency-Key-header. Hergebruik alleen voor dezelfde beoogde bestelling.
shippingJSON-bodyNullable adresarray, omgezet naar AddressData. Geen herhaalde geneste factuuradresvalidatie; domeinregels blijven gelden.
shipping_same_as_billingJSON-bodyOptionele boolean; standaard true.
shipping_method_idJSON-bodyNullable integer.
custom_propertiesJSON-bodyNullable array; domeinvereisten gelden. Producten, klantidentiteit en totalen zijn niet door de client te overschrijven.
cURL
curl --request POST "https://shop.example.test/api/v1/checkout" \
  --header 'Accept: application/json' \
  --header "Authorization: Bearer $API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"billing":{"name":"Alex Example","line1":"Example Street 1","city":"Brussels","postal_code":"1000","country":"BE"},"shipping_same_as_billing":true,"payment_method":"<discovered-method-id>","idempotency_key":"example-checkout-01"}'
Antwoord200 / 201
Succes: 200 / 201

Responsestructuur (notatie, geen opgenomen antwoord)

schema
{ data: Order }

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.
422validation_error: ongeldige invoer of niet-vervulde domeinvereisten. Betaalinitiatie kan ook payment_failed geven.
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