{
  "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
}