EVRi Corporate
Evri (formerly known as Hermes) offers domestic and international shipping solutions for shipments originating in Great Britain.
This guide provides developers with the details needed to build EVRi Corporate shipping capabilities into your ShipStation API workflows.
ShipStation API also allows you to connect your own existing EVRi International account or use the EVRi services included with ShipStation API. The requirements and service details are different than those for EVRi Corporate. For details about using EVRi from ShipStation, see our EVRi from ShipStation Guide. For details about using EVRi International services, see our EVRi International Guide.
Requirements
Property | Type | Required? | Description |
---|---|---|---|
nickname | string | Required | This is a nickname for you to identify the carrier account in ShipStation API. |
username | string | Required | API Username |
password | string | Required | API Password |
client_id | string | Required | Evri Client ID |
client_name | string | Required | Evri Client Name |
child_id | string | Optional | Evri Child Client ID |
child_name | string | Optional | Evri Child Client Name |
parcel_shop_api_key | string | Optional | ParcelShop API Key |
domestic_insurance_required | boolean | Optional | Require insurance value for domestic shipments. Enable this if your Evri contract includes coverage for domestic parcels. |
endpoint | string | Required | Type of Account ("Production" or "Testing") |
print_in_store_api_key | string | Optional | Print in Store API Key |
print_in_store_client_auth_id | string | Optional | Print in Store API Client Auth ID |
print_in_store_client_secret_key | string | Optional | Print in Store API Client Secret Key |
auth_id | string | Optional | Auth ID |
auth_secret | string | Optional | Auth Secret |
api_key | string | Optional | API Key |
sms_customer_alert_group | string | Optional |
Connection Requirements
- Must have an EVRi Corporate Client account.
- Requires test labels. Before shipping with Evri, you must create test shipping labels that will be sent to Evri for approval.
- Evri will provide you with a pre-determined list of addresses to use to create test labels. Send the test labels to our support team, and we will submit them to Evri on your behalf. We will notify you when the test labels are approved and you can start shipping!
Shipping Requirements
- All domestic Evri shipments must have carrier insurance with an insured value that is the same as the Order Total value. You'll receive a rate error if carrier insurance is not included. Evri requires all domestic shipments to include a valid parcel value or the shipment may be rejected or incur fees later on.
- When shipping internationally with Evri services, please ensure you meet the following requirements:
- You must provide your Economic Operators Registration and Identification (EORI) number to your Evri account manager before shipping. If your Evri account does not have your EORI number, you will experience errors when you try to create international labels. Do not add your EORI number to the customs details of your Evri shipment in ShipStation API.
- International shipments require a valid 8-digit harmonization code.
- You must include three copies of the commercial invoice with your parcel.
Connect Account
You can connect an EVRi Corporate account using the POST method to the /v1/connections/carriers/
endpoint, or via the ShipStation API Dashboard.
For instructions on connecting Evri via the ShipStation API dashboard, go to our Evri help article.
Connect via Endpoint
carrier_name
: hermescorp
POST /v1/connections/carriers/:carrier_name
A successful connection will return a response with the carrier_id
, which you'll use for any requests for this account going forward.
Rates
EVRi does not send estimated rates to ShipStation API, as EVRi does not have an available Rates API. Your EVRi Corp account contact can provide you with the details about your contracted rates.
Service Details
Available EVRi Corporate services are provided below. Please note that carriers may update their available services at any time. To ensure you are always using valid services, you can use the list carrier services endpoint at any time.
Domestic Services
Service | API Code |
---|---|
Hermes Postable | hermes_corp_postable |
EVRi Postable Next Day | hermes_corp_postable_next_day |
Hermes Domestic | hermes_corp_domestic |
Hermes Domestic - Next Day | hermes_domestic_next_day |
Hermes Domestic - Stay Fresh | hermes_domestic_stay_fresh |
ParcelShop* | hermes_parcel_shop |
ParcelShop Next Day | hermes_parcel_shop_next_day |
Locker Standard | hermes_locker_standard |
Locker Next Day | hermes_locker_next_day |
Courier Service 48 Hour | hermes_courier_service_48_hour |
Courier Service Saturday | hermes_courier_service_saturday |
Courier Service Sunday | hermes_courier_service_sunday |
Light & Large | hermes_light_large |
Light & Large Next Day | hermes_light_large_next_day |
Collection Courier Service 48 Hour | hermes_coll_courier_service_48_hour |
Shop2Home QR / Label less | Hermes_s2h_labelless |
International Services
Service | API Code |
---|---|
Hermes International | hermes_international |
Hermescorp International Collections - H2H | Hermescorp_international_collections-h2h |
Shipping to Northern Ireland
Evri will support B2C and C2C movement types for shipping from Great Britain to Northern Ireland, in accordance with the Windsor Framework. Evri will not support B2B shipments to Northern Ireland.
When shipping B2C and C2C shipments with Evri:
- Evri will identify internally which accounts are B2C and C2C, so there is no need to add the
windsor_framework_details
property to the request.
If you are unsure about whether you are B2C or C2C, please contact your Evri Account Manager. - B2C and C2C shipments will have additional new data requirements (see table).
TIP: You may find it helpful to see the Products Object section of our International Shipping page.
Movement Type | Data Requirements |
---|---|
B2C |
|
C2C |
|
C2B | Undeliverable returns (parcel delivery from Northern Ireland to Great Britain being returned due to being undeliverable) will be accepted without providing the enhanced data set. |
B2B | Not supported |
From 1 May 2025, Evri will start validating the new data required for Northern Ireland parcels to ensure they can provide this data to HMRC. If the required data is not provided, the label will not be generated.
Return Services
EVRi includes one return service with ShipStation API.
Service | API Code |
---|---|
ParcelShop Return (Domestic) | hermes_parcel_shop_return |
Returns are also supported with the following domestic services:
- Hermes Domestic
- Hermes Domestic - Next Day
- Hermes Domestic - Stay Fresh
- ParcelShop
- ParcelShop Next Day
- Locker Standard
- Locker Next Day
- Courier Service 48 Hour
- Courier Service Saturday
- Courier Service Sunday
- Light & Large
- Light & Large Next Day
Review the Return Shipping Labels page for details on creating return labels with ShipStation API.
Packages
EVRi does not include specific carrier package types. You can use the generic package
type or custom package types.
Adding Shipment Insurance
All domestic Evri shipments must have carrier insurance added with an insured value that is the same as the total order value. Review the Parcel Insurance page for details on adding carrier insurance with ShipStation API.
Contact Evri to verify whether parcel insurance is part of your contract, as some Evri plans don't require insurance value information. If parcel insurance is in your contract, Evri requires the parcel value to properly validate insurance claims.
Label Support
- Label sizes: 4" x 6"
- Label formats: PDF
Label Reference Fields
EVRi Corporate does not support adding custom label messages.
Multi-Package Labels
EVRi Corporate does not support creating multi-package shipments.
Label Branding
EVRi Corporate does not support label branding.
Voiding Labels
EVRi Corporate does not support voiding labels. However, labels that do not show up in their network will not be invoiced to your account.
Paperless Labels
The following EVRi services support paperless/QR code labels:
- Hermes Postable
- EVRi Postable Next Day
- Hermes Domestic
- Hermes Domestic - Next Day
- ParcelShop Next Day
- Courier Service 48 Hour
- Courier Service Saturday
- Courier Service Sunday
- Shop2Home QR / Label less
- Hermes International
See our Paperless Labels page for details about creating paperless labels with ShipStation API.
Customs Declarations
You can download commercial invoices for EVRi Corporate shipments from the forms_download
object in the label response.
Delivery Confirmation
Confirmation Type | API Code | Description |
---|---|---|
No confirmation | none | No confirmation requested for this shiment. |
Proof of delivery | signature | A signature is required for this delivery. Can be any signature, including a neighbor. |
Household signature | direct_signature | A signature of somebody at the address is required for delivery. |
Additional fees may apply for either signature option. See our Delivery Confirmation page for more details about using the confirmation
property.
Advanced Options
EVRi Corporate supports certain advanced options, which you can add to the shipment
object when creating a shipment or label.
Option | Type | Default Value | Description |
---|---|---|---|
bill_to_party | string | null | Determines which party is paying for shipping costs. This property must be used in conjunction with the bill_to_country_code , bill_to_postal_code , and bill_to_account properties. Available values: recipient , third_party |
delivered_duty_paid | boolean | false | Indicates the shipment is DDP (that is, the shipper is paying the duties/taxes for the shipment rather than the recipient). |
To ensure you always have the most up-to-date information about a carrier's advanced options, use the list carrier options call.
Manifests
EVRi Corporate does not require manifesting your shipments.
Scheduling Pickups
EVRi Corporate does not support scheduling a pickup.
Service Points (PUDO)
EVRi Corporate supports shipping to service Points for certain services.
Tracking
ShipStation API's integration with EVRi Corporate supports receiving tracking updates. Review our ​Track a Package guides​​ for details on tracking with the ShipStation API.
Disconnecting Your EVRi Corporate Account
See the Disconnect section in our Delete a Carrier page for the process of deleting or disconnecting a carrier from ShipStation API.