Skip to main content

Set up swap consignments in MaxOptra

Link a delivery and a collection at the same address so they are planned together on the same vehicle.

Written by Andrei Mogosanu

Some jobs need a delivery and a collection at the same address, such as exchanging a faulty item or returning one while receiving its replacement. A swap consignment links the two orders so they are planned together on the same vehicle, with the delivery first.

The vehicle starts the run with the delivery's load on board and returns to the end location after the collection. You can link two orders from the order card, or set the consignment type through the API.

📌Note: The Consignments feature is disabled by default. To use it, contact the MaxOptra Support Team.

🤓Tip: Swap suits exchanges, returns and replacements at a single location. For movement of goods between two different points, use Pickup and delivery (PND).


Link two orders as a swap consignment

Use these steps to link two orders as a swap consignment for planning.

  1. Open an order card for the delivery.

Open the order card for the delivery

2. Click + Add Consignment.

Click + Add Consignment

3. Click the Consignment link type dropdown. It defaults to Pickup and delivery.

Open the Consignment link type dropdown

4. Select Swap.

Select Swap

5. Click the Linked order dropdown, then select the other order in the pair.

Select the linked order from the Linked order dropdown

6. Plan the swap pair. Whether you plan manually or with auto-planning, the delivery is planned before the collection.

Plan the swap pair, with the delivery planned before the collection

Planning errors

Swap pairs can cause planning errors when a linked order is missing or when the collection is planned before the delivery.

  1. A consignment is orphaned when there is no linked order.

A consignment is orphaned when there is no linked order

2. Manually planning an orphaned consignment results in an invalid planning error.

Invalid planning error when manually planning an orphaned consignment

3. Forcing a swap consignment collection before the delivery results in a planning violation.

Planning violation when a swap consignment collection is forced before the delivery

Set consignment type in API v6

Use the API to set a swap consignment when you create an order.

  1. Set consignmentType to Swap and give the order a unique consignmentReference.

If consignmentType is empty and consignmentReference is not empty, the type is set to PND (pickup and delivery). This keeps existing integrations working.

See the API documentation for full details.

New consignmentType field in POST /orders/

📌Note: CSV import doesn't support consignmentType yet.

Did this answer your question?