Create Shipment

Create a new Evri shipment by submitting the shipment details in your request and returning an image of the shipping label in the PDF and PNG formats.

Body Params

Shipment Details

Create Shipment Request

ShipmentInformation
object
required

Indicates the operation to be performed for the shipment, determines the shipment status that is set on shipment creation and whether a shipment tracking number and labels are generated.

Valid values are:

  • Process: Creates a shipment tracking number, generates and prints a label for each package in the shipment, and returns the labels in the createShipment response. With this action, the shipment status is set to Ready to Manifest.
  • Create: Creates the shipment but does not allocate a tracking number, print the labels or return them in the createShipment response. The label(s) must be printed before the shipment is ready to manifest.
  • Allocate: Creates the tracking number and label but does not print the labels or return them in the createShipment response. The label(s) must be printed before the shipment is ready to manifest.


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

Shipper
object
required

Used to provide shipper details such as address, contact details, VAT and EORI number, etc.

Destination
object
required

An array of objects providing details on the shipment destination, such as receiver and contact details.

CarrierSpecifics
object

Used to provide specific information related to the Evri shipment. This includes service enhancements and special handling instructions for the shipments being sent.

Packages
array of objects
required

Used to provide information on the packages that are being sent in this shipment. You can add a maximum of 99 packages in a single shipment.

Note: You must add at least one package to the shipment.

Packages*
Items
array of objects | null

Used to provide information on the individual goods/products being shipped within the package. This includes vital details, such as SKU code for inventory tracking, quantity of each item, description for clarity, and shipping specifics like weight, customs classifications (HS Code), and country of origin.

Note: The item information is only required for dutiable shipments. Non-Dutiable and Documents Only (DOX) shipments do not require item information. Please be advised that the item verification on a shipment is done via Hurricane services; therefore, it should be enabled. The maximum number of distinct items that will be verified in a single shipment is 15.

Items
Customs
object

Used to provide information for customs clearance related to the shipment. This includes, reasons for export, applicable incoterms, any pre-registration numbers and type required, shipping and other charges, as well as details about the invoice and whether an export licence is needed. It ensures compliance with international shipping regulations.

ReturnToSender
object

Used to provide the address details to be used when returning the shipment back to the sender.

Note: If this information is not provided, then the shipping location's address is used.

Responses

401

Unauthorized

403

Forbidden

404

The carrier was not found.

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json