Naar de hoofdinhoud

[Order Intake - GCW] Hoe je de klant-agnostische Order API-eindpunten gebruikt

S
Geschreven door Styrbjörn Holmberg
Meer dan 3 weken geleden bijgewerkt

Je kunt via de API-endpoints alle klantbestellingen ophalen en doorzoeken — dus niet alleen de bestellingen van één specifieke klant. Zo werkt het:

1. Maak een Connector

  1. Ga naar Order Intake → Connectors.

  2. Maak een Nieuwe Connector.

  3. Kies API Connector.

  4. Selecteer Alle klanten.

  5. Geef het een naam, bijv. Customer-Agnostic Connector.

  6. Kopieer je X-API-KEY.

  7. Klik op Maken.

Nu zijn je eindpunten klaar.


2. Stel je API-verzoeken in

A. Een Enkele Bestelling Ophalen

  • Methode:GET

  • Eindpunt: Gebruik het Get Order eindpunt van je connector.

  • Koppen:

    • X-API-KEY: [uw gekopieerde sleutel]

  • Body: Geen vereist.

  • Stappen:

    1. Vervang de {orderId} in de URL door een werkelijk order-ID.

    2. Klik op Verzenden.

    3. Je ontvangt de bestelgegevens.

B. Zoeken naar meerdere bestellingen

  • Methode:POST

  • Endpoint: Gebruik het Search Orders endpoint van je connector.

  • Koppen:

    • X-API-Key: [je gekopieerde sleutel]

  • Body: Voeg je zoekfilters toe in JSON.

Stappen:

  1. Plak het zoekadres.

  2. Stel de methode in op POST.

  3. Voeg de JSON-body toe.

  4. Klik op Verzenden.

  5. Je krijgt een lijst met bestellingen die erbij passen.


Veelgemaakte fouten die je beter kunt vermijden

  • Verkeerde methode:GET voor een enkele bestelling, POST voor zoeken.

  • Geen API-sleutel: Neem altijd je X-API-KEY op in de header.

  • Ontbrekende body voor zoeken: Voor zoeken heb je een JSON-body met je filters nodig.

Was dit een antwoord op uw vraag?