---
title: "Update Carrier Configuration"
method: PUT
path: "/commerce/shipping/admin/carriers/{carrierId}"
tags: ["CarrierConfiguration"]
---

# Update Carrier Configuration

`PUT /commerce/shipping/admin/carriers/{carrierId}`

Update an existing carrier configuration. The settings[] field is deprecated and no longer needs to be provided when working with credential sets.

## Path parameters

- `carrierId` string, required

## Query parameters

- `responseFields` string

## Request body

- CarrierConfiguration
  - `areCredentialsSet` boolean — Indicates whether the credentials/passwords are set. <remarks>Credetials are updated only if this flag is set to true</remarks>
  - `auditInfo` AdminUserAuditInfo
    - `createBy` string, nullable
    - `createDate` string, date-time, nullable
    - `updateBy` string, nullable
    - `updateDate` string, date-time, nullable
  - `customTableRates` CustomTableRate[], nullable — A list of custom table rates for the 'Custom' carrier <remarks>only use this if Id == 'Custom'</remarks>
    - `content` CustomTableRateContent
      - `localeCode` string, nullable
      - `name` string, nullable
    - `deliveryDuration` string, nullable — The number of days it takes to ship the item on custom carrier types. Allowed values : EXPRESS, 1_DAY, 2_DAY, 3_DAY
    - `id` string, nullable — The Id of the CustomTableRate
    - `rateType` string, nullable — The type of this rate <value>see ../commerce/catalog/admin/shipping/global/carriers/custom/serviceTypes/en-us</value>
    - `value` number, double — The value of this custom table rate
  - `enabled` boolean — Indicates that this CarrierConfiguration should be used at runtime
  - `enabledForReturns` boolean — Indicates that this CarrierConfiguration should be the default for returns shipping
  - `id` string, nullable — Carrier Id (usually a shortname of a carrier, e.g. FedEx)
  - `isDeliveryMethod` boolean
  - `settings` Setting[], nullable — Carrier Configuration Settings
    - `key` string, nullable
    - `value` string, nullable

## Response `200`

Success

- CarrierConfiguration
  - `areCredentialsSet` boolean — Indicates whether the credentials/passwords are set. <remarks>Credetials are updated only if this flag is set to true</remarks>
  - `auditInfo` AdminUserAuditInfo
    - `createBy` string, nullable
    - `createDate` string, date-time, nullable
    - `updateBy` string, nullable
    - `updateDate` string, date-time, nullable
  - `customTableRates` CustomTableRate[], nullable — A list of custom table rates for the 'Custom' carrier <remarks>only use this if Id == 'Custom'</remarks>
    - `content` CustomTableRateContent
      - `localeCode` string, nullable
      - `name` string, nullable
    - `deliveryDuration` string, nullable — The number of days it takes to ship the item on custom carrier types. Allowed values : EXPRESS, 1_DAY, 2_DAY, 3_DAY
    - `id` string, nullable — The Id of the CustomTableRate
    - `rateType` string, nullable — The type of this rate <value>see ../commerce/catalog/admin/shipping/global/carriers/custom/serviceTypes/en-us</value>
    - `value` number, double — The value of this custom table rate
  - `enabled` boolean — Indicates that this CarrierConfiguration should be used at runtime
  - `enabledForReturns` boolean — Indicates that this CarrierConfiguration should be the default for returns shipping
  - `id` string, nullable — Carrier Id (usually a shortname of a carrier, e.g. FedEx)
  - `isDeliveryMethod` boolean
  - `settings` Setting[], nullable — Carrier Configuration Settings
    - `key` string, nullable
    - `value` 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)