Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Hermes Germany

Hermes Germany offers domestic shipping services for shipments within Germany.

This guide provides developers with the details needed to build Hermes Germany shipping capabilities into your ShipStation API workflows.

Requirements

PropertyTypeRequired?Description
nicknamestringrequiredThis is a nickname for you to identify the carrier account in ShipStation API.
usernamestringrequiredYour Hermes account username.
passwordstringrequiredYour Hermes account password.
pickup_window_slotenumerated stringrequiredValues:
BETWEEN_10_AND_13", BETWEEN_12_AND_15", BETWEEN_14_AND_17
api_languageenumerated stringOptionalDE ,EN
test_credentialsbooleanOptional

Connect Account

You can connect a Hermes Germany account using the POST method to the /v1/connections/carriers/ endpoint, or via the ShipStation API Dashboard.

For instructions on connecting Hermes Germany via the ShipStation API dashboard, go to our Hermes Germany help article.

Connect via Endpoint

carrier_name: hermes_germany

POST /v1/connections/carriers/:carrier_name

Sample request:

1
2
3
4
5
6
7
8
9
10
11
12
13
POST /v1/connections/carriers/hermes_germany HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"nickname": "My Hermes Germany Account",
"username":"YourUserName",
"password":"pa55word",
"pickup_window_slot":"your_pickup_window_slot_here",
"api_language":"your_api_language_here",
"test_credentials":"your_test_credentials_option_here"
}

A successful connection will return a response with the carrier_id, which you'll use for any requests for this account going forward.

Rates

Hermes Germany does not send estimated rates to ShipStation API, and so does not support rate shopping. Your Hermes account contact can provide you with the details about your contracted rates.

Service Details

Available Hermes Germany 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

ServiceCarrier CodeAPI Code
Hermes Package - StandardHhermes_package_standard
Hermes Package - Next DayH-nextDayhermes_package_next_day
Small Package - StandardSsmall_package_standard
Small Package - Next DayS-nextDaysmall_package_next_day
Medium Package - StandardMmedium_package_standard
Medium Package - Next DayM-nextDaymedium_package_next_day
Large Package - StandardLlarge_package_standard
Large Package - Next DayL-nextDaylarge_package_next_day
Extra Large Package - StandardXLextra_large_package_standard
Extra Large Package - Next DayXL-nextDayextra_large_package_next_day

Return Services

Hermes Germany supports the following return services:

ServiceAPI Code
Standalone Returnhermes_germany_standalone_return

Review the Return Shipping Labels page for details on creating return labels with ShipStation API.

Packages

The following carrier package types are available for Hermes Germany services:

NameAPI CodePackage Attributes
Bikehermes_germany_bikeInternational, Domestic
Baghermes_germany_bagInternational, Domestic
Large Itemhermes_germany_large_itemInternational, Domestic
Parcelhermes_germany_parcelInternational, Domestic

Adding Shipment Insurance

Hermes Germany does not support adding carrier insurance to their shipents.

Review the Parcel Insurance page for details on adding shipment insurance with ShipStation API.

Label Support

  • Label sizes: 4" x 6"
  • Label formats: PDF, ZPL

Label Reference Fields

Hermes Germany does not support adding custom label messages.

Multi-Package Labels

Hermes Germany does not support creating multi-package shipments

Label Branding

Hermes Germany does not support label branding.

Voiding Labels

Hermes Germany does not support voiding labels with ShipStation API.

Paperless Labels

Hermes Germany does not support paperless labels.

Delivery Confirmation

Confirmation TypeAPI CodeDescription
No confirmation requirednoneAvailable only for Hermes Germany return serice.

See our Delivery Confirmation page for more details about using the confirmation property.

Advanced Options

Hermes Germany does not support any advanced options.

To ensure you always have the most up-to-date information about a carrier's advanced options, use the list carrier options call.

Manifests

Hermes Germany does not require manifesting your shipments.

Scheduling Pickups

Hermes Germany does not support schedule pickups using ShipStation API.

Service Points (PUDO)

Hermes Germany does not support shipping to service points.

Tracking

ShipStation API's integration with Hermes Germany supports receiving tracking updates. Review our ​Track a Package guides​​ for details on tracking with the ShipStation API.

Disconnecting Your Hermes Germany Account

See the Disconnect section in our Delete a Carrier page for the process of deleting or disconnecting a carrier from ShipStation API.