API Changelog

This changelog lists additions and updates to the Shipwell API.

October 20, 2025

  • Payment Terms Management
    • We've added comprehensive payment terms support across shipper and carrier relationships, allowing you to define, manage, and track payment terms and conditions for business relationships.
    • New Property:
    • payment_terms (optional object) – Available in shipper relationship and carrier relationship objects
    • Key Capabilities:
    • Create relationships with terms: Include payment terms when creating shipper or carrier relationships
    • Update relationship terms: Modify payment terms during relationship management
    • View terms in responses: Access payment terms in all relationship responses
    • Manage terms independently: Full CRUD operations on payment terms within shipper relationships
    • Affected Relationship Types:
    • Shipper relationships (brokerages)
    • Carrier relationships
    • Available in Responses:
    • Individual relationship objects
    • Relationship collections (lists)
    • All relationship management workflows
    • Shipper Relationship Endpoints with Payment Terms
    • Shipper Relationship Management:
      • GET /brokerages/{brokerageId}/shipper-relationships/ – View shipper relationships with payment terms
      • POST /brokerages/{brokerageId}/shipper-relationships/ – Create shipper relationships with payment terms
      • GET /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/ – View individual shipper relationship with payment terms
      • PUT /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/ – Update shipper relationship with payment terms
    • Payment Terms Management (NEW):
      • GET /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/payment-terms/ – List all payment terms for a shipper relationship
      • POST /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/payment-terms/ – Create new payment term for a shipper relationship
      • GET /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/payment-terms/{paymentTermId}/ – Retrieve specific payment term
      • PUT /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/payment-terms/{paymentTermId}/ – Update payment term (full replacement)
      • PATCH /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/payment-terms/{paymentTermId}/ – Partially update payment term
      • DELETE /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/payment-terms/{paymentTermId}/ – Delete payment term
    • Carrier Relationship Endpoints with Payment Terms
    • Carrier Relationship Management:
      • GET /carrier-relationships/ – View carrier relationships with payment terms
      • POST /carrier-relationships/ – Create carrier relationships with payment terms
      • GET /carrier-relationships/{carrierRelationshipId}/ – View individual carrier relationship with payment terms
      • PUT /carrier-relationships/{carrierRelationshipId}/ – Update carrier relationship with payment terms
  • Ocean Shipment State Tracking
    • New ocean-specific shipment states for comprehensive container and barge tracking throughout the maritime supply chain.
    • New Shipment States:
    • loaded_on_barge_at_origin – Container loaded onto barge at origin location
    • barge_departed_from_origin – Barge departed from origin location
    • barge_berthed_at_origin_port – Barge arrived and berthed at origin port
    • discharged_from_barge_at_origin_port – Container discharged from barge at origin port
    • loaded_on_barge_at_destination_port – Container loaded onto barge at destination port
    • barge_departed_from_destination_port – Barge departed from destination port
    • barge_berthed_at_destination – Barge arrived and berthed at destination
    • discharged_from_barge_at_destination – Container discharged from barge at destination
    • full_ingated_to_offdock_facility – Full container ingated to off-dock facility
    • available_at_offdock_facility – Container available at off-dock facility
    • Applicable Modes:
    • OCEAN shipments
    • FCL (Full Container Load) shipments
    • LCL (Less than Container Load) shipments
    • Key Features:
    • Automatic state transitions from container tracking events
    • Enhanced visibility for barge movements and off-dock facilities
    • Integration with OpenTrack container tracking system
    • Shipment State Endpoints
      • All shipment GET endpoints now support the 10 new ocean-specific states
  • Workflow Identification in Policies
    • Added workflow identification to applicable policies for improved policy tracking and automation.
    • New Property:
    • workflow_id (optional string) – Workflow identifier in applicable policies
    • Key Capabilities:
    • Track which workflow is associated with each applicable policy
    • Enhanced policy automation and orchestration
    • Improved policy management and reporting
    • Policy Endpoints
    • Applicable Policies:
      • GET /shipments/{shipmentId}/applicable-policies/ – Now includes workflow_id in policy summary

September 29, 2025

  • Carrier Terms Support
    • We've added comprehensive carrier_terms support across all quoting workflows, allowing you to capture and manage specific terms and conditions from carriers during negotiations.
    • New Property:
    • carrier_terms (optional object) – Available in quote objects and awarded quote objects
    • Key Capabilities:
    • Create quotes with terms: Include carrier-specific terms when creating quotes
    • Update quote terms: Modify carrier terms during negotiations
    • View terms in responses: Access carrier terms in all quote and shipment responses
    • Track awarded terms: See carrier terms for the most recently awarded quote on shipments
    • Affected Quote Types:
    • RFQ quotes
    • Spot negotiation quotes
    • Load board spot negotiation quotes
    • Private market negotiation quotes
    • Customer negotiation quotes
    • Available in Responses:
    • Individual quote objects
    • Quote collections (lists)
    • Most recently awarded quote on shipments
    • All negotiation workflows
    • Migration Guide:
    • No action required – All carrier terms functionality is optional and additive.
    • To start using carrier terms:
      • Include carrier terms in quote creation: Add the optional carrier_terms object when creating quotes
      • Update response parsing: Handle the new carrier_terms field in quote and shipment responses
      • Leverage in negotiations: Use carrier terms to track specific conditions during the negotiation process
  • Auto-Assign Freight Class Preference
    • New company-level preference to automatically assign freight classes during shipment processing.
    • New Company Preference:
    • auto_assign_freight_class (optional boolean) – Enable/disable automatic freight class assignment
    • Endpoints:
    • GET /companies/{companyId}/preferences/ – View current setting
    • PUT /companies/{companyId}/preferences/ – Update setting
    • Migration Guide:
    • No action required – This is a new optional company preference.
    • To enable automatic freight class assignment:
      • Set auto_assign_freight_class: true in your company preferences
      • The system will automatically assign appropriate freight classes during shipment processing
  • Quoting Endpoints with Carrier Terms
    • RFQ Management:
    • POST /quoting/rfqs/ – Create RFQs with carrier terms in quotes
    • PUT /quoting/rfqs/{rfqId}/ – Update RFQ quotes with carrier terms
    • GET /quoting/rfqs/{rfqId}/ – View RFQs with carrier terms
    • POST /quoting/rfqs/{rfqId}/quotes/ – Create quotes with carrier terms
    • PUT /quoting/rfqs/{rfqId}/quotes/{quoteId}/ – Update quote carrier terms
    • Spot Negotiations:
    • POST /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/quotes/ – Create quotes with carrier terms
    • PUT /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/quotes/{spotNegotiationQuoteId}/ – Update quote carrier terms
    • All spot negotiation GET endpoints now return carrier terms
    • Private Market:
    • POST /quoting/privatemarket/spot-negotiations/{spotNegotiationId}/quotes/ – Create quotes with carrier terms
    • PUT /quoting/privatemarket/rfqs/{rfqId}/customer-negotiation/ – Update negotiations with carrier terms
    • All private market GET endpoints now return carrier terms
    • Load Board:
    • POST /quoting/loadboard/{loadBoardShipmentId}/spot-negotiations/ – Create negotiations with carrier terms
  • Shipment Endpoints with Carrier Terms
    • Enhanced Shipment Responses:
    • All shipment GET endpoints now include carrier_terms in most_recently_awarded_quote
    • Shipment creation and update endpoints support setting carrier terms on awarded quotes
    • Specific Endpoints:
    • POST /shipments/ – Create shipments with carrier terms in awarded quotes
    • PUT /shipments/{shipmentId}/ – Update shipments with carrier terms
    • GET /shipments/external/ – View external shipments with carrier terms
    • All shipment action endpoints (auto-book, award-quote, cancel, etc.) return carrier terms

September 8, 2025

  • Orders
    • Enhanced Custom Data
    • Order custom data handling has been improved across all shipment-related endpoints. The custom_data property in related_orders objects within line items and stops has been restructured for better consistency and performance.
    • Affected Areas:
      • Shipment line items with related orders
      • Shipment stops with related orders
      • Purchase order shipments
      • Spot negotiations
      • Carrier power unit shipments
    • Custom data restructuring is handled automatically and maintains backward compatibility for existing integrations.
  • P44AccountCustomer schema has been removed from the API specification
  • Rate Configuration
    • customers property has been restructured in carrier relationship rate configuration endpoints.
    • Changes affect both request and response formats for rate configuration management.
    • Review your integration to ensure compatibility with the updated customers property structure.

August 18, 2025

  • Groups
    • Introduced a new Groups object to classify parts of an organization (e.g., divisions, distribution centers, companies, etc.).
    • The first generation provides API-only CRUD and group management. Nothing is in the Shipwell interface, and nothing is tied to orders or shipments in this release.
    • Endpoints:
    • GET /groups
    • POST /groups
    • PUT /groups/{group_id}
    • PATCH /groups/{group_id}
  • Shipments & Quoting – Enhanced Charge Line Item Fields
    • Added new optional fields in both request and response schemas for charge line items:
    • base_rate
    • rate_type
    • Present within: customer_charge_line_items , vendor_charge_line_items , and associated nested objects.
    • Endpoints impacted include (not exhaustive): /shipments/ , /shipments/{shipmentId}/ , /purchase-orders/build-shipment/ , /carrier-relationships/ , /quoting/spotnegotiations/spot-negotiations/ , and more.
  • Routing Guide Policies – Contract Support
    • Added optional contract fields across policy APIs.
    • GET /routing-guide/policies/
    • Added optional response fields: contract , contract_details
    • POST /routing-guide/policies/
    • Added optional request property: contract
    • Added optional response fields: contract , contract_details
    • PUT /routing-guide/policies/{policyId}/
    • Added optional request property: contract
    • Added optional response fields: contract , contract_details
    • DELETE /routing-guide/policies/{policyId}/
    • Added optional response fields: contract , contract_details
    • GET /routing-guide/policies/{policyId}/
    • Added optional response fields: contract , contract_details
    • New endpoint:
    • GET /shipments/{shipmentId}/applicable-policies/ – retrieve policies relevant to a specific shipment.
  • Enum Fields – New Mileage Type Value
    • Extended the mileage_type enum with support for a new value: PC_MILER_39 .
    • Endpoints affected by PC_MILER_39 value:
    • GET /auth/me/
    • POST /auth/token/
    • GET /companies/{companyId}/
    • PUT /companies/{companyId}/
    • GET /brokerages/{brokerageId}/shipper-relationships/
    • POST /brokerages/{brokerageId}/shipper-relationships/
    • GET /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/
    • PUT /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/
    • GET /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/carriers/
    • PUT /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/carriers/
    • GET /carrier-relationships/
    • POST /carrier-relationships/
    • GET /carrier-relationships/{carrierRelationshipId}/
    • PUT /carrier-relationships/{carrierRelationshipId}/
    • GET /carriers/
    • GET /carriers/integrations/automated-vendors/
    • GET /carriers/{carrierId}/power-units/{powerUnitId}/shipments/
    • POST /purchase-orders/build-shipment/
    • PUT /purchase-orders/update-built-shipment/
    • GET /shipments/
    • POST /shipments/
    • GET /shipments/{shipmentId}/
    • PUT /shipments/{shipmentId}/
    • PUT /shipments/{shipmentId}/add-orders/
    • PUT /shipments/{shipmentId}/remove-orders/{orderId}/
    • PUT /shipments/{shipmentId}/carrier-assignments/{carrierAssignmentId}/
    • POST /shipments/{shipmentId}/carrier-assignments/
    • GET /shipments/{shipmentId}/carrier-assignments/
    • GET /shipments/{shipmentId}/carrier-assignments/{carrierAssignmentId}/
    • POST /shipments/{shipmentId}/initiate-check-call/
    • POST /shipments/{shipmentId}/auto-book/
    • POST /shipments/{shipmentId}/award-quote/
    • POST /shipments/{shipmentId}/cancel/
    • GET /shipments/external/
    • GET /shipments/external/{shipmentId}/
    • GET /shipments/pickups/
    • POST /shipments/pickups/
    • GET /shipments/pickups/{shipmentPickupId}/
    • PUT /shipments/pickups/{shipmentPickupId}/
    • POST /shipments/pickups/{shipmentPickupId}/cancel/
    • GET /quoting/spotnegotiations/spot-negotiations/
    • GET /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/
    • PUT /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/
    • GET /quoting/loadboard/
    • GET /quoting/loadboard/{loadBoardShipmentId}/
    • GET /tenders/
    • POST /tenders/
    • GET /tenders/{tenderId}/

July 28, 2025

  • Contracts
    • Added the ability to define zones in contracts to be used in contract matching by adding new optional properties.
    • Applicable Contracts ( API Reference )
    • data/items/contract_lane/destination_zone_reference ( 200 response )
    • data/items/contract_lane/origin_zone_reference ( 200 response )
    • Contract Lanes – Get/List ( API Reference )
    • results/items/destination_zone_reference ( 200 response )
    • results/items/origin_zone_reference ( 200 response )

June 16, 2025

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

May 28, 2025

  • Custom Logic and Scripting
  • 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

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

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
    • ADDRESS_BOOK_ENTRY_REFERENCE_ID
    • 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

December 5, 2024

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.

Copyright © Shipwell 2025. All right reserved.