Get carrier configuration information

Get Carrier Configuration (for this particular site)

GET /commerce/shipping/admin/carriers/{carrierId}

Error

A valid request URL is required to generate request examples

200

{
  "areCredentialsSet": true,
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "customTableRates": [
    {
      "content": {
        "localeCode": "<string>",
        "name": "<string>"
      },
      "deliveryDuration": "<string>",
      "id": "<string>",
      "rateType": "<string>",
      "value": 123
    }
  ],
  "enabled": true,
  "enabledForReturns": true,
  "id": "<string>",
  "settings": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}

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

200

application/json

Success

areCredentialsSet · boolean

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

auditInfo · object

Show child attributes

customTableRates · object[] | null

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

Show child attributes

enabled · boolean

Indicates that this CarrierConfiguration should be used at runtime

enabledForReturns · boolean

Indicates that this CarrierConfiguration should be the default for returns shipping

id · string | null

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

settings · object[] | null

Carrier Configuration Settings

Show child attributes