Booking API Documentation
Description
The Booking API gives the client the possibility to add and fetch a booking to and from the United Broker system. The API is based on a WCF Service with a RESTful implementation.
For access and testing of the Booking API please call the following web address:
Test: http://ubapimanagement.azure-api.net/bookingapitest/[function-name]
Production: http://ubapimanagement.azure-api.net/bookingapiprod/[function-name]
For easy testing, an extension like Postman can be used.
AddBookingBasic v1.0 Last modified: 2017-11-22
Summary
Adds simple booking
Description
The AddBookingBasic function gives the client the opportunity for adding a Booking to the United Broker system. This function is in a simple form, where the advanced form is a full booking, whereas the simple form will be enriched by the service before committing it to the system. The AddBookingBasic function demands an BasicBooking to be setup as JSON. Depending on the choice of format the function will also return the booking in the format.
URL
http://ubapimanagement.azure-api.net/bookingapitest/AddBookingBasicJSON
http://ubapimanagement.azure-api.net/bookingapiprod/AddBookingBasicJSON
Method
POST
Headers
Content-Type: application/json
Request example
{"Id":0,"Kind":1,"Labels":["ZPL"],"CustomerIdentifier":1000000295,"OrderNo":"10111093","ProductId":"2089","PickupDt":"2016-10-07","Services":[0],"Addresses":[{"Kind":1,"Name1":"Bestseller Textilhandels GmbH","Name2":" ","Attention":"-","Street1":"Modering 1, Haus A, Raum 201","Street2":" ","PostCode":"22457","City":"Hamburg","State":"","CountryCode":"DE","Phone":"+494053030","Mobile":"+494053030","Email":"thorsten.hartmann@bestseller.com"},{"Kind":0,"Name1":"ON TIME PR. GMBH","Name2":" ","Attention":"-","Street1":"SCHLESISCHE STR. 26","Street2":"","PostCode":"10997","City":"BERLIN","State":"Berlin","CountryCode":"DE","Phone":"030 6162730 0","Mobile":"030 6162730 0","Email":"email@gmail.com"},{"Kind":10,"CustNo":"0","CountryCode":"DE"}],"Lines":[{"GoodsTypeID":0,"PkgWeight":"19999","Height":"600","Length":"600","Width":"400","Packages":[{"ItemNo":1}]}],"References":[{"Kind":7,"Value":"Jack&Jones"},{"Kind":108,"Value":"07.10.2016 12:18:28"},{"Kind":9,"Value":"07.10.2016"},{"Kind":12,"Value":"Jack&Jones"}],"Messages":[{"Kind":3,"Text":"Shipped with UBsend.com"}],"UserName":"TestUser","Password":"vDiSLNlkxEH5byq6","ProviderType":0}
Parameters
Name | Type | Required | Description |
---|---|---|---|
Id | int |
Identifier of the request | |
Kind | int |
Kind of the request. | |
Labels | array |
The label will be return in a text string which can be transformed to an image. | |
CustomerIdentifier | int |
Your identifier in the United Broker System. For user wanting access to Consignor and who do not have a United Broker account, please provide 63 | |
ProductId | int |
The product id used to identify the product in the United Broker System, and in the external providers systems. For user wanting access to Consignor and who do not have an United Broker account, please provide 1032. For DAO you should provide 0. | |
OrderNo | string |
The order number of the shipment. | |
PickupDt | date |
Example: 2016-10-07. Parameter is required if there is a pick up service involved for the requested shipment. Some product are pick up product, and therefore the date need to be provided for these products. | |
UserName | string |
Your username for your account in United Broker. Will let you have access to the API. In testing cases you could provide TestUser |
|
Password | string |
Your password for your account in United Broker. Will let you have access to the API. In testing cases you could provide vDiSLNlkxEH5byq6 |
|
ProviderType | int |
Currently these providers are available:
|
|
Services | array |
Depending on the ProductId |
|
Addresses | array |
Sender and receiver should always be defined. | |
Lines | array |
||
References | array |
Extra information for the shipment | |
Messages | array |
Extra information for the shipment |
Sender or receiver
Name | Type | Required | Description |
---|---|---|---|
Kind | int |
Defines the kind of the address:
|
|
Name | string |
The name of the person | |
Name1 | string |
Only need if not enough space in Name1 | |
Attention | string |
Defines the name of another person than the sender or receiver. | |
Street1 | string |
The address of the receiver or sender | |
Street2 | string |
Only used if not enough space in Street1 | |
PostCode | string |
The post code of the address | |
City | string |
The city name of the address | |
State | string |
The state of the address. | |
CountryCode | string |
The country of the address. Format: ISO 3166-1 alpha-2 | |
Phone | string |
The landline phone number of the receiver or sender | |
Mobile | string |
The mobile number of the receiver or sender. | |
string |
The email of the receiver or sender. |
Parcel shop
Name | Type | Required | Description |
---|---|---|---|
Kind | int |
Defines the kind of the address:
|
|
CustNo | int |
Id of the parcel shop in Consignor system | |
CountryCode | string |
The country of the parcel shop. Format: ISO 3166-1 alpha-2 |
Name | Type | Required | Description |
---|---|---|---|
GoodsTypeId | string |
Should always be defined, and it differs from product to product. Provide default value 0 if the wanted product does not require it. | |
PkgWeight | int |
The package weight of the shipment in grams | |
Height | double |
The height of the package in centimetres | |
Length | double |
The length of the package in centimetres | |
Width | double |
The width of the package in centimetres | |
Packages | array |
Name | Type | Required | Description |
---|---|---|---|
ItemNo | int |
If more packages are needed for a line, provide item number different from each other. Use 1, 2, 3... |
Name | Type | Required | Description |
---|---|---|---|
Kind | int |
Kind of reference. Used to identify the kind of reference in the system | |
Value | string |
The value of the reference |
Name | Type | Required | Description |
---|---|---|---|
Kind | int |
Kind of message. Used to identify the kind of message in the system | |
Text | string |
The value of the message |
Response
If request was successful, system will return json response with information about the booking, including encoded (base64) label.
Successfull response object will have the StatusCode of "200"
.
Unsuccessfull response object will have the StatusCode of "400"
.
Example of response with an error
{ "BookingHeader":null, "StatusCode":"400", "Message":"No Valid Providor Selected", "Warning":null}
Example of succesfull response
{"StatusCode":"200","Message":null,"Warning":"Booking Returned Without SalesPrice","BookingHeader":{"ConsigneeNumber":6212,"ConsigneeName":"","InvoiceeNumber":20001794823,"InvoiceeName":"","LocationID":0,"LocationName":"","Description":"","CurrencyCode":"","BookingId":0,"ProviderId":0,"Lines":[{"LineId":"","UbLineId":0,"LineNumber":"","ShipmentDescription":"","ShipmentAWB":"0000000001","CarrierID":"156","CarrierName":"","SubCarrierID":"265","SubCarrierName":"","PurchaseProductID":"94","PurchaseProductName":"","GoodsTypeKey1":0,"GoodsTypeName":"","GoodsTypeID":"","NumberOfColli":1,"UnitType":"CLL","Length":0.0,"Width":0.0,"Height":0.0,"Weight":9999.0,"Volume":0.0,"DimensionalWeight":9999.0,"Loadmeter":0,"ShipCustomsValue":0,"ShipCustomsCurrency":"","ShipCODValue":0,"ShipCODCurrency":"","InsuranceValue":0,"InsuranceCurrency":"","InsuredBy":"","DangerousGoods":false,"IncoTerms":"","SendersReference":"","ReceiversReference":"","ReceiversReference2":"","BookingSystem":"","BookingSystemShipmentID":0.0,"BookingSystemOrderNumber":0.0,"SalesChannelSystem":"","SalesChannelSystemShipmentID":141618.0,"SalesChannelSystemOrderNumber":0.0,"ShipmentDirection":"","ShipmentPaymentDirection":"1","PayerAccountAtCarrier":"710010361","SenderAccountAtCarrier":"710010361","IsDocument":false,"IsEUShipment":false,"IsReturn":false,"BookingCreated":"2016-10-03T10:37:00","LabelPrintDate":null,"TransmitDate":null,"RequestedPickupDateStart":"2016-10-13T00:00:00","RequestedPickupDateEnd":"2016-10-13T00:00:00","RequestedDeliveryDateStart":"2016-10-13T00:00:00","RequestedDeliveryDateEnd":"2016-10-13T00:00:00","ScanLines":[{"ColliId":0,"LineId":0,"ScanDate":"2016-10-03T10:37:00","ScanServerDate":"1900-01-01T00:00:00","ScanLocation":0,"GpsLatitude":"","GpsLongtitude":"","ScanSignature":"","ScanTypeID":4,"ScanTypeName":"","ScanText":"","BookingSystemStatus":"","Origin":"","CarrierWeight":9999.0,"CarrierVolume":9999.0,"CarrierLength":0.0,"CarrierWidth":0.0,"CarrierHeight":0.0,"CarrierLoadmeter":0.0,"CarrierColliWeight":0.0,"CarrierColliVolume":0.0,"CarrierColliLength":0.0,"CarrierColliWidth":0.0,"CarrierColliHeight":0.0,"CarrierColliLoadmeter":0.0,"ScanLevel":"Shipment","ScanLineId":0}],"Specifications":[{"SpecificationId":0,"LineId":0,"FeeNumber":1,"FeeDescription":"","FeeDescription2":"","Quantity":1,"UnitType":"10000001","CurrencyCode":"DKK","FeeUnitCostPriceCur":0.0,"FeeLineCostDiscountAmountCur":0.0,"FeeUnitCostPrice":20.2500,"FeeLineCostDiscountAmount":0.0,"FeeUnitSalesPriceCur":0.0,"FeeLineSalesDiscountAmountCur":0.0,"FeeUnitSalesPrice":0.0,"FeeLineSalesDiscountAmount":0.0,"Creditor":""}],"Collies":[{"UbColliId":0,"ColliID":"","ItemNumber":"1","ColliAWB":"0000000001","ColliPackagingType":"","ColliGoodsType":"","ColliDescriptionOfContents":"","CustomerColliLength":0.0,"CustomerColliWidth":0.0,"CustomerColliHeight":0.0,"CustomerColliWeight":9999.0,"CustomerColliVolume":9999.0}],"Addresses":[{"AddressType":"Sender","AddressID":0,"CompanyName":"Tester","ContactName":"","Address1":"vestergade 32","Address2":"","Address3":"","City":"odense c","Zip":"5000","Country":"","CountryIATA":"DK","Attention":"","AttentionPhone":"","AttentionMobile":"","AttentionEmail":"","Phone":"","Mobile":"","Email":"","Description":""},{"AddressType":"","AddressID":0,"CompanyName":"","ContactName":"","Address1":"","Address2":"","Address3":"","City":"","Zip":"","Country":"","CountryIATA":"DK","Attention":"","AttentionPhone":"","AttentionMobile":"","AttentionEmail":"","Phone":"","Mobile":"","Email":"","Description":""},{"AddressType":"","AddressID":0,"CompanyName":"","ContactName":"","Address1":"","Address2":"","Address3":"","City":"","Zip":"","Country":"","CountryIATA":"","Attention":"","AttentionPhone":"","AttentionMobile":"","AttentionEmail":"","Phone":"","Mobile":"","Email":"","Description":""},{"AddressType":"Receiver","AddressID":0,"CompanyName":"Test 1","ContactName":"","Address1":"Hobrovej 452","Address2":"","Address3":"","City":"Aalborg SV","Zip":"9200","Country":"","CountryIATA":"DK","Attention":"","AttentionPhone":"","AttentionMobile":"","AttentionEmail":"","Phone":"","Mobile":"","Email":"","Description":""}]}],"Messages":[],"ShipmentId":0,"IsCreate":false,"OrderNumber":"00001","Label":null,"Sorting":"","LabelText1":"","LabelText2":"","LabelText3":""}}
ValidateBookingBasic v1.0 Last modified: 2017-09-19
Summary
Validates basic booking object.
Description
It is complementary method to the AddBookingBasic
method.
It is recommended to use this method before charging your customer, so you can be sure that the booking has a valid information
required for AddBookingBasic
method after the payment.
This method will not create a booking towards the carrier or other service provider.
Structure and information required is the same as for AddBookingBasic
method.
URL
http://ubapimanagement.azure-api.net/bookingapitest/ValidateShipmentJSON
http://ubapimanagement.azure-api.net/bookingapiprod/ValidateShipmentJSON
Method
POST
Headers
Content-Type: application/json
Request example
{"Id":0,"Kind":1,"Labels":["none"],"CustomerIdentifier":1000000295,"OrderNo":"10097226","ProductId":"94","PickupDt":"2017-12-24","Services":[9025],"Addresses":[{"Kind":1,"Name1":"VERO MODA, Aalborg Storcenter","Name2":" ","Attention":" ","Street1":"Hobrovej 452","Street2":" ","PostCode":"9200","City":"Aalborg SV","State":"","CountryCode":"DK","Phone":"+4596353703","Mobile":"+4596353703","Email":"vmdnk307637@bestseller.com"},{"Kind":0,"Name1":"vero moda","Name2":" ","Attention":" ","Street1":"vestergade 32","Street2":"","PostCode":"5000","City":"odense c","State":"","CountryCode":"DK","Phone":"","Mobile":"","Email":"email@gmail.com"},{"Kind":10,"CustNo":"0","CountryCode":"DK"}],"Lines":[{"GoodsTypeID":0,"PkgWeight":"9999","Height":"400","Length":"600","Width":"300","Packages":[{"ItemNo":1}]}],"References":[{"Kind":7,"Value":""},{"Kind":108,"Value":"24.12.2016 15:04:50"},{"Kind":9,"Value":"24.12.2016"},{"Kind":12,"Value":""}],"Messages":[{"Kind":3,"Text":"(10097226) "}],"UserName":"TestUser","Password":"vDiSLNlkxEH5byq6","ProviderType":0}
Response
Successfull response object will have the StatusCode of "200"
.
Unsuccessfull response object will have the StatusCode of "4**"
or "5**"
and will contain an error message.
Example of response with an error
{ "Message": "{\"ErrorMessages\":[\"Pickup date must be today or later\"],\"ProdCSID\":2682}", "StatusCode": "400" }
Example of succesfull response
{ "Message": "{\"Messages\":[\"Validation OK\"]}", "StatusCode": "200" }
AddBookingSmart v1.0 Last modified: 2017-09-01
Summary
Adds a booking based on your subscription.
Description
It is simplified version of AddBookingBasic, where products and services are predefined in UB system based on CustomerIdentifier and receiver country.
It is important to mention, that parcel shop product is selected only when parcel shop address is included ("Kind":10
). In this case, parcel shop ID ("CustNo"
) has to be based on the carrier, which is agreed with United Broker.
URL
http://ubapimanagement.azure-api.net/bookingapitest/AddBookingSmart
http://ubapimanagement.azure-api.net/bookingapiprod/AddBookingSmart
Method
POST
Headers
Content-Type: application/json
Request example
{ "CustomerIdentifier": 1000001015, "OrderNo": "10167306", "Addresses": [ { "Kind": 1, "Name1": "TESTSHIPMENT", "Name2": "Peter Slott Henriksen", "Attention": "Strandvejsristeriet Aps Peter Slott Henriksen", "Street1": "Moorburger Elbdeich 371", "Street2": "", "PostCode": "21079", "City": "Hamburg", "State": "Hamburg", "CountryCode": "DE", "Phone": "+4522474247", "Mobile": "+4522474247", "Email": "info@strandvejsristeriet.dk" }, { "Kind": 0, "Name1": "TESTSHIPMENT", "Name2": "Patrick Nørgaard", "Attention": "-", "Street1": "Stenhusvej 28, 1 27", "Street2": "", "PostCode": "4300", "City": "Holbæk", "State": "Region Sjælland", "CountryCode": "DK", "Phone": "+4553535151", "Mobile": "+4553535151", "Email": "email@gmail.com", "CustNo": "1" } ], "Lines": [ { "GoodsTypeId": 1, "PkgWeight": "999", "Height": "200", "Length": "300", "Width": "30", "Packages": [ { "ItemNo": 1 } ] } ], "References": [ { "Kind": 7, "Value": "1" }, { "Kind": 12, "Value": "1" } ], "Messages": [ { "Kind": 3, "Text": "Shipped with UBsend.com" } ], "UserName": "TestUser", "Password": "vDiSLNlkxEH5byq6", "LabelType": "PNG", "LabelSize": "100x150" }
Parameters
Name | Type | Required | Description | Max length |
---|---|---|---|---|
LabelType | string |
Label content will be returned in a encoded (base64) string. | 3 | |
LabelSize | string |
Size of the label in millimeters. Currently only one size available: 100x150 |
9 | |
CustomerIdentifier | int |
Your identifier in the United Broker System. For user wanting access to Consignor and who do not have a United Broker account, please provide 63 | ||
OrderNo | int |
The order number of the shipment. | ||
UserName | string |
Your username for your account in United Broker. Will let you have access to the API. In testing cases you could provide TestUser |
250 | |
Password | string |
Your password for your account in United Broker. Will let you have access to the API. In testing cases you could provide vDiSLNlkxEH5byq6 |
250 | |
Addresses | array |
Sender and receiver should always be defined. | ||
Lines | array |
|||
References | array |
Extra information for the shipment | ||
Messages | array |
Extra information for the shipment |
Sender or receiver
Name | Type | Required | Description | Max length |
---|---|---|---|---|
Kind | int |
Defines the kind of the address:
|
||
Name1 | string |
The name of the person | 250 | |
Name2 | string |
Only need if not enough space in Name1 | 250 | |
Attention | string |
Defines the name of another person than the sender or receiver. | 250 | |
Street1 | string |
The address of the receiver or sender | 250 | |
Street2 | string |
Only used if not enough space in Street1 | 250 | |
PostCode | string |
The post code of the address | 10 | |
City | string |
The city name of the address | 50 | |
State | string |
The state of the address. | 50 | |
CountryCode | string |
The country of the address. Format: ISO 3166-1 alpha-2 | 2 | |
Phone | string |
The landline phone number of the receiver or sender | 20 | |
Mobile | string |
The mobile number of the receiver or sender. | 20 | |
string |
The email of the receiver or sender. | 50 |
Parcel shop
Name | Type | Required | Description | Max length |
---|---|---|---|---|
Kind | int |
Defines the kind of the address:
|
||
CustNo | int |
Id of the parcel shop in Consignor system | ||
CountryCode | string |
The country of the parcel shop. Format: ISO 3166-1 alpha-2 | 2 |
Name | Type | Required | Description | Max length |
---|---|---|---|---|
GoodsTypeId | string |
Should always be defined, and it differs from product to product. Provide default value 0 if the wanted product does not require it. | 2 | |
PkgWeight | int |
The package weight of the shipment in grams | ||
Height | double |
The height of the package in centimetres | ||
Length | double |
The length of the package in centimetres | ||
Width | double |
The width of the package in centimetres | ||
Packages | array |
Name | Type | Required | Description | Max length |
---|---|---|---|---|
ItemNo | int |
If more packages are needed for a line, provide item number different from each other. Use 1, 2, 3... |
Name | Type | Required | Description | Max length |
---|---|---|---|---|
Kind | int |
Kind of reference. Used to identify the kind of reference in the system | ||
Value | string |
The value of the reference | 250 |
Name | Type | Required | Description | Max length |
---|---|---|---|---|
Kind | int |
Kind of message. Used to identify the kind of message in the system | ||
Text | string |
The value of the message | 250 |
Response
If request was successful, system will return json response with information about the booking, including encoded (base64) label.
Successfull response object will have the StatusCode of "200"
.
Unsuccessfull response object will have the StatusCode of "400"
.
Example of response with an error
{ "BookingHeader":null, "StatusCode":"400", "Message":"No Valid Customer", "Warning":null}
Example of succesfull response
{"StatusCode":"200","Message":null,"Warning":"Booking Returned Without SalesPrice","BookingHeader":{"ConsigneeNumber":6212,"ConsigneeName":"","InvoiceeNumber":20001794823,"InvoiceeName":"","LocationID":0,"LocationName":"","Description":"","CurrencyCode":"","BookingId":0,"ProviderId":0,"Lines":[{"LineId":"","UbLineId":0,"LineNumber":"","ShipmentDescription":"","ShipmentAWB":"0000000001","CarrierID":"156","CarrierName":"","SubCarrierID":"265","SubCarrierName":"","PurchaseProductID":"94","PurchaseProductName":"","GoodsTypeKey1":0,"GoodsTypeName":"","GoodsTypeID":"","NumberOfColli":1,"UnitType":"CLL","Length":0.0,"Width":0.0,"Height":0.0,"Weight":9999.0,"Volume":0.0,"DimensionalWeight":9999.0,"Loadmeter":0,"ShipCustomsValue":0,"ShipCustomsCurrency":"","ShipCODValue":0,"ShipCODCurrency":"","InsuranceValue":0,"InsuranceCurrency":"","InsuredBy":"","DangerousGoods":false,"IncoTerms":"","SendersReference":"","ReceiversReference":"","ReceiversReference2":"","BookingSystem":"","BookingSystemShipmentID":0.0,"BookingSystemOrderNumber":0.0,"SalesChannelSystem":"","SalesChannelSystemShipmentID":141618.0,"SalesChannelSystemOrderNumber":0.0,"ShipmentDirection":"","ShipmentPaymentDirection":"1","PayerAccountAtCarrier":"710010361","SenderAccountAtCarrier":"710010361","IsDocument":false,"IsEUShipment":false,"IsReturn":false,"BookingCreated":"2016-10-03T10:37:00","LabelPrintDate":null,"TransmitDate":null,"RequestedPickupDateStart":"2016-10-13T00:00:00","RequestedPickupDateEnd":"2016-10-13T00:00:00","RequestedDeliveryDateStart":"2016-10-13T00:00:00","RequestedDeliveryDateEnd":"2016-10-13T00:00:00","ScanLines":[{"ColliId":0,"LineId":0,"ScanDate":"2016-10-03T10:37:00","ScanServerDate":"1900-01-01T00:00:00","ScanLocation":0,"GpsLatitude":"","GpsLongtitude":"","ScanSignature":"","ScanTypeID":4,"ScanTypeName":"","ScanText":"","BookingSystemStatus":"","Origin":"","CarrierWeight":9999.0,"CarrierVolume":9999.0,"CarrierLength":0.0,"CarrierWidth":0.0,"CarrierHeight":0.0,"CarrierLoadmeter":0.0,"CarrierColliWeight":0.0,"CarrierColliVolume":0.0,"CarrierColliLength":0.0,"CarrierColliWidth":0.0,"CarrierColliHeight":0.0,"CarrierColliLoadmeter":0.0,"ScanLevel":"Shipment","ScanLineId":0}],"Specifications":[{"SpecificationId":0,"LineId":0,"FeeNumber":1,"FeeDescription":"","FeeDescription2":"","Quantity":1,"UnitType":"10000001","CurrencyCode":"DKK","FeeUnitCostPriceCur":0.0,"FeeLineCostDiscountAmountCur":0.0,"FeeUnitCostPrice":20.2500,"FeeLineCostDiscountAmount":0.0,"FeeUnitSalesPriceCur":0.0,"FeeLineSalesDiscountAmountCur":0.0,"FeeUnitSalesPrice":0.0,"FeeLineSalesDiscountAmount":0.0,"Creditor":""}],"Collies":[{"UbColliId":0,"ColliID":"","ItemNumber":"1","ColliAWB":"0000000001","ColliPackagingType":"","ColliGoodsType":"","ColliDescriptionOfContents":"","CustomerColliLength":0.0,"CustomerColliWidth":0.0,"CustomerColliHeight":0.0,"CustomerColliWeight":9999.0,"CustomerColliVolume":9999.0}],"Addresses":[{"AddressType":"Sender","AddressID":0,"CompanyName":"Tester","ContactName":"","Address1":"vestergade 32","Address2":"","Address3":"","City":"odense c","Zip":"5000","Country":"","CountryIATA":"DK","Attention":"","AttentionPhone":"","AttentionMobile":"","AttentionEmail":"","Phone":"","Mobile":"","Email":"","Description":""},{"AddressType":"","AddressID":0,"CompanyName":"","ContactName":"","Address1":"","Address2":"","Address3":"","City":"","Zip":"","Country":"","CountryIATA":"DK","Attention":"","AttentionPhone":"","AttentionMobile":"","AttentionEmail":"","Phone":"","Mobile":"","Email":"","Description":""},{"AddressType":"","AddressID":0,"CompanyName":"","ContactName":"","Address1":"","Address2":"","Address3":"","City":"","Zip":"","Country":"","CountryIATA":"","Attention":"","AttentionPhone":"","AttentionMobile":"","AttentionEmail":"","Phone":"","Mobile":"","Email":"","Description":""},{"AddressType":"Receiver","AddressID":0,"CompanyName":"Test 1","ContactName":"","Address1":"Hobrovej 452","Address2":"","Address3":"","City":"Aalborg SV","Zip":"9200","Country":"","CountryIATA":"DK","Attention":"","AttentionPhone":"","AttentionMobile":"","AttentionEmail":"","Phone":"","Mobile":"","Email":"","Description":""}]}],"Messages":[],"ShipmentId":0,"IsCreate":false,"OrderNumber":"00001","Label":null,"Sorting":"","LabelText1":"","LabelText2":"","LabelText3":""}}
ValidateBookingSmart v1.0 Last modified: 2017-09-05
Summary
Validates a booking based on your subscription.
Description
It is complementary method to the AddBookingSmart
method.
It is recommended to use this method before charging your customer, so you can be sure that the booking has a valid information
required for AddBookingSmart
method after the payment.
This method will not create a booking towards the carrier or other service provider.
Structure and information required is the same as for AddBookingSmart
method.
URL
http://ubapimanagement.azure-api.net/bookingapitest/ValidateBookingSmart
http://ubapimanagement.azure-api.net/bookingapiprod/ValidateBookingSmart
Method
POST
Headers
Content-Type: application/json
Request example
{ "CustomerIdentifier":1000001015, "OrderNo":"10167306", "Addresses":[ { "Kind":1, "Name1":"TESTSHIPMENT", "Name2":"Peter Slott Henriksen", "Attention":"Strandvejsristeriet Aps Peter Slott Henriksen", "Street1":"Kronborg 12", "Street2":"", "PostCode":"3000", "City":"Helsing\u00f8r", "State":"Region Hovedstaden", "CountryCode":"DK", "Phone":"+4522474247", "Mobile":"+4522474247", "Email":"info@strandvejsristeriet.dk" }, { "Kind":0, "Name1":"TESTSHIPMENT", "Name2":"Patrick N\u00f8rgaard", "Attention":"-", "Street1":"Stenhusvej 28, 1 27", "Street2":"", "PostCode":"4300", "City":"Holb\u00e6k", "State":"Region Sj\u00e6lland", "CountryCode":"DK", "Phone":"+4553535151", "Mobile":"+4553535151", "Email":"email@gmail.com", "CustNo":"1" } ], "Lines":[ { "GoodsTypeID":1, "PkgWeight":"999", "Height":"200", "Length":"300", "Width":"30", "Packages":[ { "ItemNo":1 } ] } ], "References":[ { "Kind":7, "Value":"1" }, { "Kind":12, "Value":"1" } ], "Messages":[ { "Kind":3, "Text":"Shipped with UBsend.com" } ], "UserName":"TestUser", "Password":"vDiSLNlkxEH5byq6", "LabelType":"ZPL", "LabelSize":"100x150" }
Response
Successfull response object will have the StatusCode of "200"
.
Unsuccessfull response object will have the StatusCode of "4**"
or "5**"
and will contain an error message.
Example of response with an error
{ "BookingHeader": null, "Message": "No access to API for applied user", "StatusCode": "401", "Warning": null }
Example of succesfull response
{ "BookingHeader": null, "Message": "{\"Messages\":[\"Validation OK\"]}", "StatusCode": "200", "Warning": null }
AddBooking v1.0 Last modified: 2017-06-29
Summary
Adds a full booking that has been booked to a carrier via another integration. This is primary used for clients who has their own carrier integrations.
Description
The AddBooking function gives the client the opportunity for adding a Booking to the United Broker system. This function is an advanced form which contains a full booking. The AddBooking function demands an AdvancedBooking to be setup up as JSON. Depending on the choice of format the function will also return the booking in the format. The data contract is defined as follows
URL
http://ubapimanagement.azure-api.net/bookingapitest/AddBookingJSON
http://ubapimanagement.azure-api.net/bookingapiprod/AddBookingJSON
Method
POST
Headers
Content-Type: application/json
Request example
{"MaturityLevel":40,"UserName":"TestUser","Password":"vDiSLNlkxEH5byq6","Topic":"booking","Booking":{"BookingHeader":{"ConsigneeNumber":6212,"LocationID":0,"LocationName":"","Description":"","CurrencyCode":"EUR","ProviderId":2,"ShipmentId":160862,"OrderNumber":"160862","Lines":[{"LineNumber":1,"ShipmentDescription":"asdas","ShipmentAWB":"GE325864796DK","SubCarrierID":10000004,"PurchaseProductID":549,"PurchaseProductName":"TNT Economy","NumberOfColli":1,"UnitType":10000004,"Length":0,"Width":0,"Height":0,"Weight":10,"Volume":10,"DimensionalWeight":0,"ShipCustomsValue":10,"ShipCustomsCurrency":"EUR","ShipCODValue":0,"ShipCODCurrency":"","InsuranceValue":0,"InsuranceCurrency":"DKK","InsuredBy":"","DangerousGoods":false,"IncoTerms":10000004,"SendersReference":"adasd","ReceiversReference":"asdsa","ReceiversReference2":"","BookingSystemShipmentID":160862,"PayerAccountAtCarrier":"2014969","SenderAccountAtCarrier":"2014969","IsDocument":false,"IsReturn":false,"BookingCreated":"2016-12-01T07:53:16","LabelPrintDate":null,"TransmitDate":null,"RequestedPickupDateStart":null,"RequestedPickupDateEnd":null,"RequestedDeliveryDateStart":null,"RequestedDeliveryDateEnd":null,"CarrierLineWeight":0,"CarrierLineHeight":0,"CarrierLineLength":0,"CarrierLineWidth":0,"CarrierLineVolume":0,"CarrierLineVolumeWeight":0,"CarrierLineLoadmeter":0,"CustomerLineWeight":0,"CustomerLineHeight":0,"CustomerLineLength":0,"CustomerLineWidth":0,"CustomerLineVolume":0,"CustomerLineVolumeWeight":0,"CustomerLineLoadmeter":0,"VolumeIndicator":null,"InvoiceWeight":0,"Specifications":[{"FeeNumber":1,"FeeDescription":"","FeeDescription2":"","Quantity":1,"UnitType":"10000001","CurrencyCode":"DKK","FeeUnitCostPriceCur":0,"FeeLineCostDiscountAmountCur":0,"FeeUnitCostPrice":20.25,"FeeLineCostDiscountAmount":0,"FeeUnitSalesPriceCur":0,"FeeLineSalesDiscountAmountCur":0,"FeeUnitSalesPrice":0,"FeeLineSalesDiscountAmount":0,"Creditor":""}],"Collies":[{"ItemNumber":"1","ColliAWB":"GE325864796DK","ColliDescriptionOfContents":"somethng","CustomerColliLength":10,"CustomerColliWidth":10,"CustomerColliHeight":10,"CustomerColliWeight":10,"CustomerColliVolume":1000,"CustomerColliVolumeWeight":0,"CustomerColliLoadmeter":0,"CarrierColliWeight":0,"CarrierColliHeight":0,"CarrierColliLength":0,"CarrierColliWidth":0,"CarrierColliVolume":0,"CarrierColliVolumeWeight":0,"CarrierColliLoadmeter":0}],"Addresses":[{"AddressType":"10000000","Name":"Dansk E Logistik TNT","Name2":"Dansk E Logistik TNT","Address1":"Naverland 33-35","Address2":null,"Address3":null,"City":"Glostrup","Zip":"2600","State":null,"CountryIATA":"DK","Attention":null,"AttentionPhone":null,"AttentionMobile":null,"AttentionEmail":"cs1@unitedbroker.com","Phone":null,"Mobile":null,"Email":"cs1@unitedbroker.com","Description":"","CompanyName":null,"ContactName":null,"Country":"DK"},{"AddressType":"10000003","Name":"Bogstad dNorsk Folkemuseum, ","Name2":"Bogstad dNorsk Folkemuseum, ","Address1":"rkedalsveien 450","Address2":null,"Address3":null,"City":"OSLO","Zip":"0758","State":null,"CountryIATA":"NO","Attention":null,"AttentionPhone":"004747010681","AttentionMobile":"004747010681","AttentionEmail":"anne.braathu@bogstad.no","Phone":"004747010681","Mobile":"004747010681","Email":"anne.braathu@bogstad.no","Description":"","CompanyName":null,"ContactName":null,"Country":"DK"},{"AddressType":"10000001","Name":"Dansk E Logistik TNT","Name2":"Dansk E Logistik TNT","Address1":"Naverland 33-35","Address2":null,"Address3":null,"City":"Glostrup","Zip":"2600","State":null,"CountryIATA":"DK","Attention":null,"AttentionPhone":null,"AttentionMobile":null,"AttentionEmail":"cs1@unitedbroker.com","Phone":null,"Mobile":null,"Email":"cs1@unitedbroker.com","Description":"","CompanyName":null,"ContactName":null,"Country":"DK"}]}]}}}
Parameters
Name | Type | Required | Description |
---|---|---|---|
Booking | object |
The booking / shipment being send | |
MaturityLevel | int |
Value of maturity in the United Broker systems. | |
UserName | string |
The user name to the Booking API (provided by United Broker) | |
Password | string |
The password to the Booking API (provided by United Broker) | |
Topic | string |
The topic name. Used internally in the United Broker system setup. Value: booking |
Name | Type | Required | Description |
---|---|---|---|
BookingHeader | object |
Name | Type | Required | Description |
---|---|---|---|
ConsigneeNumber | int |
The number of the client making the request. | |
LocationID | int |
The id of the location where from the booking is being made. | |
LocationName | string |
The name of the location where from the booking is being made. | |
Description | string |
Optional description of the booking | |
CurrencyCode | string |
The currency of the payment of the booking | |
ProviderId | int |
The id of the internal booking provider | |
ShipmentId | int |
Order Id from the client | |
OrderNumber | string |
The order number of the booking in the client's system (as per reference). | |
Lines | array |
Name | Type | Required | Description |
---|---|---|---|
LineNumber | int |
The number of the line (1, 2, 3...) | |
ShipmentDescription | string |
A description of the booking. | |
ShipmentAWB | string |
The barcode of the booking. | |
SubCarrierID | int |
The United Broker product id of the booking.(See table below for Sub Carriers available). | |
PurchaseProductID | string |
The currency of the payment of the booking.(See table below for Purchase Product Ids available). | |
PurchaseProductName | string |
The United Broker product name of the booking | |
NumberOfColli | int |
Number of collies on the line. | |
UnitType | int |
The unit type of the line. (See table below for Unit Types available). | |
Length | decimal |
The length of the line. | |
Width | decimal |
The width of the line. | |
Height | decimal |
The height of the line. | |
Weight | decimal |
The weight of the line. | |
Volume | decimal |
The volume of the line. | |
DimensionalWeight | decimal |
The dimensional weight of the package. | |
ShipCustomsValue | string |
The currency of the custom value. | |
ShipCODValue | decimal |
The cash-on-delivery value. | |
ShipCODCurrency | string |
The cash-on-delivery value currency. | |
InsuranceValue | decimal |
The insurance value. | |
InsuranceCurrency | string |
The insurance value currency. | |
InsuredBy | string |
The insurance company used. | |
DangerousGoods | boolean |
Set to true if the booking contains dangerous goods. | |
IncoTermsId | int |
The inco term id. (See table below for Inco Terms available). | |
SendersReference | string |
The senders reference. | |
ReceiversReference | string |
The receivers reference. | |
ReceiversReference2 | string |
The receivers reference 2. | |
BookingSystemShipmentID | int |
The shipment id from the client’s booking system. | |
PayerAccountAtCarrier | string |
The payer account of the service at the carrier. | |
SenderAccountAtCarrier | string |
The sender account of the service at the carrier. | |
IsDocument | boolean |
Set to true if shipment is a document. | |
IsReturn | boolean |
If booking is a return shipment, please set to true. | |
BookingCreated | DateTime |
The date and time when the booking is made in the client system. Example: 2016-10-03T10:37:00 |
|
LabelPrintDate | DateTime |
If label has been printed, please supply the date and time. Example: 2016-10-03T10:37:00 |
|
TransmitDate | DateTime |
The date and time when the booking is transmitted to the United Broker System. Example: 2016-10-03T10:37:00 |
|
RequestedPickupDateStart | DateTime |
If a pick up date exists, please provide the date and time. Example: 2016-10-03T10:37:00 |
|
RequestedPickupDateEnd | DateTime |
If the pick-up date is a time period, please provide the end time and date. Example: 2016-10-03T10:37:00 |
|
RequestedDeliveryDateStart | DateTime |
If the booking has a delivery date and time, please provide. Example: 2016-10-03T10:37:00 |
|
RequestedDeliveryDateEnd | DateTime |
If the delivery date is a time period, please provide the end time and date. Example: 2016-10-03T10:37:00 |
|
Specifications | array |
||
Collies | array |
||
Addresses | array |
At least sender and receiver addresses should be supplied. | |
CarrierLineWeight | decimal |
||
CarrierLineHeight | decimal |
||
CarrierLineLength | decimal |
||
CarrierLineWidth | decimal |
||
CarrierLineVolume | decimal |
||
CarrierLineVolumeWeight | decimal |
||
CarrierLineLoadmeter | decimal |
||
CustomerLineWeight | decimal |
||
CustomerLineHeight | decimal |
||
CustomerLineLength | decimal |
||
CustomerLineWidth | decimal |
||
CustomerLineVolume | decimal |
||
CustomerLineVolumeWeight | decimal |
||
CustomerLineLoadmeter | decimal |
||
VolumeIndicator | decimal |
||
InvoiceWeight | decimal |
Name | Type | Required | Description |
---|---|---|---|
FeeNumber | int |
The fee identification number. | |
FeeDescription | string |
The description of the fee. | |
FeeDescription2 | string |
The description of the fee. | |
Quantity | int |
The quantity of the fee. | |
UnitType | int |
The unit type of the fee. | |
CurrencyCode | string |
The currency code of the fee. | |
SpecificationId | int |
||
LineId | int |
||
FeeUnitCostPriceCur | decimal |
||
FeeLineCostDiscountAmountCur | decimal |
||
FeeUnitCostPrice | decimal |
||
FeeLineCostDiscountAmount | decimal |
||
FeeUnitSalesPriceCur | decimal |
||
FeeLineSalesDiscountAmountCur | decimal |
||
FeeUnitSalesPrice | decimal |
||
FeeLineSalesDiscountAmount | decimal |
||
Creditor | string |
Name | Type | Required | Description |
---|---|---|---|
ItemNumber | int |
The number of the colli (1, 2, 3...). | |
ColliAWB | string |
The barcode of the booking. | |
ColliDescriptionOfContents | string |
The description of the content of the colli. | |
CustomerColliLength | decimal |
The customer colli length of the booking. | |
CustomerColliWidth | decimal |
The customer colli width of the booking. | |
CustomerColliHeight | decimal |
The customer colli height of the booking. | |
CustomerColliWeight | decimal |
The customer colli weight of the booking. | |
CustomerColliVolume | decimal |
The customer colli volume of the booking. | |
CustomerColliVolumeWeight | decimal |
||
CustomerColliLoadmeter | decimal |
||
CarrierColliWeight | decimal |
||
CarrierColliHeight | decimal |
||
CarrierColliLength | decimal |
||
CarrierColliWidth | decimal |
||
CarrierColliVolume | decimal |
||
CarrierColliVolumeWeight | decimal |
||
CarrierColliLoadmeter | decimal |
Name | Type | Required | Description |
---|---|---|---|
AddressType | int |
The type of the address. (See table below for Address Types available). | |
Name | string |
The name of the person | |
Name2 | string |
Extra field for the name of the company or person. | |
ContactName | string |
The name of the contact person if any. | |
Address1 | string |
The street and street number of the address. | |
Address2 | string |
Additional field for street and street number. | |
Address3 | string |
Additional field for street and street number. | |
Zip | string |
The postal code of the address. | |
City | string |
The city name of the address | |
State | string |
The state of the address. | |
CountryIATA | string |
The country code of the address.. Format: ISO 3166-1 alpha-2 | |
Attention | string |
The name of the person at attention at the address. | |
AttentionPhone | string |
The phone number of the person at attention at the address. | |
AttentionMobile | string |
The mobile phone number of the person at attention at the address. | |
AttentionEmail | string |
The email of the person at attention at the address. | |
Phone | string |
The phone number of the address. | |
Mobile | string |
Required if email is not supplied. | |
string |
Required if mobile is not supplied. | ||
Description | string |
Description of the address.. |
Definitions
CarrierID | CarrierName |
---|---|
1000000001 |
GLS |
1000000002 |
DHL |
1000000003 |
BRING |
1000000004 |
DAO |
1000000005 |
Alpi |
1000000006 |
DKT |
1000000007 |
UPS |
1000000008 |
DPE |
1000000009 |
Postnord |
1000000010 |
Ole |
1000000011 |
LKW |
1000000012 |
Carvi |
1000000013 |
TNT |
1000000014 |
Geodis |
1000000015 |
Schenker |
1000000016 |
CitySprint |
1000000017 |
Posti |
1000000018 |
Geodis |
1000000019 |
Logika |
1000000020 |
DSV |
1000000021 |
Carelog |
1000000022 |
GLS |
1000000023 |
GLS France |
1000000024 |
Deutsche |
1000000025 |
Postnord NO |
SubcarrierID | Description (SubCarrierName) |
---|---|
1000000001 |
Bring Denmark Parcel |
1000000002 |
DAO Denmark Parcel |
1000000003 |
DHL Denmark Express |
1000000004 |
DHL Germany Parcel |
1000000005 |
DHL Sweden Parcel |
1000000006 |
Geodis Denmark Express |
1000000007 |
GLS Denmark Express |
1000000008 |
GLS Denmark Parcel |
1000000009 |
GLS Parcel (Int) |
1000000010 |
GLS Parcel (FR) |
1000000011 |
GLS Ireland Parcel |
1000000012 |
GLS Austria Parcel |
1000000013 |
GLS Belgium Parcel |
1000000014 |
GLS Italy Parcel |
1000000015 |
GLS Poland Parcel |
1000000016 |
GLS Spain Parcel |
1000000017 |
GLS United Kingdom Parcel |
1000000018 |
Postnord Denmark Parcel |
1000000019 |
Schenker Sweden Parcel |
1000000020 |
TNT Denmark Express |
1000000021 |
UPS Denmark Express |
1000000022 |
DHL Netherlands Parcel |
1000000024 |
Alpi Denmark Road |
1000000025 |
Alpi Denmark Air |
1000000026 |
Ole Henriksen Denmark Road |
1000000027 |
LKW Austria Road |
1000000028 |
Carvi Denmark Road |
1000000029 |
DKT Denmark Parcel |
1000000030 |
DPE Denmark Road |
1000000031 |
CitySprint United Kingdom Parcel |
1000000032 |
Postnord Norway Parcel |
1000000033 |
Posti Finland Parcel |
1000000034 |
Send24 Denmark Parcel |
1000000035 |
Logika Greece Parcel |
1000000036 |
Dachser Denmark Pallet |
1000000037 |
Carelog Denmark |
1000000038 |
DSV Denmark Parcel |
1000000039 |
DSV Denmark Pallet |
1000000040 |
Yodel United Kingdom Parcel |
1000000041 |
DHL Denmark Express |
1000000042 |
Correos Spain Parcel |
1000000043 |
Austrian Post Parcel |
1000000044 |
Fastway Ireland Parcel |
1000000045 |
DHL E-commerce |
1000000046 |
Royal Mail United Kingdom |
1000000047 |
4PX China Parcel |
PurchaseProductId | Description (ProductName) | Carrier |
---|---|---|
1000000001 |
PickUp Parcel | BRING |
1000000002 |
PickUp Parcel Return | BRING |
1000000003 |
PickUp Parcel Bulk | BRING |
1000000004 |
PickUp Parcel Return Bulk | BRING |
1000000005 |
Business Parcel | BRING |
1000000006 |
Business Parcel Return | BRING |
1000000007 |
Business Parcel Bulk | BRING |
1000000008 |
Business Parcel Return Bulk | BRING |
1000000009 |
Home | DAO |
1000000010 |
Shop | DAO |
1000000011 |
Home Labelless | DAO |
1000000012 |
Shop Labelless | DAO |
1000000013 |
Economy Select - Export | DHL |
1000000014 |
Economy Select - Import | DHL |
1000000015 |
Express 09.00 - Export | DHL |
1000000016 |
Express 09.00 - Import | DHL |
1000000017 |
Express 12.00 - Export | DHL |
1000000018 |
Express 12.00 - Import | DHL |
1000000019 |
Express Worldwide - Export | DHL |
1000000020 |
Express Worldwide - Import | DHL |
1000000021 |
Express Worldwide - 3-way | DHL |
1000000022 |
Paket | DHL |
1000000023 |
Weltpaket | DHL |
1000000024 |
Retoure | DHL |
1000000026 |
ServicePoint | DHL |
1000000027 |
Courier Express | Geodis |
1000000028 |
DirectSolution | GLS |
1000000030 |
Parcel Home | GLS |
1000000031 |
Parcel Business | GLS |
1000000032 |
Parcel Business Return | GLS |
1000000033 |
Parcel Euro Business | GLS |
1000000034 |
Parcel Euro Business Return | GLS |
1000000035 |
Parcel Shop | GLS |
1000000036 |
Parcel Shop Return | GLS |
1000000050 |
Parcel Business P&S (IE) | GLS |
1000000051 |
Parcel Business P&R (IE) | GLS |
1000000053 |
Parcel Euro Business P&S (IE) | GLS |
1000000054 |
Parcel Euro Business P&R (IE) | GLS |
1000000075 |
Premium 24h (DE) | GLS |
1000000076 |
Comfort 48h (DE) | GLS |
1000000084 |
Basic (ES) | GLS |
1000000087 |
Comfort Export NI (UK) | GLS |
1000000088 |
Comfort Import NI (UK) | GLS |
1000000089 |
MyPack Collect | Postnord |
1000000090 |
MyPack Home | Postnord |
1000000091 |
MyPack Collect Norden | Postnord |
1000000092 |
Parcel | Postnord |
1000000093 |
Customer Return | Postnord |
1000000094 |
Business Priority | Postnord |
1000000095 |
Private Priority | Postnord |
1000000096 |
Pallet | Postnord |
1000000097 |
Parcel | Schenker |
1000000098 |
Ombud Standard | Schenker |
1000000099 |
Express - Export | TNT |
1000000100 |
Economy Express - Export | TNT |
1000000101 |
Express Plus - Export | UPS |
1000000102 |
Express Plus - Import | UPS |
1000000105 |
Express Saver - Export | UPS |
1000000106 |
Express Saver - Import | UPS |
1000000107 |
Standard Single-Piece - Export | UPS |
1000000108 |
Standard Single-Piece - Import | UPS |
1000000109 |
Standard Multi-Piece - Export | UPS |
1000000110 |
Standard Multi-Piece - Import | UPS |
1000000111 |
Expedited - Export | UPS |
1000000112 |
Expedited - Import | UPS |
1000000113 |
Express Freight - Export | UPS |
1000000114 |
Express Freight - Import | UPS |
1000000115 |
Europlus | DHL |
1000000116 |
For You Shop | DHL |
1000000117 |
For You Home | DHL |
1000000119 |
E Com Home | DHL |
1000000120 |
Parcel Business w/pickup (DE) | GLS |
1000000121 |
Cykelbud | DKT |
1000000122 |
Bil-Kurér | DKT |
1000000123 |
Road | Alpi |
1000000124 |
Air | Alpi |
1000000125 |
Henriksen Freight | Ole |
1000000126 |
Freight | LKW |
1000000127 |
Freight | Carvi |
1000000128 |
Parcel Global Business | GLS |
1000000129 |
Parcel Euro Home | GLS |
1000000130 |
SameDay | CitySprint |
1000000131 |
90 min | CitySprint |
0 |
Standard | DPD |
UnitType | Description |
---|---|
10000000 |
CLL |
10000001 |
Piece |
10000002 |
Hour |
10000003 |
Minute |
10000004 |
Day |
10000005 |
Gram |
10000006 |
Kilo |
10000007 |
Kilometer |
10000008 |
Meter |
10000009 |
SquareMeter |
10000010 |
Liter |
10000011 |
LoadMeter |
10000012 |
Other |
Incoterm | Description |
---|---|
10000000 |
Ex Works |
10000001 |
Free Carrier |
10000002 |
Free Along Ship |
10000003 |
Free On Board |
10000004 |
Cost and Freight |
10000005 |
Cost Insurance Freight |
10000006 |
Carriage Paid to |
10000007 |
Cariage and Insurance Paid to |
10000008 |
Delivered at Terminal |
10000009 |
Delivered at Place |
10000010 |
Delivery Duty Paid |
10000011 |
Other |
AddressType | Description |
---|---|
10000000 |
Receiver |
10000001 |
PickUp |
10000002 |
Sender |
10000003 |
ReturnTo |
10000004 |
DropPoint |
10000005 |
Payer |
10000006 |
Delivery |
10000007 |
Depot |
10000008 |
Broker |
10000009 |
Buyer |
10000010 |
Forwarder |
Response
The function will return the full booking details.
Example of response with an error
{ "BookingHeader":null, "StatusCode":"400", "Message":"No Valid Providor Selected", "Warning":null}
Example of succesfull response
{"Booking":{"BookingHeader":{"BookingId":0,"ConsigneeName":null,"ConsigneeNumber":6212,"CurrencyCode":"EUR","Description":"","InvoiceeName":null,"InvoiceeNumber":0,"IsCreate":false,"Label":null,"LabelText1":null,"LabelText2":null,"LabelText3":null,"Labels":null,"Lines":[{"Addresses":[{"Address1":"Strandvejen 6","Address2":null,"Address3":null,"AddressID":0,"AddressType":"10000002","Attention":null,"AttentionEmail":null,"AttentionMobile":null,"AttentionPhone":null,"City":"Odense NØ","CompanyName":"Pakkelabels.dk ApS","ContactName":null,"Country":"Denmark","CountryIATA":"DK","Description":"","Email":null,"Mobile":null,"Name2":null,"Phone":null,"Zip":"5240"},{"Address1":"Strandvejen 6","Address2":null,"Address3":null,"AddressID":0,"AddressType":"10000000","Attention":null,"AttentionEmail":null,"AttentionMobile":null,"AttentionPhone":null,"City":"Odense NØ","CompanyName":"Pakkelabels.dk ApS","ContactName":null,"Country":"Denmark","CountryIATA":"DK","Description":"","Email":null,"Mobile":null,"Name2":null,"Phone":null,"Zip":"5240"}],"BookingCreated":"2017-02-03 15:16:45 +0100","BookingSystem":null,"BookingSystemOrderNumber":0,"BookingSystemShipmentID":1226378,"BrandName":null,"CarrierID":"1000000009","CarrierLineHeight":0,"CarrierLineLength":0,"CarrierLineLoadmeter":0,"CarrierLineVolume":0,"CarrierLineVolumeWeight":0,"CarrierLineWeight":0,"CarrierLineWidth":0,"CarrierName":"Postnord","Collies":[{"CarrierColliHeight":0,"CarrierColliLength":0,"CarrierColliLoadmeter":0,"CarrierColliVolume":0,"CarrierColliVolumeWeight":0,"CarrierColliWeight":0,"CarrierColliWidth":0,"ColliAWB":"00357128520006425190","ColliDescriptionOfContents":"Goods","ColliGoodsType":null,"ColliID":null,"ColliPackagingType":null,"CustomerColliHeight":1,"CustomerColliLength":1,"CustomerColliLoadmeter":0,"CustomerColliVolume":1,"CustomerColliVolumeWeight":0,"CustomerColliWeight":1000,"CustomerColliWidth":1,"ItemNumber":"1","UbColliId":0}],"CustomerLineHeight":0,"CustomerLineLength":0,"CustomerLineLoadmeter":0,"CustomerLineVolume":0,"CustomerLineVolumeWeight":0,"CustomerLineWeight":0,"CustomerLineWidth":0,"DangerousGoods":false,"DimensionalWeight":0,"GoodsTypeID":null,"GoodsTypeKey1":0,"GoodsTypeName":null,"Height":1,"IncoTerms":"10000004","InsuranceCurrency":"","InsuranceValue":0,"InsuredBy":"","InvoiceWeight":0,"IsDocument":false,"IsEUShipment":false,"IsReturn":false,"LabelPrintDate":null,"Length":1,"LineId":null,"LineNumber":"1","Loadmeter":0,"NumberOfColli":1,"PackageVolume":0,"PayerAccountAtCarrier":"","PurchaseProductID":"1000000092","PurchaseProductName":"Postnord Parcel","ReceiversReference":"","ReceiversReference2":"","References":null,"RequestedDeliveryDateEnd":null,"RequestedDeliveryDateStart":null,"RequestedPickupDateEnd":null,"RequestedPickupDateStart":null,"SalesChannelSystem":null,"SalesChannelSystemOrderNumber":0,"SalesChannelSystemShipmentID":0,"ScanLines":null,"SenderAccountAtCarrier":"","SendersReference":"","ShipCODCurrency":"","ShipCODValue":0,"ShipCustomsCurrency":"","ShipCustomsValue":0,"ShipmentAWB":"00357128520006425190","ShipmentDescription":"asds","ShipmentDirection":null,"ShipmentPaymentDirection":null,"Specifications":[{"Creditor":null,"CurrencyCode":null,"FeeDescription":null,"FeeDescription2":null,"FeeLineCostDiscountAmount":0,"FeeLineCostDiscountAmountCur":0,"FeeLineSalesDiscountAmount":0,"FeeLineSalesDiscountAmountCur":0,"FeeNumber":1,"FeeUnitCostPrice":0,"FeeUnitCostPriceCur":0,"FeeUnitSalesPrice":0,"FeeUnitSalesPriceCur":0,"LineId":4501242,"Quantity":1,"SpecificationId":4615081,"UnitType":10000001},{"Creditor":null,"CurrencyCode":"DKK","FeeDescription":null,"FeeDescription2":null,"FeeLineCostDiscountAmount":0,"FeeLineCostDiscountAmountCur":0,"FeeLineSalesDiscountAmount":0,"FeeLineSalesDiscountAmountCur":0,"FeeNumber":1,"FeeUnitCostPrice":0,"FeeUnitCostPriceCur":0,"FeeUnitSalesPrice":2,"FeeUnitSalesPriceCur":0,"LineId":4501242,"Quantity":1,"SpecificationId":4615081,"UnitType":10000001}],"SubCarrierID":"1000000018","SubCarrierName":"Postnord Denmark Parcel","TransmitDate":null,"UbLineId":0,"UnitType":10000006,"UnitTypeName":null,"Volume":1,"VolumeIndicator":null,"Weight":1000,"Width":1}],"LocationID":0,"LocationName":"","Messages":null,"OrderNumber":"1226378","ProviderId":2,"ShipmentId":1226378,"Sorting":null},"Message":"","StatusCode":"200","Warning":null},"Message":"Ok","StatusCode":"200","Warning":null}