Status
Draft
This is the multi-page printable view of this section. Click here to print.
Back to O62 carrier_shipment_request
Request to register a shipment with a carrier. Responded via the O63 interface.
Draft
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 | A50 | request reference id for the response | 2989cffe-dc66-4aa5-b922-e87ac6310463 | ✅ |
carrier | A50 | Carrier of the shipment | DHL, DE_HERMES_GERMANY, CH_POST, AT_POST see internal-reference-data -> 40 Outbound -> CMM -> carriers |
✅ |
dispatchLocation | A50 | Dispatch location of the shipment | HALDENSLEBEN, SUEDHAFEN | ✅ |
consignor | A50 | Seller who orders the shipment | see internal-reference-data -> 10 Master Data -> ownerCompanies | |
recipient | Object | Recipient information | ✅ | |
parcel | Object | Parcel information | ✅ |
Name | Type | Content | Example | Mandatory |
---|---|---|---|---|
firstName | A50 | First name | John | |
lastName | A50 | Last name (B2C) or Company name (B2B) | Doe | ✅ |
street | A50 | Street name | John-Doe-Str. | ✅ |
houseNumber | A10 | House number | 2 | ✅ |
addressLine2 | A60 | Address line 2 | 2nd floor | |
zipCode | A10 | ZIP code | 64689 | ✅ |
city | A40 | City | Doecity | ✅ |
countryCode | A3 | ISO-3166-Alpha 3 | DEU, AUT | ✅ |
A80 | Email address (for shipment announcements) | recipient1@email.com |
Name | Type | Content | Example | Mandatory |
---|---|---|---|---|
weightG | N10 | parcel weight in grams | 30 | ✅ |
lengthCm | N3 | parcel length in centimeters | 30 | ✅ |
widthCm | N3 | parcel width in centimeters | 30 | ✅ |
heightCm | N3 | parcel height in centimeters | 30 | ✅ |