D&H Business Community icon

D&H Business Community

Interact with D&H Catalog and Customer Order Management APIs

Actions13

Carrier → Get Carriers

AI-generated

Summary

Fetch carriers from the D&H Business Community API for a given tenant and account number, optionally filtering by shipment mode and using paginated or scroll-based retrieval.

Inputs

  • tenant (required) — D&H company tenant (options: dhus – D&H US, dhca – D&H Canada, dsc – DSC)
  • accountNumber (required) — The 10‑digit customer account number
  • pageSize — Number of carriers to return per page (minimum 1, default 50)
  • scrollId — Scroll ID for pagination (empty to start)
  • returnAll — When true, retrieves all carriers using scroll pagination; when false (default) returns a single page
  • shipMode — Filter carriers by shipment mode (options: parcel, lessThanTruckload, fullTruckload)

Output shape

Array of carrier objects (the API’s 'elements' field).

If returnAll is false, the array contains up to pageSize items from the first page. If returnAll is true, the array contains all carriers across all pages, concatenated.

Examples

Example 1: Get the first 50 carriers for a US account

tenant: dhus, accountNumber: 1234567890, pageSize: 50, returnAll: false

Example 2: Retrieve all parcel carriers for a Canadian account

tenant: dhca, accountNumber: 0987654321, shipMode: parcel, returnAll: true

Links

Discussion