You are here: Ektron Namespace > Providers API > Ektron.Cms.Commerce.Shipment Namespace > Ektron.Cms.Commerce.Shipment.Provider Namespace > ShipmentProvider Class
Ektron CMS400.NET API Documentation
ContentsIndexHome
PreviousUpNext
ShipmentProvider Class

A Shipping Provider is a pluggable component integrated into Ektron's CMS400.NET eCommerce module. The Shipping provider handles eCommerce real-time shipping rate retrieval by utilizing third party shipping services such as FedEx or UPS, or you can create your own fixed rate logic. CMS400.NET's eCommerce shipping module calculates the package(s) needed for an order and then passes the following information to the company providing the shipping services via a Shipping Provider.

  • package information - for example, how many, height, width, depth and weight of each package.
  • warehouse address - the address from which the items will be shipped. A warehouse’s information can be set in the Workarea > Modules > Commerce > Shipping > Warehouses screen.
  • destination address - the address a customer entered as his shipping address when making the purchase.
  • desired shipping options - for example, if you have Next Day, 2-Day Ground and 3-Day Ground as shipping options, you can pass the option chosen by the customer.
CMS400.NET comes with several shipping providers, including FedEx and UPS. You can customize these providers or create your own using the extendable Shipping Provider architecture. 

Each type of shipping provider accepts configuration parameters. For example, FedEx requires a username, password, account number, and meter number while UPS requires a Username, password, and account number.  

This base class allows you to define or retrieve information for a shipping provider.

C#
public abstract class ShipmentProvider : ProviderBase;
Visual Basic
Public abstract Class ShipmentProvider
Inherits ProviderBase

ShipmentProvider.cs

Name 
Description 
The methods of the ShipmentProvider class are listed here. 
The properties of the ShipmentProvider class are listed here. 
 
Name 
Description 
 
Returns a list of shipping rates for the specified shipping methods.  
 
Returns a list of available service types supported by the shipment company.  
 
Returns the Tracking URL for the provider.  
 
Name 
Description 
 
Gets or sets the account number associated with the account for the shipping company.  
 
Gets or sets the "Tracking Supported" flag for this provider.  
 
Key 
Gets or sets the key associated with account for this provider. The key is typically a unique series of numbers and letters that the shipping company provides to you when sign up for an account.  
 
Gets or sets the meter number associated with the account for the shipping company. Not all shipping companies require a meter number. If one is not required, leave blank.  
 
Gets or sets the password associated with the account for the shipping company.  
 
Gets or sets the URL used to contact the shipping company for rate requests. This URL is provided by the shipping company when sign up for an account.  
 
Gets or sets the transaction ID associated with the account for the shipping company.  
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at [email protected].
Copyright (c) 2008. All rights reserved.
What do you think about this topic? Send feedback!