API docs by Redocly

Tiramizoo Delivery API (1.0)

Download OpenAPI specification:

Tiramizoo Support: support@tiramizoo.com License: Proprietary

Overview

Tiramizoo has two APIs:

  1. Order creation API (this document) This API can be used to create/upload new orders (either for a tour or for point-to-point delivery) and to check the status of orders. It can also be used to display all service areas and time windows of the relevant process.

  2. Courier API https://dev.tiramizoo.com/courier-api-doc/ The Courier API is used by our app and therefore covers all of the app's functionality. It provides couriers with their tours/offers and enables them to change the status of a stop (delivered, picked up, upload signature, error, ...). You only need to implement this API if your couriers use your own app rather than the Tiramizoo driver app.

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

Orders

Create, retrieve, update, and manage delivery orders.

Order States

Order States Diagram

An order can transition through the following states:

  • created - Order is being processed by the Tiramizoo system

  • geocoded - Addresses have been validated and geocoded

  • distributed - Order has been assigned to a courier

  • dispatched - Courier has received order information and is en route

  • picked_up - Order has been picked up from the pickup address

  • pickup_failed - Courier went to the pickup location but couldn't complete the pickup

    Possible reasons (event types):

    • package_was_not_ready
    • sender_wants_to_cancel
    • sender_was_not_at_home
    • wrong_package_size

  • delivered - Order has been delivered to the delivery address

  • delivery_failed - Courier went to the delivery location but couldn't deliver

    Possible reasons (event types):

    • abort_delivery
    • address_not_found
    • failed_due_to_business_closed
    • name_not_found_on_doorbell
    • no_attempt_due_to_being_late
    • not_enough_money_for_payment
    • package_is_damaged
    • package_was_delivered_too_late
    • package_was_not_accepted
    • package_was_not_ordered
    • recipient_was_not_at_home

  • returned - Courier returned the delivery to the pickup location

  • cancelled - Order has been cancelled before a courier started to process the delivery

Timestamps

Each state has a corresponding timestamp field:

  • created_at - When order was created
  • dispatched_at - When courier received the order
  • picked_up_at - When package was picked up
  • pickup_failed_at - When pickup failed
  • delivered_at - When package was delivered
  • delivery_failed_at - When delivery failed
  • returned_at - When package was returned
  • cancelled_at - When order was cancelled

When a timestamp is not set, the order hasn't reached that state yet.

Finding Failure Reasons

To get the reason for pickup_failed or delivery_failed states, check the history array which contains detailed event information including the type field with the specific failure reason.

Note: photo_proof is deprecated — use photo_proofs instead.

"history": [
  {
    "retry_at": null,
    "type": "pick_up",
    "recorded_at": "2017-05-09T19:29:25+02:00",
    "signature": {
      "url": null,
      "name": null
    },
    "photo_proof": {
      "url": null,
      "name": null
    },
    "photo_proofs": {
      "name": null,
      "urls": ["http://sandbox.tiramizoo.com/courier_api/v1/signatures/16e813d2-e054-4901-8b06-b8f7102f10fb.png"]
    },
    "current_state": "picked_up"
  },
  {
    "retry_at": null,
    "type": "recipient_was_not_at_home",
    "recorded_at": "2017-05-09T20:05:00+02:00",
    "signature": {
      "url": null,
      "name": null
    },
    "photo_proof": {
      "url": null,
      "name": null
    },
    "photo_proofs": {
      "name": null,
      "urls": ["http://sandbox.tiramizoo.com/api/v1/photo_proof_images/16.png?photo_proof_id=ecfeb829-1a64-4a36-af85-f687805b9e62"]
    },
    "current_state": "delivery_failed"
  }
]

List Orders

Retrieve a paginated list of orders. You can filter orders by external_id or creation date.

Authorizations:
ApiTokenQueryApiTokenHeader
query Parameters
api_token
string
Example: api_token=jksdorj23hh

Authentication token

external_id
string
Example: external_id=ABH78H

Custom ID that enables connecting Tiramizoo orders with your internal infrastructure.

page
integer >= 1
Default: 1
Example: page=1

Page number (default is 1)

per_page
integer [ 1 .. 100 ]
Default: 100
Example: per_page=10

Orders per page (default is 100, max is 100)

from
string <date-time>
Example: from=2012-01-05T11:45:34Z

Filter orders created after this timestamp (ISO 8601)

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "meta": {
    }
}

Create Order

Create a new delivery order with pickup and delivery details.

Important Notes

Time Windows

delivery.before and delivery.after define the delivery time window. Both are ISO 8601 timestamps — see Dates and Times.

Valid values can be retrieved from Service Areas API.

If different values are provided, they are adjusted to the first window matching delivery.before. Information about the change is logged in the courier_information field.

Quick Delivery

To deliver as fast as possible using standard or express delivery, please set the delivery_type parameter. Possible values are: standard and express.

When delivery_type is set, the following parameters will be ignored:

  • pickup.after
  • pickup.before
  • delivery.after
  • delivery.before

Volume-Based Package Input

If the process handling mode is set to Volume:

  • the package.volume parameter is required

The following package parameters are not supported:

  • package.height
  • package.length
  • package.width

Contact Identifier (Address ID)

If contact_identifier (Address ID) is provided, the available pick-up and/or delivery times for this address, as well as all address information from the address book, are used.

If the Address ID in the contact's address book is the same as the Address ID of the related hub, the hub details take precedence.

Authorizations:
ApiTokenQueryApiTokenHeader
Request Body schema: application/json
required
external_id
string

Custom ID that enables connecting Tiramizoo orders with your internal infrastructure. This ID needs to be unique and can have variable length (max length: 255 chars).

secondary_external_id
string

Custom secondary ID that enables connecting Tiramizoo orders with your internal infrastructure. This ID needs to be unique and can have variable length (max length: 255 chars).

delivery_type
string
Enum: "standard" "express"

standard – Normal delivery timeframe

express – Faster delivery (see Quick Delivery section)

hazard_index
integer >= 0
web_hook_url
string <uri>

URL to be notified when the order's state changes. Please check the Order Webhook to learn more about web hooks.

required
object (StopInput)
required
object (StopInput)
required
Array of objects (PackageInput)

Responses

Request samples

Content type
application/json
Example
{
  • "external_id": "002FPD",
  • "secondary_external_id": "ORDER-12345",
  • "delivery_type": "standard",
  • "hazard_index": 0,
  • "web_hook_url": "https://example.com/webhook",
  • "pickup": {
    },
  • "delivery": {
    },
  • "packages": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "uuid": "5216db1b-ccc5-4f78-98a3-4723ba4607fd",
  • "courier_information": "pickup-instructions; delivery-instructions",
  • "external_id": "external id",
  • "secondary_external_id": "Second ID",
  • "web_hook_url": "http://api.myshop.com/deliveries/update_state",
  • "hazard_index": 10,
  • "identifier": "L8ILPX",
  • "timezone": "Europe/Berlin",
  • "state": "created",
  • "delivery_type": "standard",
  • "created_at": "2012-04-16T09:00:00+02:00",
  • "dispatched_at": null,
  • "picked_up_at": null,
  • "pickup_failed_at": null,
  • "delivered_to": null,
  • "delivered_at": null,
  • "delivery_failed_at": null,
  • "returned_at": null,
  • "cancelled_at": null,
  • "cancellation_reason": null,
  • "tracking_url": "http://app.tiramizoo.local/orders/U0V0IINIKNRBG/tracking_status?locale=en",
  • "tracking_code": "U0V0I-INIK-NRBG",
  • "cancellable": true,
  • "pickup": {
    },
  • "delivery": {
    },
  • "packages": [
    ],
  • "signature": {
    },
  • "labels_url": "http://app.tiramizoo.local/orders/U0V0IINIKNRBG/labels.pdf",
  • "events": [ ],
  • "history": [ ],
  • "tour_identifier": null,
  • "courier_identifier": null,
  • "courier_name": null,
  • "courier_company_identifier": null,
  • "courier_company_name": null,
  • "vehicle": null
}

Get Order Details

Retrieve detailed information about a specific order by its identifier.

Authorizations:
ApiTokenQueryApiTokenHeader
path Parameters
identifier
required
string
Example: N4R7A1

The unique order identifier

query Parameters
api_token
string

Authentication token

Responses

Response samples

Content type
application/json
{
  • "uuid": "7ef15e0a-726b-4ca1-a2ed-27c1b98cc274",
  • "courier_information": "go go go; now now now",
  • "external_id": "6ULZI9",
  • "secondary_external_id": null,
  • "web_hook_url": null,
  • "hazard_index": 0,
  • "identifier": "4SUX7T",
  • "timezone": "Europe/Berlin",
  • "state": "created",
  • "delivery_type": "standard",
  • "created_at": "2012-04-16T05:00:00+02:00",
  • "dispatched_at": null,
  • "picked_up_at": null,
  • "pickup_failed_at": null,
  • "delivered_to": null,
  • "delivered_at": null,
  • "delivery_failed_at": null,
  • "returned_at": null,
  • "cancelled_at": null,
  • "cancellation_reason": null,
  • "tracking_url": "http://app.tiramizoo.local/orders/TN8Y966CTG850/tracking_status?locale=en",
  • "tracking_code": "TN8Y9-66CT-G850",
  • "cancellable": false,
  • "pickup": {
    },
  • "delivery": {
    },
  • "packages": [
    ],
  • "signature": {
    },
  • "labels_url": "http://app.tiramizoo.local/orders/TN8Y966CTG850/labels.pdf",
  • "events": [ ],
  • "history": [ ],
  • "tour_identifier": null,
  • "courier_identifier": null,
  • "courier_name": null,
  • "courier_company_identifier": null,
  • "courier_company_name": null,
  • "vehicle": null
}

Update Order / Cancel Order

Update order external_id or cancel an existing order.

Cancelling an Order

Note: Only orders in cancellable state can be cancelled.

Check the order's cancellable field before attempting to cancel:

{
  "cancellable": true
}

To cancel an order, set state to "cancelled" in the request body.

Updating an Order

You can use this endpoint to update the order's external_id.

Authorizations:
ApiTokenQueryApiTokenHeader
path Parameters
identifier
required
string
Examples:
  • VZQSWU - Order identifier
  • a505ff78-67c5-4fbd-ab4f-a8db81f2c45a - Order UUID

Unique order identifier. Can be either:

  • Order identifier (e.g., VZQSWU)
  • Order UUID (e.g., a505ff78-67c5-4fbd-ab4f-a8db81f2c45a)
Request Body schema: application/json
required
external_id
string

Updated custom ID that connects Tiramizoo orders with your internal infrastructure (max length: 255 chars).

state
string
Value: "cancelled"

Set to "cancelled" to cancel the order

Responses

Request samples

Content type
application/json
Example
{
  • "state": "cancelled",
  • "external_id": "AABBCC"
}

Response samples

Content type
application/json
{
  • "uuid": "5b343883-76e4-47d2-be8c-d33270106507",
  • "courier_information": "go go go; now now now",
  • "external_id": "AABBCC",
  • "secondary_external_id": null,
  • "web_hook_url": null,
  • "hazard_index": 0,
  • "identifier": "U6PJFW",
  • "timezone": "Europe/Berlin",
  • "state": "delivery_failed",
  • "delivery_type": "standard",
  • "created_at": "2012-04-16T05:00:00+02:00",
  • "dispatched_at": "2012-04-16T05:05:00+02:00",
  • "picked_up_at": "2012-04-16T07:10:00+02:00",
  • "pickup_failed_at": null,
  • "delivered_to": null,
  • "delivered_at": null,
  • "delivery_failed_at": "2012-04-16T09:00:00+02:00",
  • "returned_at": null,
  • "cancelled_at": null,
  • "cancellation_reason": null,
  • "tracking_url": "http://app.tiramizoo.local/orders/ETZ50MZL3TUCQ/tracking_status?locale=en",
  • "tracking_code": "ETZ50-MZL3-TUCQ",
  • "cancellable": false,
  • "pickup": {
    },
  • "delivery": {
    },
  • "packages": [
    ],
  • "signature": {
    },
  • "labels_url": "http://app.tiramizoo.local/orders/ETZ50MZL3TUCQ/labels.pdf",
  • "events": [
    ],
  • "history": [
    ],
  • "tour_identifier": null,
  • "courier_identifier": null,
  • "courier_name": null,
  • "courier_company_identifier": "WYM4KC",
  • "courier_company_name": "Company 1",
  • "vehicle": null
}

Order Drafts

Draft orders allow you to prepare orders before finalizing them.

Create Order Draft

Create an order draft that can be reviewed and finalized later.

Authorizations:
ApiTokenHeader
Request Body schema: application/json
required
pickup_identifier
string

Identifier of the pickup place (warehouse) the order should be sent from. If not provided, the pickup contact associated with the given process is used.

delivery_identifier
required
string

Identifier of the delivery place the order should be sent to.

identifier
required
string <= 255 characters

Custom ID that enables connecting Tiramizoo orders with your internal infrastructure. This ID needs to be unique (max length 255 chars).

information_to_sender
string

Information that the sender can read before creating the order.

webhook_url
string <uri>

URL to be notified when the order's state changes.

Array of objects

Array of products with dimensions and details.

Responses

Request samples

Content type
application/json
{
  • "pickup_identifier": "WAREHOUSE-01",
  • "delivery_identifier": "STORE-42",
  • "identifier": "DRAFT-2024-001",
  • "information_to_sender": "Please handle with care",
  • "webhook_url": "https://example.com/webhooks/order_draft",
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "Invalid or missing API token"
}

Return Process

The return process is activated when an order has been picked up but, for some reason, cannot be delivered. By default, the order is delivered back to the pickup location within the next 24 hours.

States Involved

  • delivery_failed - Courier went to the delivery location but couldn't deliver. The delivery will be returned to the pickup location.
  • returned - Courier returned the delivery to the pickup location.

Additional Information

When a courier fails to deliver an order, the state changes to delivery_failed and the events parameter contains the failure details.

Example event data:

{
  "state": "delivery_failed",
  "events": [
    {
      "type": "package_was_not_ordered",
      "recorded_at": "2015-05-27T14:25:37+02:00",
      "signature_name": "Bob Obbay",
      "signature_url": "http://sandbox.tiramizoo.com/courier_api/v1/signatures/16e813d2-e054-4901-8b06-b8f7102f10fb.png"
    }
  ]
}

Possible Delivery Failure Reasons (Event Types)

  • abort_delivery
  • address_not_found
  • failed_due_to_business_closed
  • name_not_found_on_doorbell
  • no_attempt_due_to_being_late
  • not_enough_money_for_payment
  • package_is_damaged
  • package_was_delivered_too_late
  • package_was_not_accepted
  • package_was_not_ordered
  • recipient_was_not_at_home

Service Areas

Retrieve information about delivery coverage.

Get Service Area

Note: Service area is returned with time windows (limited by default to next 7 days).

Authorizations:
ApiTokenQueryApiTokenHeader
query Parameters
api_token
required
string
Example: api_token=b612a4efd56151b5c0f79bd5631f0ad1

Authentication token

Responses

Response samples

Content type
application/json
{
  • "time_zone": "Europe/Berlin",
  • "postal_codes": [
    ],
  • "postal_codes_country_codes": [
    ],
  • "express_availability": {
    },
  • "special_days": [
    ],
  • "time_windows": [
    ]
}

Time Windows

Get available delivery time windows for specific dates.

Get Available Time Windows

Retrieve available delivery time windows (limited by default to next 7 days).

Authorizations:
ApiTokenQueryApiTokenHeader
query Parameters
api_token
required
string
Example: api_token=b612a4efd56151b5c0f79bd5631f0ad1

Authentication token

from_date
string <date-time>
Example: from_date=2018-04-10T08:29:00Z

Date and time in ISO 8601 format, time zone information required (UTC preferred). Does not need to be provided together with to_date. Allows to specify start time for time windows, earliest pickup_from for an order.

to_date
string <date-time>
Example: to_date=2018-04-17T08:29:00Z

Date and time in ISO 8601 format, time zone information required (UTC preferred). Does not need to be provided together with from_date. Allows to specify end time for time windows, latest delivery_to for an order. Cannot exceed 7 days limit.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Web Hooks

Configure webhooks to receive real-time notifications about status changes.

Order Webhook

You can avoid polling the API by providing the web_hook_url parameter when creating an order. If provided, Tiramizoo will POST to the web_hook_url whenever the order changes state.

To ensure that your endpoint received, understood and accepted the request, we check your response status code. Any status code outside the 2xx range is treated as a failure. On failure we retry up to 3 times with increasing delays of 3 minutes, then 30 minutes, then 60 minutes. If the final attempt still fails, the notification is discarded and a notification email is sent.

The webhook payload contains exactly the same fields as the response body from the Get Order Details request.

Keep in mind that the order of the webhook requests is not guaranteed, though usually they are ordered by the timestamp of the status change.

Authorizations:
ApiTokenQueryApiTokenHeader
Request Body schema: application/json
required
uuid
string <uuid>

Unique universal identifier for the order

identifier
string

Human-readable order identifier

external_id
string

Your custom order ID

secondary_external_id
string

Additional custom identifier

state
string
Enum: "created" "geocoded" "distributed" "dispatched" "picked_up" "delivered" "cancelled" "pickup_failed" "delivery_failed" "returned"

Current state of the order

delivery_type
string
Enum: "standard" "express"

Type of delivery service

hazard_index
integer >= 0

Hazard level indicator (0 = no hazard)

tracking_code
string

Tracking code for the shipment

tracking_url
string <uri>

URL to track the order

labels_url
string <uri>

URL to download shipping labels

courier_information
string

Information about the courier

web_hook_url
string <uri>

Webhook URL for status updates

timezone
string

Time zone for the order

cancellable
boolean

Whether the order can be cancelled

created_at
string <date-time>

When the order was created

dispatched_at
string <date-time>
picked_up_at
string <date-time>
delivered_at
string <date-time>

Timestamp when order was delivered

delivery_failed_at
string <date-time>

Timestamp when delivery failed

pickup_failed_at
string <date-time>

Timestamp when pickup failed

returned_at
string <date-time>

Timestamp when order was returned

cancelled_at
string <date-time>

Timestamp when order was cancelled

cancellation_reason
string

Reason for cancellation

delivered_to
string

Name of person who received the delivery

object (Stop)
object (Stop)
Array of objects (Package)
object (Signature)
Array of objects (Event)
Array of objects (HistoryEntry)
tour_identifier
string
courier_identifier
string
courier_name
string
courier_company_identifier
string
courier_company_name
string
vehicle
string

Request samples

Content type
application/json
{
  • "uuid": "5216db1b-ccc5-4f78-98a3-4723ba4607fd",
  • "courier_information": "pickup-instructions; delivery-instructions",
  • "external_id": "external id",
  • "secondary_external_id": "Second ID",
  • "web_hook_url": "http://api.myshop.com/deliveries/update_state",
  • "hazard_index": 10,
  • "identifier": "L8ILPX",
  • "timezone": "Europe/Berlin",
  • "state": "created",
  • "delivery_type": "standard",
  • "created_at": "2012-04-16T09:00:00+02:00",
  • "dispatched_at": null,
  • "picked_up_at": null,
  • "pickup_failed_at": null,
  • "delivered_to": null,
  • "delivered_at": null,
  • "delivery_failed_at": null,
  • "returned_at": null,
  • "cancelled_at": null,
  • "cancellation_reason": null,
  • "tracking_url": "http://app.tiramizoo.local/orders/U0V0IINIKNRBG/tracking_status?locale=en",
  • "tracking_code": "U0V0I-INIK-NRBG",
  • "cancellable": true,
  • "pickup": {
    },
  • "delivery": {
    },
  • "packages": [
    ],
  • "signature": {
    },
  • "labels_url": "http://app.tiramizoo.local/orders/U0V0IINIKNRBG/labels.pdf",
  • "events": [ ],
  • "history": [ ],
  • "tour_identifier": null,
  • "courier_identifier": null,
  • "courier_name": null,
  • "courier_company_identifier": null,
  • "courier_company_name": null,
  • "vehicle": null
}

Tour Plan Webhook

Tiramizoo sends information to the base location's tour_plan_web_hook_url whenever a new tour (which starts from this particular base location) is created.

Please respond to the POST request with the appropriate HTTP status code.

Authorizations:
ApiTokenQueryApiTokenHeader
Request Body schema: application/json
required
object
Array of objects

Request samples

Content type
application/json
{
  • "time_window": {
    },
  • "tours": [
    ]
}

Package Labelling

On order creation, the Tiramizoo service generates a unique identifier for each package.

Generate identifier for a package

Packages Representation

"packages": [
  {
    "width": 2,
    "height": 8.2,
    "length": 5,
    "weight": 2,
    "quantity": 1,
    "description": "chunky bacon",
    "category": null,
    "identifier": "3E39C50E40226436",
    "unpackable": false,
    "non_rotatable": false,
    "external_id": null,
    "barcode": {
      "symbology": "QR Code",
      "data": "3E39C50E40226436"
    },
    "state": "pending"
  }
]
  • barcode.symbology - QR Code
  • barcode.data - The encoded data

Tracking

For successfully created orders, the response contains a tracking_url parameter.

{
  ...
  "tracking_url" : "https://sandbox.tiramizoo.com/orders/TRACKING_CODE/tracking_status",
  ...
}

TRACKING_CODE - a unique, 13-character alphanumeric tracking code. It is randomly generated and always in uppercase.

Example: EONREDW73HKQ2

On the tracking page, you can check the current status of your order.