Get Carrier Definitions

Retrieves all shipping carrier definitions for the specified tenant

GET /commerce/shipping/admin/carriers/definitions

Error

A valid request URL is required to generate request examples

200

[
  {
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "carrierId": "<string>",
    "certified": true,
    "configFields": [
      {
        "dataType": "String",
        "localizations": [
          {
            "description": "<string>",
            "label": "<string>",
            "localeCode": "<string>"
          }
        ],
        "name": "<string>",
        "required": true
      }
    ],
    "description": "<string>",
    "features": [
      "<string>"
    ],
    "isBuiltIn": true,
    "logoUrl": "<string>",
    "name": "<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

200

application/json

Success

auditInfo · object

Show child attributes

carrierId · string | null

certified · boolean | null

configFields · object[] | null

Show child attributes

description · string | null

features · string[] | null

isBuiltIn · boolean

logoUrl · string | null

name · string | null