This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

CMM

1 - O49 Outbound scan event FLASH

Status

Final

Process flow

Process flow diagram

Business Object Model

1.1 - O49 outbound scan event FLASH

Back to o49_outbound scan event flash

Description

Scan status from the outbound context. Starting with the data transfer into the warehouse management system, through picking and clarification cases, up to the handover to the responsible carrier. Atm this interface is only used by bulky item warehouses.

Status

Final

Business Object

Following the description of the schema specific (data property) contents. See here for the FINE service header.

Name Type Content Example Mandatory
directionNo N3 Numeric delivery direction (a.k.a. “depository”) 33 ✅
locationCode Enum(N2) Warehouse location

1: Warehouse Loehne
2: Warehouse Ohrdruf
4: Warehouse Haldensleben
7: Warehouse Tilburg (Holland)
13: Warehouse Witt
14: Warehouse Graz/Salzburg
23: Warehouse Altenkunstadt Hf
25: Warehouse Altenkunstadt Db
40: Warehouse Haldensleben Südhafen
47: Warehouse Sonnefeld
48: Warehouse Langenselbold
54: Warehouse Mosina
55: Warehouse Ansbach
57: Warehouse Marl
58: Warehouse Erfurt		 2 ✅
trackingNumber A30 Shipment identification number “H1023750009606502034”, “90999001941832”, “3SF19700002” ✅
carrierCode Enum(N2) Last mile carrier

0: Undefined
1: Hermes Germany
2: Hermes Einrichtungsservice
3: Hermes Int.
4: DHL
5: Swiss Post
6: FR Colissimo
7: FR Mondial
8: TNT Netherlands
16: Hungarian Post
17: Czech Post
18: Slovak Post
19: Hermes UK		 1 ✅
outgoingShipmentPackageNumber A18 BI packing unit id 22868420085733852 ✅
outgoingShipmentComponentNumber A18 BI single item id 22771924754866402 ✅
internalParcelCode N15 Technical identifier of shipment ident record 522716783 ✅
placeId N15 Technical identifier of pick place 522716783
parentContainerId N15 Technical identifier of parent container 522716783
parentContainerAno A16 Business identifier of parent container “C1234567890”
parentContainerPackagingId N15 Technical identifier of parent container packaging type 522716783
pickingAreaCode ENUM(N1) Picking area

0: undefined
1: Valuable area (Wertbereich)
2: Carton area (Fachboden)
3: Bulk (Pulk)
4: Rack (Regalkommissionierung)
5: Stock integrated non-warehouse item (DLW)
pickBuildingNo N1 Building from which picking takes place (only set for scanning from wms own picking warehouses) 9 ✅
eventTypeDescription A50 Name of scan type “An Carrier übergeben” ✅
eventType Enum(N2) Business identifier of scan type record

0: unbearbeitet
1: klärfall
2: Überhang
3: Nachlieferung
4: Lagerdifferenz
5: Kundenstorno
6: Limit
7: Einen Tag später
9: Fehler
10: verladen
11: manuell verladen
12: WE im KP
13: WE im KP WAP Übernahme
14: verladen KP
15: verladen KP WAP Übernahme
16: scanning WA-Sorter
17: kommissioniert(2)
18: in KS
19: kommissioniert(1)
20: FTS-quittiert
21: SLS-quittiert
22: Klärfall: Falsche Artikelnummer
23: Klärfall: Falsche Teilenummer
24: Klärfall: Artikel defekt
25: Klärfall: Lagerort leer
26: Klärfall: Nicht erreichbar
27: Klärfall: Nicht sorterfähig
28: An Carrier übergeben
29: Abbruch		 ✅
eventOrigin N3 Origin of scanning

0=Manuell
1=Verladesorter
2=Tütensorter
3=Man. Scannung
4=COBRA - Verladescan
5=COBRA - Vorg. absch.
6=Hermes Germany
7=Hermes Einrichtungsservice
9=Großstück
10=COBRA: Lieferstatus zuw.
11=ANTS		 1 ✅
scanningId N15 Technical identifier of scanning record 490817679 ✅
businessEventTimestamp A30 Timestamp of the scan event (ISO8601 with TZ offset) 2022-04-25T12:58:36.053+00:00 ✅
srcSystem Enum Output identifier of the producing system. Possible values: ‘COBRA’ ✅

2 - O52 Outbound Carrier event

Status

Final

Process flow

Process flow diagram

Business Object Model

2.1 - O52 Outbound Carrier event

Back to o52_outbound carrier event

Status

Final

Business Object

This is part of 052_outbound_carrier_event

Name Type Content Example Mandatory
erpSendungId A36 Bulky fulfillment order ID (UUID) :heavy_check_mark:
erpPackageId A50 Retailer packaging ID (UUDI) :heavy_check_mark:
finishedTimestamp String Business event time stamp (ISO8601) :heavy_check_mark:
carrierId Enum Carrier:
1 = Hermes Germany
2 = Hermes Einrichtungsservice		 :heavy_check_mark:

Versions

Following the version history of the corresponding JSON schema:

Version Date File Comments
1.00 2024-01-14 outbound.carrier_event.json.v1.00.json First final version

3 - O54 Outbound scan event

Status

Final

Process flow

Process flow diagram

Business Object Model

3.1 - O54 outbound scan event

Back to o54_outbound scan event

Description

Scan status from the outbound context. Starting with the data transfer into the warehouse management system, through picking and clarification cases, up to the handover to the responsible carrier. Atm this interface is only used by bulky item warehouses.

Status

Final

Business Object

Following the description of the schema specific (data property) contents. See here for the FINE service header.

Name Type Content Example Mandatory
directionNo N3 Numeric delivery direction (a.k.a. “depository”) 33 ✅
location Enum(N2) Warehouse location

1: Warehouse Loehne
2: Warehouse Ohrdruf
4: Warehouse Haldensleben
7: Warehouse Tilburg (Holland)
13: Warehouse Witt
14: Warehouse Graz/Salzburg
23: Warehouse Altenkunstadt Hf
25: Warehouse Altenkunstadt Db
40: Warehouse Haldensleben Südhafen
47: Warehouse Sonnefeld
48: Warehouse Langenselbold
54: Warehouse Mosina
55: Warehouse Ansbach
57: Warehouse Marl
58: Warehouse Erfurt		 2 ✅
parcelAno A30 Shipment identification number “H1023750009606502034”, “90999001941832”, “3SF19700002” ✅
parcelCarrierCode Enum(N2) Last mile carrier

0: Undefined
1: Hermes Germany
2: Hermes Einrichtungsservice
3: Hermes Int.
4: DHL
5: Swiss Post
6: FR Colissimo
7: FR Mondial
8: TNT Netherlands
16: Hungarian Post
17: Czech Post
18: Slovak Post
19: Hermes UK		 1 ✅
parcelDwhPackingUnitAno A18 BI packing unit id 22868420085733852 ✅
parcelDwhSingleitemAno A18 BI single item id 22771924754866402 ✅
parcelId N15 Technical identifier of shipment ident record 522716783 ✅
placeId N15 Technical identifier of pick place 522716783
parentContainerId N15 Technical identifier of parent container 522716783
parentContainerAno A16 Business identifier of parent container “C1234567890”
parentContainerPackagingId N15 Technical identifier of parent container packaging type 522716783
pickingAreaCode ENUM(N1) Picking area

0: undefined
1: Valuable area (Wertbereich)
2: Carton area (Fachboden)
3: Bulk (Pulk)
4: Rack (Regalkommissionierung)
5: Stock integrated non-warehouse item (DLW)
pickBuildingNo N1 Building from which picking takes place (only set for scanning from wms own picking warehouses) 9 ✅
scanTypeId N15 Technical identifier of scan type record 126 ✅
scanTypeName A50 Name of scan type “An Carrier übergeben” ✅
scanTypeNo Enum(N2) Business identifier of scan type record

0: unbearbeitet
1: klärfall
2: Überhang
3: Nachlieferung
4: Lagerdifferenz
5: Kundenstorno
6: Limit
7: Einen Tag später
9: Fehler
10: verladen
11: manuell verladen
12: WE im KP
13: WE im KP WAP Übernahme
14: verladen KP
15: verladen KP WAP Übernahme
16: scanning WA-Sorter
17: kommissioniert(2)
18: in KS
19: kommissioniert(1)
20: FTS-quittiert
21: SLS-quittiert
22: Klärfall: Falsche Artikelnummer
23: Klärfall: Falsche Teilenummer
24: Klärfall: Artikel defekt
25: Klärfall: Lagerort leer
26: Klärfall: Nicht erreichbar
27: Klärfall: Nicht sorterfähig
28: An Carrier übergeben
29: Abbruch		 ✅
scannedDirectionNo N2 At the loading gate against scanned delivery direction. Only set if SCAN_TYPE.NO=28 33
scanningId N15 Technical identifier of scanning record 490817679 ✅
scanningOriginCode Enum(N3) Origin of the scanning

0=Manuell
1=Verladesorter
2=Tütensorter
3=Man. Scannung
4=COBRA - Verladescan
5=COBRA - Vorg. absch.
6=Hermes Germany
7=Hermes Einrichtungsservice
9=Großstück
10=COBRA: Lieferstatus zuw.
11=ANTS		 ✅
scanningScanDate A30 Timestamp of the scan event (ISO8601 with TZ offset) 2022-04-25T12:58:36.053+00:00 ✅
srcSystem Enum Output identifier of the producing system. Possible values: ‘COBRA’ ✅

4 - O55 Outbound scan event HES

Status

Final

Process flow

Process flow diagram

Business Object Model

4.1 - O55 outbound scan event HES

Back to o55_outbound scan event HES

Description

Bulky item logistics scan events for Hermes Einrichtungsservice (HES). Only scan events from the clusters of embarkation and clarification cases are contained.

Status

Final

Business Object

Following the description of the schema specific contents. The table below indicates mandatory fields with a ✅.

Name Type Content Example Mandatory
destination N3 Numeric delivery direction (a.k.a. “depository”) 33 ✅
location Enum(N2) Warehouse location

1: Warehouse Loehne
2: Warehouse Ohrdruf
4: Warehouse Haldensleben
7: Warehouse Tilburg (Holland)
13: Warehouse Witt
14: Warehouse Graz/Salzburg
23: Warehouse Altenkunstadt Hf
25: Warehouse Altenkunstadt Db
40: Warehouse Haldensleben Südhafen
47: Warehouse Sonnefeld
48: Warehouse Langenselbold
54: Warehouse Mosina
55: Warehouse Ansbach
57: Warehouse Marl
58: Warehouse Erfurt		 2 ✅
colli A30 Shipment identification number H1023750009606502034, 90999001941832, 3SF19700002 ✅
carrierType Enum(N2) Last mile carrier

1: Hermes Germany
2: Hermes Einrichtungsservice		 1 ✅
building N1 Building from which picking takes place (only set for scanning from wms own picking warehouses) 9 ✅
statusHFID Enum(N2) Business identifier of scan type record

1: klärfall
11: manuell verladen
22: Klärfall: Falsche Artikelnummer
23: Klärfall: Falsche Teilenummer
24: Klärfall: Artikel defekt
25: Klärfall: Lagerort leer
27: Klärfall: Nicht sorterfähig
28: An Carrier übergeben		 ✅
scanTime A30 Timestamp (localtime) of the scan event (yyyy-mm-dd HH24:mi:ss) 2024-07-16 04:20:20 ✅
scanLocation Enum(N1) Scan location - only set if statusHFID = 28

0: External warehouse/tunnel
1: Loading gate		 1

5 - O60 outbound shipment event

Status

Final

Data flow

Data flow diagram

Business Object Model

5.1 - O60 outbound shipment event

Back to O60 outbound shipment event

Description

Logistic events for outbound shipments.

Status

Final

Business Object

Following the description of the schema specific (data property) contents. See here for the FINE service header. The table below indicates mandatory fields with a ✅.

Name Type Content Example Mandatory
shipmentIdentcode A30 Carrier specific identcode of the shipment 123456789012345678901234567890 ✅
carrier A Carrier of the shipment DHL ✅
eventTimestamp A Timestamp of the shipment event (ISO8601 with TZ offset) 2024-07-16T04:20:20.321+02:00 ✅
warehouselocation A Warehouse location where the shipment event took place OHRDRUF ✅
eventType Enum Type of the shipment event:

- EMBARKED		 EMBARKED ✅
transportVehicleId A20 ID of the goods discharge bridge or license plate of the vehicle 238645, DD-AB 123

6 - O62 carrier shipment request

Status

Draft

Data flow

Data flow diagram

Business Object Model

6.1 - O62 carrier shipment request

Back to O62 carrier_shipment_request

Description

Request to register a shipment with a carrier. Responded via the O63 interface.

Status

Draft

Business Object

Following the description of the schema specific (data property) contents. See here for the FINE service header. The table below indicates mandatory fields with a ✅.

Name Type Content Example Mandatory
externalReferenceId String request reference id for the response 2989cffe-dc66-4aa5-b922-e87ac6310463 ✅
carrier String Carrier of the shipment DHL, DE_HERMES_GERMANY, CH_POST, AT_POST

see internal-reference-data -> 40 Outbound -> CMM -> carriers		 ✅
dispatchLocation String Dispatch location of the shipment HALDENSLEBEN, SUEDHAFEN ✅
consignor String Seller who orders the shipment see internal-reference-data -> 10 Master Data -> ownerCompanies ✅
createReturnOrder Bool Also register a return shipment true, false ✅
sender Object Sender information
recipient Object Recipient information ✅
parcel Object Parcel information ✅

Embedded objects

sender

Name Type Content Example Mandatory
companyName String Company name ExampleCompany ✅
street String Street name ExampleCompany-Str. ✅
houseNumber String House number 2 ✅
zipCode String ZIP code 31541 ✅
city String City ExampleCity ✅
countryCode String ISO-3166-Alpha 2 DE, AT

recipient

Name Type Content Example Mandatory
firstName String First name John ✅
lastName String Last name Doe ✅
street String Street name John-Doe-Str. ✅
houseNumber String House number 2 ✅
addressLine2 String Address line 2 2nd floor
zipCode String ZIP code 64689 ✅
city String City Doecity ✅
countryCode String ISO-3166-Alpha 2 DE, AT

parcel

Name Type Content Example Mandatory
weightG integer parcel weight in grams 30 ✅
lengthCm integer parcel length in centimeters 30 ✅
widthCm integer parcel width in centimeters 30 ✅
heightCm integer parcel height in centimeters 30 ✅

7 - O63 carrier shipment response

Status

Draft

Data flow

Data flow diagram

Business Object Model

7.1 - O63 carrier shipment response

Back to O63 carrier shipment response

Description

Carrier shipment response to an O62 shipment registration request. The response contains the shipment state and, in case of success, the shipment document data. Otherwise the carrier specific error message.

Status

Draft

Business Object

Following the description of the schema specific (data property) contents. See here for the FINE service header. The table below indicates mandatory fields with a ✅.

Name Type Content Example Mandatory
externalReferenceId String request reference id 2989cffe-dc66-4aa5-b922-e87ac6310463 ✅
state Enum State of the request SUCCESS, ERROR ✅
direction Integer Carrier specific delivery direction 1, 2 when state = SUCCESS
shippingLabel Object Shipping label data when state = SUCCESS
returnsLabel Object Returns label data
errormessage String Error message when state = ERROR

Embedded objects

shippingLabel

Name Type Content Example Mandatory
id String unique document identifier H1234567890123456789 ✅
data String depends on dataType SGVsbG8gV29ybGQ= ✅
dataType Enum document content type PDF, PNG, ZPL, DATA_DHL, DATA_HG, DATA_CHP ✅

data schema dataType=DATA_DHL

{
  "properties": {
    "identcode": { 
      "type": "string"
    },
    "postleitcode": {
      "type": "string"
    },
    "labelUrl": {
      "type": "string"
    },
    "labelFormat": {
      "enum": ["PDF", "ZPL2"]
    }
  },
  "required": [
    "identcode", 
    "postleitcode",
    "labelUrl",
    "labelFormat"
  ]
}

data schema dataType=DATA_HG

{
  "properties": {
    "sendungsidentnummer": {
      "type": "string"
    },
    "tour": {
      "type": "number",
      "minimum": 0,
      "maximum": 99
    },
    "zelle": {
      "type": "number",
      "minimum": 0,
      "maximum": 99
    },
    "depotbezeichnung": {
      "type": "string"
    },
    "sperrgut": {
      "type": "boolean"
    },
    "gewichtsklasse": {
      "enum": ["UP_TO_10KG", "MORE_THAN_10KG", "MORE_THAN_20KG"]
    }
  },
  "required": [
    "sendungsidentnummer",
    "tour",
    "zelle",
    "depotbezeichnung",
    "sperrgut",
    "gewichtsklasse"
  ]
}

data schema dataType=DATA_CHP

{
  "properties": {
    "sendungsidentnummer": {
      "type": "string"
    }
  },
  "required": ["sendungsidentnummer"]
}

returnsLabel

Name Type Content Example Mandatory
id String unique document identifier H1234567890123456789 ✅
data String depends on dataType SGVsbG8gV29ybGQ= ✅
dataType Enum document content type PDF, PNG, ZPL, DATA_DHL, DATA_HG, DATA_CHP ✅

data schema dataType=DATA_DHL

{

}

data schema dataType=DATA_HG

{

}

data schema dataType=DATA_CHP

{

}