Intro to Rottbeck Integration
This markdown contains documentation about integration with Rottbeck.
1. Tracking Reference and Label
Tracking Reference for handlingUnits are generated by the Viya reference generator. The Label is also generated by Viya.
2. Dangerous Goods
Dangerous goods not included in the integration.
3. Service Levels
| Viya Reference | SIS Reference | Rottbeck Description |
|---|---|---|
classic | CLASSIC | This is the default service |
nextDay | NEXTDAY | Express overnight |
nextDayBefore8 | ND0800 | Express Next Day before 08:00 |
nextDayBefore10 | ND1000 | Express Next Day before 10:00 |
nextDayBefore12 | ND1200 | Express Next Day before 12:00 |
bisTermin | BIS-TERMIN | Delivery before date … (Not next working day) |
fixDay | FIXDAY | Fixed Delivery Date (Not next working day) |
fixDayBefore10 | FIX1000 | Fixed Delivery Date before 10:00 (Not next working day) |
fixDayBefore12 | FIX1200 | Fixed Delivery Date before 12:00 (Not next working day) |
fixDayBetween16-18 | FIX16-18 | Fixed Delivery Date between 16:00-18:00 (Not next working day) |
fixDayBetween18-20 | FIX18-20 | Fixed Delivery Date between 18:00-20:00 (Not next working day) |
4. Service Codes
| Condition / Service Level(s) | ServiceCode(s) | Text Value | Explanation / Notes |
|---|---|---|---|
| NEXTDAY | 250 | ” | Standard next day delivery |
| NEXTDAYBEFORE8, ND0800 | 090 | ” | Next day delivery before 8:00 |
| NEXTDAYBEFORE10, ND1000 | 255 | ” | Next day delivery before 10:00 |
| NEXTDAYBEFORE12, ND1200 | 257 | ” | Next day delivery before 12:00 |
| BISTERMIN, BIS-TERMIN | 202 | shipment.timeWindows.delivery.requested.start (formatted as %d%m%Y) | Delivery on a specific date |
| FIXDAY | 270 | shipment.timeWindows.delivery.requested.start (formatted as %d%m%Y) | Fixed delivery date |
| FIXDAYBEFORE10, FIX1000 | 270, 082 | shipment.timeWindows.delivery.requested.start (formatted as %d%m%Y), ” | Fixed date, before 10:00 |
| FIXDAYBEFORE12, FIX1200 | 270, 083 | shipment.timeWindows.delivery.requested.start (formatted as %d%m%Y), ” | Fixed date, before 12:00 |
| FIXDAYBETWEEN16-18, FIX16-18 | 270, 091 | shipment.timeWindows.delivery.requested.start (formatted as %d%m%Y), ” | Fixed date, delivery between 16:00-18:00 |
| FIXDAYBETWEEN18-20, FIX18-20 | 270, 092 | shipment.timeWindows.delivery.requested.start (formatted as %d%m%Y), ” | Fixed date, delivery between 18:00-20:00 |
shipment.timeWindows.delivery.requested.onlySaturday = true | 084 | ” | Delivery only on Saturday |
shipment.serviceOptions.appointmentForDelivery = true | 101 | Tel: shipment.addresses.receiver.contactPhone Email: shipment.addresses.receiver.contactEmail | Appointment required for delivery, contact details provided |
shipment.serviceOptions.preAdviceDelivery.useDriverPhone = true | 052 | Tel: shipment.addresses.receiver.contactPhone | Pre-advice delivery, use driver’s phone |
shipment.serviceOptions.signatureForDelivery = none or noSignatureRequired | 132 | shipment.addresses.receiver.addressLine1 + ” ” + shipment.addresses.receiver.streetNumber | No signature required, receiver address provided |
shipment.serviceOptions.residentialDelivery = true | 815 | ” | Residential delivery |
5. Package Types
Package types can be overwritten in the ordering configuration.
| carrierPackageCode | carrierPackageName | packageTypeCodeContains | Notes / Explanation |
|---|---|---|---|
| KI | Kiste | box, crate | Maps SIS codes “box” or “crate” to “Kiste” |
| EP2 | Einwegpalette 120 x 100 | pallet-100x120-chep, pallet-100x120-euro | Maps SIS codes for 100x120 pallets |
| EP1 | Einwegpalette 120 x 80 | pallet-80x120-euro, pallet-80x120-chep, pallet-80x120-oneway, pallet-80x120-lpr | Maps SIS codes for 80x120 pallets |
| HP | Halbpalette | pallet-80x60 | Maps SIS code “pallet-80x60” to “Halbpalette” |
6. Address Qualifiers
| Qualifier | Address Source | Description / Usage | Condition |
|---|---|---|---|
CON | Shipment.addresses.receiver | Consignee (delivery address) | |
SHP | Shipment.addresses.sender | Shipper (sender address) | |
ORD | Shipment.addresses.buyer | Orderer/Buyer (if present) | notEmpty(Shipment.addresses.buyer) |
INV | Shipment.addresses.sender + Shipment.accounts.transport.reference | Invoice address (sender) + matchcode |
7. Carrier Instructions
Any carrier instructions can be added:
| Instruction Type | Trigger |
|---|---|
collection | shipment?.instructions.carrierInstructions.collection |
delivery | shipment?.instructions.carrierInstructions.delivery |
transport | shipment?.instructions.carrierInstructions.transport |