/carriers

post

https://api.dev.orbit.do/v5/carriers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

carrier to create

name

string

required

length ≥ 1

The carrier company's name.

contactName

string

deprecated

Deprecated — use entityInfo instead. Primary contact person's name.

phone

string

deprecated

Deprecated — use entityInfo.phone instead. Contact phone number.

^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

General contact email address of the carrier company.

address

object

deprecated

Deprecated — use entityInfo.address instead. Company address.

entityInfo

object

regions

array of strings

required

Region ids this carrier covers; drive dispatch eligibility and carrier-selection filtering. Each entry is a Region id, not a name.

regions*

status

string

enum

required

Directory status: whether the carrier is currently usable for assignment (Active) or not (Inactive).

Allowed:

updatedAtMilliseconds

number

Last-update timestamp in epoch MILLISECONDS (milliseconds, unlike createdAt which is seconds).

properties

object | null

Custom property values keyed by the tenant's PropertyDefinition id.

extras

array of strings

Carrier-level certification flags (e.g. CarrierADR, HACCP) this carrier holds; gate which work it is eligible for.

extras

Allowed:

type

string

enum

Whether the carrier executes tours through Orbit's own apps ('native') or an external transport API ('integrated'). Omitted defaults to native.

Allowed:

transportMode

string

enum

How this carrier executes legs, for the emissions calculation. A leg's transport mode resolves in this order: the purchasing product's transportMode, then this carrier's, then the integration provider's default, else directTrip. Omitted means unset.

Allowed:

integration

Integration config, present only for type 'integrated'. Credential values are masked on read.

Responses

401

unauthorized

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200created carrier