Skip to main content
GET
/
commerce
/
shipping
/
admin
/
carriers
/
credentials
/
{carrierId}
Error
A valid request URL is required to generate request examples
{
  "carrierId": "<string>",
  "siteId": 123,
  "locationGroupCode": "<string>",
  "locationCode": "<string>",
  "credentialSet": {
    "carrierId": "<string>",
    "code": "<string>",
    "name": "<string>",
    "values": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "integrationId": "<string>",
    "auditInfo": {
      "updateDate": "2023-11-07T05:31:56Z",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "createBy": "<string>"
    }
  },
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
carrierId
string
required

The carrier ID.

Query Parameters

​
siteId
integer<int32>

The site ID, if any.

​
locationGroupCode
string

The location group code, if any.

​
locationCode
string

The location code, if any.

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Stores a reference to a Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredentialSet for use at different levels. Valid levels include Site, Location Group, and Location. Different levels may be used for rates versus labels. Site level is overriden by Location Group level which is overriden by Location level.

​
carrierId
string | null

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

​
siteId
integer<int32> | null

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

​
locationGroupCode
string | null

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

​
locationCode
string | null

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

​
credentialSet
object

Stores a set of carrier credential key-value pairs. Sets are stored at the tenant level and referenced by a Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredential.

​
auditInfo
object