{
  "opencollection": "1.0.0",
  "info": {
    "name": "MVMNT Bill Payments Services API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Services",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Filter services",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mvmnt.io/v1/services/filter",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search for services using filter criteria.\n\n## Common Filters\n\n- By shipment: `{ \"filter\": { \"shipmentId\": { \"equalTo\": \"uuid\" } } }`\n- By vendor: `{ \"filter\": { \"vendorId\": { \"equalTo\": \"uuid\" } } }`\n- Awaiting invoice: `{ \"filter\": { \"status\": { \"equalTo\": \"AWAITING_INVOICE\" } } }`\n"
        },
        {
          "info": {
            "name": "Create a service",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mvmnt.io/v1/services",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new service for a shipment.\n\n## What happens\n\n- Service is created for the specified shipment\n- Vendor is associated with the service\n- Charges are recorded\n\n## Note\n\nServices are typically created as part of shipment creation.\nUse this endpoint to add additional services to an existing shipment.\n"
        },
        {
          "info": {
            "name": "Get a service",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mvmnt.io/v1/services/: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 service by ID.\n\nThe response includes vendor info and charges.\n"
        },
        {
          "info": {
            "name": "Update a service",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.mvmnt.io/v1/services/: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 service fields.\n\n**Note:** Status changes happen automatically based on billing workflow.\n"
        },
        {
          "info": {
            "name": "Delete a service",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.mvmnt.io/v1/services/: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 service.\n\n## Prerequisites\n\n- Service must not be paid\n"
        }
      ]
    }
  ],
  "bundled": true
}