API Changelog

This changelog lists additions and updates to the Shipwell API.

June 16, 2025

Contracts
- Added new API endpoints that enable:
  - Retrieving contracts and lanes that match the provided criteria ( API Reference )
    - See guide .
  - Retrieving charge items for a given shipment and contract ( API Reference )
    - See guide .

May 28, 2025

Custom Logic and Scripting
- Added new scripting guide and cloneable template to enable customers to add custom logic with viewable logs within the Shipwell platform:
  - See Google Apps Script – Webhook Processing Template with ScriptLab Logging .
Shipment Assembly
- Added new properties for Create Shipment ( API Reference ):
  - equipment_type
  - service_level
Webhooks
- Added ability to replay or retry a Webhook Delivery Attempt ( API Reference )
- Added a new REST API endpoint that enables an API caller to resend, retry, or republish a previously attempted webhook delivery attempt .
- Core use cases for the ability to replay a specific previous webhook attempt:
  - Replay or retry a webhook delivery attempt that failed or timed out
  - Debug or use a payload from an existing webhook delivery attempt
  - Fix an issue by replaying a webhook delivery attempt that already succeeded
  - Etc.

April 14, 2025

Customers
- Added ability for customer create, read/retrieve, update, and delete within an account. This enables retrieval and modification of customer details via API such as name , billing_address , billing_email , mailing_address , external_id (ERP customer identifier), notes , etc.
- New Customer API Endpoints:
Shipments
- Added new optional properties to Related Orders of:
  - Shipment ( shipment.related_orders )
  - Shipment Stop ( shipment.stops[].related_orders )
  - Shipment Line Item ( shipment.lineitems[].relatedorders )
- The new properties are:
  - custom_data (represents Custom Reference Data – only for shipment.related_orders ; other properties apply across all three related_orders options). This follows the same consistent structure of other custom_data API properties in the Shipwell platform. See Custom Data .
  - order_name
  - pickup_number
  - purchase_order_number
  - sales_order_number
  - Note: purchase_order_number and sales_order_number are not available for v2 Orders.

March 13, 2025

Contracts
- Added ability for shipment line items to have freight classes at the Contract Lane table level and dimensional Contract Lane factors like dimensional weight and freight class.
  - Added new freight_class_rates property to Contract Lane.
  - Added new dimensional_factor property to Contract Lane.
  - Added new freight_class_dimensional_factor property to Contract Lane.
Orders (Modern/Next Gen)
- Added new objects and properties to the Shipping Requirements ( shipping_requirements ) of an Order:
  - temperature
  - references
- Added new properties that Orders may be filtered by in the Get/List Orders API endpoint :
  - temperature_maximum
  - temperature_maximum__lte
  - temperature_maximum__gte
  - temperature_minimum
  - temperature_minimum__gte
  - temperature_minimum__lte
SFTP
- Added an additional outbound shipment financials/freight invoice .csv file format type of INVOICE_SHIPWELL . When a freight invoice is APPROVED , a .csv file is generated and placed in the customer’s /outbound/invoices directory.
  - See Format Shipment Financials Invoice Outbound File Definition – Shipwell Format .

February 27, 2025

Contracts
- Added ability for accessorials that are added directly on a Contract to have an accessorial charge type ( FLAT_RATE , QTY , etc.) and an accessorial minimum amount.
- Added charge_type property to Contract Lane . Possible values include:
  - FLAT_RATE
  - CWT
  - QTY
  - LB
  - KG
  - TON
- Added minimum_charge property to Contract Lane Accessorial Charge Table Calculation Row .

February 13, 2025

Order Importer (Modern/Next Gen Orders)
- Updated to include the fields documented in the order importer instructions which are available here .
Order Items Routes (Modern/Next Gen Orders)
- Added new polymorphic API routes for Order Items (Modern/Next Gen Orders). This endpoint style will support different types of orders in the future and works for purchase orders .

January 30, 2025

Shipper Relationships
- Added new distance_provider_config object to enable configuration of distance calculation providers for a shipper relationship through the API.
Carrier Assignment
- Added ability to reapply contracts/contract rates after shipment or stop details have been changed.
- Added contract_id property to Carrier Assignment.
- Added contract_applied_at property to Carrier Assignment.
Company Preferences
- Added new reapply_contract_on_shipment_change property. Related to the ability to reapply contracts/contract rates after shipment or stop details have been changed.
Orders (Modern/Next Gen)
- Added new Order cancel endpoint ( /orders/{order_id}/cancel ) to cancel purchase orders, sales orders, etc. using the same polymorphic endpoint.
- Added new Order Items endpoints:
  - POST /orders/{order_id}/items : Adds ability to add one or more order items to a purchase order, sales order, etc. without updating the entire order.
  - PUT /orders/{order_id}/items/{order_item_id} : Adds ability to update an order item on a purchase order, sales order, etc. without updating the entire order.
  - DELETE /orders/{order_id}/items/{order_item_id} : Adds ability to delete an order item on a purchase order, sales order, etc. without updating the entire order.
- Added ability for Orders and Order Items to populate an order item’s description and shipping_requirements automatically from a Product Reference (see Return a specific product ). If a valid PRODUCT_REF is provided in a request, the product’s description property automatically fills the order.item.description and order.item.shipping_requirements fields when those fields are empty or set to null in the request.

January 9, 2025

Address Book / Locations
- Added new optional querystring params to Locations list/query endpoint :
  - id
  - external_reference
Contracts
- Added new distance property to Contract and Contract Lane .
  - distance is a decimal value that represents the value part of a distance combined with a distance_unit ( MILE or KILOMETER ).
    - For example, if distance is 123.45 and the distance_unit is MILE so this is 123.45 miles in the contract or contract lane. This distance and the distance_unit are used in charge line item calculations.
- Added support for new stop charge currency codes (with continued support for "USD" and "CAD" ):
  - "CNY" - Chinese Yuan
  - "EUR" - Euro
  - "MXN" - Mexican Peso
Events
- Added shipment.document.created and shipment.document.updated events.
  - These events are also available as events that may be subscribed to through webhooks.
Orders (Modern/Next Gen)
- Added new optional ADDRESS_BOOK_ENTRY_ID and ADDRESS_BOOK_ENTRY_REFERENCE_ID qualifier options to the available references in the order stops of ship_to and ship_from . When you provide a valid ADDRESS_BOOK_ENTRY_ID or ADDRESS_BOOK_ENTRY_REFERENCE_ID during order creation or update, the system will automatically use the specified address book entry , eliminating the need to enter additional shipping details. If both of these address book entry-related properties are specified, the system will use the ADDRESS_BOOK_ENTRY_ID over the ADDRESS_BOOK_ENTRY_REFERENCE_ID .
- ADDRESS_BOOK_ENTRY_ID
  - This is the address book identifier for the particular address book entry.
- ADDRESS_BOOK_ENTRY_REFERENCE_ID
  - This is the address book external reference that is typically the identifier from an ERP (Enterprise Resource Planning) system or external system for the particular address book entry.
- Added new optional properties to order-level shipping_requirements :
  - non_managed_freight
  - required_delivery_date
  - ship_by_date
- Added new optional querystring params to Orders (Modern/Next Gen) list/query endpoint to determine if order(s) match or do not match certain order tags.
  - tags__id__all
  - tags__id__not_all
  - tags__id__in
  - tags__id__not_in
  - tags__slug__all
  - tags__slug__not_all
  - tags__slug__in
  - tags__slug__not_in
Shipments
- Added new optional querystring params to Shipment Templates list/query endpoint :
  - q

December 5, 2024

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

November 14, 2024

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

October 28, 2024

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.

October 10, 2024

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.

September 26, 2024

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

September 12, 2024

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

Note

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