Skip to main content

List carrier connections

GET 

/v1/connections

Retrieve all carrier connections

Request

Query Parameters

    active boolean
    carrier_name string

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

    metadata_key string
    metadata_value string
    system_only boolean

Responses

Schema

    count integernullable
    next urinullable
    previous urinullable

    results

    object[]

    required

  • Array [

  • id stringrequired

    A unique carrier connection identifier

    object_type string

    Default value: carrier-connection

    Specifies the object type

    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, 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]

    A carrier connection type.

    display_name string

    The carrier connection type verbose name.

    carrier_id stringrequired

    A carrier connection friendly name.

    credentials

    object

    oneOf

    api_key stringrequired
    capabilities string[]nullable

    The carrier enabled capabilities.

    config

    object

    Carrier connection custom config.

    property name* any

    Default value: [object Object]

    Carrier connection custom config.

    metadata

    object

    User metadata for the carrier.

    property name* any

    Default value: [object Object]

    User metadata for the carrier.

    is_system booleanrequired

    The carrier connection is provided by the system admin.

    active booleanrequired

    The active flag indicates whether the carrier account is active or not.

    test_mode booleanrequired

    The test flag indicates whether to use a carrier configured for test.

  • ]

Loading...