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

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
carrierId
string
required

The carrier ID.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

The carrier credential set data.

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
​
carrierId
string | null

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

​
code
string | null

A unique code identifying this credential set. The code is only guaranteed to be unique at the tenant and carrier level.

​
integrationId
string | null

Specifies the ID returned from an integration.

​
name
string | null

A name (i.e., nickname) for this credential set.

​
values
object[] | null

A collection of values contained in this credential set.

Response

Success

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
​
carrierId
string | null

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

​
code
string | null

A unique code identifying this credential set. The code is only guaranteed to be unique at the tenant and carrier level.

​
integrationId
string | null

Specifies the ID returned from an integration.

​
name
string | null

A name (i.e., nickname) for this credential set.

​
values
object[] | null

A collection of values contained in this credential set.