Import orders
POST/import/process
Imports orders into the database
Request
- application/json
Body
Input data
Whether to render a PDF from the Import.
Whether to send a confirmation email to visitor.
Content of an import CSV file. This is required when path
is not given in the request.
The URL path to an import CSV file. This is only used if the csv_string
is not given in the request. This is required when csv_string
is not given in the request.
Responses
- 200
- 403
- 404
- 406
Import succesсful
- application/json
- Schema
- Example (from schema)
Schema
The guid of the Import.
The guid of the Company the Import belongs to.
The guid of the User the Import belongs to.
A csv string of the Orders to Import.
Possible values: [process_pending
, process_success
, process_failed
, process_applying
]
The status of Import.
Whether to render a PDF from the Import.
Whether to send a confirmation email to visitor.
Number of Orders in this Import. Required if ticket_count
or product_count
is used.
Number of Ticket Types in this Import. Required if order_count
or product_count
is used.
Number of Products in this Import. Required if order_count
or ticket_count
is used.
The time it was created.
The time it was last updated.
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"csv_string": "string",
"status": "process_pending",
"render_pdf": true,
"send_email": true,
"order_count": 0,
"ticket_count": 0,
"product_count": 0,
"created_at": "string",
"updated_at": "string"
}
Unauthorized. You do not have permission to manage Imports for the requested 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"
}
The request variables are invalid, the CSV data is invalid or the user is not allowed to make the operation on (one of) the shops and/or Ticket Types, the
-
import data is returned as JSON in the error message.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}