POST /v2/checkout/orders/{id}/track

Adds tracking information for an Order.

Servers

Path parameters

Name Type Required Description
id String Yes

The ID of the order that the tracking information is associated with.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

PayPal-Auth-Assertion String No

An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.

Request body fields

Name Type Required Description
capture_id String Yes

The PayPal capture ID.

notify_payer Boolean No

If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for notify_payer, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences.

Default value: false

carrier String No

The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier to OTHER and set carrier name in carrier_name_other. For allowed values, see Carriers.

Possible values:

  • "HSM_GLOBAL"
  • "MX_CARGO"
  • "BUDBEE_WEBHOOK"
  • "WORLDNET"
  • "CHAMPION_LOGISTICS"
  • "DE_DPD_DELISTRACK"
  • "_4_72"
  • "AGSYSTEMS"
  • "POST_SLOVENIA"
  • "TNT_IT"
  • "THAIPARCELS"
  • "GLOBEGISTICS"
  • "JAVIT"
  • "WHISTL_SFTP"
  • "FASTTRACK"
  • "TIKI_ID"
  • "IMX"
  • "RINCOS"
  • "THA_KERRY"
  • "SPANISH_SEUR_FTP"
  • "FRETERAPIDO"
  • "US_APC"
  • "DELIVERYONTIME"
  • "STEPFORWARDFS"
  • "LOGYSTO"
  • "DSV_REFERENCE"
  • "ROADBULL"
  • "POST_SERBIA"
  • "DESIGNERTRANSPORT_WEBHOOK"
  • "MBW"
  • "KERRYTTC_VN"
  • "NLD_DHL"
  • "SFC_LOGISTICS"
  • "DBSCHENKER_SV"
  • "PACKETA"
  • "DAO365"
  • "SHIP_GATE"
  • "ACSWORLDWIDE"
  • "CJ_INT_MY"
  • "FASTRACK"
  • "LEXSHIP"
  • "ARAMEX"
  • "AMS_GRP"
  • "KEC"
  • "TRUNKRS"
  • "SKYNET_UK"
  • "WINESHIPPING"
  • "TAQBIN_MY"
  • "KEDAEX"
  • "COM1EXPRESS"
  • "MYS_MYS_POST"
  • "PTT_POST"
  • "BRING"
  • "NAQEL_EXPRESS"
  • "OMNIPARCEL"
  • "SMG_EXPRESS"
  • "TRACKON"
  • "DPD_AT_SFTP"
  • "SAILPOST"
  • "SZENDEX"
  • "PTS"
  • "BLUEDART_API"
  • "DHL_ECOMERCE_ASA"
  • "CNDEXPRESS"
  • "DPD_RU_API"
  • "DAYTON_FREIGHT"
  • "APRISAEXPRESS"
  • "PRT_SEUR"
  • "DIALOGO_LOGISTICA_API"
  • "RHENUS_GROUP"
  • "WESHIP"
  • "POSTUR_IS"
  • "VOX"
  • "YUSEN"
  • "LTIANEXP"
  • "FLEETOPTICSINC"
  • "ZTO_EXPRESS"
  • "RCL"
  • "CLEVY_LINKS"
  • "PHSE_API"
  • "SWE_POSTNORD"
  • "AXLEHIRE_FTP"
  • "GLS_IT"
  • "ROUTIFIC_WEBHOOK"
  • "ADICIONAL_PT"
  • "ESHIPPER"
  • "CASTLEPARCELS"
  • "WEASHIP"
  • "PPL"
  • "EUROPAKET_API"
  • "FASTWAY_IR"
  • "EASY_MAIL"
  • "SUTTON"
  • "YODEL_INTNL"
  • "SYPOST"
  • "VNM_VIETTELPOST"
  • "DHL_JP"
  • "HELTHJEM_API"
  • "ADERONLINE"
  • "MXE"
  • "DHL_PA_API"
  • "SPEEDCOURIERS_GR"
  • "VNPOST_API"
  • "FEDEX_UK"
  • "DHLPARCEL_UK"
  • "ABCUSTOM_SFTP"
  • "CJ_CENTURY"
  • "NATIONAL_SAMEDAY"
  • "SEINO_API"
  • "GESWL"
  • "THECOURIERGUY"
  • "PARCELRIGHT"
  • "MYDYNALOGIC"
  • "ABCUSTOM"
  • "WEWORLDEXPRESS"
  • "PIGGYSHIP"
  • "ESP_MRW"
  • "HANJIN"
  • "CN_SF_EXPRESS"
  • "SPRINT_PACK"
  • "TRANS2U"
  • "DPD_SK_SFTP"
  • "INEXPOST"
  • "BLR_BELPOST"
  • "UK_YODEL"
  • "AO_DEUTSCHLAND"
  • "SHOPLINE"
  • "US_LASERSHIP"
  • "DNJ_EXPRESS"
  • "ANSERX"
  • "CN_POST56"
  • "DHL_PARCEL_NL"
  • "ROADRUNNER_FREIGHT"
  • "ZJS_EXPRESS"
  • "ADUIEPYLE"
  • "NEWEGGEXPRESS"
  • "ZA_COURIERIT"
  • "AGILITY"
  • "LALAMOVE"
  • "HAPPY2POINT"
  • "XDE_WEBHOOK"
  • "TOURLINE_REFERENCE"
  • "NIMBUSPOST"
  • "EASYROUTES"
  • "CNWANGTONG"
  • "BLUEX"
  • "GLS_SPAIN_API"
  • "GLOBAL_IPARCEL"
  • "INTEGRA2_FTP"
  • "HOUNDEXPRESS"
  • "NOVOFARMA_WEBHOOK"
  • "HERMES"
  • "THIJS_NL"
  • "DMS_MATRIX"
  • "US_YRC"
  • "PL_POCZTA_POLSKA"
  • "ROYAL_MAIL"
  • "DELIVERR_SFTP"
  • "JUSDASR"
  • "SENDEO_KARGO"
  • "EXPRESSSALE"
  • "PARCELONE"
  • "DHL_HK"
  • "ECOUTIER"
  • "JNE_API"
  • "AAA_COOPER"
  • "TOLL_NZ"
  • "TOLOS"
  • "PARCEL2GO"
  • "AEX"
  • "SPOTON"
  • "ATSHEALTHCARE"
  • "EXPRESSONE"
  • "MAERGO"
  • "ONTRAC"
  • "GLS_HUN"
  • "AITWORLDWIDE_SFTP"
  • "JTEXPRESS_VN"
  • "RPXLOGISTICS"
  • "TH_CJ"
  • "AN_POST"
  • "RAM"
  • "LANDMARK_GLOBAL_REFERENCE"
  • "BLUECARE"
  • "AGEDISS_SFTP"
  • "DBSCHENKER_ICELAND"
  • "GLS_ES"
  • "BRT_IT_SENDER_REF"
  • "XINDUS"
  • "FULFILLME"
  • "BROUWER_TRANSPORT"
  • "CLE_LOGISTICS"
  • "ENSENDA"
  • "TRANSPAK"
  • "FIEGE_NL"
  • "CN_PAYPAL_PACKAGE"
  • "CELLO_SQUARE"
  • "MORNING_EXPRESS"
  • "ASYADEXPRESS"
  • "FEDEX_FR"
  • "GLS_ITALY"
  • "URBIFY"
  • "TWO_GO"
  • "INTERSMARTTRANS"
  • "PAPER_EXPRESS"
  • "FLASHEXPRESS_WEBHOOK"
  • "KR_KOREA_POST"
  • "GSI_EXPRESS"
  • "KARGOMKOLAY"
  • "RIXONHK_API"
  • "SGT_IT"
  • "GLOBAVEND"
  • "WNDIRECT"
  • "DHL_UK"
  • "JTEXPRESS_PH"
  • "DHL_SG"
  • "AWEST"
  • "RELAISCOLIS"
  • "ESP_PACKLINK"
  • "VESYL"
  • "NINJAVAN_SG"
  • "LALAMOVE_API"
  • "ESP_ASM"
  • "GODEPENDABLE"
  • "EASYPARCEL"
  • "RPM"
  • "NTLOGISTICS_VN"
  • "ESHIPPING"
  • "XPRESSEN_DK"
  • "POSTA_RO"
  • "HELLENIC_POST"
  • "PARCELPAL_WEBHOOK"
  • "MAZET"
  • "CN_CHINA_POST_EMS"
  • "ZELERIS"
  • "BOMBINOEXP"
  • "TNT_REFR"
  • "HUODULL"
  • "PASSPORTSHIPPING"
  • "IORDIRECT"
  • "GLOBAL_ESTES"
  • "SG_QXPRESS"
  • "KERRY_EXPRESS_TW_API"
  • "AXLEHIRE"
  • "PARCEL_2_POST"
  • "ILYANGLOGIS"
  • "TOPHATTEREXPRESS"
  • "VALUE_WEBHOOK"
  • "NOWLOG_API"
  • "SDH_SCM"
  • "ENVIALIA_REFERENCE"
  • "UBI_LOGISTICS"
  • "TARRIVE"
  • "HERMESWORLD_UK"
  • "GIO_ECOURIER_API"
  • "SEKOLOGISTICS"
  • "AVERITT"
  • "JPN_JAPAN_POST"
  • "GLOBAL_TNT"
  • "SUPERPACKLINE"
  • "XPOST"
  • "CEVA"
  • "MILKMAN"
  • "DAIGLOBALTRACK"
  • "ARAMEX_API"
  • "QUALITYPOST"
  • "SFCSERVICE"
  • "SHIPA"
  • "NIM_EXPRESS"
  • "A1POST"
  • "KGMHUB"
  • "INTEXPRESS"
  • "ENDEAVOUR_DELIVERY"
  • "CN_YUNDA"
  • "SHREENANDANCOURIER"
  • "EASTWESTCOURIER_FTP"
  • "LOGISTICSWORLDWIDE_HK"
  • "DHL_PARCEL_ES"
  • "DYNALOGIC"
  • "PANDION"
  • "LCTBR_API"
  • "JET_SHIP"
  • "FEDEX_INTL_MLSERV"
  • "OPTIMACOURIER"
  • "SKYNET_ZA"
  • "ONECLICK"
  • "YAMATO"
  • "APG"
  • "SHERPA"
  • "NIGHTLINE_UK"
  • "ROYAL_MAIL_FTP"
  • "POSTONE"
  • "NAVLUNGO"
  • "BESTTRANSPORT_SFTP"
  • "DHL_FR"
  • "DPD_FR_REFERENCE"
  • "DIRMENSAJERIA"
  • "DHL_GLOBAL_MAIL_ASIA"
  • "HKD"
  • "COLLIVERY"
  • "CNEXPS"
  • "UPS_CHECKER"
  • "ECOURIER"
  • "GCX"
  • "FAXECARGO"
  • "DOORA"
  • "FIRSTMILE"
  • "NACEX_SPAIN_REFERENCE"
  • "WISELOADS"
  • "FIRST_LOGISITCS"
  • "MYHERMES_UK_API"
  • "TIPSA"
  • "UBER_WEBHOOK"
  • "HK_TGX"
  • "ALLJOY"
  • "WISE_EXPRESS"
  • "DELIVER_IT"
  • "BURD"
  • "STARKEN"
  • "GBS_BROKER"
  • "MEX_SENDA"
  • "TECOR"
  • "NIPOST_NG"
  • "SENDIT"
  • "ALLEGRO"
  • "POSTNORD_LOGISTICS_DK"
  • "SPREETAIL_API"
  • "BEL_BELGIUM_POST"
  • "GLS_ITALY_FTP"
  • "DAJIN"
  • "CAGO"
  • "MORNINGLOBAL"
  • "LIVRAPIDE"
  • "CORREO_UY"
  • "HK_POST"
  • "GEMWORLDWIDE"
  • "OVERSE_EXP"
  • "POSTNORD_LOGISTICS"
  • "BH_POSTA"
  • "LBCEXPRESS_FTP"
  • "INPOST_UK"
  • "PFLOGISTICS"
  • "GPS"
  • "DEUTSCHE_DE"
  • "JUMPPOINT"
  • "LICCARDI_EXPRESS"
  • "LTL"
  • "INTERPARCEL_UK"
  • "PANTHER_REFERENCE"
  • "DAIICHI"
  • "OAKH"
  • "US_OLD_DOMINION"
  • "HIPSHIPPER"
  • "SMARTKARGO"
  • "FDSEXPRESS"
  • "MISUMI_CN"
  • "RAF_PH"
  • "SHIPROCKET"
  • "MEDAFRICA"
  • "YODEL_API"
  • "ZEPTO_EXPRESS"
  • "CAE_DELIVERS"
  • "ECOSCOOTING"
  • "PAPERFLY"
  • "COORDINADORA"
  • "THA_DYNAMIC_LOGISTICS"
  • "NANJINGWOYUAN"
  • "DOTZOT"
  • "SONICTL"
  • "GLS_SPAIN"
  • "DIAMOND_EUROGISTICS"
  • "EWE"
  • "CHIENVENTURE_WEBHOOK"
  • "BRT_IT_API"
  • "PAACK_WEBHOOK"
  • "HUNTER_EXPRESS"
  • "LOGINEXT_WEBHOOK"
  • "YINGNUO_LOGISTICS"
  • "SHIPXPRES"
  • "WYNGS"
  • "CN_DPEX"
  • "JTCARGO"
  • "GORUSH"
  • "TNT_AU"
  • "GOGLOBALPOST"
  • "TNT_NL"
  • "DE_DHL_EXPRESS"
  • "NEWZEALAND_COURIERS"
  • "COSTMETICSNOW"
  • "SHENZHEN"
  • "HELTHJEM"
  • "IT_DHL_ECOMMERCE"
  • "CHILEXPRESS"
  • "ECHO"
  • "FRAGILEPAK_SFTP"
  • "STARTRACK_EXPRESS"
  • "JD_EXPRESS"
  • "YUNHUIPOST"
  • "WATKINS_SHEPARD"
  • "DACHSER_WEB"
  • "FIRST_LOGISTICS_API"
  • "ASENDIA"
  • "ARCO_SPEDIZIONI"
  • "BLINKLASTMILE"
  • "MEX_ESTAFETA"
  • "HEPPNER_FR"
  • "PICKUPP_VNM"
  • "UCS"
  • "FEDEX_API"
  • "AUSTRIAN_POST_EXPRESS"
  • "ZUELLIGPHARMA_SFTP"
  • "ACTIVOS24_API"
  • "NINJAVAN_THAI"
  • "PACKS"
  • "SHIPPIE"
  • "SPEDISCI"
  • "SENDLE"
  • "KOLAY_GELSIN"
  • "DPD_LOCAL"
  • "DEX_I"
  • "YUNEXPRESS"
  • "BNEED"
  • "STATOVERNIGHT"
  • "GPOST"
  • "TELEPORT_WEBHOOK"
  • "PARCLL"
  • "PARCELLED_IN"
  • "APC_OVERNIGHT_CONNUM"
  • "IND_GOJAVAS"
  • "BOMI"
  • "VIRTRANSPORT"
  • "FORWARDAIR"
  • "I_DIKA"
  • "TOPYOU"
  • "COLIS_PRIVE"
  • "GB_APC"
  • "CANPAR"
  • "CROSHOT"
  • "UPS_FREIGHT"
  • "USPS_API"
  • "SERVIENTREGA"
  • "FETCHR"
  • "TEAMEXPRESSLLC"
  • "BPOST_INT"
  • "GB_ARROW"
  • "YANWEN"
  • "SIMPLETIRE_WEBHOOK"
  • "AIRSPEED"
  • "IML"
  • "MAGYAR_HU"
  • "POSTA_PLUS"
  • "ICUMULUS"
  • "KY_EXPRESS"
  • "ELOGISTICA"
  • "STRECK_TRANSPORT"
  • "SRE_KOREA"
  • "ACILOGISTIX"
  • "ASE"
  • "LINKBRIDGE"
  • "SWISS_POST_FTP"
  • "VAMOX"
  • "CHOIR_EXP"
  • "CRYOPDP_FTP"
  • "VENIPAK"
  • "CPEX"
  • "CONCISE_API"
  • "RL_US"
  • "NTL"
  • "CHAZKI"
  • "LOGISTIKA"
  • "BJSHOMEDELIVERY"
  • "GOPEOPLE"
  • "ASENDIA_US"
  • "XYY"
  • "DHL_BENELUX"
  • "SINOTRANS"
  • "BRA_CORREIOS"
  • "MYS_EMS"
  • "INTELCOM_CA"
  • "VIAEUROPE"
  • "BLUEDART"
  • "QWINTRY"
  • "IT_NEXIVE"
  • "JOYINGBOX"
  • "POSTE_ITALIANE_PACCOCELERE"
  • "FASTWAY_AU"
  • "COORDINADORA_API"
  • "OSM_WORLDWIDE"
  • "CORREOS_DE_MEXICO"
  • "DTDC_IN"
  • "LONESTAR"
  • "SWISHIP"
  • "DAWN_WING"
  • "DIALOGO_LOGISTICA"
  • "DHL_SUPPLYCHAIN_ID"
  • "UK_XDP"
  • "JOOM_LOGIS"
  • "AMAZON_UK_API"
  • "DPD_RO"
  • "SCOTTY"
  • "NEWGISTICSAPI"
  • "USPS"
  • "PALEXPRESS"
  • "PAIKEDA"
  • "FR_COLISSIMO"
  • "EMPS_CN"
  • "POSTA_UKR"
  • "HSDEXPRESS"
  • "VIRTRANSPORT_SFTP"
  • "COLLECTCO"
  • "LOCUS_WEBHOOK"
  • "LATVIJAS_PASTS"
  • "AERONET"
  • "WISH_EMAIL_PUSH"
  • "SKYEXPRESS_INTERNATIONAL"
  • "AMAZON_FBA_SWISHIP_IN"
  • "PICKUP"
  • "TFORCE_FINALMILE"
  • "HFD"
  • "EPARCEL_KR"
  • "KWE_GLOBAL"
  • "SWE"
  • "CAINIAO"
  • "POSTNL_INTL_3S"
  • "DPEX"
  • "LBCEXPRESS_API"
  • "ARIHANTCOURIER"
  • "RPX_ID"
  • "SPX"
  • "SDA_IT"
  • "DEXPRESS_WEBHOOK"
  • "AUEXPRESS"
  • "DHL_REFERENCE_API"
  • "DHL_GLOBAL_FORWARDING_API"
  • "SG_DETRACK"
  • "MYS_SKYNET"
  • "HOMELOGISTICS"
  • "SHOPOLIVE"
  • "XQ_EXPRESS"
  • "WINESHIPPING_WEBHOOK"
  • "FUJEXP"
  • "JT_LOGISTICS"
  • "ICSCOURIER"
  • "CN_LOGISTICS"
  • "UPS"
  • "DHL_SUPPLYCHAIN_IN"
  • "CTC_EXPRESS"
  • "WANBEXPRESS"
  • "LIEFERGRUN"
  • "DX_B2B_CONNUM"
  • "BEL_DHL"
  • "MOTHERSHIP_API"
  • "GRAB_WEBHOOK"
  • "YTO"
  • "PAN_ASIA"
  • "ORANGECONNEX"
  • "COURANT_PLUS_API"
  • "UPARCEL"
  • "SG_SPEEDPOST"
  • "HDB"
  • "PANDAGO_API"
  • "CJ_KR"
  • "JS_EXPRESS"
  • "CJ_HK_INTERNATIONAL"
  • "SERVIP_WEBHOOK"
  • "TOLL_PRIORITY"
  • "TUFFNELLS_REFERENCE"
  • "TNT_CN"
  • "DHL_GT_API"
  • "PAGO"
  • "DPD_IR"
  • "COURIER_POST"
  • "CBL_LOGISTICA_API"
  • "DIRECTCOURIERS"
  • "DHL_PARCEL_RU"
  • "FURDECO"
  • "SETEL"
  • "SHIPGLOBAL_US"
  • "CORREOS_DE_ESPANA"
  • "TNT_UK_REFR"
  • "MENSAJEROSURBANOS_API"
  • "FR_EXAPAQ"
  • "DE_DHL"
  • "ATSHEALTHCARE_REFERENCE"
  • "YUSEN_SFTP"
  • "EARLYBIRD"
  • "CORPORATECOURIERS_WEBHOOK"
  • "DPE_SOUTH_AFRC"
  • "TCK_EXPRESS"
  • "NMTRANSFER"
  • "PIDGE"
  • "CRLEXPRESS"
  • "INDIA_POST_INT"
  • "TNT_ES"
  • "BOX_BERRY"
  • "KURASI"
  • "B_TWO_C_EUROPE"
  • "ZES_EXPRESS"
  • "TESTING_COURIER"
  • "NACEX_ES"
  • "PITTOHIO"
  • "DSV"
  • "XPEDIGO"
  • "CJ_GLS"
  • "ZINC"
  • "FLIGHTLG"
  • "MIKROPAKKET_BE"
  • "DANNIAO"
  • "CUBYN"
  • "CITY56_WEBHOOK"
  • "MATDESPATCH"
  • "T_CAT_API"
  • "TAMERGROUP_WEBHOOK"
  • "CLOUDWISH_ASIA"
  • "CORREOS_ES"
  • "ANDREANI"
  • "ELIAN_POST"
  • "FETCHR_WEBHOOK"
  • "LOOMIS_EXPRESS"
  • "HH_EXP"
  • "SMOOTH"
  • "KPOST"
  • "WIZMO"
  • "NOVA_POSHTA_INT"
  • "VIAXPRESS"
  • "YDH_EXPRESS"
  • "DIDADI"
  • "KINISI"
  • "POSTI"
  • "MONDIALRELAY_ES"
  • "DPD_UK_SFTP"
  • "_3JMSLOGISTICS"
  • "MOBI_BR"
  • "MYS_GDEX"
  • "CHROBINSON"
  • "NZ_NZ_POST"
  • "IMEXGLOBALSOLUTIONS"
  • "HERMES_IT"
  • "YOUPARCEL"
  • "SCUDEX_EXPRESS"
  • "GAC"
  • "CONTINENTAL"
  • "NETLOGIXGROUP"
  • "SMARTCAT"
  • "MGLOBAL"
  • "GENERAL_OVERNIGHT"
  • "EMEGA"
  • "HOMERUNNER"
  • "FNF_ZA"
  • "TNT_PL"
  • "PALLET_NETWORK"
  • "DHL_FREIGHT"
  • "TOTAL_EXPRESS"
  • "SFB2C"
  • "PRT_CTT"
  • "FASTDESPATCH"
  • "POSTNL_INTERNATIONAL"
  • "CHUKOU1"
  • "EFWNOW_API"
  • "SAU_SAUDI_POST"
  • "JINSUNG"
  • "ADSONE"
  • "PRODUCTCAREGROUP_SFTP"
  • "SKYNET_WORLDWIDE"
  • "YIFAN"
  • "YYCOM"
  • "MAINFREIGHT"
  • "AUSTRALIA_POST_API"
  • "MAIL_BOX_ETC"
  • "ORANGE_DS"
  • "FITZMARK_API"
  • "CARRY_FLAP"
  • "URB_IT"
  • "INTERNATIONAL_SEUR_API"
  • "GEODIS_ESPACE"
  • "ETOMARS"
  • "RZYEXPRESS"
  • "BONDSCOURIERS"
  • "WOOYOUNG_LOGISTICS_SFTP"
  • "SIC_TELIWAY"
  • "EXPEDITORS"
  • "FASTSHIP"
  • "LOGOIX"
  • "YAKIT"
  • "RELAY"
  • "IT_POSTE_ITALIA"
  • "SG_SG_POST"
  • "ACS_GR"
  • "POSTI_API"
  • "FERCAM_IT"
  • "XPRESSBEES"
  • "MULTIENTREGAPANAMA"
  • "CESKA_CZ"
  • "SHUNBANG_EXPRESS"
  • "XMSZM"
  • "SPEEDY"
  • "DELCART_IN"
  • "SIODEMKA"
  • "DPD_HGRY"
  • "TNT_UK"
  • "PILOT_FREIGHT"
  • "ROCKET_PARCEL"
  • "QUANTIUM"
  • "GLS_CROTIA"
  • "OCS"
  • "HUNTER_EXPRESS_SFTP"
  • "AMAZON_EMAIL_PUSH"
  • "NATIONEX"
  • "COPE"
  • "JD_WORLDWIDE"
  • "ONEWORLDEXPRESS"
  • "QINTL_API"
  • "TRANS_KARGO"
  • "TAZMANIAN_FREIGHT"
  • "MRW"
  • "SPEEDX"
  • "NORTHLINE"
  • "SAIA_FREIGHT"
  • "CDEK_TR"
  • "DOBROPOST"
  • "POLARSPEED"
  • "SEKO_SFTP"
  • "GEODIS"
  • "FR_MONDIAL"
  • "THABIT_LOGISTICS"
  • "YYEXPRESS"
  • "FASTWAY_NZ"
  • "DMM_NETWORK"
  • "TYP"
  • "PTT_KARGO"
  • "CGS_EXPRESS"
  • "K1_EXPRESS"
  • "STARTRACK"
  • "EDF_FTP"
  • "IMILE_API"
  • "LOGISTYX_TRANSGROUP"
  • "LEGION_EXPRESS"
  • "PARCELINKLOGISTICS"
  • "EFS"
  • "CONCISE_WEBHOOK"
  • "HEROEXPRESS"
  • "FULFILLA"
  • "GLS_ROMANIA"
  • "ABXEXPRESS_MY"
  • "HDB_BOX"
  • "GIO_ECOURIER"
  • "NLD_POSTNL"
  • "LEADER"
  • "THENILE_WEBHOOK"
  • "PANDU"
  • "PLANZER"
  • "KUEHNE"
  • "SENDING"
  • "MATKAHUOLTO"
  • "GLS_SLOVEN"
  • "COURIERS_PLEASE"
  • "HRV_HRVATSKA"
  • "TOTAL_EXPRESS_API"
  • "PACKALY"
  • "SIMPLYPOST"
  • "CDLDELIVERS"
  • "FEDEX_POLAND"
  • "PACKFLEET"
  • "IND_DELIVREE"
  • "NOVA_POSHTA"
  • "EXELOT_FTP"
  • "ZTO_DOMESTIC"
  • "USHIP"
  • "EU_FLEET_SOLUTIONS"
  • "OCS_WORLDWIDE"
  • "TNT_FR_REFERENCE"
  • "FEDEX_CROSSBORDER"
  • "FASTWAY_UK"
  • "PHL_JAMEXPRESS"
  • "CDEK"
  • "CARRIERS"
  • "TFM"
  • "GIAO_HANG"
  • "PCHOME_API"
  • "SFPLUS_WEBHOOK"
  • "SHIPPIT"
  • "TNT_FR"
  • "LOGISYSTEMS_SFTP"
  • "DPD_POLAND"
  • "DHL_GLOBAL_MAIL"
  • "ANDREANI_API"
  • "CON_WAY"
  • "PARKNPARCEL"
  • "HEPSIJET"
  • "STAR_TRACK_NEXT_FLIGHT"
  • "SURAT_KARGO"
  • "GOLS"
  • "STAR_TRACK_WEBHOOK"
  • "DPD_DE"
  • "AIRTERRA"
  • "OTSCHILE"
  • "ECOFREIGHT"
  • "SPEEDEE"
  • "PIL_LOGISTICS"
  • "FIEGE"
  • "UK_UK_MAIL"
  • "GIO_EXPRESS"
  • "MWD"
  • "ARGENTS_WEBHOOK"
  • "NOVA_POSHTA_API"
  • "SMSA_EXPRESS"
  • "RANSA_WEBHOOK"
  • "DEALERSEND"
  • "EC_CN"
  • "IND_SAFEEXPRESS"
  • "SF_EX"
  • "PARCELSTARS"
  • "AMAZON_SHIP_MCF"
  • "GREYHOUND"
  • "TRUMPCARD"
  • "LOGGI"
  • "GSO"
  • "ZOOM_RED"
  • "PRT_INT_SEUR"
  • "THEDELIVERYGROUP"
  • "SIMSGLOBAL"
  • "ETS_EXPRESS"
  • "HOLISOL"
  • "IDEXPRESS_ID"
  • "SHIPTOR"
  • "PROCARRIER"
  • "XDP_UK_REFERENCE"
  • "THUNDEREXPRESS"
  • "HOTSIN_CARGO"
  • "FLASHEXPRESS"
  • "TRUSK"
  • "NAEKO_FTP"
  • "ZA_SPECIALISED_FREIGHT"
  • "INTERPARCEL_AU"
  • "SHIPX"
  • "TAQBIN_SG"
  • "PIXSELL"
  • "DPD_HK"
  • "FREIGHTQUOTE"
  • "AEROFLASH"
  • "MALCA_AMIT"
  • "DPD"
  • "GLS_FR"
  • "MARKEN"
  • "RRDONNELLEY"
  • "REDJEPAKKETJE"
  • "MHI"
  • "OMNIRPS_WEBHOOK"
  • "DDEXPRESS"
  • "OBIBOX"
  • "ASENDIA_HK"
  • "TOMYDOOR"
  • "CJPACKET"
  • "GLS_US"
  • "GLOBAL_EXPRESS"
  • "PGEON_API"
  • "HERMES_UK_SFTP"
  • "ZEEK_2_DOOR"
  • "LIEFERY"
  • "DPE_EXPRESS"
  • "COUREX"
  • "ESP_NACEX"
  • "GEODIS_API"
  • "DELIVERYOURPARCEL_ZA"
  • "A2B_BA"
  • "ZAJIL_EXPRESS"
  • "FR_COLIS"
  • "LUWJISTIK"
  • "PALLETWAYS"
  • "BUFFALO"
  • "TCS_API"
  • "DHL_SUPPLY_CHAIN"
  • "RABEN_GROUP"
  • "ANTERAJA"
  • "HCT_LOGISTICS"
  • "CACESA"
  • "KERRYTJ"
  • "XPERT_DELIVERY"
  • "DELTEC_DE"
  • "KERRY_EXPRESS_TH_WEBHOOK"
  • "JOCOM"
  • "MOOVA"
  • "DPD_AT"
  • "SPRING_GDS"
  • "TDN"
  • "JX"
  • "SAEE"
  • "REIMAGINEDELIVERY"
  • "UPS_REFERENCE"
  • "CHRONOPOST_FR"
  • "DPD_RU"
  • "IDS_LOGISTICS"
  • "ACOMMERCE"
  • "FASTBOX"
  • "INPOST_PACZKOMATY"
  • "CORREOSEXPRESS_API"
  • "DAESHIN"
  • "AIR_CANADA"
  • "ALPHAFAST"
  • "FONSEN"
  • "DTDC_AU"
  • "DHL_IT"
  • "LOGISTICSWORLDWIDE_MY"
  • "SPX_TH"
  • "GTAGSM"
  • "XL_EXPRESS"
  • "QTRACK"
  • "WESHIP_API"
  • "PUROLATOR"
  • "EPST_GLBL"
  • "ASENDIA_DE"
  • "DPD_NL"
  • "ISR_POST_DOMESTIC"
  • "DICOM"
  • "ADS"
  • "PARCELFORCE"
  • "COLLECTPLUS"
  • "DHL_ECOMMERCE_GC"
  • "GB_PANTHER"
  • "QUIQUP"
  • "MNX"
  • "PICKUPP_SGP"
  • "AIR_21"
  • "IND_ECOM"
  • "AUPOST_CN"
  • "U_ENVIOS"
  • "DEMANDSHIP"
  • "LANDMARK_GLOBAL"
  • "CJ_PHILIPPINES"
  • "LOTTE"
  • "SEUR_ES"
  • "DAYROSS"
  • "DBSCHENKER_B2B"
  • "NINJAVAN_VN"
  • "TIPSA_REF"
  • "MRW_FTP"
  • "COMET_TECH"
  • "BESTWAYPARCEL"
  • "HERMES_DE_FTP"
  • "VIA_EXPRESS"
  • "ELTA_GR"
  • "CN_BOXC"
  • "XPO_LOGISTICS"
  • "TANET"
  • "BRT_IT_PARCELID"
  • "FOUR_PX_EXPRESS"
  • "IVOY_WEBHOOK"
  • "LOGISTICSWORLDWIDE_KR"
  • "ANJUN"
  • "WHISTL"
  • "J_NET"
  • "DELTEC_UK"
  • "ARE_EMIRATES_POST"
  • "GATI_KWE_API"
  • "BIOCAIR_FTP"
  • "DIRECTFREIGHT_AU_REF"
  • "SPEEDAF"
  • "INTERPARCEL_NZ"
  • "DHL_API"
  • "JANIO"
  • "DPD_CH_SFTP"
  • "LINE"
  • "GEL_EXPRESS"
  • "OKAYPARCEL"
  • "T_CAT"
  • "BH_WORLDWIDE"
  • "EURODIS"
  • "PANTHER_ORDER_NUMBER"
  • "GLOBALTRANZ"
  • "STONE3PL"
  • "SEINO"
  • "GB_NORSK"
  • "DESCARTES"
  • "YURTICI_KARGO"
  • "DTD_EXPR"
  • "TIGFREIGHT"
  • "HRPARCEL"
  • "TOLL"
  • "USPS_WEBHOOK"
  • "GWLOGIS_API"
  • "GENIKI_GR"
  • "SPEEDEXCOURIER"
  • "DMFGROUP"
  • "NIPPON_EXPRESS"
  • "JTEXPRESS"
  • "ETOWER"
  • "ZYLLEM"
  • "PARCELPOST_SG"
  • "GEIS"
  • "DELNEXT"
  • "SAP_EXPRESS"
  • "CARIBOU"
  • "BORDEREXPRESS"
  • "AMAZON"
  • "DHL_PIECEID"
  • "DANSKE_FRAGT"
  • "BE_KIALA"
  • "TW_TAIWAN_POST"
  • "GLS_SLOV"
  • "BPOST_API"
  • "MAINWAY"
  • "DIMERCO"
  • "BETTERTRUCKS"
  • "99MINUTOS"
  • "LOGISTERS"
  • "ASENDIA_UK"
  • "TNT_JP"
  • "NYTLOGISTICS"
  • "M_XPRESS"
  • "MAILAMERICAS"
  • "CAPITAL"
  • "BJSHOMEDELIVERY_FTP"
  • "STALLIONEXPRESS"
  • "WAHANA_ID"
  • "WESTGATE_GL"
  • "BERT"
  • "KWT"
  • "BIRDSYSTEM"
  • "ALWAYS_EXPRESS"
  • "TNT_DE"
  • "YUNANT"
  • "SMSA_EXPRESS_WEBHOOK"
  • "MOOVIN"
  • "DYLT"
  • "GB_TUFFNELLS"
  • "CSE"
  • "KYUNGDONG_PARCEL"
  • "_2EBOX"
  • "JTEXPRESS_SG_API"
  • "OSM_WORLDWIDE_SFTP"
  • "LEMAN"
  • "PCFCORP"
  • "IND_GATI"
  • "ENERGOLOGISTIC"
  • "SHADOWFAX"
  • "ARASKARGO"
  • "WEEE"
  • "NINJAVAN_MY"
  • "STARLINKS_API"
  • "P2P_TRC"
  • "DHL"
  • "VTFE"
  • "SNTGLOBAL_API"
  • "INTEL_VALLEY"
  • "TCS"
  • "EMS"
  • "VNM_VIETNAM_POST"
  • "LHT_EXPRESS"
  • "USF_REDDAWAY"
  • "YODEL_DIR"
  • "JANCO"
  • "EKART"
  • "TOURLINE"
  • "CN_BESTEXPRESS"
  • "DHL_ES"
  • "PRIMAMULTICIPTA"
  • "ESP_ENVIALIA"
  • "DIRECTLOG"
  • "JAWAR"
  • "UDS"
  • "URGENT_CARGUS"
  • "RHENUS_UK"
  • "ISRAEL_POST"
  • "LA_POSTE_SUIVI"
  • "DIREX"
  • "ECARGO"
  • "EXPRESSONE_SV"
  • "ESP_REDUR"
  • "PRESIDENT_TRANS"
  • "RUSTON"
  • "SRT_TRANSPORT"
  • "DBSCHENKER_SE"
  • "SHREE_MARUTI"
  • "FASTWAY_ZA"
  • "PANTHER_REFERENCE_API"
  • "AQUILINE"
  • "MADROOEX"
  • "CN_JCEX"
  • "KERRY_ECOMMERCE"
  • "DKSH"
  • "TESTING_COURIER_WEBHOOK"
  • "SKYNET_UAE"
  • "PITNEY_BOWES"
  • "DOORDASH_WEBHOOK"
  • "PACK_MAN"
  • "GLS_CZ"
  • "SHIP_IT_ASIA"
  • "MEGASAVE"
  • "CN_EQUICK"
  • "PB_USPSFLATS_FTP"
  • "JETSHIP_MY"
  • "MEEST"
  • "PONY_EXPRESS"
  • "HELLMANN"
  • "ESDEX"
  • "CITYLINK_MY"
  • "WESTBANK_COURIER"
  • "SEUR_SP_API"
  • "CN_STO"
  • "SHIPTER"
  • "PARCELPOINT"
  • "AOYUE"
  • "JERSEY_POST"
  • "ETOTAL"
  • "DX_SFTP"
  • "ALLIED_EXPRESS_FTP"
  • "ANICAM_BOX"
  • "MYSENDLE_API"
  • "FASTRK_SERV"
  • "PFCEXPRESS"
  • "SKYBOX"
  • "M3LOGISTICS"
  • "IND_DELHIVERY"
  • "IND_FIRSTFLIGHT"
  • "AITWORLDWIDE_API"
  • "KNG"
  • "JOYING_BOX"
  • "SHYPLITE"
  • "DBSCHENKER_API"
  • "CN_WEDO"
  • "HUANTONG"
  • "XGS"
  • "DHL_PL"
  • "UPS_MAIL_INNOVATIONS"
  • "DHL_SUPPLY_CHAIN_AU"
  • "FORRUN"
  • "FLYTEXPRESS"
  • "FLIPXP"
  • "WINIT"
  • "RHENUS_UK_API"
  • "ARK_LOGISTICS"
  • "KOMON_EXPRESS"
  • "SIN_GLBL"
  • "HUBBED"
  • "YODEL"
  • "SHIPENTEGRA"
  • "IBEONE"
  • "KRONOS_WEBHOOK"
  • "BARSAN"
  • "RPX"
  • "CPACKET"
  • "COPA_COURIER"
  • "UC_EXPRE"
  • "HERMES_2MANN_HANDLING"
  • "AU_AU_POST"
  • "DX"
  • "EXPEDITORS_API_REF"
  • "ALLIEDEXPRESS"
  • "FAIRSENDEN_API"
  • "MEX_REDPACK"
  • "TIPSA_API"
  • "INNTRALOG_SFTP"
  • "PARCELSTARS_WEBHOOK"
  • "BRT_IT"
  • "GANGBAO"
  • "DTDC_EXPRESS"
  • "INTEX_DE"
  • "KRONOS"
  • "APC_OVERNIGHT"
  • "PARCELJET"
  • "TNT_CLICK_IT"
  • "TONAMI_FTP"
  • "ALFATREX"
  • "GDPHARM"
  • "MONDIAL_BE"
  • "DPD_PRT"
  • "_6LS"
  • "CUCKOOEXPRESS"
  • "INSTABOX_WEBHOOK"
  • "PATHEON"
  • "SPEEDEX"
  • "NACEX"
  • "CJ_LOGISTICS"
  • "IDN_JNE"
  • "BIGSMART"
  • "WSPEXPRESS"
  • "HK_RPX"
  • "ARG_OCA"
  • "STAR_TRACK_EXPRESS"
  • "SPECTRAN"
  • "HEPPNER"
  • "CFL_LOGISTICS"
  • "MAIL_PLUS"
  • "SAGAWA"
  • "GLOVO"
  • "FMX"
  • "GLS"
  • "PICKUPP_MYS"
  • "LMPARCEL"
  • "AMSTAN"
  • "AIR_CANADA_GLOBAL"
  • "AUS_STARTRACK"
  • "NHANS_SOLUTIONS"
  • "SKY_POSTAL"
  • "PLUS_LOG_UK"
  • "SWISHIP_JP"
  • "ECEXPRESS"
  • "KHM_CAMBODIA_POST"
  • "HUAHAN_EXPRESS"
  • "DELIVERE"
  • "POSTEN_NORGE"
  • "RUSSIAN_POST"
  • "GOJEK"
  • "ECMS"
  • "MAGYAR_POSTA_API"
  • "ASSOCIATED_COURIERS"
  • "CONCISE"
  • "NIPPON_EXPRESS_FTP"
  • "BOND"
  • "AMAZON_FBA_SWISHIP"
  • "AIRMEE_WEBHOOK"
  • "MYS_MYPOST_ONLINE"
  • "DHL_ES_SFTP"
  • "DPD_UK"
  • "POSTAPLUS"
  • "SEFL"
  • "HERMES_DE"
  • "FEDEX"
  • "AO_COURIER"
  • "GRANDSLAMEXPRESS"
  • "CYPRUS_POST_CYP"
  • "SOUTH_AFRICAN_POST_OFFICE"
  • "KANGAROO_MY"
  • "JINDOUYUN"
  • "CORREOS_EXPRESS"
  • "DHL_AT"
  • "DHL_SFTP"
  • "BLUESTAR"
  • "WMG"
  • "HX_EXPRESS"
  • "SGLINK"
  • "SENDY"
  • "VIWO"
  • "PROFESSIONAL_COURIERS"
  • "BOLLORE_LOGISTICS"
  • "EMS_CN"
  • "_360LION"
  • "GBA"
  • "NINJAVAN_WB"
  • "NLD_GLS"
  • "HOME_DELIVERY_SOLUTIONS"
  • "NATIONWIDE_MY"
  • "CBL_LOGISTICA"
  • "INDIA_POST"
  • "UP_EXPRESS"
  • "CA_CANADA_POST"
  • "GLOBAL_ABF"
  • "SBERLOGISTICS_RU"
  • "TOLL_IPEC"
  • "ZIINGFINALMILE"
  • "MONDIALRELAY_FR"
  • "FAN"
  • "IDN_POS"
  • "MALCA_AMIT_API"
  • "FAR_INTERNATIONAL"
  • "SHREE_ANJANI_COURIER"
  • "MOVIANTO"
  • "FRONTDOORCORP"
  • "INTIME_FTP"
  • "ZYOU"
  • "PRESSIODE"
  • "EP_BOX"
  • "EFEX"
  • "SWISHIP_DE"
  • "BRAUNSEXPRESS"
  • "SWISS_POST"
  • "INTELIPOST"
  • "RPD2MAN"
  • "WEPOST"
  • "PRT_CHRONOPOST"
  • "TAQBIN_SG_API"
  • "DPD_DELISTRACK"
  • "BRINGER"
  • "CESKAPOSTA_API"
  • "DOMINO"
  • "PACK_UP"
  • "DACHSER"
  • "ATA"
  • "TNT"
  • "POSTPLUS"
  • "TRANSMISSION"
  • "OZEPARTS_SHIPPING"
  • "ADICIONAL"
  • "DHL_REFR"
  • "CROSSFLIGHT"
  • "DX_FREIGHT"
  • "CHITCHATS"
  • "OMNIVA"
  • "COURIERPLUS"
  • "PICKRR"
  • "SHIPPIFY"
  • "MIKROPAKKET"
  • "SKYKING"
  • "FASTWAY_US"
  • "POSTNL_INT_3_S"
  • "SHOPFANS"
  • "PROMEDDELIVERY"
  • "FARGOOD"
  • "ELITE_CO"
  • "MAILPLUS_JPN"
  • "CN_17POST"
  • "DPD_FR"
  • "MORE_LINK"
  • "PAPA_WEBHOOK"
  • "BEL_RS"
  • "ROCHE_INTERNAL_SFTP"
  • "SMTL"
  • "UPS_API"
  • "CEVA_TRACKING"
  • "GW_WORLD"
  • "DHL_GLOBAL_MAIL_API"
  • "GLS_DE"
  • "PAQUETEXPRESS"
  • "DHL_ACTIVE_TRACING"
  • "WELIVERY"
  • "BE_BPOST"
  • "RAIDEREX"
  • "LTU_LIETUVOS"
  • "OHI_WEBHOOK"
  • "NEWAY"
  • "FXTRAN"
  • "DIRECTPARCELS"
  • "COURANT_PLUS"
  • "SHREETIRUPATI"
  • "PAKAJO"
  • "MUDITA"
  • "PUROLATOR_INTERNATIONAL"
  • "SOLISTICA_API"
  • "ASIGNA"
  • "AFLLOG_FTP"
  • "TAQBIN_HK"
  • "GOBOLT"
  • "MWD_API"
  • "NOX_NACHTEXPRESS"
  • "SAGAWA_API"
  • "OMLOGISTICS_API"
  • "MYS_AIRPAK"
  • "TRANSVIRTUAL"
  • "DESTINY"
  • "AMAZON_ORDER"
  • "DISCOUNTPOST"
  • "IBVENTURE_WEBHOOK"
  • "SWISS_UNIVERSAL_EXPRESS"
  • "MNG_KARGO"
  • "DHL_AU"
  • "PAYO"
  • "CN_WISHPOST"
  • "AU_AUSTRIAN_POST"
  • "CUSTOMCO_API"
  • "LION_PARCEL"
  • "THA_THAILAND_POST"
  • "NOX_NIGHT_TIME_EXPRESS"
  • "CELERITAS"
  • "SK_POSTA"
  • "CLICKLINK_SFTP"
  • "PLYCONGROUP"
  • "TOLL_WEBHOOK"
  • "TRUNKRS_WEBHOOK"
  • "DPD_LOCAL_REF"
  • "TUSKLOGISTICS"
  • "SHOWL"
  • "LOGWIN_LOGISTICS"
  • "INDOPAKET"
  • "MYHERMES"
  • "SECRETLAB_WEBHOOK"
  • "WORLDCOURIER"
  • "BG_BULGARIAN_POST"
  • "IDEXPRESS"
  • "PADTF"
  • "ITHINKLOGISTICS"
  • "BUYLOGIC"
  • "NEWGISTICS"
  • "GRUPO"
  • "ARAMEX_AU"
  • "SF_EXPRESS_CN"
  • "VNPOST_EMS"
items[] Array No

An array of details of items in the shipment.

items[].name String No

The item name or title.

items[].sku String No

The stock keeping unit (SKU) for the item. This can contain unicode characters.

items[].url String No

The URL to the item being purchased. Visible to buyer and used in buyer experiences.

items[].quantity String No

The item quantity. Must be a whole number.

items[].upc Object No

The Universal Product Code of the item.

items[].upc.type String Yes

The Universal Product Code type.

Possible values:

  • "UPC-C"
  • "UPC-B"
  • "UPC-2"
  • "UPC-E"
  • "UPC-5"
  • "UPC-D"
  • "UPC-A"
items[].upc.code String Yes

The UPC product code of the item.

items[].image_url String No

The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored.

carrier_name_other String No

The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode.

tracking_number String No

The tracking number for the shipment. This property supports Unicode.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.