Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipments

Add Commercial Invoice

Add Commercial Invoices associated with your shipments as in the base64-encoded PDF format.

put/v4/shipments/commercialInvoice/{carrierCode}/{shipmentId}

Path parameters

carrierCodestring required

A unique identifier for this carrier. This code is typically alphanumeric and serves as a reference to distinguish between various carriers within the system.

shipmentIdstring required

Shipment Id <br />The Shipment Id may be an id or a tracking/barcode number.

Request body

InvoiceNumberstring nullable

A unique identifier assigned to each commercial invoice, typically used for tracking and reference purposes.

InvoiceDatestring date nullable

The date when the commercial invoice was issued. <br /> <br />Note: The invoice date must be in the YYYY-MM-DD format. If the date is not provided, it defaults to today's date.

Documentstring required

The base64-encoded string of the document to be uploaded. <br />
<br />Note: The max file size allowed for the encoded base64 PDF is 2MB.

Example request

{
  "Document": "iVBORw0KGgoAAAANSUhEUgAA ... A4QAAAXcCAYAAAB6Q0CbAAAAAXNSR0IArs4"
}

Response

The Commercial Invoice has been successfully linked to the Shipment Id.