Allocation tags

  • v1
  • tags
  • pro
  • api
  • consignments

Allocation tags enable you to filter out carrier services that would not be suitable for a particular consignment. This page explains how to use and combine tags.

Tags overview

Tagged shipments can only be allocated to those carrier services that have a matching tag. You can still allocate untagged shipments to a carrier service that has tags. To associate tags with carrier services, use the Settings > Carrier Services > [select carrier service] > Allocation Rules > Allocation Filtering Tags panel of the SortedPRO UI.

For example, a retailer might use the UI to add a Flammables tag to all the carrier services that they wanted to use for flammable products. They would then add the Flammables tag to all consignments containing flammable products. PRO would only allocate those consignments tagged as Flammables to a consignment in the pre-approved Flammables list.

Scenarios

Suppose that you set your carrier services up in the following way:

  • You tag Carrier Service A with Alcohol.
  • You tag Carrier Service B with Flammables.
  • You tag Carrier Service C with Alcohol and Flammables.
  • You tag Carrier Service D with Oil.
  • You don't add any tags to Carrier Service E.

This configuration would produce the following results:

  • Consignment with no tags - A, B, C, D, and E are returned.
  • Consignment tagged with Alcohol - A and C are returned.
  • Consignment tagged with Flammables - B and C are returned.
  • Consignment tagged with Alcohol and Flammables - C is returned.
  • Consignment tagged with Alcohol, Flammables, and Oil - No services are returned.

Tags example

The example shows a tags property for a consignment that contains flammable materials, oil and alcohol.

"Tags": [
   "Flammables",
   "Oil",
   "Alcohol"
]