O62 carrier shipment request

• 1: O62 carrier shipment request

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	✅