Skip to main content
GET
/
commerce
/
shipping
/
admin
/
carriers
/
{carrierId}
Error
A valid request URL is required to generate request examples
{
  "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.

Path Parameters

carrierId
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

id
string | null

Carrier Id (usually a shortname of a carrier, e.g. FedEx)

enabled
boolean

Indicates that this CarrierConfiguration should be used at runtime

enabledForReturns
boolean

Indicates that this CarrierConfiguration should be the default for returns shipping

settings
object[] | null

Carrier Configuration Settings

customTableRates
object[] | null

A list of custom table rates for the 'Custom' carrier only use this if Id == 'Custom'

auditInfo
object
areCredentialsSet
boolean

Indicates whether the credentials/passwords are set. Credetials are updated only if this flag is set to true