ReflexBlue Externe API V2 referentie: Orders API
Met de ReflexBlue Externe API V2 importeer en raadpleeg je eenvoudig orders. Daarnaast kun je leverdata en prijzen van verkoopartikelen opvragen.
Gebruik deze API om inkoop- en verkoopprocessen te automatiseren en direct inzicht te krijgen in levermogelijkheden en prijzen voor je klanten.
Bekijk voor gedetailleerde technische informatie over deze API de Swagger documentatie.
Een enkele order opvragen
| HTTP-methode | Eindpunt |
|---|---|
| POST | /{administrationNumber}/api/external/v{version}/orders/{orderId} |
Gebruik dit eindpunt om detailgegevens van een specifieke order op te halen. Dit is bijvoorbeeld handig wanneer je op basis van een webhookgebeurtenis een order wilt ophalen.
Een lijst van orders opvragen
| HTTP-methode | Eindpunt |
|---|---|
| POST | /{administrationNumber}/api/external/v{version}/orders/list |
Met dit eindpunt vraag je een lijst van orders op. Je kunt de resultaten filteren op verschillende criteria. Gebruik dit eindpunt voor de initiële datavulling of het periodiek ophalen van nieuwe of gewijzigde orders.
Een order importeren
Een verkooporder importeren
| HTTP-methode | Eindpunt |
|---|---|
| POST | /{administrationNumber}/api/external/v{version}/orders/sales/import |
Via dit eindpunt importeer je een verkooporder in ReflexBlue. Je kunt hiermee nieuwe verkooporders toevoegen of bestaande verkooporders bijwerken.
Belangrijke aandachtspunten
-
Je kunt alleen verkooporders importeren voor relaties die in ReflexBlue zijn aangemerkt als klant, en voor artikelen die als verkoopartikel zijn gemarkeerd.
-
Verkooporders voor EDI-relaties worden op dit moment niet ondersteund.
-
Bij het importeren van verkooporders worden deze eerst gematcht op de order-ID en daarna op de externe code (
ExternalCode), als die aanwezig is.Geef altijd een unieke externe code mee. Hiermee leg je een koppeling tussen verkooporders in ReflexBlue en je externe systeem.
-
Als een eerder geïmporteerde verkooporder inmiddels gesloten is in ReflexBlue, kun je deze niet meer bijwerken via de API. Na 60 dagen kun je de verkooporder opnieuw importeren als een nieuwe order.
-
Bij het importeren kun je orderregels en dynamische velden alleen bijwerken, niet verwijderen.
Een inkooporder importeren
| HTTP-methode | Eindpunt |
|---|---|
| POST | /{administrationNumber}/api/external/v{version}/orders/purchase/import |
Via dit eindpunt importeer je een inkooporder in ReflexBlue. Je kunt hiermee nieuwe inkooporders toevoegen of bestaande inkooporders bijwerken.
Belangrijke aandachtspunten
-
Je kunt alleen inkooporders importeren voor relaties die in ReflexBlue zijn aangemerkt als leverancier, en voor artikelen die als inkoopartikel zijn gemarkeerd.
-
Inkooporders voor EDI-relaties worden op dit moment niet ondersteund.
-
Bij het importeren van inkooporders worden deze eerst gematcht op de order-ID en daarna op de externe code (
ExternalCode), als die aanwezig is.Geef altijd een unieke externe code mee. Hiermee leg je een koppeling tussen inkooporders in ReflexBlue en je externe systeem.
-
Als een eerder geïmporteerde inkooporder inmiddels gesloten is in ReflexBlue, kun je deze niet meer bijwerken via de API. Na 60 dagen kun je de inkooporder opnieuw importeren als een nieuwe order.
-
Bij het importeren kun je orderregels en dynamische velden alleen bijwerken, niet verwijderen.
Importstrategie kiezen
Je geeft in het HTTP-verzoek aan welke importstrategie je wilt gebruiken.
| Strategie | Omschrijving |
|---|---|
Create | Maakt een nieuwe order aan. Bestaat er al een order met dezelfde externe code? Dan faalt het verzoek. |
Update | Werkt een bestaande, eerder geïmporteerde order bij. Bestaat de order niet? Dan faalt het verzoek. |
Upsert | Maakt een nieuwe order aan als deze nog niet bestaat. Bestaat de order al? Dan wordt deze bijgewerkt. |
Response bij importeren
Als het importeren van een order is gelukt, ontvang je de order terug met een lijst van meldingen. Deze meldingen bevatten informatieve berichten en waarschuwingen die tijdens het importproces zijn opgetreden. Bij een mislukte import bevat deze lijst ook foutmeldingen.
Leveringsinformatie opvragen voor verkoopartikelen
| HTTP-methode | Eindpunt |
|---|---|
| POST | /{administrationNumber}/api/external/v{version}/orders/sales/deliverydates |
Met dit eindpunt vraag je leveringsinformatie op voor verkoopartikelen in ReflexBlue voor specifieke relaties. Je kunt hiermee verkoopprijzen, leveringsdatums en routes en de beschikbare voorraad opvragen die gelden voor relaties en verkoopartikelen. Gebruik dit eindpunt om te controleren of en wanneer artikelen leverbaar zijn voor een bepaalde relatie.
Belangrijke aandachtspunten
- Dit eindpunt werkt alleen voor relaties die als klant zijn aangemerkt in ReflexBlue en voor artikelen die als verkoopartikel zijn ingesteld.
- Je kunt per verzoek de leveringsinformatie van tot maximaal honderd artikelen opvragen. Indien je voor meer dan honderd artikelen de leveringsinformatie wil opvragen dan zul je dit in meerdere verzoeken moeten doen.
Stapsgewijze instructie
-
Stuur een eerste verzoek naar dit eindpunt met daarin een relatie en optioneel de gewenste lever-/verzenddatums en route. Je ontvangt een lijst met mogelijke lever-/verzenddatums en routes voor die relatie.
-
Stuur een tweede verzoek voor dezelfde relatie, en kies één van de ontvangen lever-/verzenddatums en routes uit het eerste verzoek. Voeg een lijst van verkoopartikelen met gewenste hoeveelheid/gewicht toe om de mogelijke lever-/verzenddatums, prijzen en voorraad voor die artikelen op te vragen.
- Kan een artikel geleverd worden op de opgegeven lever-/verzenddatums en route? Dan wordt het artikel geretourneerd zonder verzendinformatie en staat
isDeliverableoptrue. - Is een artikel niet beschikbaar op de opgegeven lever-/verzenddatums en route, of komen deze niet overeen? Dan retourneert de server de eerstvolgende beschikbare lever-/verzenddatums en route, en staat
isDeliverableoptrue. - Is een artikel niet leverbaar? Dan wordt het artikel geretourneerd zonder leveringsinformatie en staat
isDeliverableopfalse. - Wanneer het een vooraadhoudend artikel betreft, wordt de beschikbare voorraad op de opgegeven lever-/verzenddatums ook geretourneerd.
- Kan een artikel geleverd worden op de opgegeven lever-/verzenddatums en route? Dan wordt het artikel geretourneerd zonder verzendinformatie en staat