---
title: "Get Carrier Definition"
method: GET
path: "/commerce/shipping/admin/carriers/definitions/{carrierId}"
tags: ["CarrierDefinition"]
---

# Get Carrier Definition

`GET /commerce/shipping/admin/carriers/definitions/{carrierId}`

Retrieves the carrier definition for the specified carrier

## Path parameters

- `carrierId` string, required

## Query parameters

- `responseFields` string

## Response `200`

Success

- CarrierDefinition — A carrier definition including config field metadata. Can either be a built-in system carrier or an Extensible Carrier installed via a <see cref="T:Mozu.ShippingAdmin.Contracts.Carriers.CarrierInstallation">carrier installation</see>.
  - `auditInfo` AdminUserAuditInfo
    - `createBy` string, nullable
    - `createDate` string, date-time, nullable
    - `updateBy` string, nullable
    - `updateDate` string, date-time, nullable
  - `carrierId` string, nullable
  - `certified` boolean, nullable
  - `configFields` CarrierCredentialSetMetadata[], nullable
    - `dataType` 'String' | 'Integer' | 'Boolean' | 'Password' — The type of field stored in a Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredentialSetMetadata item.
    - `localizations` CarrierCredentialSetMetadataLocalizedContent[], nullable
      - `description` string, nullable
      - `label` string, nullable
      - `localeCode` string, nullable
    - `name` string, nullable
    - `required` boolean
  - `description` string, nullable
  - `features` string[], nullable
  - `isBuiltIn` boolean
  - `logoUrl` string, nullable
  - `name` string, nullable

---

[API](https://skmtc.net/kibocommerce/apis/customer.md) · [All operations](https://skmtc.net/kibocommerce/apis/customer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kibocommerce/customer/versions/47c0cf7b75ab/schema)