/// <summary>
/// Gets the available services method.
/// See the API v15 documention for more information - https://github.com/despatchbay/api.v15/wiki/Shipping-Service
/// </summary>
/// <returns>an array of ServiceType[] </returns>
/// <param name="shipment">Shipment.</param>
private static ServiceType[] GetAvailableServicesMethod(ShipmentRequestType shipment)
{
ServiceType[] availableServices = null;
Service = GetAuthoriseService();
try {
// Call the GetDomesticServices soap service
availableServices = Service.GetAvailableServices(shipment);
} catch (Exception soapEx) {
Console.WriteLine("{0}", soapEx.Message);
throw;
}
return(availableServices);
}
/// <summary>
/// Add a Shipment Method
/// </summary>
/// <param name="shipment"></param>
/// <returns></returns>
static String AddShipmentMethod(ShipmentRequestType shipment)
{
String ShipmentID = null;
var Service = GetAuthoriseService();
try
{
// Call the GetDomesticServices soap service
Console.WriteLine(shipment.ServiceID);
ShipmentID = Service.AddShipment(shipment);
}
catch (Exception soapEx)
{
Console.WriteLine("{0}", soapEx.Message);
}
return(ShipmentID);
}
/// <summary>
/// Example to Get available services, Add a shipment to the account and the book the collection
/// </summary>
public static void Main()
{
LoadConfiguration();
int count = 0;
ServiceType[] availableServices = null;
try {
// First we need to build a shipment request object
ShipmentRequestType Shipment = new ShipmentRequestType();
//shipment.ServiceID = null;
//shipment.ClientReference = null;
//shipment.FollowShipment = null;
ParcelType Parcel = new ParcelType
{
Height = 10, // This is cm
Length = 10, // This is cm
Width = 10, // This is cm
Weight = 10, // This is kg
Value = 100, // This is GBP
Contents = "New Dress for Klingor"
};
// Obviously we could add more parcels here
ParcelType[] Parcels = new ParcelType[1];
Parcels[0] = Parcel;
AddressType Address = new AddressType();
// Receipient Details
RecipientAddressType RecipientAddress = new RecipientAddressType
{
RecipientName = "Cprl Klingor",
RecipientEmail = "*****@*****.**",
RecipientTelephone = "01522 76767676"
};
Address.CompanyName = "The SaleGroup";
Address.Street = "Unit 6 The Regatta";
Address.Locality = "Henley Way";
Address.TownCity = "Lincoln";
Address.County = "Lincolnshire";
Address.PostalCode = "LN6 3QR";
Address.CountryCode = "GB";
RecipientAddress.RecipientAddress = Address;
// Senders details
// Despatch bay lets you send parcels from an "Away Address",
// but you could pull this from the account API, which is the preferred method
SenderAddressType SenderAddress = new SenderAddressType
{
SenderName = "Hawkeye Pearce",
SenderEmail = "*****@*****.**",
SenderTelephone = "01522 000000"
};
Address = new AddressType(); // clear the address to reuse the object
Address.Street = "West Parade ";
Address.TownCity = "Lincoln";
Address.PostalCode = "LN1 1YP";
Address.County = "Lincolnshire";
Address.CountryCode = "GB";
SenderAddress.SenderAddress = Address;
// Put the Shipment together
Shipment.Parcels = Parcels;
Shipment.RecipientAddress = RecipientAddress;
Shipment.SenderAddress = SenderAddress;
// Call the service
availableServices = GetAvailableServicesMethod(Shipment);
// iterate though the list of returned services
count = 0;
foreach (ServiceType element in availableServices)
{
count += 1;
if (count == 1)
{
// Manually apply the First service
Shipment.ServiceID = element.ServiceID;
// Not sure why, but errors with ServiceID = 0
// if ServiceIDSpecified is Not set to true;
Shipment.ServiceIDSpecified = true;
}
System.Console.WriteLine("Service id:{0} - {1} £{2}", element.ServiceID, element.Name, element.Cost);
}
Shipment.ClientReference = "Dummy Client Ref";
// We need a collection Date
CollectionDateType CollectionDate = new CollectionDateType
{
// Set the Collection date for tomorrow
CollectionDate = DateTime.Today.AddDays(1).ToString("yyyy-MM-dd")
};
Shipment.CollectionDate = CollectionDate;
// Add Shipment
String ShipmentID = AddShipmentMethod(Shipment);
Console.WriteLine(ShipmentID);
// Book collection
// This is deliberatly written to handle one booking request
String [] Bookings = new String[1];
Bookings[0] = ShipmentID;
ShipmentReturnType[] BookingResults = null;
BookingResults = BookShipmentsMethod(Bookings);
// iterate though the list of returned services
count = 0;
foreach (ShipmentReturnType element in BookingResults)
{
count += 1;
System.Console.WriteLine("Service id:{0} - ShipmentID {1} - Label Url{2}", element.ServiceID, element.ShipmentID, element.LabelsURL);
}
} catch (Exception ex) {
Console.WriteLine(ex.Message);
throw;
}
}
