036 535 80 70 helpdesk@reflex-systems.nl
Documentatie

ReflexBlue Externe API V2 referentie: Relaties API

2026-06-17 09:24 UTC
Externe API V2

Met de ReflexBlue Externe API V2 raadpleeg je eenvoudig relatiegegevens.
Daarnaast kun je het artikelassortiment van relaties opvragen, inclusief details zoals prijzen en leverdatums.

Gebruik deze API om CRM-processen 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 relatie opvragen

HTTP-methode Eindpunt
POST /{administrationNumber}/api/external/v{version}/relations/{relationId}

Gebruik dit eindpunt om detailgegevens van een specifieke relatie op te halen. Dit is bijvoorbeeld handig als je op basis van een webhookgebeurtenis een relatie wilt ophalen.

Een lijst van relaties opvragen

HTTP-methode Eindpunt
POST /{administrationNumber}/api/external/v{version}/relations/list

Met dit eindpunt vraag je een lijst van relaties 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 relaties.

Assortiment van relaties opvragen

Let op: Voor het gebruik van de relatie-assortiment eindpunten is eerst extra configuratie nodig voor het aanmaken van het relatie-assortiment. Hieronder lees je hoe je dit instelt.

Het relatie-assortiment aanmaken

Om het relatie-assortiment aan te maken in ReflexBlue, voer je deze stappen uit:

  1. Maak een integratie aan in ReflexBlue via het Integraties overzichtsscherm in de ReflexBlue Desktop Client.

    De ID van deze integratie gebruik je als integrationId in het verzoek naar de relatie-assortiment eindpunten van de ReflexBlue Externe API V2.

    Je kunt de integratie-ID opvragen via het integraties-eindpunt van de ReflexBlue Externe API V2, op basis van de Externe integratie ID die je hebt opgegeven bij het aanmaken van de integratie.

  2. Maak een geplande taak aan in ReflexBlue via het Geplande taken overzichtsscherm in de ReflexBlue Desktop Client. Hou daarbij rekening met het volgende:

    • Kies de taak Assortiment van relaties exporteren voor een integratie.

    • Geef onder de kop Extra instellingen de volgende gegevens op:

      • Geef bij Integratie de integratie op die je hebt aangemaakt.
      • Geef bij Dynamisch veld van de relatie aan welk dynamisch veld bepaalt of de relatie wordt opgenomen in het assortimentbestand.
      • Geef bij Dynamisch veld van het artikel aan welk dynamisch veld bepaalt of het artikel wordt opgenomen in het assortimentbestand.

      De dynamische velden bij de relatie en het artikel moeten van het type Ja/Nee (boolean) zijn. Je maakt dynamische velden aan via het Dynamische velden overzichtsscherm in de ReflexBlue Desktop Client.

      Staat de Standaardwaarde van deze velden op Ja (true)? Dan worden alle relaties en artikelen waarbij deze velden niet expliciet op Nee (false) staan meegenomen in het assortiment.

Na de eerste uitvoering van de geplande taak is het relatie assortiment beschikbaar voor gebruik via de ReflexBlue Externe API V2.

Let op:

  • Alleen relaties die in ReflexBlue als klant zijn ingesteld, worden meegenomen in het assortiment.
  • Alleen artikelen die in ReflexBlue als verkoopartikel zijn ingesteld, worden meegenomen in het assortiment.
  • Relaties en artikelen moeten via een dynamisch veld zijn geconfigureerd om opgenomen te worden in het assortiment.

Assortiment van alle relaties opvragen in CSV formaat

HTTP-methode Eindpunt
GET /{administrationNumber}/api/external/v{version}/relations/assortment/{integrationId}

Via dit eindpunt vraag je het assortiment van alle relaties op uit ReflexBlue.
Je downloadt het assortiment als CSV-bestand. Het assortiment bevat artikelen die beschikbaar zijn per relatie, inclusief details zoals prijzen en leverdatums.

Werkwijze

  1. Stuur een verzoek naar dit API-eindpunt. Je ontvangt HTTP-statuscode 302 (Found) met een redirect-URL naar het assortiment CSV-bestand. Met een vervolgverzoek download je het CSV-bestand. De meeste HTTP-clients volgen redirects automatisch, waardoor het bestand direct wordt gedownload.

  2. Is het relatie-assortiment CSV-bestand nog niet aangemaakt, dan ontvang je HTTP-statuscode 404 (Not Found). Maak in dat geval eerst het relatie-assortiment aan.

Inhoud van het relatie-assortiment CSV-bestand in ReflexBlue

Het relatie-assortiment CSV-bestand bevat alle artikelen die beschikbaar zijn voor relaties in ReflexBlue, inclusief prijs- en leverinformatie. Gebruik dit bestand om snel inzicht te krijgen in het assortiment, prijzen en levermogelijkheden per klant.

Beschikbare kolommen in het CSV-bestand

In de tabel hieronder zie je welke gegevens in het relatie-assortiment CSV-bestand staan. Elke rij geeft de informatie van één artikel voor één relatie weer.

Kolom Naam Type Optioneel Omschrijving
1 relationId guid De unieke ID van de relatie in ReflexBlue.
2 relationCode number De relatiecode in ReflexBlue.
3 articleId guid De unieke ID van het artikel in ReflexBlue.
4 articleCode number De code van het artikel in ReflexBlue.
5 inAssortment boolean Geeft aan of het artikel in het assortiment van de relatie zit (true of false).
6 priceCurrencyCode string De valutacode van de verkoopprijs (bijvoorbeeld EUR).
7 price decimal De verkoopprijs van het artikel voor de relatie.
8 specialOfferPrice decimal ✓ De reclameprijs van het artikel voor de relatie.
9 specialOfferFromDate date ✓ De datum (yyyy-MM-dd) vanaf wanneer de reclameprijs geldig is.
10 specialOfferUntilDate date ✓ De datum (yyyy-MM-dd) tot wanneer de reclameprijs geldig is.
11 amountDiscountPercentage decimal ✓ Het kortingspercentage dat geldt voor het artikel.
12 isUnlimited boolean Geeft aan of het artikel onbeperkt leverbaar is (true of false).
13 deliverableAt date ✓ De eerst mogelijke leverdatum (yyyy-MM-dd) van het artikel voor deze relatie.
14 availableQuantity decimal ✓ Het aantal stuks van het artikel dat beschikbaar is voor levering.
15 availableWeight decimal ✓ Het gewicht van het artikel dat beschikbaar is voor levering.

Assortiment van een enkele relatie opvragen in JSON formaat

HTTP-methode Eindpunt
POST /{administrationNumber}/api/external/v{version}/relations/assortment

Via dit eindpunt vraag je het assortiment van een enkele relatie op uit ReflexBlue in JSON formaat. Het assortiment bevat artikelen die beschikbaar zijn voor de relatie, inclusief details zoals prijzen en leverdatums. De beschikbare gegevens zijn hetzelfde als bij het CSV-bestand.

Is het relatie-assortiment nog niet aangemaakt, dan ontvang je HTTP-statuscode 404 (Not Found). Maak in dat geval eerst het relatie-assortiment aan.

Navigatie

Zoeken

Geen resultaten.