API Changelog

This changelog lists additions and updates to the Shipwell API.

Added tags property to Order in the Shipment Assembly create shipment endpoint request body
- Note: This property has the same schema as Order tags
Added is_roundtrip property to Contract Lane list/get lanes endpoint
- Note: This property is supported when importing Contract Lanes in the web app UI Contract Importer

Increased maximum limit (aka page size) when querying for Events and Webhooks to 200 items per page
Added temperature_unit property to Load Board
- temperature_unit is the system of measurement used for the temperature value, e.g. "F" for Fahrenheit and "C" for Celsius .
Added new optional querystring param to Orders list/query endpoint .
- archived

Added new optional querystring param to Locations list/query endpoint .
- external_reference
Increased maximum limit (aka page size) when querying for Events and Webhooks to 200 items per page
Added temperature_unit property to Shipments
- temperature_unit is the system of measurement used for the temperature value, e.g. "F" for Fahrenheit and "C" for Celsius .
Removed optional feature flags and optional properties related to the custom CEVA Logistics workflow (e.g. ceva_enabled on a Company , ceva_instant_rate_quote in Quoting ). CEVA Logistics is supported via the standard LTL (Less-Than-Truckload) process.
- Note: Removal of optional properties is not a breaking API change.

Added "RAND_MILEMAKER" as a mileage_type value to Companies
- Adds the ability the use "RAND_MILEMAKER" as a company mileage_type setting for distance (aka mileage) calculation.
Added default_accessorials to Contracts
- Adds the ability to assign a list of one or more default_accessorials to a contract. default_accessorials may be set when creating or updating the contract.

Added accessorial_charge_table to Contracts
- Adds the ability to assign an accessorial table to a contract by setting the id/uuid of the charge table as the value for the property accessorial_charge_table when creating or updating the contract.
Added new optional querystring params to Freight Invoices list/query endpoint .
- due_date__gt
- due_date__gte
- due_date__lt
- due_date__lte
- exclude_document_urls
- exclude_related_entities
- invoice_date
- invoice_date__gt
- invoice_date__gte
- invoice_date__lt
- invoice_date__lte
- invoiceable_mode
- invoiceable_mode__in
- invoiceable_shipwell_custom_data_id
- invoiceable_shipwell_custom_data_value
- stops__address
- stops__company_name
- stops__company_name__in
- sub_statuses__sub_status
- sub_statuses__sub_status__in

Added and clarified Contracts properties related to distance in different units of measure (i.e. MILE and KILOMETER )
- Added new distance property to a Contract
- Deprecated the optional read-only property of distance_miles in a Contract
- The unit of measure that is associated with the numeric distance value remains the distance_unit property
Added fields for querying and inspection for Orders (next generation)
- Added created_at property to an Order
- Added updated property to an Order
- Orders may be queried by the created_at and updated_at properties

This API changelog contains changes after September 12, 2024 and does not contain changes before this date.