Get (just) all (deleted) Exports
GET/export/:type
Returns all Exports of the requested Company.
The "trashed" operation returns all Exports including deleted Exports.
The "justtrashed" operation returns only the deleted Exports.
Note, "normal" will yield the same result as without a type.
Request
Path Parameters
- "normal"
- Returns all the Exports except those which are deleted.
- "trashed"
- Returns all the Exports including those which are deleted.
- "justtrashed"
- Returns all and only the deleted Exports.
Possible values: [normal
, trashed
, justtrashed
]
Type of operations for querying deleted Exports.
Responses
- 200
- 403
- 404
Exports found.
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
Array [
]
]
The guid of the Export.
The guid of the Company associated with this Export.
Possible values: >= 3 characters
and <= 255 characters
The name of the Export.
Possible values: >= 3 characters
and <= 255 characters
The description of the Export.
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.
The timezone the dates and times in this Export are formatted to.
The total Order count for Export.
How many Orders are already added to Export.
The download hash of the Export.
download_links
object[]
The download links of the Export.
The download link for this filetype.
The time it was created.
The time it was last updated.
The time it was deleted.
events
object[]
The guid of the Event.
The guid of the Company the Event belongs to.
The guid of the Location the Event belongs to.
The guid of the EventRefundSetting of the Event.
Possible values: <= 255 characters
The name of the Event.
Possible values: <= 65536 characters
The description of the Event.
Possible values: <= 1000 characters
Extra information added to the email sent to ticket buyers.
Possible values: [once
, repeating
]
The type of the Event. This is either "repeating" or just "once".
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.
Possible values: <= 255 characters
Contact email for visitors.
Possible values: <= 255 characters
Contact phone for visitors.
Possible values: <= 255 characters
Contact url for visitors.
Possible values: <= 255 characters
The website of the Event.
The locale of the Event.
The currency of the Event
The category of the Event.
The subcategories of the Event.
The date after which the Ticket Types of this Event may be retrieved.
Whether to automatically remove Events from the Shops.
location
object
The guid of the Location
The guid of the Company of the Location.
Possible values: <= 255 characters
The name of the Location.
Possible values: <= 65535 characters
The description of the Location.
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.
Possible values: >= -85
and <= 85
The latitude in LatLng format.
Possible values: >= -180
and <= 180
The longitude in LatLng format.
Possible values: <= 65536 characters
The address of this Location. This is free text, so it can be as large or small as desired.
Whether this Location should appear in the public listing.
The key of the seating chart. See Seats.io for more information.
The guid of the parent Location. In the case that the Location has a parent.
Whether the Location provides seating or not.
The time it was created.
The time it was last updated.
The time it was deleted.
export_filetypes
object[]
The guid of the ExportFiletype.
The guid of the Export associated with the ExportFiletype.
Possible values: <= 255 characters
, [csv
, xslx
]
The name of the ExportFiletype.
Possible values: <= 255 characters
, [pending
, created
]
The status of the Export for this ExportFiletype.
The time it was created.
The time it was last updated.
[
{
"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": "string",
"updated_at": "string",
"deleted_at": "string",
"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": "string",
"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": "string",
"updated_at": "string",
"deleted_at": "string"
}
}
],
"export_filetypes": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"export_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"filetype": "csv",
"status": "pending",
"created_at": "string",
"updated_at": "string"
}
]
}
]
Unauthorized. You do not have permission to retrieve Exports of the Company.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
Company not found.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}