Allocating to a Specific Carrier Service

  • v1
  • allocation
  • pro
  • api
  • consignments

Want to specify the carrier service that should take your consignment? This page explains how to allocate consignments to services manually.

Getting the Carrier Service Reference

In order to allocate a consignment to a specific carrier service, you'll need to know that service's {MpdCarrierServiceReference}. The {MpdCarrierServiceReference} is a unique identifier for each service available in PRO.

There are two ways of obtaining a carrier service's {MpdCarrierServiceReference}:

  • Via the UI - The Carrier Services page (Settings > Carrier Services) displays a list of all available services. The {MpdCarrierServiceReference} for each service is displayed in the Service Code field.

  • Via API - The Get Available MPD Carrier Services endpoint returns a list of all available services. The {MpdCarrierServiceReference} for each service is displayed in the Reference field.

    Note

    For full reference information on the Get Available MPD Carrier Services endpoint, see the Get Available MPD Carrier Services page of the API reference.

Allocating to a Carrier Service Manually

The Allocate With Carrier Service endpoint enables you to allocate one or more consignments to a specific carrier service.

To call Allocate With Carrier Service, make a PUT request to https://api.electioapp.com/allocation/allocatewithcarrierservice. The body of the request should contain the {MpdCarrierServiceReference} of the carrier service you want to allocate to, and an array of consignmentReferences listing the references of the consignments you want to allocate to that service.

Note

For full reference information on the Allocate With Carrier Service endpoint, see the Allocate With Carrier Service page of the API reference.

Once the request is received, SortedPRO takes each consignment in turn and checks whether the specified service is eligible to take that consignment. If the specified service can meet the consignment's delivery promise, and allocating to that service would not break any existing allocation rules, then PRO allocates the consignment to that service and returns an allocation summary.

Note

For information on using allocation rules, see the What Is An Allocation Rule? section of the Allocating Consignments To Carriers page.

If PRO is unable to allocate the consignment to the specified carrier service, it puts the consignment into a state of Allocation Failed and takes no further action. For information on dealing with failed allocations, see the Manage Not Shipped Consignments section of the PRO UI User Manual.

Allocate With Carrier Service Example

The example shows a request to allocate three consignments to a carrier service with an {MpdCarrierServiceReference} of Example-Carrier-Service .

PUT https://api.electioapp.com/allocation/allocatewithcarrierservice

{
  "MpdCarrierServiceReference": "Example-Carrier-Service",
  "ConsignmentReferences": [
    "EC-000-05A-Z6S",
    "EC-000-083-45D",
    "EC-000-A04-0DV"
  ]
}

Next Steps