Get carrier services

GET 
/v1/carriers/:carrier_name/services

Retrieve a carrier's services

Request

Path Parameters

carrier_name stringrequired

The unique carrier slug.
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

Responses

200

application/json

Schema

Schema

property name* any

Example (from schema)

{}

CarrierList

Carrier List

{
  "canadapost_regular_parcel": "DOM.RP",
  "canadapost_expedited_parcel": "DOM.EP",
  "canadapost_xpresspost": "DOM.XP",
  "canadapost_xpresspost_certified": "DOM.XP.CERT",
  "canadapost_priority": "DOM.PC",
  "canadapost_library_books": "DOM.LIB",
  "canadapost_expedited_parcel_usa": "USA.EP",
  "canadapost_priority_worldwide_envelope_usa": "USA.PW.ENV",
  "canadapost_priority_worldwide_pak_usa": "USA.PW.PAK",
  "canadapost_priority_worldwide_parcel_usa": "USA.PW.PARCEL",
  "canadapost_small_packet_usa_air": "USA.SP.AIR",
  "canadapost_tracked_packet_usa": "USA.TP",
  "canadapost_tracked_packet_usa_lvm": "USA.TP.LVM",
  "canadapost_xpresspost_usa": "USA.XP",
  "canadapost_xpresspost_international": "INT.XP",
  "canadapost_international_parcel_air": "INT.IP.AIR",
  "canadapost_international_parcel_surface": "INT.IP.SURF",
  "canadapost_priority_worldwide_envelope_intl": "INT.PW.ENV",
  "canadapost_priority_worldwide_pak_intl": "INT.PW.PAK",
  "canadapost_priority_worldwide_parcel_intl": "INT.PW.PARCEL",
  "canadapost_small_packet_international_air": "INT.SP.AIR",
  "canadapost_small_packet_international_surface": "INT.SP.SURF",
  "canadapost_tracked_packet_international": "INT.TP"
}

404

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": {}
    }
  ]
}

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...