API Integration
Hermes
hermesbeta
Hermes shipping integration for Karrio
TrackingRatingShippingPickup
Connection Requirements
| Field | Type | Required |
|---|---|---|
| username | string | |
| password | string | |
| client_id | string | |
| client_secret | string | |
| account_country_code | string | |
| metadata | object | |
| config | object |
Carrier Configuration
| Field | Type |
|---|---|
| shipping_options | list |
| shipping_services | list |
| label_type | string |
| language | string |
Available Services
| Service Name | Service Code |
|---|---|
| hermes_standard | hermes_standard |
| hermes_next_day | hermes_next_day |
| hermes_stated_day | hermes_stated_day |
| hermes_parcel_shop | hermes_parcel_shop |
| hermes_international | hermes_international |
Shipping Options
| Option | Code | Type |
|---|---|---|
| hermes_next_day | nextDayService | boolean |
| hermes_bulk_goods | bulkGoodService | boolean |
| hermes_compact_parcel | compactParcelService | boolean |
| hermes_redirection_prohibited | redirectionProhibitedService | boolean |
| hermes_stated_day | statedDay | string |
| hermes_time_slot | timeSlot | string |
| hermes_express | expressService | boolean |
| hermes_after_hours_delivery | afterHoursDeliveryService | boolean |
| hermes_parcel_class | parcelClass | string |
| hermes_signature | signatureService | boolean |
| hermes_household_signature | householdSignatureService | boolean |
| hermes_ident_id | identID | string |
| hermes_ident_type | identType | string |
| hermes_ident_fsk | identVerifyFsk | string |
| hermes_ident_birthday | identVerifyBirthday | string |
| hermes_parcel_shop_id | psID | string |
| hermes_parcel_shop_selection_rule | psSelectionRule | string |
| hermes_parcel_shop_customer_firstname | psCustomerFirstName | string |
| hermes_parcel_shop_customer_lastname | psCustomerLastName | string |
| hermes_exclude_parcel_shop_auth | excludeParcelShopAuthorization | boolean |
| hermes_notification_email | notificationEmail | string |
| hermes_notification_type | notificationType | string |
| hermes_cod_amount | codAmount | float |
| hermes_cod_currency | codCurrency | string |
| hermes_cod_distribution | codDistribution | string |
| hermes_limited_quantities | limitedQuantitiesService | boolean |
| hermes_return_enabled | returnService | boolean |
| hermes_include_return_label | includeReturnLabel | boolean |
| hermes_digital_sales_return | digitalSalesReturn | boolean |
| hermes_customer_reference_1 | customerReference1 | string |
| hermes_customer_reference_2 | customerReference2 | string |
| hermes_tan_service | tanService | boolean |
| hermes_late_injection | lateInjectionService | boolean |
| hermes_part_number | partNumber | integer |
| hermes_number_of_parts | numberOfParts | integer |
| hermes_parent_shipment_order_id | parentShipmentOrderID | string |
