Upload Document

This method uploads a document to the carrier.

Request
Request Body schema: application/json

An object information about the document to upload.

document_id
string or null

The document id

document_type
string (DocumentUploadType)
Enum: "commercial_invoice" "certificate_of_origin" "usmca_commercial_invoice_certification_of_origin" "usmca_certification_of_origin" "pro_forma_invoice" "other" "authorization_form" "export_accompanying_document" "export_license" "import_permit" "one_time_nafta" "power_of_attorney" "packing_list" "sed_document" "shippers_letter_of_instruction" "declaration"
document_format
string (DocumentUploadFormat)
Enum: "PDF" "PNG"
file_name
string or null

The file name

file_url
string or null

The file URL

tracking_number
string or null

The carrier tracking number for this shipment

Array of objects or null (Identifier)

Alternative identifiers associated with this package

transaction_id
required
string <uuid>

The transaction ID uniquely represents this request. If the request is retried then this transaction ID will be the same. You should only perform the requested action once per given transaction ID.

object (Authorization)
object or null
connection_name
string or null

The name of the connection to use, if this app has connection names defined

Responses
200

This object model represents the response from a successful upload document response.

post/UploadDocument
Request samples
application/json
{
  • "document_id": "string",
  • "document_type": "commercial_invoice",
  • "document_format": "PDF",
  • "file_name": "string",
  • "file_url": "string",
  • "tracking_number": "string",
  • "alternative_identifiers": [
    ],
  • "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  • "authorization": {
    },
  • "metadata": {
    },
  • "connection_name": "string"
}
Response samples
application/json
{
  • "carrier_document_id": "string",
  • "metadata": {
    }
}