List all carriers

GET 
/v1/carriers

Returns the list of configured carriers

Responses

200

application/json

Schema

Schema

• Array [

carrier_name stringrequired

Possible values: [allied_express, allied_express_local, amazon_shipping, aramex, asendia_us, australiapost, boxknight, bpost, canadapost, canpar, chronopost, colissimo, dhl_express, dhl_parcel_de, dhl_poland, dhl_universal, dicom, dpd, dpdhl, easypost, easyship, eshipper, fedex, fedex_ws, freightcom, generic, geodis, hay_post, laposte, locate2u, nationex, purolator, roadie, royalmail, sapient, seko, sendle, tge, tnt, ups, usps, usps_international, usps_wt, usps_wt_international, zoom2u]

Indicates a carrier (type)

display_name stringrequired

The carrier verbose name.

capabilities string[]

Default value: ``

The carrier supported and enabled capabilities.

connection_fields

object

The carrier connection fields.

property name* any

Default value: [object Object]

The carrier connection fields.

config_fields

object

The carrier connection config.

property name* any

Default value: [object Object]

The carrier connection config.

• ]

Example (from schema)

[
  {
    "carrier_name": "allied_express",
    "display_name": "string",
    "capabilities": [
      "string"
    ],
    "connection_fields": {},
    "config_fields": {}
  }
]

CarrierList

Carrier List

[
  {
    "carrier_name": "dhl_express",
    "display_name": "DHL Express",
    "connection_fields": {
      "site_id": {
        "name": "site_id",
        "required": true,
        "type": "string"
      },
      "password": {
        "name": "password",
        "required": true,
        "type": "string"
      },
      "account_number": {
        "name": "account_number",
        "required": false,
        "type": "string"
      }
    },
    "capabilities": [
      "paperless",
      "shipping",
      "tracking",
      "rating",
      "pickup"
    ],
    "config_fields": {
      "label_type": {
        "code": "label_type",
        "name": "label_type",
        "required": false,
        "type": "string"
      },
      "skip_service_filter": {
        "code": "skip_service_filter",
        "name": "skip_service_filter",
        "required": false,
        "type": "string"
      },
      "shipping_options": {
        "code": "shipping_options",
        "name": "shipping_options",
        "required": false,
        "type": "list"
      },
      "shipping_services": {
        "code": "shipping_services",
        "name": "shipping_services",
        "required": false,
        "type": "list"
      }
    }
  }
]

500

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

Loading...