Print Document

post

https://api.proshipping.net/v4/shipments/printDocument/{carrierCode}/{shipmentId}

Request the associated Customs Documents for the printed label.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

carrierCode

string

required

Carrier Code

shipmentId

string

required

length between 1 and 36

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

Body Params

Print Document Request

DocumentType

string

enum

Document Type
Defaults to CN23

CN23 CN23
PI Proforma Invoice
CI Commercial Invoice

Allowed:

NumberOfCopies

int32

1 to 5

Defaults to 1

Number of Copies

EoriNumber

string | null

EORI Number
Shipper/Receiver's EORI number starts with the ISO Alpha-2 Country Code followed by a maximum 15 alphanumeric characters. For Northern Ireland starts with XI
Overrides the shipper's EORI number on the shipment if provided.
If both an EORI and VAT number exist, then only the EORI Number is printed on the CN23.

VatNumber

string | null

VAT Number
Overrides the shipper's VAT number on the shipment if provided.

ReasonForExport

string | null

Reason for Export
Overrides the shipment's Reason for Export if provided.
If the carrier is UPU affiliated, then the allowed Reason for Exports are:
Gift
Commercial Sample
Documents
Sale of Goods
Return of Goods
Mixed Content
Other

Name

string | null

Shipper's Name
Override the shipment's shipper's company/contact name if provided.

Position

string | null

Position
The shipper's job title in the sender's company.
Note: The field can only be used with the proforma and commercial invoice. It will be ignored for CN23s.

SignatureImage

string | null

Signature Image
Base 64 encoded PNG or JPEG. Maximum image size supported is 240 x 34 pixels.
Note: The field can only be used with the proforma and commercial invoice. It will be ignored for CN23s.

CompanyStampImage

string | null

Company Stamp Image
Base 64 encoded PNG or JPEG. Maximum image size supported is 600 x 66 pixels.
Note: The field can only be used with the proforma and commercial invoice. It will be ignored for CN23s.

Responses

401

Unauthorized

403

Forbidden

404

The shipment was not found.

500

Internal Server Error

200Returns the specified document for the given shipment.

400Invalid request response.