Skip to main content

A carrier relationship represents the relationship between a carrier and an organization, including their onboarding status and whether they can be assigned to freight.

If a carrier relationship is not found, the carrier will be offered an onboarding link but will not be assigned to freight until a relationship is created.

A NEEDS_REVIEW but onboarded carrier still requires manual review prior to being assigned to freight. An ACTIVE but not onboarded carrier can be assigned to freight but the carrier is still offered an onboarding link.

DO_NOT_DISPATCH should be used to block a carrier from being assigned to freight at an organization level. Use freight level rules to block a carrier from being assigned to specific freight.

​
id
string
required
​
organizationId
string
required
​
carrierOrganizationId
string
required
​
status
enum<string>
required

  • ACTIVE: The carrier is active with the organization and ready to be assigned to freight.

  • NEEDS_REVIEW: The carrier needs review prior to being assigned to freight.

  • DO_NOT_DISPATCH: The carrier is not allowed to be assigned to freight, and will not see

    any freight in the marketplace.

Available options:
ACTIVE,
NEEDS_REVIEW,
DO_NOT_DISPATCH
​
onboardingStatus
enum<string>
required

There are 2 possible values for a carrier relationship status:

  • ONBOARDED: The carrier is onboarded.
  • NEEDS_TO_ONBOARD: The carrier needs to be onboarded, even if they have been onboarded before.
Available options:
ONBOARDED,
NEEDS_TO_ONBOARD
​
source
enum<string>
Available options:
API,
USER