Network mode

Network mode is for carrier and LSP networks, marketplaces and alliances whose members serve first, middle or last mile. This reference lists only the operations a Network implementation exposes, following the mode profile in Modes §2. Switch modes from the REST Interface tab menu at the top of the page.

Module	In this mode	Operations	Count
`core`	Required	Rates, Shipments, Tracking, Events, Carriers, Batches, Test Helpers, Discovery	32
`webhooks`	Required	Webhooks, Inbound	11
`pickups`	Required	Pickups, Pickup Schedules	17
`manifests`	Optional	Manifests	6
`documents`	Optional	Files, Document Uploads	9
`connections`	Optional	Connections	9
`platform`	Required	Accounts	5
`catalog`	Required	Catalog	1
`pricing`	Required	GraphQL Interface only	—
`trade`	Optional	Trade	16
`routes`	Required	Routes	2
`fleet`	Optional	GraphQL Interface only	—
`injection`	Required	Injection	10
`products`	Optional	Products	10
`network`	Required	GraphQL Interface only	—
`iot`	Optional	IoT	3
`consolidation`	Required	Consolidation	1
`templates`	Optional	Templates	16
`integrations`	Required	Integrations	14
`jobs`	Required	Jobs	7
`inventory`	Optional	Inventory	7
`billing`	Required	Billing	20
`data_network`	Optional	Data Network	25

Required modules are grouped first in the sidebar, optional ones after. Every module is part of this mode. The machine-readable file for this mode is /openapi/network.yaml. The complete document, with every module, is /openapi.yaml.

Overview

Required modules

Optional modules