Offsys documentatie

Inleiding

Door middel van de API is het mogelijk om een koppeling te maken met Offsys.

Starten

Voor elke aanvraag is een API key nodig. De key staat in Offsys onder layouts. Open de layout die je wilt gebruiken en kopieer de key. Stuur de key mee in de header Authorization.

Voorbeeld:

curl "https://api.offsys.nl/products" \
-X GET \
-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d"

Een key hoort bij één layout. Orders die je aanmaakt krijgen die layout. Je ziet alleen de orders en statistieken van die layout.

Antwoorden en fouten

Elk antwoord heeft een veld status: success of error. Bij error staat in message wat er mis is.

{
    "status": "error",
    "message": "date doesn't have a (valid) value"
}

Code	Betekenis
200	Gelukt
400	Het filter of de sortering is ongeldig
401	Er is geen of een ongeldige API key meegestuurd
404	De order, klant of het product bestaat niet
422	Een veld ontbreekt of heeft een ongeldige waarde. In message staat om welk veld het gaat
500	Er ging iets mis in Offsys
502	De mail kon niet naar alle ontvangers verstuurd worden, zie mailen

Pagina's

Orders, producten, productgroepen, klanten en beschikbaarheid komen per pagina terug. Onder meta staat hoeveel resultaten en pagina's er zijn.

Veld	Standaard	Omschrijving
page	1	Welke pagina je wilt ophalen
per_page	100	Aantal resultaten per pagina, maximaal 500

"meta": {
    "total": 248,
    "per_page": 100,
    "current_page": 1,
    "last_page": 3
}