Shipwell

Shipwell is an AI-powered transportation management system (TMS) and freight execution platform for shippers, brokers, and carriers. The Shipwell v2 Core API lets developers plan, rate, tender, book, track, and settle multimodal freight - parcel, LTL, truckload, intermodal, rail, and ocean - programmatically. It covers shipments, quoting and rating, carrier management, purchase orders and orders, documents, tenders, freight pay and audit, and a real-time events and webhooks surface. The production base URL is https://api.shipwell.com/v2 (the newer Orders API is served under https://api.shipwell.com without the /v2 prefix), with a fully separate sandbox at https://sandbox-api.shipwell.com/v2. Requests are authenticated with company-scoped API keys passed in the Authorization header. Access to the full platform and API is enterprise and contract-gated.

5 APIs 0 Features
Transportation ManagementTMSFreightLogisticsShippingSupply Chain

APIs

Shipwell Shipments API

Create, list, retrieve, and update multimodal freight shipments with stops, line items, equipment, service levels, notes, and carrier assignments. The central resource of the Sh...

Shipwell Quoting and Rating API

Request rates and quotes for shipments, run requests for quote (RFQs) against carriers, and manage spot negotiations and carrier bids. Endpoint shapes are modeled from the docum...

Shipwell Carriers API

List and manage carriers and carrier relationships in your network, including compliance and performance master data, carrier tags, and the carrier assignments attached to shipm...

Shipwell Orders API

Create and manage orders and purchase orders, then consolidate them onto shipments for execution. The newer Orders API is served under https://api.shipwell.com without the /v2 p...

Shipwell Events and Webhooks API

Retrieve real-time supply-chain events (including shipment tracking timeline updates like in_transit and delivered) and register webhook subscriptions that Shipwell delivers by ...

Collections

Shipwell v2 Core API

OPEN

Pricing Plans

Shipwell Plans Pricing

3 plans

PLANS

Rate Limits

Shipwell Rate Limits

3 limits

RATE LIMITS

FinOps

Shipwell Finops

FINOPS

Resources

🔗
DomainSecurity
DomainSecurity
🔑
Authentication
Authentication
🔗
Website
Website
🔗
LinkedIn
LinkedIn
🔗
Documentation
Documentation
📝
SignUp
SignUp
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
📰
Blog
Blog

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Shipwell v2 Core API
  version: '2.0'
request:
  auth:
    type: apikey
    apikey:
      key: Authorization
      value: '{{authToken}}'
      in: header
items:
- info:
    name: Shipments
    type: folder
  items:
  - info:
      name: List shipments.
      type: http
    http:
      method: GET
      url: https://api.shipwell.com/v2/shipments/
    docs: Returns a paginated list of shipments visible to the authenticated company. (confirmed)
  - info:
      name: Create a shipment.
      type: http
    http:
      method: POST
      url: https://api.shipwell.com/v2/shipments/
      body:
        type: json
        data: "{\n  \"metadata\": {\"open\": true},\n  \"mode\": {\"code\": \"FTL\"},\n  \"equipment_type\": {\"machine_readable\"\
          : \"DRY_VAN\"},\n  \"stops\": [],\n  \"line_items\": []\n}"
    docs: Creates a shipment with metadata, mode, equipment_type, service_level, stops, and line_items. (confirmed)
  - info:
      name: Retrieve a shipment.
      type: http
    http:
      method: GET
      url: https://api.shipwell.com/v2/shipments/:shipmentId/
      params:
      - name: shipmentId
        value: ''
        type: path
        description: The ID of the shipment.
    docs: Retrieves a single shipment by its ID. (confirmed)
  - info:
      name: Update a shipment.
      type: http
    http:
      method: PUT
      url: https://api.shipwell.com/v2/shipments/:shipmentId/
      params:
      - name: shipmentId
        value: ''
        type: path
        description: The ID of the shipment.
      body:
        type: json
        data: '{}'
    docs: Updates an existing shipment. (confirmed)
  - info:
      name: List notes for a shipment.
      type: http
    http:
      method: GET
      url: https://api.shipwell.com/v2/shipments/:shipmentId/notes/
      params:
      - name: shipmentId
        value: ''
        type: path
        description: The ID of the shipment.
    docs: Lists the notes attached to a shipment or shipment quote. (confirmed)
  - info:
      name: Create a carrier assignment.
      type: http
    http:
      method: POST
      url: https://api.shipwell.com/v2/shipments/:shipmentId/carrier-assignments/
      params:
      - name: shipmentId
        value: ''
        type: path
        description: The ID of the shipment.
      body:
        type: json
        data: '{}'
    docs: Assigns a carrier to a shipment. (confirmed)
- info:
    name: Quoting
    type: folder
  items:
  - info:
      name: Request a quote / rates.
      type: http
    http:
      method: POST
      url: https://api.shipwell.com/v2/quotes/
      body:
        type: json
        data: '{}'
    docs: Requests rates and quotes for a shipment (an RFQ). Modeled - confirm the exact path against the live reference.
      (modeled)
  - info:
      name: Retrieve a quote.
      type: http
    http:
      method: GET
      url: https://api.shipwell.com/v2/quotes/:quoteId/
      params:
      - name: quoteId
        value: ''
        type: path
        description: The ID of the quote.
    docs: Retrieves a quote and its returned rates. (modeled)
- info:
    name: Carriers
    type: folder
  items:
  - info:
      name: List carriers.
      type: http
    http:
      method: GET
      url: https://api.shipwell.com/v2/carriers/
    docs: Lists carriers in your network, with compliance and performance master data. (modeled)
  - info:
      name: Retrieve a carrier.
      type: http
    http:
      method: GET
      url: https://api.shipwell.com/v2/carriers/:carrierId/
      params:
      - name: carrierId
        value: ''
        type: path
        description: The ID of the carrier.
    docs: Retrieves a single carrier by its ID. (modeled)
- info:
    name: Orders
    type: folder
  items:
  - info:
      name: List orders.
      type: http
    http:
      method: GET
      url: https://api.shipwell.com/orders
    docs: Lists orders. The Orders API is served under the host root without the /v2 prefix. (modeled)
  - info:
      name: Create an order.
      type: http
    http:
      method: POST
      url: https://api.shipwell.com/orders
      body:
        type: json
        data: '{}'
    docs: Creates an order that can later be consolidated onto a shipment. (modeled)
  - info:
      name: Retrieve an order.
      type: http
    http:
      method: GET
      url: https://api.shipwell.com/orders/:orderId
      params:
      - name: orderId
        value: ''
        type: path
        description: The ID of the order.
    docs: Retrieves a single order by its ID. (modeled)
- info:
    name: Events and Webhooks
    type: folder
  items:
  - info:
      name: Retrieve a list of events.
      type: http
    http:
      method: GET
      url: https://api.shipwell.com/v2/events/
    docs: Retrieves supply-chain events, including shipment tracking timeline updates. (confirmed)
  - info:
      name: List event names by version.
      type: http
    http:
      method: GET
      url: https://api.shipwell.com/v2/events/event-names-by-version/
    docs: Returns the up-to-date list of event names available for webhook subscriptions. (confirmed)
  - info:
      name: Create a webhook subscription.
      type: http
    http:
      method: POST
      url: https://api.shipwell.com/v2/webhooks/
      body:
        type: json
        data: "{\n  \"url\": \"https://example.com/webhook\",\n  \"event_names\": []\n}"
    docs: Creates a webhook subscription; Shipwell delivers matching events by HTTP POST. (partly confirmed)
bundled: true