This article will show you how to manage your additional stops in a shipment.
How to add a Stop
Note: You can only add additional stops after you save the shipment.
- The "Add Stop" button will be visible to the right of the shipment summary's First Pickup / Last Drop Information section.
- Add Stop Modal utilizes your Address Book to add your saved contacts easily.
- An additional stop can be a Pick, a Drop, or Both.
- Once you add the first stop, the system will create a new section called Stops, and from there, you can add other stops if necessary.
- The additional stops will be listed, and you will see blue arrows so you can easily rearrange them if needed.
Stop Reference Numbers
- Add reference numbers to your stops from the Edit Shipment Stop modal by clicking the Add Reference Numbers option at the bottom.
Use the reference numbers in Content Templates to customize your shipment documents using the following HTML codes.
Note: When selecting reference numbers, all of them will be displayed in the shipment documents. You can choose to display reference numbers for pickup, delivery, or additional stops. Alternatively, you can show all reference numbers for all types of stops.
Pickup References
<table>
<tbody>
<!-- [EACH]([PICKUP_REFERENCES]) -->
<tr>
<td>[PICKUP_REFERENCES.REFERENCE_TYPE]</td>
<td>[PICKUP_REFERENCES.REFERENCE_VALUE]</td>
</tr>
<!-- [ENDEACH] -->
</tbody>
</table>
Delivery References
<table>
<tbody>
<!-- [EACH]([DELIVERY_REFERENCES]) -->
<tr>
<td>[DELIVERY_REFERENCES.REFERENCE_TYPE]</td>
<td>[DELIVERY_REFERENCES.REFERENCE_VALUE]</td>
</tr>
<!-- [ENDEACH] -->
</tbody>
</table>
Additional Stops References
<table>
<tbody>
<!-- [EACH]([ADDITIONAL_STOPS]) -->
<!-- [EACH]([ADDITIONAL_STOPS.SHIPMENT_STOP_REFERENCES]) -->
<tr>
<td>[SHIPMENT_STOP_REFERENCES.REFERENCE_TYPE]</td>
<td>[SHIPMENT_STOP_REFERENCES.REFERENCE_VALUE]</td>
</tr>
<!-- [ENDEACH] -->
<!-- [ENDEACH] -->
</tbody>
</table>
ALL Stops References
<table>
<tbody>
<!-- [EACH]([SHIPMENT_STOP_REFERENCES_ALL]) -->
<tr>
<td>[SHIPMENT_STOP_REFERENCES.REFERENCE_TYPE]</td>
<td>[SHIPMENT_STOP_REFERENCES.REFERENCE_VALUE]</td>
</tr>
<!-- [ENDEACH] -->
</tbody>
</table>
Stop references are also available in our Public APIs and Webhooks.
- API: POST/PublicApi/Shipping/v2/Shipments
- WebHook: PublicAPI.v2.PublicAPIShipmentDetails
How to delete a Stop
To delete a stop, you only need to click on the blue pencil to enter the Edit Shipment Stop modal and scroll to the bottom, where you will find the delete button.
