Skip to main content
GET
/
commerce
/
shipping
/
admin
/
carriers
/
credentials
Error
A valid request URL is required to generate request examples
{
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "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.

Query Parameters

startIndex
integer<int32>

The starting index.

pageSize
integer<int32>

The page size.

sortBy
string

Any sorting filters.

filter
string

Any query filters.

responseFields
string

limits which fields are returned in the response body

Response

Success

A collection of carrier credentials.

startIndex
integer<int32>
pageSize
integer<int32>
pageCount
integer<int32>
totalCount
integer<int32>
items
object[] | null