Add Commercial Invoice

put

https://api.intersoftsapient.net/v4/shipments/commercialInvoice/{carrierCode}/{shipmentId}

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

Path Params

carrierCode

string

required

length between 1 and 10

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

shipmentId

string

required

length between 1 and 36

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

Body Params

Commercial Invoice Request

InvoiceNumber

string | null

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

InvoiceDate

date | null

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

Document

string

required

length ≥ 1

The base64-encoded string of the document to be uploaded.

Note: The max file size allowed for the encoded base64 PDF is 2MB.

Responses

200

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

401

Unauthorized

403

Forbidden

404

The shipment was not found.

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

400Invalid request response.