Tiramizoo Delivery API (1.0)

Getting Started

You can 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 API uses the HTTPS protocol for communication and JSON for serialization of request and response bodies. All URLs start with https://app.tiramizoo.com/api/v1. SSL is mandatory.

Any programming language used in a web development context will usually feature libraries for conveniently accessing a RESTful JSON web service. PHP, Ruby, Java, .NET and Python all do, to name only a few. Integrating RESTful JSON services is usually also much faster and easier than working with SOAP and other XML-based or stateful services.

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

API Tokens

You will need an API token for accessing the API. The API tokens on the sandbox and production systems are different — please contact your salesperson to get them or log in to your Tiramizoo staff interface to access them.

Versioning

All API URLs have to be prefixed with the API version, e.g. /v1/orders.

Authentication

Some API calls require authentication with an API token. We accept API tokens as:

• Query parameter: ?api_token=YOUR_TOKEN
• Header: Api-Token: YOUR_TOKEN

Example with query parameter:

GET /api/v1/orders?api_token=YOUR_TOKEN

Example with header:

GET /api/v1/orders
Api-Token: YOUR_TOKEN

Making Requests

Text payloads must be UTF-8 encoded.

Error Codes & Responses

200 OK

The request succeeded and the resource was retrieved.

201 Created

The resource was created successfully. Typically returned when creating a new order.

204 No Content

The request was processed successfully and no content is 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.

403 Forbidden

The user is not allowed to access the requested resource.

404 Not Found

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

405 Method Not Allowed

The parameter or verb is not supported.

406 Not Acceptable

The request uses a format that is currently not supported.

422 Unprocessable Entity

The data supplied is not valid. See the detailed errors in the response.

429 Too Many Requests

The rate limit has been exceeded. See Rate Limiting.

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.

In requests, send UTC — 2024-01-15T13:30:00Z. An explicit offset is also accepted: 2024-01-15T14:30:00+01:00.

A value sent without time zone information (2024-01-15T14:30:00) is interpreted in your organization's time zone, returned as time_zone by the Service Areas API. Prefer UTC — it stays unambiguous across daylight saving time changes.

Responses always carry time zone information.

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

Rate Limiting

The API implements rate limiting to ensure fair usage. If you exceed the rate limit, you'll receive a 429 Too Many Requests response.

Support

For API support, please contact support@tiramizoo.com