Print Document

post

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

Generate and print various shipping-related documents required for international shipping and customs clearance. With this endpoint, you can specify details of the document you wish to print, submit necessary information, and receive a formatted document in return, typically in the PDF format.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

carrierCode

string

required

A unique identifier for the carrier associated with the shipping account. This code is typically alphanumeric and helps in identifying the specific carrier linked to the shipping account.

shipmentId

string

required

length between 1 and 36

A unique identifier for the specific shipment for which the document is being printed. This ID is used to reference and track specific shipments within the system.

Note: This ID can be a tracking/barcode number.

Body Params

Print Document Request

DocumentType

string

enum

Specifies the type of document being requested for printing. Common types include the following:

CN23: A customs declaration form used for packages sent outside of the EU. A CN23 is typically only used for postal shipments, not commercial shipments.
Proforma Invoice (PI): An estimated invoice provided prior to shipping, outlining the items, charges, and terms.
Commercial Invoice (CI): A formal document provided by the seller to the buyer detailing the items sold, their prices, and terms of sale.

Note: By default, this field is set to CN23.

Allowed:

NumberOfCopies

int32

1 to 5

Defaults to 1

An integer indicating how many copies of the specified document should be printed. This allows users to request multiple copies for various purposes, such as retaining records or providing documentation to customs.

Note: By default, this value is set to 1.

EoriNumber

string | null

The Economic Operators Registration and Identification (EORI) number assigned to businesses for trading in the EU. This number is necessary for customs clearance processes.

Shipper/Receiver's EORI number starts with the ISO Alpha-2 Country Code followed by a maximum of 15 alphanumeric characters. For Northern Ireland, it starts with XI, respectively.

Note: If this information is provided, it overrides the shipper's EORI number on the shipment. Additionally, if both VAT and EORI numbers are provided, then only the EORI number is printed on the CN23.

VatNumber

string | null

The Value Added Tax (VAT) registration number of the business or individual, used for taxation purposes in international transactions.

Note: If this information is provided, it overrides the shipper's VAT number on the shipment.

ReasonForExport

string | null

Identifies the purpose of the export, such as sale, gift, or return. This information is useful for customs processing to determine the appropriate tariffs and requirements.

If the carrier is associated with the Universal Postal Union (UPU), then the allowed reasons for export are the following:

Gift
Commercial Sample
Documents
Sale of Goods
Ecommerce Sale of Goods
Commercial Sale of Goods
Return of Goods
Mixed Content
Other

Note: Before populating this field, keep in mind the following:

If the Sale of Goods value is selected, the system automatically determines whether the shipment is Ecommerce (B2C or D2C) or Commercial (B2B) based on the value provided in the BusinessTransactionType field in the create shipment request.
If this information is provided, it overrides the shipment's reason for export.

Name

string | null

The name of the individual (shipper) who is associated with the shipment. This personalises the documentation and can be important for official purposes.

Note: If this information is provided, it overrides the shipment's shipper's company/contact name.

Position

string | null

The job title or position of the individual (shipper) named on the document. This information can add legitimacy and context to the document, especially if it is to be presented to authorities.

Note: This field is only applicable for the proforma and commercial invoices. It is ignored for the CN23s.

SignatureImage

string | null

An image of the individual's signature, in the Base64 encoded PDF or JPEG format. This provides a digital representation of the signature, required on the customs documents for authenticity.

Note: This field is only applicable for the proforma and commercial invoices. It is ignored for the CN23s.

CompanyStampImage

string | null

An image of the company stamp, in the Base64 PDF or JPEG format. This stamp can be used to validate the document and provide a formal presentation of the company's authority.

Note: This field is only applicable for the proforma and commercial invoices. It is ignored for the 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.