Booking method

POST /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 ParcelDetailsModel	Required
ShipmentStatus	Status for parcel, wether it is published/draft or not. If the status is set to published, but the parcel is missing adresses and weight you will get an error.	ParcelStatusEnum	Required
CustomerId	The Schenker customer number.	String	Required
ShipmentId	Shipment-id. The API will generate one if it is not set. The type must be according to the GSIN standard.	String
PickupCompanyName		String
PickupFirstName		String
PickupLastName		String
PickupAddress		String
PickupAddress2		String
PickupZip		String
PickupPlace		String
PickupCounty		String
PickupPhone		String
PickupEmail		String
RecipientCompanyName		String
RecipientFirstName		String
RecipientLastName		String
RecipientAddress		String
RecipientAddress2		String
RecipientZip		String
RecipientPlace		String
RecipientCounty		String
RecipientPhone	Required if the service Pre-Notice SMS is used.	String
RecipientEmail	Required if the service Pre-Notice Email is used.	String
ReturnCompanyName	Not required. Add return information if the parcel must be returned to another address then the pickup address.	String
ReturnFirstName	Not required. Add return information if the parcel must be returned to another address then the pickup address.	String
ReturnLastName	Not required. Add return information if the parcel must be returned to another address then the pickup address.	String
ReturnAddress	Not required. Add return information if the parcel must be returned to another address then the pickup address.	String
ReturnAddress2	Not required. Add return information if the parcel must be returned to another address then the pickup address.	String
ReturnZip	Not required. Add return information if the parcel must be returned to another address then the pickup address.	String
ReturnPlace	Not required. Add return information if the parcel must be returned to another address then the pickup address.	String
ReturnCounty	Not required. Add return information if the parcel must be returned to another address then the pickup address.	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
PickupPointCompanyName	Not required. The company owning the pickuppoint.	String
PickupPointAddress	Not required. Address of the pickuppoint.	String
PickupPointAddress2	Not required. Second address line of the pickuppoint.	String
PickupPointZip	Not required. Pickuppoint zip code.	String
PickupPointPlace	Not required. The pickuppoint city.	String
PickupPointCounty	Not required. The pickuppoint county.	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
SenderReference	Senders reference for the shipment. Visible on the label if you use the Label API. It is also visible on your invoice, but only 15 characters will be visible on the invoice.	String
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