Item Logo
Yms apiCarrier level 1

POST Search Carriers

POST Search Carriers

Introduction

Searches and retrieves carriers with pagination support and multiple filter criteria. This API allows filtering by carrier name, SCAC code, USDOT number, MC number, verification status, and carrier status. Supports both exact match and regex pattern matching for flexible searching. Commonly used in carrier selection dropdowns and carrier management interfaces.

API Request

POST /public/carrier/search-by-paging

Body Request Parameters

Request Parameters

Name

Location

Type

Required

Description

X-Tenant-ID

header

string

No

none

X-Yard-ID

header

string

No

none

Item-Time-Zone

header

string

No

none

Authorization

header

string

No

none

externalCarrierId

body

string

No

External carrier identifier for cross-system mapping (max 128 chars)

body

body

CarrierQuery

No

none

Response Example

200 Response

Response

Status Code

Definition

Description

Data Model

200

OK

none

RPageResultCarrierView