Connections
Retrieve a connection
Retrieve carrier connection.
get/v1/connections/{id}
Path parameters
idstring required
Response
idstring required
A unique carrier connection identifier
object_typestring
Specifies the object type
carrier_name'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' required
A carrier connection type.
display_namestring
The carrier connection type verbose name.
carrier_idstring required
A carrier connection friendly name.
capabilitiesstring[] nullable
The carrier enabled capabilities.
configobject
Carrier connection custom config.
metadataobject
User metadata for the carrier.
is_systemboolean required
The carrier connection is provided by the system admin.
activeboolean required
The active flag indicates whether the carrier account is active or not.
test_modeboolean required
The test flag indicates whether to use a carrier configured for test.
Changes
No recorded changes to this endpoint across all 1 revision of this API.