---
title: tm.deliveryscenario
slug: db/tmdeliveryscenario
createdAt: 2023-12-14T14:12:46.742Z
---

A delivery scenario describes the requirements that need to be fullfilled and the actions that will be taken to deliver the purchased tickets to the end customer.

## Fields

| FIELD                                | TYPE                           | DESCRIPTION                                                                                                                                                                                                                                                                                                                       |
| ------------------------------------ | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                                   | `int`                          | Unique ID                                                                                                                                                                                                                                                                                                                         |
| name                                 | `mlstring`                     | Name of the delivery scenario                                                                                                                                                                                                                                                                                                     |
| shortdescription                     | `mlstring`                     | A short description of the deilvery scenario. Will be shown to customers.                                                                                                                                                                                                                                                         |
| feedescription                       | `mlstring`                     | A very short description of the fee that is applicable.                                                                                                                                                                                                                                                                           |
| logo                                 | `string`                       | Logo url                                                                                                                                                                                                                                                                                                                          |
| internalremark                       | `string`                       | An internal description field. Will not be shown to customers.                                                                                                                                                                                                                                                                    |
| typeid                               | `int`                          | The type of this delivery scenario, defines when this delivery scenario is triggered. The available values for this field can be found on the [delivery scenario overview](https://www.ticketmatic.com/docs/api/settings/ticketsales/deliveryscenarios/) page.<br />**References:** [tm.systemtype](docId\:YVf7OQ_iruf6NpUOHG2XQ) |
| needsaddress                         | `bool`                         | A physical address is required                                                                                                                                                                                                                                                                                                    |
| visibility                           | `string`                       | Parameter that sets the visibility of this scenario, can be either 'FULL' or 'API'.                                                                                                                                                                                                                                               |
| availability                         | `DeliveryscenarioAvailability` | The rules that define when this scenario is available. See the [delivery scenario overview](https://www.ticketmatic.com/docs/api/settings/ticketsales/deliveryscenarios/) page for a description of this field                                                                                                                    |
| deliverystatusaftertrigger           | `int`                          | The delivery status the order will transition to when the trigger occurs.                                                                                                                                                                                                                                                         |
| ordermailtemplateid\_delivery        | `int`                          | The ID of the order mail template that will be used for sending out when changing to delivery state 'delivered'. Can be 0 to indicate that no mail should be sent                                                                                                                                                                 |
| ordermailtemplateid\_deliverystarted | `int`                          | The ID of the order mail template that will be used for sending out when changing to delivery state 'delivery started'. Can be 0 to indicate that no mail should be sent                                                                                                                                                          |
| allowetickets                        | `int`                          | Are e-tickets allowed with this delivery scenario?<br />**References:** [tm.systemtype](docId\:YVf7OQ_iruf6NpUOHG2XQ)                                                                                                                                                                                                             |
| mailorganization                     | `bool`                         | Send mail to organization if known                                                                                                                                                                                                                                                                                                |
| createdts                            | `timestamp`                    | Created timestamp                                                                                                                                                                                                                                                                                                                 |
| lastupdatets                         | `timestamp`                    | Last updated timestamp                                                                                                                                                                                                                                                                                                            |
| isarchived                           | `bool`                         | Whether or not this item is archived                                                                                                                                                                                                                                                                                              |