Upload documents

POST 
/v1/documents/uploads

Upload a shipping document.

Request

application/json

Body

required

shipment_id stringrequired

The documents related shipment.

document_files

object[]

required

Shipping document files

Array [

doc_file stringrequired

A base64 file to upload

doc_name stringrequired

The file name

doc_format stringnullable

The file format

doc_type stringnullable

Possible values: <= 50 characters

Default value: other

    Shipment document type

    values: <br/>
    `certificate_of_origin` `commercial_invoice` `pro_forma_invoice` `packing_list` `other`

    For carrier specific packaging types, please consult the reference.
    

]

reference stringnullable

Possible values: <= 50 characters

Shipping document file reference

Responses

201

application/json

Schema

Schema

id string

A unique identifier

carrier_name stringnullable

The shipment carrier

carrier_id stringnullable

The shipment carrier configured identifier

documents

object[]

the carrier shipping document ids

Array [

doc_id string

The uploaded document id.

file_name string

The uploaded document file name.

]

meta

object

nullable

provider specific metadata

property name* anynullable

provider specific metadata

reference stringnullable

Possible values: <= 50 characters

Shipping document file reference

messages

object[]

The list of note or warning messages

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

carrier_name string

The targeted carrier

carrier_id string

The targeted carrier name (unique identifier)

]

Example (from schema)

{
  "id": "string",
  "carrier_name": "string",
  "carrier_id": "string",
  "documents": [
    {
      "doc_id": "string",
      "file_name": "string"
    }
  ],
  "meta": {},
  "reference": "string",
  "messages": [
    {
      "message": "string",
      "code": "string",
      "details": {},
      "carrier_name": "string",
      "carrier_id": "string"
    }
  ]
}

400

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

424

application/json

Schema

Schema

messages

object[]

The list of error messages

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

carrier_name string

The targeted carrier

carrier_id string

The targeted carrier name (unique identifier)

]

Example (from schema)

{
  "messages": [
    {
      "message": "string",
      "code": "string",
      "details": {},
      "carrier_name": "string",
      "carrier_id": "string"
    }
  ]
}

500

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

Loading...