Upload order proforma invoice file

POST 
/api/v1/order/:orderId/proforma-invoice

Upload proforma invoice file and store it under order id - max file size is 10 MB and max size of the whole request (all files plus headers etc) is 11 MB

Request

Path Parameters

orderId stringrequired

id of order to attach proforma invoice to

multipart/form-data

Body

file binaryrequired

Responses

201

File(s) successfully uploaded and saved

application/json

Schema

Schema

id stringdeprecated

identifier of file - deprecated - kept for backwards compatibility

path string

(unique) path of the file in storage

url string

absolute url where to get file content

mediaLink stringdeprecated

deprecated - use url instead

contentType string

mime content type of file

size int64

size of file in bytes

created date-time

when was file created

updated date-time

when was file updated

Example (from schema)

{
  "path": "string",
  "url": "string",
  "contentType": "string",
  "size": 0,
  "created": "2024-04-18T09:59:31.514Z",
  "updated": "2024-04-18T09:59:31.514Z"
}

application/problem+json

Schema

Schema

id stringdeprecated

identifier of file - deprecated - kept for backwards compatibility

path string

(unique) path of the file in storage

url string

absolute url where to get file content

mediaLink stringdeprecated

deprecated - use url instead

contentType string

mime content type of file

size int64

size of file in bytes

created date-time

when was file created

updated date-time

when was file updated

Example (from schema)

{
  "path": "string",
  "url": "string",
  "contentType": "string",
  "size": 0,
  "created": "2024-04-18T09:59:31.514Z",
  "updated": "2024-04-18T09:59:31.514Z"
}

400

Input data validation error - e.g. file empty or file too large

application/problem+json

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

401

Invalid API token provided.

application/problem+json

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

403

AccessDeniedException

*/*

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

409

Conflict

*/*

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

413

Request payload too large

*/*

Schema

Schema

type uri
title string
status int32
detail string
instance uri

properties

object

property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

Loading...