Skip to main content
Smart Shipping
← Back
Throughout This Page
You can jump to the specified sections by clicking on these titles.

Overview

The Shipping API simplifies choosing delivery services by allowing you to establish predefined shipping criteria. These criteria can be customized to include parcel dimensions, weight, value, or destination region. Once these rules are configured, the Shipping API intelligently assigns the most appropriate service for your shipment. The Smart Shipping functionality within the Shipping API enables you to define these rules.
This documentation will walk you through setting up these rules using the Smart Shipping page within the Shipping API. Additionally, we will offer a thorough explanation of how this feature functions.

Accessing the Smart Shipping Page

To access the "Smart Shipping" feature, click the corresponding button in the left-hand menu.

Creating a Rule Group

Rule groups provide a method to categorize and differentiate the smart rules you generate. For instance, you may establish two distinct rule groups: one designated as the standard group and another designated as the express rule group. Subsequently, you can create sets of rules within these designated groups. This approach lets you selectively determine whether your shipment adheres to the standard or express rules simply by selecting the corresponding group.

Before creating a smart rule, you need to establish a rule group. To do this, follow these steps:

  1. Select an API Account.
  2. Click the "Create" button.
  3. Choose "Create Rule Group" from the options provided.

A popup window will appear, prompting you to give the rule group a name. Once you've provided a name, click the "Create Group" button to complete the process.

Creating a Smart Rule

To begin, follow these steps to initiate the process:

  1. Choose Your API Account: Select the API account you intend to work with.
  2. Create a New Rule:
    • Click on the "Create" button.
    • Opt for the "Create Smart Rule" option.

Afterwards, the system will prompt you to input essential information for the rule:

  • Rule Priority: The priority assigned to a rule is crucial, as it dictates the order in which rules are executed. A zero (0) priority signifies the highest precedence, with higher numbers indicating lower priority. For instance, if you have two rules, one with a priority of 5 and the other with a priority of 0, the rule with a priority of 0 will be applied first when the filter criteria match.
  • Rule Name: Provide a unique name for your rule. You have the flexibility to choose any name that suits your needs.
  • Group Name: Select one of the groups you have previously created to categorise and filter your rules.

Once you've filled in these details, proceed to the following steps:

Set Parameters:

  • Click on "Set Parameters."
  • Choose a "Parameter Type." The available fields will vary based on your parameter selection.
  • To include multiple parameters, click the "Add Parameter" button.
  • For example, you can set parameters for "Price" within the range of £5-£10, "Weight" between 1-3 KG, "Channel" as Amazon, and "Supported Country" as UK. The courier specified in this rule will process any package meeting these criteria.

Set Output Service:

  • Click "Set Output Service."
  • You will be presented with options to select the desired "Courier," "Auth," and "Courier Preset" for use when the criteria you established in the previous step are met.

Configure Failover Service:

  • To ensure continuity during technical issues with your primary courier choice, you can configure a "Failover Service." This feature automatically switches to an alternative courier and service when no response is received from the primary courier or when the primary courier does not accept the label. The failover service will be activated in such situations to ensure your operations keep running smoothly without any issues.

Finalise and Create Rule:

  • Once all the parameters and services are configured to your satisfaction, click "Create Rule."

Your newly created rule will appear under the selected group. Within the group section, you have the flexibility to activate or deactivate it and edit or delete the rule as needed.

Rule Parameter Descriptions

Below are descriptions for all the functionalities related to the rule parameters.

Booking Day

This enables you to manage the booking schedule by defining days for inclusion or exclusion. It allows for precise control over order processing timelines.

  • Exclude Days: Designate specific days that should be excluded from the booking schedule, ensuring orders are not processed during specified periods.
  • Include Days: Specifies particular days that are eligible for booking orders, allowing for flexible scheduling based on business requirements.

image-1710844580780.png

Booking Time

You can specify the time frame during which booking is available for orders. This ensures efficient scheduling and order processing management.

  • Start Time: Specifies the earliest time at which orders can be booked, ensuring proper organization of order processing schedules.
  • End Time: Indicates the latest time by which orders must be booked, facilitating effective time management for order fulfilment.

image-1710844745500.png

Price

    This provides control over the pricing criteria for shipping, ensuring the accurate calculation of shipping costs based on predefined thresholds.

    • Min Price: Sets the minimum threshold for the shipping price, ensuring that orders below this value are appropriately priced for shipping.
    • Max Price: Defines the maximum threshold for the shipping price, ensuring that orders above this value are accurately priced for shipping.

    image-1710845254718.png

    Parcel Weight

    Offers control over the weight criteria for parcels, ensuring compliance with weight restrictions for shipping services.

    • Min Weight: Specifies the minimum weight allowed for parcels, ensuring that only parcels meeting the weight requirement are processed for shipping.
    • Max Weight: Defines the maximum permitted weight for parcels, ensuring that parcels exceeding this weight are appropriately handled during shipping.

    image-1710845414209.png

    Parcel Count

    Allows you to manage the quantity criteria for parcels, ensuring efficient handling and processing of orders based on parcel quantities.

    • Min Parcel QTY: Sets the minimum quantity of parcels allowed per order, ensuring that orders with insufficient parcels are appropriately processed.
    • Max Parcel QTY: Defines the maximum quantity of parcels allowed per order, ensuring that orders with excessive parcels are appropriately managed.

    image-1710845635385.png

    Dimensions

    Provides control over the dimensional criteria for parcels, ensuring compliance with size restrictions for shipping services.

    • Min Height / Max Height: This setting specifies the range of heights allowed for parcels, ensuring that they meet shipping height requirements.
    • Min Width / Max Width: Defines the range of widths allowed for parcels, ensuring that parcels meet width requirements for shipping.
    • Min Length / Max Length: This setting sets the range of parcel lengths allowed, ensuring that parcels meet shipping length requirements.
    • Min Girth / Max Girth: Specifies the range of girths allowed for parcels, ensuring that parcels meet girth requirements for shipping.
    • Min Volume / Max Volume: This setting defines the range of parcel volumes allowed, ensuring that parcels meet shipping volume requirements.

    image-1710845701457.png

    Postcode

    Offers control over the postal code criteria for shipping destinations, ensuring accurate routing of orders based on specified postcode criteria.

    • Exclude Postcodes: Defines postcodes to be excluded from shipping, ensuring that orders are not processed for specified geographical areas.
    • Include Postcodes: Specifies postcodes eligible for shipping, ensuring that orders are accurately routed to specified geographical areas.

    image-1710845809664.png

    Keywords

    This feature enables filtering orders based on specified keywords, allowing for targeted processing and management of orders based on keyword criteria.

    • Exclude Keywords: Defines keywords to exclude from shipping criteria, ensuring that orders containing specific keywords are not processed.
    • Include Keywords: Specifies keywords to include in shipping criteria, ensuring that orders containing specific keywords are appropriately processed.

    image-1710846085432.png

    Tags

    Allows categorisation of orders with custom tags for shipping criteria, facilitating organised and efficient order processing based on tag categories.

    • Include Tags: Specifies tags to include in shipping criteria, allowing for targeted processing of orders based on tag categories.
    • Exclude Tags: Defines tags to exclude from shipping criteria, ensuring that orders with specific tag categories are not processed.

    image-1710846118399.png

    SKUs

    Enables filtering of orders based on specified SKUs, allowing for targeted processing and management of orders based on SKU criteria.

    • Exclude SKUs: Specifies SKUs to be excluded from shipping criteria, ensuring that orders containing specific SKUs are not processed.
    • Include SKUs: Defines SKUs to be included in shipping criteria, ensuring that orders containing specific SKUs are appropriately processed.

    image-1710846279292.png

    Channels

    This option offers control over sales channel criteria for shipping, ensuring accurate routing and processing of orders based on specified channel criteria.

    • Include Channels: Specifies sales channels to be included in shipping criteria, allowing for targeted processing of orders based on channel categories.
    • Exclude Channels: Defines sales channels to be excluded from shipping criteria, ensuring that orders from specific channels are not processed.

    image-1710846337288.png

    Supported Countries

    Allows selection of eligible shipping destinations from a list of available countries.

    • Select from a list of all available countries for shipping, with the option to choose multiple countries.

    image-1710846363183.png

    Shipping Charge

    This controls the shipping charge criteria, ensuring the accurate calculation and management of shipping charges based on predefined thresholds.

    • Min Shipping Charge: Sets the minimum threshold for shipping charges, ensuring that orders meet minimum shipping charge requirements.
    • Max Shipping Charge: This defines the maximum threshold for shipping charges, ensuring that orders do not exceed the maximum shipping charge limits.

    image-1710846408842.png

    Requested Shipping Service

    Offers control over the selection of shipping services.

    • Operation: Specifies how shipping service names are matched against the specified criteria, ensuring accurate selection and allocation of shipping services.
      • Equals: Matches exact shipping service names.
      • Starts With: Matches shipping service names that begin with specified text.
      • Ends With: Matches shipping service names that end with specified text.
      • Contains: Matches shipping service names containing specified text.
    • Text: Specifies the text to be matched with shipping service names, facilitating targeted selection and allocation of shipping services.

    image-1710846517399.png

    Reference

    This option offers control over the reference criteria for orders, allowing for precise matching and processing of orders based on reference values.

    • Operation: Specifies how reference values are matched against the specified criteria, ensuring accurate order selection and processing.
      • Equals: Matches exact reference values.
      • Starts With: Matches reference values that begin with specified text.
      • Ends With: Matches reference values that end with specified text.
      • Contains: Matches reference values containing the specified text.
    • Text: Specifies the text to be matched with reference values, facilitating precise selection and processing of orders.

    image-1710846672021.png

    Order ID

    Enables filtering of orders based on order ID values, allowing for precise selection and processing of orders based on order identification.

    • Operation: Specifies how order ID values are matched against the specified criteria, ensuring accurate selection and processing of orders.
      • Equals: Matches exact order ID values.
      • Starts With: Matches order ID values that begin with specified text.
      • Ends With: Matches order ID values that end with specified text.
      • Contains: Matches order ID values containing specified text.
    • Text: Specifies the text to be matched with order ID values, facilitating targeted selection and processing of orders.

    image-1710846724144.png

    Back to top