Skip to main content
GET
/
commerce
/
shipping
/
admin
/
carriers
Error
A valid request URL is required to generate request examples
{
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "id": "<string>",
      "enabled": true,
      "enabledForReturns": true,
      "settings": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "customTableRates": [
        {
          "id": "<string>",
          "content": {
            "localeCode": "<string>",
            "name": "<string>"
          },
          "rateType": "<string>",
          "value": 123,
          "deliveryDuration": "<string>"
        }
      ],
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "areCredentialsSet": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

​
startIndex
integer<int32>
default:0

Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional.

​
pageSize
integer<int32>
default:0

Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.

​
sortBy
string

The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.

​
filter
string

A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Collection of carrrier configurations.

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