---
title: "CarrierMatchResponse"
url: "https://stage-api-docs.centraldispatch.com/apis/stage-membership-api-1-0-0/versions/50dc9109-f861-4ac9-a838-9ba774c3df98/schemas/CarrierMatchResponse"
---

> Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-membership-api-1-0-0/versions/50dc9109-f861-4ac9-a838-9ba774c3df98.md

# CarrierMatchResponse

A carrier matched for a listing, enriched with rating, tenure, contact, and network information.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Membership API
  version: 1.0.0
servers:
  - url: https://membership-api.centraldispatch.com
    description: Production server
components:
  schemas:
    AddressResponse:
      type: object
      properties:
        streetAddress:
          type: string
          description: The street address.
          nullable: true
          example: 345 W Elm St.
        streetAddress2:
          type: string
          description: Additional street address line.
          nullable: true
          example: 2nd Floor
        city:
          type: string
          description: The city.
          nullable: true
          example: Anaheim
        state:
          type: string
          description: The state.
          nullable: true
          example: CA
        zipcode:
          type: string
          description: The ZIP code. Must be a valid United States ZIP code or Canadian
            postal code.
          nullable: true
          example: "92802"
        type:
          type: string
          description: The type of address (e.g., PRIMARY, LOCAL, BILLING).
          nullable: true
          example: PRIMARY
      description: Details of a customer's address.
    CarrierRating:
      type: object
      properties:
        averageRatings:
          type: number
          description: Average rating across the period.
          format: double
          example: 4.7
        totalRatings:
          type: integer
          description: Number of ratings the average is computed from.
          format: int32
          example: 42
        periodDays:
          type: integer
          description: Rating window in days; `null` means lifetime, `90` means the recent
            (90-day) window.
          format: int32
          nullable: true
          example: 90
      description: A carrier's rating summary for a given period.
      nullable: true
    CarrierWarning:
      type: object
      properties:
        code:
          type: string
          description: Namespaced warning code (`carrier.fmcsa.*` or `carrier.audit.*`).
          nullable: true
          example: carrier.fmcsa.authority_revoked
        message:
          type: string
          description: Human-readable warning description.
          nullable: true
          example: FMCSA operating authority has been revoked.
      description: An advisory warning about a matched carrier.
    CarrierMatchResponse:
      type: object
      properties:
        href:
          type: string
          description: Canonical self URL for the carrier's customer resource.
          nullable: true
          example: https://membership-api.centraldispatch.com/customers/id/0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
        customerId:
          type: string
          description: The Central Dispatch customer ID of the customer.
          format: uuid
          example: 0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
        customerName:
          type: string
          description: The carrier name.
          nullable: true
          example: Acu Logistics
        address:
          $ref: "#/components/schemas/AddressResponse"
        phone:
          type: string
          description: The carrier's business phone number.
          nullable: true
          example: 800-555-0142
        establishedIn:
          type: string
          description: The year the company was established.
          nullable: true
          example: "1998"
        joinedOn:
          type: string
          description: The date the company joined the platform, in UTC/ISO 8601 format.
          format: date-time
          nullable: true
          example: 2024-09-10T00:00:00Z
        usDotAuthorizedState:
          type: string
          description: The state under which the carrier's USDOT number is authorized to
            operate, if on file; otherwise `null`.
          nullable: true
          example: OH
        overallRating:
          $ref: "#/components/schemas/CarrierRating"
        recentRating:
          $ref: "#/components/schemas/CarrierRating"
        isPreferred:
          type: boolean
          description: Whether this carrier is in the calling shipper's preferred-carrier
            network.
          example: true
        warnings:
          type: array
          items:
            $ref: "#/components/schemas/CarrierWarning"
          description: Collection of advisory warnings derived from FMCSA and audit data.
          nullable: true
      description: A carrier matched for a listing, enriched with rating, tenure,
        contact, and network information.
```