REST API
You need an account to use the Simplymail REST API with a proper username/password combination.
A successful login results in a JSON Web Token. Every API request needs a valid JWT token.
Base URL
The service can be reached with the following base url:
https://restapi.simplymail.quadient.nlFor testing the following base url is used:
https://sandbox.simplymail.quadient.nl
Authentication
The API requires a JWT access token on every request.
To get an access token, you first need to make a request to the Login endpoint.
The login endpoint requires an active account which has been setup for API usage.
You can make the login request by using Basic Authorization.
After a successful login request you obtain an access token.
This access token is valid for a short time and can be renewed by requesting a new access token.
Versioning
To differentiate between the different versions of the endpoints, a custom Request Header is required.
Api-Version: 3.0
Services
The following features are available for the Rest API:
| Function | Method | Endpoint | Description |
|---|---|---|---|
| Parcel | |||
| Create shipment | POST | /parcel/shipment | Create a shipment |
| Update shipment | PUT | /parcel/shipment/{shipmentId} | Update a shipment |
| Delete shipment | DELETE | /parcel/shipment | Delete a shipment |
| Download label | POST | /parcel/label | Download label |
| Shipment status | GET | /parcel/status/{barcode} | Status of shipment |
| Pick up points | GET | /parcel/pickup/{zipCode} | Retrieve pick up points by zip code |
| Flex | |||
| List products | POST | /flex/list | List product options |
| Create order | POST | /flex/order | Create a Flex order |
Parcel
Shipments can be created, partially updated and deleted with the Parcel API. Several methods are available to create shipments and retrieve the labels in a specified format.
Additional services are available for parcels type shipments. These service options can be found on the Options page.
Flex
It's possible to retrieve a list of products for creating Flex orders.
Based on the supplied parameters a list of products is returned from which men can choose to create the Flex order.
The order endpoint is almost identical to the list endpoint but with an additional required parameter product code.
This product code can be obtained from the list endpoint which retrieves the available products based on the input parameters.
After the order endoint has created the Flex order an email will be send with the tender pdf.
If additional addresses have been supplied with the request also the address labels will be generated and attached to the email.