GOgoaugment
Carrier Management

Create or update carrier

Create a new carrier or update an existing one. This endpoint supports three operations:

  • Creation: Provide all required fields to create a new carrier.

  • Partial Update: Include only the fields you want to update. Carriers are matched by tmsId, so provide the tmsId of the carrier you want to update.

  • Full Update: Include all fields to completely replace the carrier data.

For updating managers and contacts, it is highly recommended to provide tmsId for each manager and contact when creating them. This allows the system to match and update existing managers/contacts by their tmsId during subsequent updates. If tmsId is not provided for managers or contacts, you will need to clear the entire array and re-add all managers/contacts when updating.

post/v1/carriers

Request

Request body

namestring required

Carrier name (required)

tmsIdstring required

TMS identifier for the carrier. Used for matching existing carriers. Cannot be changed after creation.

mcNumberinteger

MC number

dotNumberinteger

DOT number

scacstring

SCAC code

emailstring email

Carrier email address.

phonestring

Phone number in E.164 format (e.g., +13125551234).

phoneExtensionstring

Phone extension.

notesstring

Free-form notes about the carrier.

customDataCarrierCustomData

Optional metadata for the carrier. Use string keys; each value may be a string, number, boolean, array of JSON-safe values, or nested object with the same rules. Omit or send {} when you have nothing to store.

Example request

{
  "customData": {
    "tier": "gold",
    "score": 98.5,
    "verified": true,
    "aliases": [
      "Acme Freight",
      "Acme Carriers LLC"
    ],
    "routing": {
      "defaultRegion": "NS",
      "allowCrossBorder": false
    }
  }
}

Response

Carrier created or updated successfully

idstring

Carrier ID (ULID)

namestring

Carrier name

tmsIdstring nullable

TMS identifier for the carrier

mcNumberinteger nullable

MC number

dotNumberinteger nullable

DOT number

scacstring nullable

SCAC code

emailstring nullable

Carrier email address

phonestring nullable

Phone number in E.164 format (e.g., +13125551234)

phoneExtensionstring nullable

Phone extension

notesstring nullable

Free-form notes about the carrier

customDataCarrierCustomData

Optional metadata for the carrier. Use string keys; each value may be a string, number, boolean, array of JSON-safe values, or nested object with the same rules. Omit or send {} when you have nothing to store.

Example response

{
  "customData": {
    "tier": "gold",
    "score": 98.5,
    "verified": true,
    "aliases": [
      "Acme Freight",
      "Acme Carriers LLC"
    ],
    "routing": {
      "defaultRegion": "NS",
      "allowCrossBorder": false
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.