Skip to main content

Custom Stop Data

When you create orders or shipments using address book entries, any custom fields you've defined automatically appear on the order and shipment detail pages, helping you track location-specific requirements and details.

S
Written by Shipwell TMS Support
Updated over a week ago

HOW TO VIEW CUSTOM STOP DATA

  1. Navigate to an order or shipment

    • From your dashboard, click on an order or shipment to view its details

    • You can access this from Orders or Shipments in the main navigation

  2. Locate the stop information section

    • Scroll to the Stops or Route section of the detail page

    • Each pickup and delivery stop displays with its address and scheduled times. For example, for this location below the field named “Stop Field Custom Data” has the value of “Test custom data” in the address book. This will now set these fields automatically and separate the required from the optional custom data fields.

3. View custom fields for each stop

  • Below the standard stop information (address, contact, time window),
    you'll see any custom data associated with that location

  • Custom fields appear with their field names and values as defined in your
    address book

  • Note: Custom data only displays if the location was selected from your
    address book when the order was created

4. Understand custom data sources

  • Custom stop data comes from your saved address book entries

  • If you manually entered an address (not from address book), custom fields
    won't display

  • To add custom data to future shipments, update the address book entry for
    that location for the address book external_reference or address_book_id when building an order or shipment from the API

Did this answer your question?