CarrierConfiguration

Update Carrier Configuration

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

put/commerce/shipping/admin/carriers/{carrierId}

Request

  • Base URL
    https://t1000000.sb.usc1.gcp.kibocommerce.com/api
  • URL
    https://t1000000.sb.usc1.gcp.kibocommerce.com/api/commerce/shipping/admin/carriers/{carrierId}
  • Auth
    HTTP bearer

Path parameters

carrierIdstring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Request body

areCredentialsSetboolean

Indicates whether the credentials/passwords are set. <remarks>Credetials are updated only if this flag is set to true</remarks>

enabledboolean

Indicates that this CarrierConfiguration should be used at runtime

enabledForReturnsboolean

Indicates that this CarrierConfiguration should be the default for returns shipping

idstring nullable

Carrier Id (usually a shortname of a carrier, e.g. FedEx)

isDeliveryMethodboolean

Response

Success

areCredentialsSetboolean

Indicates whether the credentials/passwords are set. <remarks>Credetials are updated only if this flag is set to true</remarks>

enabledboolean

Indicates that this CarrierConfiguration should be used at runtime

enabledForReturnsboolean

Indicates that this CarrierConfiguration should be the default for returns shipping

idstring nullable

Carrier Id (usually a shortname of a carrier, e.g. FedEx)

isDeliveryMethodboolean

Changes

No recorded changes to this operation across all 1 revision of this API.