Booking method

POST /v2/Shipment/Book

Uri parameters

None

Body parameters

Name	Description	Type	Additional description
Parcels	List of Parcels you want to ship. Max number of parcels is 999.	Collection of ParcelFeaturesModel	Required
ShipmentStatus	Status for parcel. When a shipment is draft you may change it as much as you want. As soon as it is set as published it cannot be changed and it is formally booked/ordered.	ParcelStatusEnum	Required
CustomerId	The Schenker customer number.	String	Required
ShipmentId	Shipment-id. Only accepts numbers. The API will generate one if it is not set. We strongly recommend to use GS1 SSCC numbers to avoid any duplicates and issues. If you do not use GS1 SSCC numbers, errors might occur further down and your booking might be stopped without you knowing it.	String
Addresses	Name, zip and address is required if the shipment status is set to published. AddressTypeId is always required. Also notice if the status is Published one of types of pickup/sender/customer and recipient must be set. It is only allowed to add one of each address types.	Collection of AddressModel	Required
PickupPhone		String
PickupEmail		String
RecipientPhone	Required if the service Pre-Notice SMS is used.	String
RecipientEmail	Required if the service Pre-Notice Email is used.	String
ReturnPhone	Not required. Add return information if the parcel must be returned to another address then the pickup address.	String
ReturnEmail	Not required. Add return information if the parcel must be returned to another address then the pickup address.	String
ProductCode	Set which type of product you want to use.	String	Required
Services	List of services/options that you want. Use the Product API to find available options.	List`1
CommentToCarrier	Comment to the carrier - use to add extra information	String
GoodsDescription	Goods description	String
DeliveryType	Required. Delivered to private or company: Private = 0, Company = 1	DeliveryTypeEnum	Required
DeliveryDate	Desired date you want the parcel to be delivered. Not required. The date must be a working day and cannot deviate more than +3 days from the transport schedule. Use the schedule api to get available delivery dates.	DateTime
PickupDate	Desired date you want the parcel to be picked up. Not required. The date must be a working day and cannot deviate more than +3 days from the transport schedule. Pickup date is only applicable with the product Direct.	DateTime
UnitCode	Default is KL. Not required. Depending on custom customer agreements - you may use the special code. Special customer code: 51..99, Kolli: KL, Paller: PL	String
RecipientShallPay	Set to true if you want the recipient to pay. Must also set RecipientCustomerId. Cannot be used for returns	Boolean
RecipientCustomerId	The customer id to the recipient. Used if the recipient shall pay.	Int32
References	References that is relevant for the shipment. It is only allowed to have one reference of each type.	Collection of ReferenceModel
PickupPointId	Pickup point id. Not required. If you want to use a pickup point, you must set the pickup point id. Use the pickup point api to get available pickup points. When used, you must also specify PickupPoint address fields	Int32
ShouldGenerateReturnShipment	Set true to request automatic generation of a return shipment with digital label and/or QR Code. Subject to availability. Only applicable for B2C products HE and HJ.	Boolean