Create a new Export

POST 
/export

Creates a new Export and queues the job for the Export.

Note, if no Events are given, the Events of the requested Company will be used for the Export.

Request

application/json

Body

Input data

name stringrequired

Possible values: >= 3 characters and <= 255 characters

The name of the Export.

description string

Possible values: >= 3 characters and <= 255 characters

The description of the Export.

type stringrequired

Possible values: [orders, order_tickets, orders_and_order_tickets, orders_and_order_tickets_and_order_products, direct_mail, order_tickets_scanned, orders_location, order_products_optional]

The type of the Export.

timezone string

The timezone the dates and times in this Export are formatted to.

events uuid[]

The guids of the Events to include in the Export. If left empty, all Events of the requested Company are taken instead.

filetypes enum[]required

Possible values: [csv, xls]

The filetypes to export to.

Responses

200

Dispatched job for Export was successfully requested.

application/json

Schema

Schema

guid uuidrequired

The guid of the Export.

company_id uuid

The guid of the Company associated with this Export.

name stringrequired

Possible values: >= 3 characters and <= 255 characters

The name of the Export.

description string

Possible values: >= 3 characters and <= 255 characters

The description of the Export.

type stringrequired

Possible values: [orders, order_tickets, orders_and_order_tickets, orders_and_order_tickets_and_order_products, direct_mail, order_tickets_scanned, orders_location, order_products_optional]

The type of the Export.

timezone string

The timezone the dates and times in this Export are formatted to.

order_count integer

The total Order count for Export.

processed_order_count integer

How many Orders are already added to Export.

location string

The download hash of the Export.

download_links

object[]

The download links of the Export.

Array [

:filetype url

The download link for this filetype.

]

created_at ISO 8601

The time it was created.

updated_at ISO 8601

The time it was last updated.

deleted_at ISO 8601

The time it was deleted.

events

object[]

Array [

guid uuidrequired

The guid of the Event.

company_id uuid

The guid of the Company the Event belongs to.

location_id uuid

The guid of the Location the Event belongs to.

event_refund_setting_id uuid

The guid of the EventRefundSetting of the Event.

name stringrequired

Possible values: <= 255 characters

The name of the Event.

description string

Possible values: <= 65536 characters

The description of the Event.

email_info string

Possible values: <= 1000 characters

Extra information added to the email sent to ticket buyers.

type stringrequired

Possible values: [once, repeating]

The type of the Event. This is either "repeating" or just "once".

status stringrequired

Possible values: [disabled, normal, sold_out, refunding, moving]

Default value: normal

The current status of sale or refund of the Event. One can set the status of a Ticket Type here.

visitor_contact_email email

Possible values: <= 255 characters

Contact email for visitors.

visitor_contact_phone phoneNumber

Possible values: <= 255 characters

Contact phone for visitors.

visitor_contact_url string

Possible values: <= 255 characters

Contact url for visitors.

website url

Possible values: <= 255 characters

The website of the Event.

locale IETF BCP 47required

The locale of the Event.

currency ISO 4217required

The currency of the Event

category string

The category of the Event.

subcategories string[]

The subcategories of the Event.

retrievable_after ISO 8601

The date after which the Ticket Types of this Event may be retrieved.

auto-prune boolean

Whether to automatically remove Events from the Shops.

location

object

guid uuidrequired

The guid of the Location

company_id uuid

The guid of the Company of the Location.

name stringrequired

Possible values: <= 255 characters

The name of the Location.

description string

Possible values: <= 65535 characters

The description of the Location.

capacity integerrequired

Possible values: <= 9999999999

The maximum capacity of people that can be at this Location. This number is strictly positive or 0 signaling an infinite capacity.

latitude float

Possible values: >= -85 and <= 85

The latitude in LatLng format.

longitude float

Possible values: >= -180 and <= 180

The longitude in LatLng format.

address string

Possible values: <= 65536 characters

The address of this Location. This is free text, so it can be as large or small as desired.

public boolean

Whether this Location should appear in the public listing.

seats_chart_key string

The key of the seating chart. See Seats.io for more information.

parent_guid uuid

The guid of the parent Location. In the case that the Location has a parent.

seated boolean

Whether the Location provides seating or not.

created_at ISO 8601

The time it was created.

updated_at ISO 8601

The time it was last updated.

deleted_at ISO 8601

The time it was deleted.

]

export_filetypes

object[]

Array [

guid uuidrequired

The guid of the ExportFiletype.

export_id uuid

The guid of the Export associated with the ExportFiletype.

filetype stringrequired

Possible values: <= 255 characters, [csv, xslx]

The name of the ExportFiletype.

status stringrequired

Possible values: <= 255 characters, [pending, created]

The status of the Export for this ExportFiletype.

created_at ISO 8601

The time it was created.

updated_at ISO 8601

The time it was last updated.

]

Example (from schema)

{
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "type": "orders",
  "timezone": "string",
  "order_count": 0,
  "processed_order_count": 0,
  "location": "string",
  "download_links": [
    {
      ":filetype": "string"
    }
  ],
  "created_at": "2023-08-01T14:40:24+00:00",
  "updated_at": "2023-08-01T14:40:24+00:00",
  "deleted_at": "2023-08-01T14:40:24+00:00",
  "events": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "event_refund_setting_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "email_info": "string",
      "type": "once",
      "status": "normal",
      "visitor_contact_email": "user@example.com",
      "visitor_contact_phone": "string",
      "visitor_contact_url": "string",
      "website": "string",
      "locale": "en_GB",
      "currency": "EUR",
      "category": "string",
      "subcategories": [
        "string"
      ],
      "retrievable_after": "2023-08-01T14:40:24+00:00",
      "auto-prune": true,
      "location": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "description": "string",
        "capacity": 0,
        "latitude": 0,
        "longitude": 0,
        "address": "string",
        "public": true,
        "seats_chart_key": "string",
        "parent_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "seated": true,
        "created_at": "2023-08-01T14:40:24+00:00",
        "updated_at": "2023-08-01T14:40:24+00:00",
        "deleted_at": "2023-08-01T14:40:24+00:00"
      }
    }
  ],
  "export_filetypes": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "export_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "filetype": "csv",
      "status": "pending",
      "created_at": "2023-08-01T14:40:24+00:00",
      "updated_at": "2023-08-01T14:40:24+00:00"
    }
  ]
}

403

Unauthorized. You do not have permission to manage the Exports of the Company.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

404

Company or Event not found. Or, there are no Events to export.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

406

Request is invalid, see error context for validation errors. Or, there are no filetypes to export to.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

Loading...