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 |
Request body sample:
{ "Parcels": [ { "ParcelId": "sample string 1", "Delete": false, "Weight": 1.1, "Length": 1, "Height": 1, "Width": 1, "Volume": 1.1 } ], "ShipmentStatus": 1, "CustomerId": "sample string 3", "ShipmentId": "sample string 4", "PickupCompanyName": "sample string 5", "PickupFirstName": "sample string 6", "PickupLastName": "sample string 7", "PickupAddress": "sample string 8", "PickupAddress2": "sample string 9", "PickupZip": "sample string 10", "PickupPlace": "sample string 11", "PickupCounty": "sample string 12", "PickupPhone": "sample string 13", "PickupEmail": "sample string 14", "RecipientCompanyName": "sample string 15", "RecipientFirstName": "sample string 16", "RecipientLastName": "sample string 17", "RecipientAddress": "sample string 18", "RecipientAddress2": "sample string 19", "RecipientZip": "sample string 20", "RecipientPlace": "sample string 21", "RecipientCounty": "sample string 22", "RecipientPhone": "sample string 23", "RecipientEmail": "sample string 24", "ReturnCompanyName": "sample string 25", "ReturnFirstName": "sample string 26", "ReturnLastName": "sample string 27", "ReturnAddress": "sample string 28", "ReturnAddress2": "sample string 29", "ReturnZip": "sample string 30", "ReturnPlace": "sample string 31", "ReturnCounty": "sample string 32", "ReturnPhone": "sample string 33", "ReturnEmail": "sample string 34", "PickupPointCompanyName": "sample string 35", "PickupPointAddress": "sample string 36", "PickupPointAddress2": "sample string 37", "PickupPointZip": "sample string 38", "PickupPointPlace": "sample string 39", "PickupPointCounty": "sample string 40", "ProductCode": "sample string 41", "Services": [ "sample item string 1", "sample item string 2" ], "CommentToCarrier": "sample string 43", "GoodsDescription": "sample string 44", "DeliveryType": 1, "DeliveryDate": "2024-11-21T11:18:18", "PickupDate": "2024-11-21T11:18:18", "UnitCode": "sample string 48", "RecipientShallPay": false, "RecipientCustomerId": 1, "SenderReference": "sample string 51", "PickupPointId": 1, "ShouldGenerateReturnShipment": false }
Response sample:
[ { "ParcelStatus": 1, "CustomerId": "sample string 2", "ParcelId": "sample string 3", "IsReturn": false, "Weight": 1.1, "Length": 1, "Height": 1, "Width": 1, "Volume": 1.1, "CalculatedVolume": "sample string 10", "PickupCompanyName": "sample string 11", "PickupFirstName": "sample string 12", "PickupLastName": "sample string 13", "PickupAddress": "sample string 14", "PickupAddress2": "sample string 15", "PickupZip": "sample string 16", "PickupPlace": "sample string 17", "PickupCounty": "sample string 18", "PickupPhone": "sample string 19", "PickupEmail": "sample string 20", "RecipientCompanyName": "sample string 21", "RecipientFirstName": "sample string 22", "RecipientLastName": "sample string 23", "RecipientAddress": "sample string 24", "RecipientAddress2": "sample string 25", "RecipientZip": "sample string 26", "RecipientPlace": "sample string 27", "RecipientCounty": "sample string 28", "RecipientPhone": "sample string 29", "RecipientEmail": "sample string 30", "ReturnCompanyName": "sample string 31", "ReturnFirstName": "sample string 32", "ReturnLastName": "sample string 33", "ReturnAddress": "sample string 34", "ReturnAddress2": "sample string 35", "ReturnZip": "sample string 36", "ReturnPlace": "sample string 37", "ReturnCounty": "sample string 38", "ReturnPhone": "sample string 39", "ReturnEmail": "sample string 40", "PickupPointId": 1, "PickupPointCompanyName": "sample string 42", "PickupPointAddress": "sample string 43", "PickupPointAddress2": "sample string 44", "PickupPointCounty": "sample string 45", "PickupPointPlace": "sample string 46", "PickupPointZip": "sample string 47", "DeliveryDate": "2024-11-21T11:18:18", "PickupDate": "2024-11-21T11:18:18", "ServiceTypesJson": "sample string 50", "ProductCode": "sample string 51", "Services": [ "sample item string 1", "sample item string 2" ], "DeliveryType": 1, "CommentToCarrier": "sample string 54", "GoodsDescription": "sample string 55", "ShipmentId": "sample string 56", "UnitCode": "sample string 57", "RecipientShallPay": false, "RecipientCustomerId": 1, "SenderReference": "sample string 60" } ]