OpenAPI Specification
openapi: 3.1.0
info:
title: MVMNT Bill Payments Carriers API
version: 1.0.0
description: "The MVMNT API enables you to automate freight brokerage workflows by integrating\ndirectly with our Transportation Management System.\n\n## Authentication\n\nOAuth 2.0 client credentials flow. See [Authentication Guide](/getting-started/authentication)\nfor details.\n\n### Token Endpoint\n\n```\nPOST https://api.mvmnt.io/oauth2/token\n```\n\n#### Request\n\n**Headers:**\n```http\nContent-Type: application/x-www-form-urlencoded\n```\n\n**Body Parameters:**\n```\ngrant_type=client_credentials\nclient_id=YOUR_CLIENT_ID\nclient_secret=YOUR_CLIENT_SECRET\n```\n\n#### Example Request\n\n```bash\ncurl -X POST https://api.mvmnt.io/oauth2/token \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n -d \"grant_type=client_credentials\" \\\n -d \"client_id=YOUR_CLIENT_ID\" \\\n -d \"client_secret=YOUR_CLIENT_SECRET\"\n```\n\n#### Success Response\n\n**Status:** `200 OK`\n\n```json\n{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}\n```\n\n**Response Fields:**\n- `access_token`: JWT Bearer token to use for API requests\n- `token_type`: Always `Bearer`\n- `expires_in`: Token lifetime in seconds (3600 = 1 hour)\n"
contact:
name: MVMNT Support
email: support@mvmnt.io
url: https://docs.mvmnt.io
license:
name: Proprietary
url: https://mvmnt.io/legal/terms
x-parsed-md-description:
result:
- $$mdtype: Node
errors: []
lines:
- 0
- 2
inline: false
attributes: {}
children:
- $$mdtype: Node
errors: []
lines:
- 0
- 2
inline: false
attributes: {}
children:
- $$mdtype: Node
errors: []
lines:
- 0
- 2
inline: true
attributes:
content: The MVMNT API enables you to automate freight brokerage workflows by integrating
children: []
type: text
annotations: []
slots: {}
- $$mdtype: Node
errors: []
lines:
- 0
- 2
inline: true
attributes: {}
children: []
type: softbreak
annotations: []
slots: {}
- $$mdtype: Node
errors: []
lines:
- 0
- 2
inline: true
attributes:
content: directly with our Transportation Management System.
children: []
type: text
annotations: []
slots: {}
type: inline
annotations: []
slots: {}
type: paragraph
annotations: []
slots: {}
- $$mdtype: Node
errors: []
lines:
- 3
- 4
inline: false
attributes:
level: 2
children:
- $$mdtype: Node
errors: []
lines:
- 3
- 4
inline: false
attributes: {}
children:
- $$mdtype: Node
errors: []
lines:
- 3
- 4
inline: true
attributes:
content: Authentication
children: []
type: text
annotations: []
slots: {}
type: inline
annotations: []
slots: {}
type: heading
annotations: []
slots: {}
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: false
attributes: {}
children:
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: false
attributes: {}
children:
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: true
attributes:
content: 'OAuth 2.0 client credentials flow. See '
children: []
type: text
annotations: []
slots: {}
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: true
attributes:
href: /getting-started/authentication
children:
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: true
attributes:
content: Authentication Guide
children: []
type: text
annotations: []
slots: {}
type: link
annotations: []
slots: {}
redocly:::linkOriginal:href: /getting-started/authentication
- $$mdtype: Node
errors: []
lines:
- 5
- 6
inline: true
attributes:
content: ' for details.'
children: []
type: text
annotations: []
slots: {}
type: inline
annotations: []
slots: {}
type: paragraph
annotations: []
slots: {}
servers:
- url: https://api.mvmnt.io/v1
description: Production
security:
- BearerAuth: []
tags:
- name: Carriers
description: Carrier management operations
paths:
/carriers/filter:
post:
tags:
- Carriers
summary: Filter carriers
description: 'Query carriers using flexible filter criteria with AND/OR logic.
By default, only non-deleted carriers are returned (deletedAt: { isNull: true }).
Override this by explicitly setting deletedAt filter criteria.
Returns carriers of all types (TRUCKLOAD, AIR, CARTAGE, LINEHAUL, LTL, OCEAN, RAIL)
with type-specific fields included based on carrier type.
'
operationId: filterCarriers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierFilterRequest'
responses:
'200':
description: Filtered carriers with pagination
content:
application/json:
schema:
type: object
required:
- data
- pageInfo
properties:
data:
type: array
items:
$ref: '#/components/schemas/Carrier'
pageInfo:
$ref: '#/components/schemas/PaginationInfo'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'500':
$ref: '#/components/responses/InternalServerError'
/carriers:
post:
tags:
- Carriers
summary: Create a new carrier
description: 'Create a new carrier within an organization.
The carrier type must be specified and determines which fields are available:
- **TRUCKLOAD**: Includes insurance, safety rating, and FMCSA inspection fields
- **AIR, CARTAGE, LINEHAUL, LTL, OCEAN, RAIL**: Include only base carrier fields
Note: In the backend, null carrier type is represented as TRUCKLOAD in the public API.
'
operationId: createCarrier
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierInput'
examples:
truckload:
summary: Truckload carrier with insurance
value:
name: Swift Transportation Co
type: TRUCKLOAD
email: dispatch@swifttrans.com
phone: +1-555-987-6543
status: ACTIVE
mcNumber: MC-123456
dotNumber: '1234567'
insuranceCompany: State Farm Insurance
insuranceAutoLiabilityLimit: 1000000
rating: SATISFACTORY
inFmcsa: true
air:
summary: Air carrier
value:
name: FedEx Express
type: AIR
email: cargo@fedex.com
phone: +1-555-123-4567
status: ACTIVE
iataCode: FX
ltl:
summary: LTL carrier
value:
name: XPO Logistics
type: LTL
email: dispatch@xpo.com
phone: +1-555-456-7890
status: ACTIVE
scac: XPOL
responses:
'201':
description: Carrier created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Carrier'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'409':
$ref: '#/components/responses/ConflictError'
'500':
$ref: '#/components/responses/InternalServerError'
/carriers/{id}:
get:
tags:
- Carriers
summary: Get a carrier by ID
description: 'Retrieve a single carrier by its unique identifier.
The response will include type-specific fields based on the carrier''s type:
- **TRUCKLOAD**: Includes insurance, safety rating, and FMCSA inspection fields
- **AIR, CARTAGE, LINEHAUL, LTL, OCEAN, RAIL**: Include only base carrier fields
'
operationId: getCarrierById
parameters:
- $ref: '#/components/parameters/IdOrClientKey'
responses:
'200':
description: Carrier found
content:
application/json:
schema:
$ref: '#/components/schemas/Carrier'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
'500':
$ref: '#/components/responses/InternalServerError'
patch:
tags:
- Carriers
summary: Update a carrier
description: 'Partially update a carrier. Only provided fields will be updated.
- **Omitted fields**: Not modified (current value preserved)
- **Provided fields**: Updated to the new value
- **Null values**: Clear the field (set to null) where applicable
The carrier type determines which fields can be updated:
- **TRUCKLOAD**: Can update insurance, safety rating, and FMCSA fields
- **AIR, CARTAGE, LINEHAUL, LTL, OCEAN, RAIL**: Can only update base carrier fields
Changing the carrier type will affect which specialized fields are available.
'
operationId: updateCarrier
parameters:
- $ref: '#/components/parameters/IdOrClientKey'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierPatch'
responses:
'200':
description: Carrier updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Carrier'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
'409':
$ref: '#/components/responses/ConflictError'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
tags:
- Carriers
summary: Delete a carrier
description: 'Soft delete a carrier (sets deletedAt timestamp).
The carrier will no longer appear in default queries but can be retrieved
by explicitly filtering for deleted records.
'
operationId: deleteCarrier
parameters:
- $ref: '#/components/parameters/IdOrClientKey'
responses:
'204':
description: Carrier deleted successfully
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
'500':
$ref: '#/components/responses/InternalServerError'
/carriers/search:
post:
summary: Search carriers
description: 'Search carriers using OpenSearch-powered full-text and field-specific search.
This endpoint searches both:
- **ONBOARDED carriers**: Carriers with profiles in your organization
- **FMCSA carriers**: Public carrier records from FMCSA database
Features:
- Full-text search across multiple fields
- Field-specific filtering with various operators
- Sorting and pagination
- Saved search preferences
**Note:** Only active (non-deleted) carriers are searchable. Soft-deleted records are automatically excluded from all search results.
**Response Formats:**
- `flat` (default): Returns indexed fields only for faster performance
- `full`: Returns complete carrier objects with all relationships
'
operationId: searchCarriers
tags:
- Carriers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierSearchRequest'
responses:
'200':
description: Successful search results
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierSearchResponse'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/UnauthorizedError'
'422':
$ref: '#/components/responses/ValidationError'
'429':
$ref: '#/components/responses/RateLimitExceeded'
/carriers/{id}/outstanding-bills:
get:
summary: Get carrier outstanding bills
description: 'List outstanding (unpaid) bills for a carrier.
Returns bills with status `APPROVED_TO_PAY`.
'
operationId: getCarrierOutstandingBills
tags:
- Carriers
parameters:
- $ref: '#/components/parameters/IdOrClientKey'
- $ref: '#/components/parameters/LookupBy'
responses:
'200':
description: Outstanding bills retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/OutstandingBillsResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
/carriers/{id}/bills-for-payment:
get:
summary: Get carrier bills available for payment
description: 'List bills available for payment from a carrier.
Returns bills with status `APPROVED_TO_PAY` and open balance.
## Carrier factor
If the carrier has a factor configured, factor details are included.
'
operationId: getCarrierBillsForPayment
tags:
- Carriers
parameters:
- $ref: '#/components/parameters/IdOrClientKey'
- $ref: '#/components/parameters/LookupBy'
responses:
'200':
description: Bills for payment retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/OutstandingBillsForPaymentResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
components:
schemas:
RailCarrier:
allOf:
- $ref: '#/components/schemas/CarrierBase'
- type: object
description: Rail freight carrier
required:
- type
properties:
type:
type: string
enum:
- RAIL
description: Carrier type discriminator
example: RAIL
AddressPatch:
type: object
description: 'Partial address update. All fields are optional.
- **Omitted fields**: Not modified (current value preserved)
- **Provided fields**: Updated to the new value
- **Null values**: Clear the field (set to null) where applicable
'
properties:
line1:
type: string
description: Primary street address line
example: 123 Main St
line2:
type:
- string
- 'null'
description: Secondary address line
example: Suite 400
city:
type: string
description: City name
example: Chicago
country:
type: string
description: Country name or code
example: USA
market:
type: string
description: Market or region identifier
example: CHI
latitude:
type:
- string
- 'null'
description: Latitude coordinate
example: '41.8781'
longitude:
type:
- string
- 'null'
description: Longitude coordinate
example: '-87.6298'
isAirportOrAirbase:
type: boolean
description: Whether this location is an airport or airbase
example: false
isConstructionOrUtilitySite:
type: boolean
description: Whether this location is a construction or utility site
example: false
isSmartyValidated:
type: boolean
description: Whether address has been validated by SmartyStreets
example: true
obeysDst:
type: boolean
description: Whether this location observes daylight saving time
example: true
cityId:
type:
- string
- 'null'
format: uuid
description: Reference to standardized city record
example: null
CarrierFilter:
type: object
description: Filter criteria for carriers with AND/OR logic support
properties:
and:
type: array
description: All conditions must match (recursive)
items:
$ref: '#/components/schemas/CarrierFilter'
or:
type: array
description: At least one condition must match (recursive)
items:
$ref: '#/components/schemas/CarrierFilter'
not:
$ref: '#/components/schemas/CarrierFilter'
description: Negates the filter
id:
$ref: '#/components/schemas/IDFilter'
friendlyId:
$ref: '#/components/schemas/StringFilter'
name:
$ref: '#/components/schemas/StringFilter'
dbaName:
$ref: '#/components/schemas/StringFilter'
key:
$ref: '#/components/schemas/ClientKeyFilter'
email:
$ref: '#/components/schemas/StringFilter'
phone:
$ref: '#/components/schemas/StringFilter'
website:
$ref: '#/components/schemas/StringFilter'
status:
$ref: '#/components/schemas/StringFilter'
statusReason:
$ref: '#/components/schemas/StringFilter'
type:
$ref: '#/components/schemas/StringFilter'
mcNumber:
$ref: '#/components/schemas/StringFilter'
dotNumber:
$ref: '#/components/schemas/StringFilter'
scac:
$ref: '#/components/schemas/StringFilter'
einNumber:
$ref: '#/components/schemas/StringFilter'
ffNumber:
$ref: '#/components/schemas/StringFilter'
mxNumber:
$ref: '#/components/schemas/StringFilter'
rfcNumber:
$ref: '#/components/schemas/StringFilter'
iataCode:
$ref: '#/components/schemas/StringFilter'
isHazmat:
$ref: '#/components/schemas/BooleanFilter'
tsaApproved:
$ref: '#/components/schemas/BooleanFilter'
trucks:
$ref: '#/components/schemas/IntFilter'
trailers:
$ref: '#/components/schemas/IntFilter'
drivers:
$ref: '#/components/schemas/IntFilter'
powerUnits:
$ref: '#/components/schemas/IntFilter'
currency:
$ref: '#/components/schemas/StringFilter'
isFactoringPreferred:
$ref: '#/components/schemas/BooleanFilter'
goldenCarrierId:
$ref: '#/components/schemas/UUIDFilter'
paymentTermId:
$ref: '#/components/schemas/UUIDFilter'
rating:
$ref: '#/components/schemas/StringFilter'
ratingDate:
$ref: '#/components/schemas/DatetimeFilter'
operatingAbility:
$ref: '#/components/schemas/StringFilter'
inFmcsa:
$ref: '#/components/schemas/BooleanFilter'
insuranceCompany:
$ref: '#/components/schemas/StringFilter'
insuranceExpirationDate:
$ref: '#/components/schemas/DatetimeFilter'
createdAt:
$ref: '#/components/schemas/DatetimeFilter'
updatedAt:
$ref: '#/components/schemas/DatetimeFilter'
deletedAt:
$ref: '#/components/schemas/DatetimeFilter'
AirCarrier:
allOf:
- $ref: '#/components/schemas/CarrierBase'
- type: object
description: Air cargo carrier
required:
- type
properties:
type:
type: string
enum:
- AIR
description: Carrier type discriminator
example: AIR
DatetimeSearchCriteria:
type: object
required:
- operator
description: 'Search criteria for datetime fields.
Supports both absolute datetime values and relative time expressions.
'
properties:
operator:
type: string
enum:
- EQUALS
- NOT_EQUALS
- BEFORE
- AFTER
- BETWEEN
- NOT_BETWEEN
- EXISTS
- DOES_NOT_EXIST
description: 'Search operator:
- `EQUALS`: Exact match
- `NOT_EQUALS`: Not equal to
- `BEFORE`: Before datetime
- `AFTER`: After datetime
- `BETWEEN`: Between min and max (inclusive)
- `NOT_BETWEEN`: Not between min and max
- `EXISTS`: Field has a value (not null)
- `DOES_NOT_EXIST`: Field is null
'
value:
type: string
format: date-time
description: Absolute datetime for EQUALS, NOT_EQUALS
example: '2025-01-15T10:00:00Z'
min:
type: string
format: date-time
description: Minimum datetime for BETWEEN or NOT_BETWEEN
example: '2025-01-01T00:00:00Z'
max:
type: string
format: date-time
description: Maximum datetime for BETWEEN or NOT_BETWEEN
example: '2025-12-31T23:59:59Z'
valueRelative:
type: integer
description: 'Relative time from now (negative for past, positive for future).
Example: -7 with WEEK unit means 7 weeks ago.
'
valueRelativeUnit:
$ref: '#/components/schemas/RelativeTimeUnit'
minRelative:
type: integer
description: Relative time for min boundary
minRelativeUnit:
$ref: '#/components/schemas/RelativeTimeUnit'
maxRelative:
type: integer
description: Relative time for max boundary
maxRelativeUnit:
$ref: '#/components/schemas/RelativeTimeUnit'
example:
operator: AFTER
value: '2025-01-01T00:00:00Z'
KeywordSearchCriteria:
type: object
required:
- operator
description: Search criteria for keyword fields (exact match, no partial matching)
properties:
operator:
type: string
enum:
- EQUALS
- NOT_EQUALS
- ONE_OF
- NOT_ONE_OF
- EXISTS
- DOES_NOT_EXIST
description: 'Search operator:
- `EQUALS`: Exact match
- `NOT_EQUALS`: Not equal to
- `ONE_OF`: Matches any value in array
- `NOT_ONE_OF`: Does not match any value in array
- `EXISTS`: Field has a value (not null)
- `DOES_NOT_EXIST`: Field is null
'
values:
type: array
items:
type: string
description: Array of values for ONE_OF or NOT_ONE_OF operators
example:
- ACTIVE
- PENDING
example:
operator: ONE_OF
values:
- ACTIVE
- PENDING
OceanCarrierInput:
allOf:
- $ref: '#/components/schemas/CarrierInputBase'
- type: object
description: Input for creating an ocean carrier
required:
- type
properties:
type:
type: string
enum:
- OCEAN
description: Carrier type discriminator (must be OCEAN)
example: OCEAN
AirCarrierInput:
allOf:
- $ref: '#/components/schemas/CarrierInputBase'
- type: object
description: Input for creating an air carrier
required:
- type
properties:
type:
type: string
enum:
- AIR
description: Carrier type discriminator (must be AIR)
example: AIR
LtlCarrier:
allOf:
- $ref: '#/components/schemas/CarrierBase'
- type: object
description: Less-than-truckload (LTL) carrier
required:
- type
properties:
type:
type: string
enum:
- LTL
description: Carrier type discriminator
example: LTL
AddressInput:
type: object
description: Address data for creating a new location
required:
- line1
- city
- country
- market
properties:
line1:
type: string
description: Primary street address line
example: 123 Main St
line2:
type: string
description: Secondary address line (suite, floor, etc.)
example: Suite 400
city:
type: string
description: City name
example: Chicago
country:
type: string
description: Country name or code
example: USA
market:
type: string
description: Market or region identifier
example: CHI
latitude:
type: string
description: Latitude coordinate
example: '41.8781'
longitude:
type: string
description: Longitude coordinate
example: '-87.6298'
isAirportOrAirbase:
type: boolean
default: false
description: Whether this location is an airport or airbase
example: false
isConstructionOrUtilitySite:
type: boolean
default: false
description: Whether this location is a construction or utility site
example: false
isSmartyValidated:
type: boolean
default: false
description: Whether address has been validated by SmartyStreets
example: true
obeysDst:
type: boolean
default: true
description: Whether this location observes daylight saving time
example: true
cityId:
type: string
format: uuid
description: Reference to standardized city record (internal use)
UUIDSearchCriteria:
type: object
required:
- operator
description: Search criteria for UUID fields
properties:
operator:
type: string
enum:
- EQUALS
- NOT_EQUALS
- ONE_OF
- NOT_ONE_OF
- EXISTS
- DOES_NOT_EXIST
description: 'Search operator:
- `EQUALS`: Exact match
- `NOT_EQUALS`: Not equal to
- `ONE_OF`: Matches any UUID in array
- `NOT_ONE_OF`: Does not match any UUID in array
- `EXISTS`: Field has a value (not null)
- `DOES_NOT_EXIST`: Field is null
'
values:
type: array
items:
type: string
format: uuid
description: Array of UUIDs for ONE_OF or NOT_ONE_OF operators
example:
- 550e8400-e29b-41d4-a716-446655440000
- 550e8400-e29b-41d4-a716-446655440001
example:
operator: EQUALS
values:
- 550e8400-e29b-41d4-a716-446655440000
SearchPaginationInfo:
type: object
required:
- pageNumber
- pageSize
- totalPages
description: Pagination information for search results
properties:
pageNumber:
type: integer
description: Current page number
example: 1
pageSize:
type: integer
description: Number of results returned on this page
example: 50
totalPages:
type: integer
description: Total number of pages available
example: 25
example:
pageNumber: 1
pageSize: 50
totalPages: 25
UUIDFilter:
type: object
description: Filter options for UUID fields (all operations)
properties:
equalTo:
type: string
format: uuid
description: Exact match
notEqualTo:
type: string
format: uuid
description: Not equal to
in:
type: array
items:
type: string
format: uuid
description: Matches any UUID in the array
notIn:
type: array
items:
type: string
format: uuid
description: Does not match any UUID in the array
isNull:
type: boolean
description: Field is null (true) or not null (false)
LinehaulCarrier:
allOf:
- $ref: '#/components/schemas/CarrierBase'
- type: object
description: Linehaul (long-distance) carrier
required:
- type
properties:
type:
type: string
enum:
- LINEHAUL
description: Carrier type discriminator
example: LINEHAUL
BillEntityType:
type: string
enum:
- CARRIER
- VENDOR
description: 'Type of entity the bill is for.
- `CARRIER`: Bill for a carrier (LoadCarrier)
- `VENDOR`: Bill for a vendor service (VendedService)
'
CartageCarrierPatch:
allOf:
- $ref: '#/components/schemas/CarrierPatchBase'
- type: object
description: Partial update for cartage carrier
properties:
type:
type: string
enum:
- CARTAGE
description: Carrier type discriminator (optional - only needed if changing type)
example: CARTAGE
OutstandingBill:
type: object
properties:
id:
type: string
format: uuid
friendlyId:
type: string
entityType:
$ref: '#/components/schemas/BillEntityType'
carrier:
$ref: '#/components/schemas/CarrierReference'
vendor:
$ref: '#/components/schemas/VendorReference'
invoiceDate:
type:
- string
- 'null'
format: date
dueDate:
type:
- string
- 'null'
format: date
amount:
type: number
amountPaid:
type: number
openBalance:
type: number
isOverdue:
type: boolean
shipmentId:
type:
- string
- 'null'
format: uuid
shipmentFriendlyId:
type:
- string
- 'null'
RailCarrierPatch:
allOf:
- $ref: '#/components/schemas/CarrierPatchBase'
- type: object
description: Partial update for rail carrier
properties:
type:
type: string
enum:
- RAIL
description: Carrier type discriminator (optional - only needed if changing type)
example: RAIL
VendorReference:
type: object
description: 'Enhanced reference to a vendor profile.
Incl
# --- truncated at 32 KB (121 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mvmnt/refs/heads/main/openapi/mvmnt-carriers-api-openapi.yml