API Integration
Easyship
easyshipproduction-ready
No description available.
TrackingRatingPickupManifestShipping
Connection Requirements
| Field | Type | Required |
|---|---|---|
| access_token | string | |
| account_country_code | string | |
| metadata | object | |
| config | object |
Carrier Configuration
| Field | Type |
|---|---|
| platform_name | string |
| apply_shipping_rules | boolean |
| allow_courier_fallback | boolean |
| shipping_options | list |
| shipping_services | list |
Available Services
| Service Name | Service Code |
|---|---|
| Parcel | easyship_aramex_parcel |
| Domestic | easyship_sfexpress_domestic |
| Speedpost | easyship_hkpost_speedpost |
| Air Mail Tracking | easyship_hkpost_air_mail_tracking |
| EExpress | easyship_hkpost_eexpress |
| Air Parcel | easyship_hkpost_air_parcel |
| easyship_sfexpress_mail | |
| Local Parcel | easyship_hkpost_local_parcel |
| SaverNet Battery | easyship_ups_saver_net_battery |
| Worldwide Saver® | easyship_ups_worldwide_saver |
| Air Parcel XP | easyship_hkpost_air_parcel_xp |
| Airmail | easyship_singpost_airmail |
| Express | easyship_simplypost_express |
| ePack | easyship_singpost_e_pack |
| Priority Mail Express | easyship_usps_priority_mail_express |
| First Class International | easyship_usps_first_class_international |
| Priority Mail International Express | easyship_usps_priority_mail_international_express |
| Priority Mail International | easyship_usps_priority_mail_international |
| InternationalPriority | easyship_fedex_international_priority |
| GroundAdvantage | easyship_usps_ground_advantage |
| PriorityMail | easyship_usps_priority_mail |
| Worldwide Express® | easyship_ups_worldwide_express |
| Ground | easyship_ups_ground |
| Worldwide Expedited® | easyship_ups_worldwide_expedited |
| International Economy® | easyship_fedex_international_economy |
| Priority Overnight® | easyship_fedex_priority_overnight |
| Standard Overnight® | easyship_fedex_standard_overnight |
| 2Day® A.M. | easyship_fedex_2_day_a_m |
| 2Day® | easyship_fedex_2_day |
| Express Saver® | easyship_fedex_express_saver |
| Next Day Air® | easyship_ups_next_day_air |
| 2nd Day Air® | easyship_ups_2nd_day_air |
| 3DaySelect | easyship_ups_3_day_select |
| Standard | easyship_ups_standard |
| Media | easyship_usps_media |
| Standard Express | easyship_sfexpress_standard_express |
| Economy Express | easyship_sfexpress_economy_express |
| GlobalPost Economy | easyship_global_post_global_post_economy |
| GlobalPost Priority | easyship_global_post_global_post_priority |
| SpeedPost Priority | easyship_singpost_speed_post_priority |
| Standard Private Delivery | easyship_skypostal_standard_private_delivery |
| 1000Express | easyship_tnt_1000_express |
| Express Parcel | easyship_toll_express_parcel |
| Premium International | easyship_sendle_premium_international |
| PremiumDomestic | easyship_sendle_premium_domestic |
| Pro Domestic | easyship_sendle_pro_domestic |
| ePac | easyship_quantium_e_pac |
| PM Flat Rate | easyship_usps_pm_flat_rate |
| PMI Flat Rate | easyship_usps_pmi_flat_rate |
| easyship_quantium_mail | |
| International Mail | easyship_quantium_international_mail |
| ParcelConnect Expedited | easyship_apc_parcel_connect_expedited |
| EPX | easyship_aramex_epx |
| Road Express | easyship_tnt_road_express |
| Overnight | easyship_tnt_overnight |
| PME Flat Rate | easyship_usps_pme_flat_rate |
| PMEI Flat Rate | easyship_usps_pmei_flat_rate |
| CDEK Russia | easyship_easyship_cdek_russia |
| PMEI Flat Rate Padded Envelope | easyship_usps_pmei_flat_rate_padded_envelope |
| Mate Bike Shipping Services | easyship_easyship_mate_bike_shipping_services |
| Documents | easyship_dhl_express_documents |
| UK_HomeDelivery | easyship_evri_uk_home_delivery |
| HomeDelivery | easyship_evri_home_delivery |
| NextDay | easyship_dpd_next_day |
| ClassicParcel | easyship_dpd_classic_parcel |
| ClassicExpresspak | easyship_dpd_classic_expresspak |
| AirClassic | easyship_dpd_air_classic |
| SpeedPostExpress | easyship_singpost_speed_post_express |
| Expedited | easyship_ups_expedited |
| 0900Express | easyship_tnt_0900_express |
| 1200Express | easyship_tnt_1200_express |
| Domestic Regular Parcel | easyship_canadapost_domestic_regular_parcel |
| Domestic Expedited Parcel | easyship_canadapost_domestic_expedited_parcel |
| Domestic Xpresspost Domestic | easyship_canadapost_domestic_xpresspost_domestic |
| Domestic Priority | easyship_canadapost_domestic_priority |
| USA Small Packet Air | easyship_canadapost_usa_small_packet_air |
| USA Expedited Parcel | easyship_canadapost_usa_expedited_parcel |
| USA Tracked Parcel | easyship_canadapost_usa_tracked_parcel |
| USA Xpresspost | easyship_canadapost_usa_xpresspost |
| International Xpresspost | easyship_canadapost_international_xpresspost |
| International Small Packet Air | easyship_canadapost_international_small_packet_air |
| International Tracked Packet | easyship_canadapost_international_tracked_packet |
| International Small Packet Surface | easyship_canadapost_international_small_packet_surface |
| International Parcel Surface | easyship_canadapost_international_parcel_surface |
| International Parcel Air | easyship_canadapost_international_parcel_air |
| ATL | easyship_couriersplease_atl |
| Signature | easyship_couriersplease_signature |
| International | easyship_canpar_international |
| USA | easyship_canpar_usa |
| Select USA | easyship_canpar_select_usa |
| USA Pak | easyship_canpar_usa_pak |
| Overnight Pak | easyship_canpar_overnight_pak |
| Select Pak | easyship_canpar_select_pak |
| Select | easyship_canpar_select |
| ExpressSaver | easyship_ups_express_saver |
| SF Express Economy Express | easyship_ebay_send_sf_express_economy_express |
| Worldwide Express Plus® | easyship_ups_worldwide_express_plus |
| IntlPriority | easyship_quantium_intl_priority |
| Next Day Air® Early | easyship_ups_next_day_air_early |
| Next Day Air Saver® | easyship_ups_next_day_air_saver |
| 2nd Day Air® A.M. | easyship_ups_2nd_day_air_a_m |
| Home Delivery® | easyship_fedex_home_delivery |
| CountryTracked | easyship_asendia_country_tracked |
| FullyTracked | easyship_asendia_fully_tracked |
| ExpressDG | easyship_dhl_express_express_dg |
| InternationalPriorityDG | easyship_fedex_international_priority_dg |
| Expert | easyship_colissimo_expert |
| Access | easyship_colissimo_access |
| InternationalHomeDelivery | easyship_mondialrelay_international_home_delivery |
| Economy | easyship_fedex_economy |
| Express1200 | easyship_dhl_express_express1200 |
| Express0900 | easyship_dhl_express_express0900 |
| Express1800 | easyship_dhl_express_express1800 |
| ExpressWorldwide | easyship_dhl_express_express_worldwide |
| EconomySelect | easyship_dhl_express_economy_select |
| Express1030International | easyship_dhl_express_express1030_international |
| DomesticExpress0900 | easyship_dhl_express_domestic_express0900 |
| DomesticExpress1200 | easyship_dhl_express_domestic_express1200 |
| LightandLarge | easyship_evri_lightand_large |
| Standard Deliveries | easyship_ninjavan_standard_deliveries |
| ParcelTier2 | easyship_couriersplease_parcel_tier2 |
| Postal Packet Standard | easyship_skypostal_postal_packet_standard |
| Basic | easyship_easyshipdemo_basic |
| Tracked | easyship_easyshipdemo_tracked |
| Battery | easyship_easyshipdemo_battery |
| DomesticExpress | easyship_dhl_express_domestic_express |
| SmartPost | easyship_fedex_smart_post |
| InternationalConnectPlus | easyship_fedex_international_connect_plus |
| SaverNet | easyship_ups_saver_net |
| ChronoClassic | easyship_chronopost_chrono_classic |
| ChronoExpress | easyship_chronopost_chrono_express |
| Chrono10 | easyship_chronopost_chrono10 |
| Chrono13 | easyship_chronopost_chrono13 |
| Chrono18 | easyship_chronopost_chrono18 |
| Parcel Expedited | easyship_omniparcel_parcel_expedited |
| Parcel Expedited Plus | easyship_omniparcel_parcel_expedited_plus |
| HomeDeliveryDomestic | easyship_evri_home_delivery_domestic |
| HomeDomesticPostable | easyship_evri_home_domestic_postable |
| PacketExpress | easyship_skypostal_packet_express |
| Express48Large | easyship_parcelforce_express48_large |
| Express24 | easyship_parcelforce_express24 |
| Express1000 | easyship_parcelforce_express1000 |
| ExpressAM | easyship_parcelforce_express_am |
| Express48 | easyship_parcelforce_express48 |
| EuroEconomy | easyship_parcelforce_euro_economy |
| GlobalPriority | easyship_parcelforce_global_priority |
| TrakpakWorldwideHermes | easyship_fedex_cross_border_trakpak_worldwide_hermes |
| TrakpakWorldwide | easyship_fedex_cross_border_trakpak_worldwide |
| HomeDomesticPostableNextDay | easyship_evri_home_domestic_postable_next_day |
| ExpressPakNextDay | easyship_dpd_express_pak_next_day |
| ClassicExpressPak | easyship_dpd_classic_express_pak |
| LightAndLarge | easyship_evri_light_and_large |
| Home Delivery Domestic NextDay | easyship_evri_home_delivery_domestic_next_day |
| HomeDeliveryEU | easyship_evri_home_delivery_eu |
| EpaqPlus | easyship_asendia_epaq_plus |
| EpaqSelect | easyship_asendia_epaq_select |
| LightweightStandard | easyship_usps_lightweight_standard |
| LightweightEconomy | easyship_usps_lightweight_economy |
| DomesticExpressSaver | easyship_ups_domestic_express_saver |
| ePacket | easyship_apg_e_packet |
| ePacketPlus | easyship_apg_e_packet_plus |
| EComBaseKilo | easyship_couriersplease_ecom_base_kilo |
| STDATLBaseKilo | easyship_couriersplease_stdatlbase_kilo |
| InternationalCourier | easyship_nz_post_international_courier |
| AirSmallParcel | easyship_nz_post_air_small_parcel |
| TrackedAirSatchel | easyship_nz_post_tracked_air_satchel |
| Economy Parcel | easyship_nz_post_economy_parcel |
| ParcelLocal | easyship_nz_post_parcel_local |
| ExpressDomestic | easyship_dhl_express_express_domestic |
| Roadexpress | easyship_alliedexpress_roadexpress |
| AsendiaePAQSelect | easyship_flatexportrate_asendiae_paqselect |
| AsendiaCountryTracked | easyship_flatexportrate_asendia_country_tracked |
| NSaver | easyship_singpost_nsaver |
| Home | easyship_colisprive_home |
| Domestic Parcel | easyship_osm_domestic_parcel |
| Door To Door | easyship_malca_amit_door_to_door |
| Next Day Deliveries | easyship_ninjavan_next_day_deliveries |
| ePAQSelect | easyship_asendia_e_paqselect |
| Classic | easyship_dpd_classic |
| PriorityMailSignature | easyship_usps_priority_mail_signature |
| PacketStandard | easyship_bringer_packet_standard |
| Prime | easyship_bringer_prime |
| ExpeditedDDP | easyship_orangeds_expedited_ddp |
| ExpeditedDDU | easyship_orangeds_expedited_ddu |
| Preferred | easyship_sendle_preferred |
| GroundSaver | easyship_ups_ground_saver |
| UPSGroundSaverUS | easyship_ups_upsground_saver_us |
| PriorityDelconDDUEWR | easyship_passport_priority_delcon_dduewr |
| PriorityDelconDDPEWR | easyship_passport_priority_delcon_ddpewr |
| TrackedParcel | easyship_bringer_tracked_parcel |
| ExpressEarly | easyship_ups_express_early |
| WolrdwideExpress | easyship_ups_wolrdwide_express |
Shipping Options
| Option | Code | Type |
|---|---|---|
| easyship_box_slug | box_slug | string |
| easyship_courier_id | courier_id | string |
| easyship_eei_reference | eei_reference | string |
| easyship_incoterms | incoterms | string |
| easyship_apply_shipping_rules | apply_shipping_rules | boolean |
| easyship_show_courier_logo_url | show_courier_logo_url | boolean |
| easyship_allow_courier_fallback | allow_courier_fallback | boolean |
| easyship_list_unavailable_couriers | list_unavailable_couriers | boolean |
| easyship_buyer_notes | buyer_notes | string |
| easyship_seller_notes | seller_notes | string |
| easyship_sender_address_id | sender_address_id | string |
| easyship_return_address_id | return_address_id | string |
