CarrierCredential

Update Carrier Credentials

Updates existing carrier credentials. See <a href="/pages/shipping-carriers-api-overview">this guide</a> for details about the fields that are required for each carrier.

put/commerce/shipping/admin/carriers/credentials/{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/credentials/{carrierId}
  • Auth
    HTTP bearer

Path parameters

carrierIdstring required

The carrier ID.

Query parameters

siteIdinteger

The site ID, if any.

locationGroupCodestring

The location group code, if any.

locationCodestring

The location code, if any.

responseFieldsstring

limits which fields are returned in the response body

Request body

carrierIdstring nullable

The Carrier ID associated with this carrier credential. Usually the short name of a carrier (e.g., "FedEx").

locationCodestring nullable

The Location Code associated with this carrier credential, if any.

locationGroupCodestring nullable

The Location Group Code associated with this carrier credential, if any.

siteIdinteger nullable

The Site ID associated with this carrier credential, if any.

Response

Success

carrierIdstring nullable

The Carrier ID associated with this carrier credential. Usually the short name of a carrier (e.g., "FedEx").

locationCodestring nullable

The Location Code associated with this carrier credential, if any.

locationGroupCodestring nullable

The Location Group Code associated with this carrier credential, if any.

siteIdinteger nullable

The Site ID associated with this carrier credential, if any.

Changes

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