Tiramizoo Courier API (1.0)

Getting Started

You can easily connect Tiramizoo to your platform by programming against the corresponding REST/JSON API.

Please use sandbox.tiramizoo.com for testing purposes. It's a full copy of the production environment.

The tiramizoo.com API uses the HTTPS protocol for communication and JSON for serialization of request and response bodies. All URLs start with https://app.tiramizoo.com/courier_api/v1. SSL is mandatory.

Text payloads are supported only as UTF-8-encoded.

If you encounter a problem when using the API, please let us know.

Versioning

All API URLs have to be prefixed with the API mount path, e.g. /courier_api/v1/tours.

Authentication

Every Courier API endpoint is protected and requires authentication via an auth_token passed as a Bearer token in the Authorization header:

GET /courier_api/v1/tours
Authorization: Bearer YOUR_AUTH_TOKEN

The auth_token is obtained by calling the authorization endpoint (POST /courier_api/v1/auth, or the SSO variants POST /courier_api/v1/google_auth and POST /courier_api/v1/microsoft_auth) with the courier's credentials. The returned token is then passed in the Authorization header on every subsequent request.

A missing or invalid auth_token results in a 401 Unauthorized response.

Error Codes & Responses

200 OK

The request succeeded. The resource was retrieved successfully.

201 Created

The resource was created successfully.

204 No Content

The request has been processed successfully and no content was returned.

400 Bad Request

The request was not valid. The request may be incorrect, or the data in the request is not in the correct format. Check the message details for more information concerning the bad request, correct the request data, and try the invocation again.

401 Unauthorized

The user is not authorized to access the requested resource. The auth_token is missing or invalid.

403 Forbidden

The user is not granted access to the requested resource.

404 Not Found

The requested resource was not found or no corresponding data is available.

405 Method Not Allowed

The HTTP method used is not supported for this resource.

406 Not Acceptable

The requested response format is not currently supported.

422 Unprocessable Entity

Data supplied is not valid. See detailed errors in the response.

500 Internal Server Error

The server encountered an unexpected condition that prevented it from processing the request.

503 Service Unavailable

The application is offline for maintenance.

504 Gateway Timeout

The request couldn't complete in time. Tiramizoo waits up to 25 seconds for a response. Try breaking it down into multiple smaller requests.

Data Formats

Dates and Times

All dates and times are in ISO 8601 format with time zone information.

Example: 2024-01-15T14:30:00+01:00

Phone Numbers

Phone numbers should be in international format with country code.

Example: +4930123456

Country Codes

Country codes follow ISO 3166-1 alpha-2 standard.

Examples: de, at, ch

Geographic Coordinates

Locations are represented as latitude/longitude pairs in decimal degrees.

Support

For API support, please contact support@tiramizoo.com