{
  "opencollection": "1.0.0",
  "info": {
    "name": "MVMNT Bill Payments Loads API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Loads",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Filter loads",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mvmnt.io/v1/loads/filter",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search for loads using filter criteria.\n\n## Common Filters\n\n- By shipment: `{ \"filter\": { \"shipmentId\": { \"equalTo\": \"uuid\" } } }`\n- Active loads: `{ \"filter\": { \"status\": { \"notIn\": [\"DELIVERED\", \"CANCELED\"] } } }`\n- TL loads: `{ \"filter\": { \"mode\": { \"equalTo\": \"TL\" } } }`\n"
        },
        {
          "info": {
            "name": "Create a load",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mvmnt.io/v1/loads",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new load for a shipment.\n\n## What happens\n\n- Load is created for the specified shipment\n- Optionally assigns an initial carrier\n\n## Note\n\nLoads are typically created as part of shipment creation.\nUse this endpoint to add additional loads to an existing shipment.\n"
        },
        {
          "info": {
            "name": "Get a load",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mvmnt.io/v1/loads/:id",
            "params": [
              {
                "name": "id",
                "value": "550e8400-e29b-41d4-a716-446655440000",
                "type": "path",
                "description": "Resource ID (UUID) or client key"
              },
              {
                "name": "by",
                "value": "key",
                "type": "query",
                "description": "Specify lookup type for faster retrieval.\nIf omitted, defaults to looking up by ID first, then falls back to client key if not found.\nUse `by=key` when you know you're providing a client key for best performance.\n"
              }
            ]
          },
          "docs": "Retrieve a load by ID.\n\nThe response includes embedded carriers and stops.\n"
        },
        {
          "info": {
            "name": "Update a load",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.mvmnt.io/v1/loads/:id",
            "params": [
              {
                "name": "id",
                "value": "550e8400-e29b-41d4-a716-446655440000",
                "type": "path",
                "description": "Resource ID (UUID) or client key"
              },
              {
                "name": "by",
                "value": "key",
                "type": "query",
                "description": "Specify lookup type for faster retrieval.\nIf omitted, defaults to looking up by ID first, then falls back to client key if not found.\nUse `by=key` when you know you're providing a client key for best performance.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update load fields.\n\n**Note:** To manage carriers, use the carrier-specific endpoints.\n"
        },
        {
          "info": {
            "name": "Delete a load",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.mvmnt.io/v1/loads/:id",
            "params": [
              {
                "name": "id",
                "value": "550e8400-e29b-41d4-a716-446655440000",
                "type": "path",
                "description": "Resource ID (UUID) or client key"
              },
              {
                "name": "by",
                "value": "key",
                "type": "query",
                "description": "Specify lookup type for faster retrieval.\nIf omitted, defaults to looking up by ID first, then falls back to client key if not found.\nUse `by=key` when you know you're providing a client key for best performance.\n"
              }
            ]
          },
          "docs": "Soft delete a load.\n\n## Prerequisites\n\n- Load must not have any active carriers\n"
        },
        {
          "info": {
            "name": "Add carrier to load",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mvmnt.io/v1/loads/:id/add-carrier",
            "params": [
              {
                "name": "id",
                "value": "550e8400-e29b-41d4-a716-446655440000",
                "type": "path",
                "description": "Resource ID (UUID) or client key"
              },
              {
                "name": "by",
                "value": "key",
                "type": "query",
                "description": "Specify lookup type for faster retrieval.\nIf omitted, defaults to looking up by ID first, then falls back to client key if not found.\nUse `by=key` when you know you're providing a client key for best performance.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add an additional carrier to a load.\n\n## Use cases\n\n- Split loads (multiple carriers for same load)\n- Adding backup carrier\n- Re-assigning after TONU/bounce\n\n## What happens\n\n- New LoadCarrier record is created\n- Carrier is notified (if configured)\n"
        },
        {
          "info": {
            "name": "Rebook a TONU load",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mvmnt.io/v1/loads/:id/rebook",
            "params": [
              {
                "name": "id",
                "value": "550e8400-e29b-41d4-a716-446655440000",
                "type": "path",
                "description": "Resource ID (UUID) or client key"
              },
              {
                "name": "by",
                "value": "key",
                "type": "query",
                "description": "Specify lookup type for faster retrieval.\nIf omitted, defaults to looking up by ID first, then falls back to client key if not found.\nUse `by=key` when you know you're providing a client key for best performance.\n"
              }
            ]
          },
          "docs": "Create a new load to replace a TONU'd load.\n\n## Use case\n\nAfter a carrier reports TONU, use this to create a replacement load\nthat can be assigned to a new carrier.\n\n## What happens\n\n- New Load is created with same stops\n- Original load remains in TONU status\n- New load is ready for carrier assignment\n"
        },
        {
          "info": {
            "name": "Get load carrier",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mvmnt.io/v1/loads/:loadId/carriers/:carrierId",
            "params": [
              {
                "name": "loadId",
                "value": "",
                "type": "path",
                "description": "Load ID"
              },
              {
                "name": "carrierId",
                "value": "",
                "type": "path",
                "description": "LoadCarrier ID"
              }
            ]
          },
          "docs": "Retrieve a specific carrier assignment for a load."
        },
        {
          "info": {
            "name": "Update load carrier",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.mvmnt.io/v1/loads/:loadId/carriers/:carrierId",
            "params": [
              {
                "name": "loadId",
                "value": "",
                "type": "path"
              },
              {
                "name": "carrierId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update carrier assignment details.\n\nUse this to update driver info, truck/trailer numbers, or contact.\n"
        },
        {
          "info": {
            "name": "Bounce carrier",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mvmnt.io/v1/loads/:loadId/carriers/:carrierId/bounce",
            "params": [
              {
                "name": "loadId",
                "value": "",
                "type": "path"
              },
              {
                "name": "carrierId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Mark carrier as bounced (rejected load without payment).\n\n## What happens\n\n- LoadCarrier status changes to BOUNCED\n- Carrier is removed from active execution\n- No payment is recorded\n\n## When to use\n\nUse bounce when carrier rejects the load before dispatch,\nor fails to show up without prior notice.\n\nFor carriers who were dispatched but cancelled, use TONU instead.\n"
        },
        {
          "info": {
            "name": "Report TONU",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mvmnt.io/v1/loads/:loadId/carriers/:carrierId/tonu",
            "params": [
              {
                "name": "loadId",
                "value": "",
                "type": "path"
              },
              {
                "name": "carrierId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Report Truck Ordered Not Used (TONU).\n\n## What happens\n\n- LoadCarrier status changes to TONU\n- TONU costs are recorded if provided\n- Optionally creates a replacement load\n\n## When to use\n\nUse TONU when:\n- Carrier was dispatched but load was cancelled\n- Carrier arrived but freight wasn't ready\n- Carrier was turned away at shipper\n\nTONU typically involves some payment to the carrier.\n"
        }
      ]
    }
  ],
  "bundled": true
}