Deallocating a consignments
Remove carrier service assignments from consignments using the Deallocate endpoint. Reset packages to unallocated state for editing or reallocation.
Overview
Change of plans for a consignment? This page explains how to deallocate consignments from their carrier services both individually and in bulk.
A consignment cannot be edited once it is allocated. In order to edit or cancel an allocated consignment, or to allocate it to a different carrier service, you will first need to deallocate it.
For more information on editing existing consignments, see the Updating existing consignments page.
Deallocating a consignment erases any allocation data that consignment holds and changes its state to Unallocated. You can only deallocate consignments that are in a state of Allocated, Manifested, or Manifest Failed.
Deallocate an individual consignment
The Deallocate Consignment endpoint enables you to deallocate a single consignment. To call Deallocate Consignment, send a PUT request to https://api.electioapp.com/consignments/{consignmentReference}/deallocate, where {consignmentReference} corresponds to the consignment that you want to deallocate.
Once the request is received, the Consignments platform deallocates the consignment and returns a code 200 response with no body.