POST Update Carrier
POST Update Carrier
Introduction
Updates an existing carrier's information including name, identification numbers, verification status, and organization associations. This API is used when carrier details change or when updating the carrier's operational status. All carrier attributes can be modified except the carrier ID, which remains immutable.
API Request
POST /public/carrier/{carrierId}/update
Body Request Parameters
Request Parameters
Name | Location | Type | Required | Description |
|---|---|---|---|---|
carrierId | path | string | Yes | none |
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 | CarrierUpdateCmd | No | none |
Response Example
200 Response
Response
Status Code | Definition | Description | Data Model |
|---|---|---|---|
200 | OK | none | RCarrierView |