Upload file to order
POST/api/v1/order/:orderId/file
Upload file and store it under order id. File will be attached to order communication emails.
Request
Path Parameters
id of order to attach file to
Query Parameters
optional name of file. if not provided, name is derived from original file name of uploaded file
- multipart/form-data
Body
Responses
- 201
- 400
- 401
- 403
- 409
- 413
File successfully uploaded and saved
- application/json
- application/problem+json
- Schema
- Example (from schema)
Schema
identifier of file - deprecated - kept for backwards compatibility
(unique) path of the file in storage
absolute url where to get file content
deprecated - use url instead
mime content type of file
size of file in bytes
when was file created
when was file updated
{
"path": "string",
"url": "string",
"contentType": "string",
"size": 0,
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z"
}
- Schema
- Example (from schema)
Schema
identifier of file - deprecated - kept for backwards compatibility
(unique) path of the file in storage
absolute url where to get file content
deprecated - use url instead
mime content type of file
size of file in bytes
when was file created
when was file updated
{
"path": "string",
"url": "string",
"contentType": "string",
"size": 0,
"created": "2024-07-29T15:51:28.071Z",
"updated": "2024-07-29T15:51:28.071Z"
}
Uploaded file is empty
- application/problem+json
- Schema
- Example (from schema)
Schema
properties
object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Invalid API token provided.
- application/problem+json
- Schema
- Example (from schema)
Schema
properties
object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
AccessDeniedException
- */*
- Schema
- Example (from schema)
Schema
properties
object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Conflict
- */*
- Schema
- Example (from schema)
Schema
properties
object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Uploaded file is larger than 1MB
- application/problem+json
- Schema
- Example (from schema)
Schema
properties
object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}