Skip to main content
GET
/
commerce
/
shipping
/
admin
/
carriers
/
definitions
Error
A valid request URL is required to generate request examples
[
  {
    "carrierId": "<string>",
    "isBuiltIn": true,
    "certified": true,
    "name": "<string>",
    "description": "<string>",
    "logoUrl": "<string>",
    "features": [
      "<string>"
    ],
    "configFields": [
      {
        "name": "<string>",
        "dataType": "String",
        "required": true,
        "localizations": [
          {
            "localeCode": "<string>",
            "label": "<string>",
            "description": "<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

responseFields
string

limits which fields are returned in the response body

Response

Success

carrierId
string | null
isBuiltIn
boolean
certified
boolean | null
name
string | null
description
string | null
logoUrl
string | null
features
string[] | null
configFields
object[] | null
auditInfo
object