Get a specific Export
GET/export/:guid
Retrieve a specific Export.
Request
Path Parameters
The guid of the Export.
Responses
- 200
- 404
Export found.
- application/json
- Schema
- Example (from schema)
Schema
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.
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",
"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"
}
]
}
Export not found.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}