Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Create a carrier

Describes how to create a carrier in Optimizely Configured Commerce.

The Admin Console in Optimizely Configured Commerce manages all carriers used for all websites. This centralized management allows for carriers to be updated in one location and then have those updates apply to all assigned websites. A carrier must have at least one service assigned before it is visible on the website.

Create a carrier

  1. Go to Admin Console > Shipping & Fulfillment > Carriers.

  2. Click Add Carrier.

  3. Enter the Carrier's name in the Name field.

  4. Optionally, enter the appropriate information for Contact Name, Phone, Email and Image Path.

  5. If the new carrier should be the primary carrier, change the Primary Carrier toggle to YES.

  6. Enable the Carrier by changing the Enabled toggle to YES.

  7. When configured, the Tracking URL field provides order tracking information.

  8. Use the Live URL and Test URL fields to employ a rating service. When the Is Live toggle displays Yes, the console uses the Live URL to run the rating service. When the Is Live toggle displays No, the console uses the Test URL.

  9. The Rating Service is the method the console uses to get real-time or flat-fee pricing for each shipping option.

    • A Rating Service must be selected. Not specifying a Rating Service results in the Carrier not being available on the website's checkout screen.
    • A Zones finger tab displays if the ZoneWeight is selected as the Rating Service, allowing for the configuration of the necessary zones.
  10. Depending on the selected Rating Service, populate the Account Number, User Name, Password, and Access Key fields.

  11. Click Save.

Modify the carrier packages

After the first order is placed on a website, a default package appears under the Carrier's Packages finger tab. The system uses this package to determine shipping charges for customers when using the Carrier or package rating services. Use the steps below to customize the package or add an additional package:

  1. Go to Admin Console > Shipping & Fulfillment > Carriers

  2. Click Edit for the desired Carrier.

  3. Select the Packages finger tab.

  4. Click Add Carrier Package to add a new package.

  5. Populate the following fields: Name, Length, Width, Height, and Max Weight.

  6. Click the Active toggle to display Yes, which makes this package the default for the package rating service. Activating a new Carrier Package deactivates the formerly active Carrier Package.



    Although many package sizes can be customized, only one can be active at a time.

    Click Save or Save and Add New.

Carrier rules

After you create a carrier, you may want to create Rules, which determine when the carrier does or does not appear as a selectable option on the website. If there are no rules assigned, the carrier always appears on the site, provided it is set up correctly.

For example, Carrier A is only available to customers in Canada. A user could create a carrier rule that stated the carrier appears if Order Ship To Country = Canada. This prevents the carrier from appearing if the user's selected Ship To Country is any other country.

To create carrier rules:

  1. In the Admin Console, go to Shipping & Fulfillment > Carriers.
  2. Click Edit next to a carrier.
  3. Select the Rules finger tab.
  4. Use the rules engine to create one or more rules.
  5. Click Save.

Assign the carrier to the website

A carrier must be assigned to a website before a user may select it.

  1. Click Websites on the left side of the Admin Console.
  2. Click Edit for the desired website.
  3. Click the Carriers finger tab.
  4. Click Assign Carriers.
  5. Select the check box for the desired Carrier.
  6. Click Assign and click Done to save.