Connect External Carrier Element
The Connect External Carrier Element allows users to connect their own existing external carrier account.
For more information about External Carrier Connections, refer to the full carrier connection documentation.
To view and manage previously connected accounts, and to add additional external carrier accounts, we recommend instantiating the Manage External Carriers Element.
Configuring Carriers
By providing a value to the carrierName
prop, the Connect External Carrier Element will populate a form with the required fields relevant to the carrier specified.
If carrierName
is not provided, users will be able to select a carrier to connect from a list of carriers specified within the globalFeatures.enabledExternalCarriers
array within the features prop.
For an in depth overview of the global features
object, please review the Configuring Elements Features step in either the ElementsProvider or the Elements SDK guides.
- amazon_shipping
- amazon_shipping_uk
- an_post
- apc_overnight
- aramex
- asendia
- asendia_uk
- australia_post
- australia_post_mypost_business
- axlehire
- b2c_europe
- better_trucks
- bring_parcels
- brt_it
- canada_post
- canpar
- chronopost
- colis_prive
- colissimo
- couriers_please
- dai
- delivengo
- deutsche_post_cross_border
- deutsche_post_dhl
- dhl_ecommerce_au
- dhl_express_australia
- dhl_express
- dhl_express_mydhl
- dhl_parcel_uk
- dhl_global_mail
- dhl_ecommerce_uk
- direct_freight
- direct_link
- doordash_us
- dpd
- dpd_france
- dpd_germany
- apicode-dpd-local
- dpd_nl
- dpd_poland
- dropoff
- dx
- envialia
- estafeta_mexico
- fairsenden
- fastway_nz
- fastway_au
- fedex
- fedex_uk
- firstmile
- flashbox
- fleet_optics
- castle_parcels
- new_zealand_couriers
- now_couriers
- post_haste
- gls_france
- gls_germany
- gls_us
- gophr
- grupo_ampm
- hermescorp
- hermes_germany
- apc
- access_worldwide
- rr_donnelley
- inpost
- inpost_it
- intelcom_ca
- intelliquick_delivery
- landmark_global
- lasership
- lettre_suivie
- linex
- loomis_express
- lso
- metroland
- mondial_relay
- n9minutos
- nationex
- netparcel
- newgistics
- ninja_van
- ontrac
- packeta
- packfleet
- pandion
- parcelforce
- parcll
- parxl
- posta_slovenije
- poste_italiane
- postnl
- purolator_ca
- quantium
- redpack
- royal_mail
- seko
- seko_ltl_walleted
- sendle
- shipx
- skypostal
- speedy
- starlinks
- star_track
- swyft
- the_delivery_group_uk
- tnt_australia
- tnt_uk
- toll_ipec
- toll_priority
- ups
- stamps_com
- endicia
- yamato
- yodel
- yodel_collect_plus_c2
React Component
SDK
Args/Props | Description |
---|---|
carrierName | string, optional The carrier name to show the connection form for (ie. ups, usps, fedex, etc.). If no carrier is provided, the user may select from a list of carriers specified in the enabledExternalCarriers array. |
onCancel | function, optional An optional callback function that will be invoked when a carrierName was provided and the form is cancelled. Otherwise the user will again be presented with the list of available carriers to connect. |
onCarrierConnected | function, optional An optional callback function to be invoked after the successful connection of a carrier account. |