Overview

Resource HTTP verb Endpoint Omschrijving
Orders GET /services/rest/orders/v2 Het ophalen van orders.
Orders PUT /services/rest/order-items/v2/:id/cancellation Het annuleren van een order.
Shipments GET /services/rest/shipments/v2 Het ophalen van shipments.
Shipments POST /services/rest/shipments/v2 Het aanmaken van een shipment met of zonder een shipping-label.
Shipping-labels GET /services/rest/purchasable-shipping-labels/v2?orderItemId=:id Het ophalen van alle beschikbare shipping-labels op basis van het opgegeven order-item.
Shipping-labels GET /services/rest/transports/v2/:transportId/shipping-label/:shippingLabelId Het ophalen van een specifieke shipping-label.
Transports PUT /services/rest/transports/v2/:id Het achteraf toevoegen van track&trace informatie.
Process-status GET /services/rest/process-status/v2/:id Het ophalen van de status. Dit is de status van een eerder uitgevoerde POST/PUT request.
Return-items GET /services/rest/return-items/v2/unhandled Het ophalen van open return-items.
Return-items PUT /services/rest/return-items/v2/:id/handle Het verwerken van een open return-item.
Payments GET /services/rest/payments/v2/:yyyymm Het ophalen van alle betalingen in een specifieke maand.

API keys

Voor meer informatie over het verkrijgen van jouw API keys, zie hier.

Authenticatie

Alle API requests moeten over HTTPS gaan. Een API request over HTTP zal een foutmelding teruggeven. Daarnaast zijn alle endpoints beveiligd en wordt toegang enkel verleend indien de request headers correct worden ingevuld, hieronder volgt informatie welke request headers toegevoegd moeten worden bij alle API requests. Een API request zonder deze request headers zal leiden tot een foutmelding.

Root endpoint

https://plazaapi.bol.com

Request headers

Alle API requests moeten voorzien zijn van deze onderstaande request headers:

Content-Type

De Content-Type header wordt op dit moment enkel gevuld met de waarde “application/xml“.

X-Bol-Date

De X-Bol-Date header wordt op onderstaande manier opgebouwd:

Wed, 17 Feb 2016 00:00:00 GMT

X-Bol-Authorization

De X-Bol-Authorization header wordt op een specifieke manier opgebouwd, zie hier voor meer informatie.

User-Agent

Het gebruik van de User-agent header is niet verplicht maar wel aangeraden.

HTTP verbs

Indien mogelijk streeft de v2 API ernaar om de juiste HTTP verbs te gebruiken per methode.

HTTP verbs Omschrijving
GET Wordt gebruikt om resources op te vragen.
POST Wordt gebruikt om resources aan te maken.
PUT Wordt gebruikt om resources te wijzigen.
DELETE Wordt gebruikt om resources te verwijderen.