/// <summary>
/// Gets available shipping options
/// </summary>
/// <param name="getShippingOptionRequest">A request for getting shipping options</param>
/// <returns>Represents a response of getting shipping rate options</returns>
public GetShippingOptionResponse GetShippingOptions(GetShippingOptionRequest getShippingOptionRequest)
{
if (getShippingOptionRequest == null)
throw new ArgumentNullException("getShippingOptionRequest");
var response = new GetShippingOptionResponse();
if (getShippingOptionRequest.Items == null || getShippingOptionRequest.Items.Count == 0)
{
response.AddError("No shipment items");
return response;
}
int? restrictByCountryId = (getShippingOptionRequest.ShippingAddress != null && getShippingOptionRequest.ShippingAddress.Country != null) ? (int?)getShippingOptionRequest.ShippingAddress.Country.Id : null;
var shippingMethods = this._shippingService.GetAllShippingMethods(restrictByCountryId);
foreach (var shippingMethod in shippingMethods)
{
var shippingOption = new ShippingOption();
shippingOption.Name = shippingMethod.GetLocalized(x => x.Name);
shippingOption.Description = shippingMethod.GetLocalized(x => x.Description);
shippingOption.Rate = GetRate(shippingMethod.Id);
response.ShippingOptions.Add(shippingOption);
}
return response;
}
/// <summary>
/// Gets available shipping options
/// </summary>
/// <param name="getShippingOptionRequest">A request for getting shipping options</param>
/// <returns>Represents a response of getting shipping rate options</returns>
public GetShippingOptionResponse GetShippingOptions(GetShippingOptionRequest getShippingOptionRequest)
{
if (getShippingOptionRequest == null)
throw new ArgumentNullException("getShippingOptionRequest");
var response = new GetShippingOptionResponse();
response.ShippingOptions.Add(new ShippingOption()
{
Name = "Shipping option 1",
Description = "",
Rate = GetRate()
});
response.ShippingOptions.Add(new ShippingOption()
{
Name = "Shipping option 2",
Description = "",
Rate = GetRate()
});
return response;
}
/// <summary>
/// Gets available shipping options
/// </summary>
/// <param name="getShippingOptionRequest">A request for getting shipping options</param>
/// <returns>Represents a response of getting shipping rate options</returns>
public GetShippingOptionResponse GetShippingOptions(GetShippingOptionRequest getShippingOptionRequest)
{
if (getShippingOptionRequest == null)
throw new ArgumentNullException("getShippingOptionRequest");
var response = new GetShippingOptionResponse();
if (getShippingOptionRequest.Items == null || getShippingOptionRequest.Items.Count == 0)
{
response.AddError("No shipment items");
return response;
}
int storeId = _storeContext.CurrentStore.Id;
decimal subTotal = decimal.Zero;
int countryId = 0;
if (getShippingOptionRequest.ShippingAddress != null)
{
countryId = getShippingOptionRequest.ShippingAddress.CountryId ?? 0;
}
foreach (var shoppingCartItem in getShippingOptionRequest.Items)
{
if (shoppingCartItem.Item.IsFreeShipping || !shoppingCartItem.Item.IsShipEnabled)
continue;
subTotal += _priceCalculationService.GetSubTotal(shoppingCartItem, true);
}
decimal weight = _shippingService.GetShoppingCartTotalWeight(getShippingOptionRequest.Items);
var shippingMethods = _shippingService.GetAllShippingMethods(countryId);
foreach (var shippingMethod in shippingMethods)
{
var record = _shippingByWeightService.FindRecord(shippingMethod.Id, storeId, countryId, weight);
decimal? rate = GetRate(subTotal, weight, shippingMethod.Id, storeId, countryId);
if (rate.HasValue)
{
var shippingOption = new ShippingOption();
shippingOption.Name = shippingMethod.GetLocalized(x => x.Name);
if (record != null && record.SmallQuantityThreshold > subTotal)
{
shippingOption.Description = shippingMethod.GetLocalized(x => x.Description)
+ _localizationService.GetResource("Plugin.Shipping.ByWeight.SmallQuantitySurchargeNotReached").FormatWith(
_priceFormatter.FormatPrice(record.SmallQuantitySurcharge),
_priceFormatter.FormatPrice(record.SmallQuantityThreshold));
shippingOption.Rate = rate.Value + record.SmallQuantitySurcharge;
}
else {
shippingOption.Description = shippingMethod.GetLocalized(x => x.Description);
shippingOption.Rate = rate.Value;
}
response.ShippingOptions.Add(shippingOption);
}
}
return response;
}
public virtual GetShippingOptionResponse GetShippingOptions(
IList <OrganizedShoppingCartItem> cart,
Address shippingAddress,
string allowedShippingRateComputationMethodSystemName = "",
int storeId = 0)
{
if (cart == null)
{
throw new ArgumentNullException("cart");
}
var result = new GetShippingOptionResponse();
//create a package
var getShippingOptionRequest = CreateShippingOptionRequest(cart, shippingAddress, storeId);
var shippingRateComputationMethods = LoadActiveShippingRateComputationMethods(storeId)
.Where(srcm =>
String.IsNullOrWhiteSpace(allowedShippingRateComputationMethodSystemName) ||
allowedShippingRateComputationMethodSystemName.Equals(srcm.Metadata.SystemName, StringComparison.InvariantCultureIgnoreCase))
.ToList();
if (shippingRateComputationMethods.Count == 0)
{
throw new SmartException(T("Shipping.CouldNotLoadMethod"));
}
//get shipping options
foreach (var srcm in shippingRateComputationMethods)
{
var getShippingOptionResponse = srcm.Value.GetShippingOptions(getShippingOptionRequest);
foreach (var so2 in getShippingOptionResponse.ShippingOptions)
{
//system name
so2.ShippingRateComputationMethodSystemName = srcm.Metadata.SystemName;
so2.Rate = so2.Rate.RoundIfEnabledFor(_services.WorkContext.WorkingCurrency);
result.ShippingOptions.Add(so2);
}
//log errors
if (!getShippingOptionResponse.Success)
{
var hasItemsToShip = getShippingOptionRequest.Items != null && getShippingOptionRequest.Items.Count > 0;
foreach (string error in getShippingOptionResponse.Errors)
{
result.AddError(error);
if (hasItemsToShip)
{
Logger.Warn(error);
}
}
}
}
if (_shippingSettings.ReturnValidOptionsIfThereAreAny)
{
//return valid options if there are any (no matter of the errors returned by other shipping rate compuation methods).
if (result.ShippingOptions.Count > 0 && result.Errors.Count > 0)
{
result.Errors.Clear();
}
}
//no shipping options loaded
if (result.ShippingOptions.Count == 0 && result.Errors.Count == 0)
{
result.Errors.Add(T("Checkout.ShippingOptionCouldNotBeLoaded"));
}
return(result);
}
/// <summary>
/// Gets available shipping options
/// </summary>
/// <param name="getShippingOptionRequest">A request for getting shipping options</param>
/// <returns>Represents a response of getting shipping rate options</returns>
public GetShippingOptionResponse GetShippingOptions(GetShippingOptionRequest getShippingOptionRequest)
{
if (getShippingOptionRequest == null)
{
throw new ArgumentNullException("getShippingOptionRequest");
}
var response = new GetShippingOptionResponse();
if (getShippingOptionRequest.Items == null || getShippingOptionRequest.Items.Count == 0)
{
response.AddError("No shipment items");
return response;
}
if (getShippingOptionRequest.ShippingAddress == null)
{
response.AddError("Shipping address is not set");
return response;
}
var storeId = _storeContext.CurrentStore.Id;
int countryId = getShippingOptionRequest.ShippingAddress.CountryId.HasValue ? getShippingOptionRequest.ShippingAddress.CountryId.Value : 0;
int stateProvinceId = getShippingOptionRequest.ShippingAddress.StateProvinceId.HasValue ? getShippingOptionRequest.ShippingAddress.StateProvinceId.Value : 0;
string zip = getShippingOptionRequest.ShippingAddress.ZipPostalCode;
decimal subTotal = decimal.Zero;
foreach (var shoppingCartItem in getShippingOptionRequest.Items)
{
if (shoppingCartItem.Item.IsFreeShipping || !shoppingCartItem.Item.IsShipEnabled)
{
continue;
}
subTotal += _priceCalculationService.GetSubTotal(shoppingCartItem, true);
}
decimal sqThreshold = _shippingByTotalSettings.SmallQuantityThreshold;
decimal sqSurcharge = _shippingByTotalSettings.SmallQuantitySurcharge;
var shippingMethods = _shippingService.GetAllShippingMethods(countryId);
foreach (var shippingMethod in shippingMethods)
{
decimal? rate = GetRate(subTotal, shippingMethod.Id, storeId, countryId, stateProvinceId, zip);
if (rate.HasValue)
{
if (rate > 0 && sqThreshold > 0 && subTotal <= sqThreshold)
{
// add small quantity surcharge (Mindermengenzuschalg)
rate += sqSurcharge;
}
var shippingOption = new ShippingOption();
shippingOption.Name = shippingMethod.Name;
shippingOption.Description = shippingMethod.Description;
shippingOption.Rate = rate.Value;
response.ShippingOptions.Add(shippingOption);
}
}
return response;
}
/// <summary>
/// Gets available shipping options
/// </summary>
/// <param name="cart">Shopping cart</param>
/// <param name="shippingAddress">Shipping address</param>
/// <param name="allowedShippingRateComputationMethodSystemName">Filter by shipping rate computation method identifier; null to load shipping options of all shipping rate computation methods</param>
/// <param name="storeId">Load records allows only in specified store; pass 0 to load all records</param>
/// <returns>Shipping options</returns>
public virtual GetShippingOptionResponse GetShippingOptions(IList<OrganizedShoppingCartItem> cart, Address shippingAddress,
string allowedShippingRateComputationMethodSystemName = "", int storeId = 0)
{
if (cart == null)
throw new ArgumentNullException("cart");
var result = new GetShippingOptionResponse();
//create a package
var getShippingOptionRequest = CreateShippingOptionRequest(cart, shippingAddress);
var shippingRateComputationMethods = LoadActiveShippingRateComputationMethods(storeId)
.Where(srcm =>
String.IsNullOrWhiteSpace(allowedShippingRateComputationMethodSystemName) ||
allowedShippingRateComputationMethodSystemName.Equals(srcm.Metadata.SystemName, StringComparison.InvariantCultureIgnoreCase))
.ToList();
if (shippingRateComputationMethods.Count == 0)
throw new SmartException("Shipping rate computation method could not be loaded");
//get shipping options
foreach (var srcm in shippingRateComputationMethods)
{
var getShippingOptionResponse = srcm.Value.GetShippingOptions(getShippingOptionRequest);
foreach (var so2 in getShippingOptionResponse.ShippingOptions)
{
//system name
so2.ShippingRateComputationMethodSystemName = srcm.Metadata.SystemName;
//round
if (_shoppingCartSettings.RoundPricesDuringCalculation)
so2.Rate = Math.Round(so2.Rate, 2);
result.ShippingOptions.Add(so2);
}
//log errors
if (!getShippingOptionResponse.Success)
{
foreach (string error in getShippingOptionResponse.Errors)
{
result.AddError(error);
_logger.Warning(string.Format("Shipping ({0}). {1}", srcm.Metadata.FriendlyName, error));
}
}
}
if (_shippingSettings.ReturnValidOptionsIfThereAreAny)
{
//return valid options if there are any (no matter of the errors returned by other shipping rate compuation methods).
if (result.ShippingOptions.Count > 0 && result.Errors.Count > 0)
result.Errors.Clear();
}
//no shipping options loaded
if (result.ShippingOptions.Count == 0 && result.Errors.Count == 0)
result.Errors.Add(_localizationService.GetResource("Checkout.ShippingOptionCouldNotBeLoaded"));
return result;
}
/// <summary>
/// Gets available shipping options
/// </summary>
/// <param name="getShippingOptionRequest">A request for getting shipping options</param>
/// <returns>Represents a response of getting shipping rate options</returns>
public GetShippingOptionResponse GetShippingOptions(GetShippingOptionRequest getShippingOptionRequest)
{
if (getShippingOptionRequest == null)
throw new ArgumentNullException("getShippingOptionRequest");
var response = new GetShippingOptionResponse();
if (getShippingOptionRequest.Items == null || getShippingOptionRequest.Items.Count == 0)
{
response.AddError("No shipment items");
return response;
}
if (getShippingOptionRequest.ShippingAddress == null)
{
response.AddError("Shipping address is not set");
return response;
}
var storeId = _storeContext.CurrentStore.Id;
int countryId = getShippingOptionRequest.ShippingAddress.CountryId.HasValue ? getShippingOptionRequest.ShippingAddress.CountryId.Value : 0;
decimal subTotal = decimal.Zero;
foreach (var shoppingCartItem in getShippingOptionRequest.Items)
{
if (shoppingCartItem.Item.IsFreeShipping || !shoppingCartItem.Item.IsShipEnabled)
continue;
subTotal += _priceCalculationService.GetSubTotal(shoppingCartItem, true);
}
decimal weight = _shippingService.GetShoppingCartTotalWeight(getShippingOptionRequest.Items);
var shippingMethods = _shippingService.GetAllShippingMethods(countryId);
foreach (var shippingMethod in shippingMethods)
{
decimal? rate = GetRate(subTotal, weight, shippingMethod.Id, storeId, countryId);
if (rate.HasValue)
{
var shippingOption = new ShippingOption();
shippingOption.Name = shippingMethod.GetLocalized(x => x.Name);
shippingOption.Description = shippingMethod.GetLocalized(x => x.Description);
shippingOption.Rate = rate.Value;
response.ShippingOptions.Add(shippingOption);
}
}
return response;
}
/// <summary>
/// Gets available shipping options
/// </summary>
/// <param name="getShippingOptionRequest">A request for getting shipping options</param>
/// <returns>Represents a response of getting shipping rate options</returns>
public GetShippingOptionResponse GetShippingOptions(GetShippingOptionRequest getShippingOptionRequest)
{
if (getShippingOptionRequest == null)
throw new ArgumentNullException("getShippingOptionRequest");
var response = new GetShippingOptionResponse();
if (getShippingOptionRequest.Items == null || getShippingOptionRequest.Items.Count == 0)
{
response.AddError(T("Admin.System.Warnings.NoShipmentItems"));
return response;
}
var shippingMethods = this._shippingService.GetAllShippingMethods(getShippingOptionRequest);
foreach (var shippingMethod in shippingMethods)
{
var shippingOption = new ShippingOption();
shippingOption.ShippingMethodId = shippingMethod.Id;
shippingOption.Name = shippingMethod.GetLocalized(x => x.Name);
shippingOption.Description = shippingMethod.GetLocalized(x => x.Description);
shippingOption.Rate = GetRate(shippingMethod.Id);
response.ShippingOptions.Add(shippingOption);
}
return response;
}
/// <summary>
/// Gets available shipping options
/// </summary>
/// <param name="cart">Shopping cart</param>
/// <param name="shippingAddress">Shipping address</param>
/// <param name="allowedShippingRateComputationMethodSystemName">Filter by shipping rate computation method identifier; null to load shipping options of all shipping rate computation methods</param>
/// <param name="storeId">Load records allows only in specified store; pass 0 to load all records</param>
/// <returns>Shipping options</returns>
public virtual GetShippingOptionResponse GetShippingOptions(IList <OrganizedShoppingCartItem> cart,
Address shippingAddress, string allowedShippingRateComputationMethodSystemName = "", int storeId = 0)
{
if (cart == null)
{
throw new ArgumentNullException("cart");
}
var result = new GetShippingOptionResponse();
//create a package
var getShippingOptionRequest = CreateShippingOptionRequest(cart, shippingAddress);
var shippingRateComputationMethods = LoadActiveShippingRateComputationMethods(storeId)
.Where(srcm =>
String.IsNullOrWhiteSpace(allowedShippingRateComputationMethodSystemName) ||
allowedShippingRateComputationMethodSystemName.Equals(srcm.PluginDescriptor.SystemName, StringComparison.InvariantCultureIgnoreCase))
.ToList();
if (shippingRateComputationMethods.Count == 0)
{
throw new SmartException("Shipping rate computation method could not be loaded");
}
//get shipping options
foreach (var srcm in shippingRateComputationMethods)
{
var getShippingOptionResponse = srcm.GetShippingOptions(getShippingOptionRequest);
foreach (var so2 in getShippingOptionResponse.ShippingOptions)
{
//system name
so2.ShippingRateComputationMethodSystemName = srcm.PluginDescriptor.SystemName;
//round
if (_shoppingCartSettings.RoundPricesDuringCalculation)
{
so2.Rate = Math.Round(so2.Rate, 2);
}
result.ShippingOptions.Add(so2);
}
//log errors
if (!getShippingOptionResponse.Success)
{
foreach (string error in getShippingOptionResponse.Errors)
{
result.AddError(error);
_logger.Warning(string.Format("Shipping ({0}). {1}", srcm.PluginDescriptor.FriendlyName, error));
}
}
}
if (_shippingSettings.ReturnValidOptionsIfThereAreAny)
{
//return valid options if there are any (no matter of the errors returned by other shipping rate compuation methods).
if (result.ShippingOptions.Count > 0 && result.Errors.Count > 0)
{
result.Errors.Clear();
}
}
//no shipping options loaded
if (result.ShippingOptions.Count == 0 && result.Errors.Count == 0)
{
result.Errors.Add(_localizationService.GetResource("Checkout.ShippingOptionCouldNotBeLoaded"));
}
return(result);
}
