ReflexBlue Externe API V2 referentie: Relaties API

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

Een enkele relatie opvragen

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

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

Via dit eindpunt vraag je het assortiment van 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 bestand aan (zie hieronder).

Het relatie-assortiment CSV-bestand aanmaken

Om het relatie-assortiment CSV-bestand 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 het relatie-assortiment eindpunt 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 assortiment CSV-bestand beschikbaar voor download via de ReflexBlue Externe API V2.

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.