Allocation Service Methods

The methods in this service allow you to create and allocate consignments, to despatch them simultaneously if required (i.e. generate the paperwork at the point of allocation), and to deallocate those that are not required.

Note

despatch refers to the end-to-end process of creating, allocating, and generating the paperwork for, consignments.

The recommended and most commonly used methods for creating and allocating consignments are those using booking codes. This is because booking codes are more straightforward than the advanced allocation filter. They also provide more consistency, particularly when used in conjunction with carrier 'service groups'.

The Allocation Service methods are as follows:

  • allocateConsignments - This method tries to allocate each of the specified consignments to a carrier, using the defined allocation filter to see which is the best carrier.

  • allocateConsignmentsWithBookingCode - This method tries to allocate each of the specified consignments to a carrier, using the defined booking code to see which is the best carrier.

  • createAndAllocateConsignments - This method creates consignments and then tries to allocate each of them to a carrier, using the defined allocation filter to see which is the best carrier.

  • createAndAllocateConsignmentsWithBookingCode - This method creates consignments and then tries to allocate each of them to a carrier, using the defined booking code to see which is the best carrier.

  • deallocate - This method de-allocates unwanted consignments,

  • despatchConsignment - This method creates a consignment, tries to allocate it using the defined allocation filter, and then returns the labels/documentation.

  • despatchConsignmentWithBookingCode - This method creates a consignment, tries to allocate it using the defined booking code, and then returns the labels/documentation.

  • findDeliveryOptionsWithBookingCode - This method tells you what the cheapest costs and associated delivery options for a proposed consignment would be if a particular booking code was used.

  • findDeliveryOptionsForConsignmentWithBookingCode - This method tells you what the costs and delivery options for an existing consignment would be if a particular booking code was used.