Add Tracking API
- Update tracking details.
- Show tracking details.
- Cancel tracking numbers.
Trackers (resource group)
Use the /trackers
resource to create and manage tracking information for PayPal transactions.
Update or cancel tracking information for PayPal transaction
status
to CANCELLED
. For more information, see Update or cancel tracking information.Path parameters
id
string
required
The ID of the tracker in the
transaction_id-tracking_number
format.
Request body
status
enum
required
The status of the item shipment. For allowed values, see Shipping Statuses.
The possible values are:
CANCELLED
. The shipment was cancelled and the tracking number no longer applies.DELIVERED
. The item was already delivered when the tracking number was uploaded.LOCAL_PICKUP
. Either the buyer physically picked up the item or the seller delivered the item in person without involving any couriers or postal companies.ON_HOLD
. The item is on hold. Its shipment was temporarily stopped due to bad weather, a strike, customs, or another reason.SHIPPED
. The item was shipped and is on the way.SHIPMENT_CREATED
. The shipment was created.DROPPED_OFF
. The shipment was dropped off.IN_TRANSIT
. The shipment is in transit on its way to the buyer.RETURNED
. The shipment was returned.LABEL_PRINTED
. The label was printed for the shipment.ERROR
. An error occurred with the shipment.UNCONFIRMED
. The shipment is unconfirmed.PICKUP_FAILED
. Pick-up failed for the shipment.DELIVERY_DELAYED
. The delivery was delayed for the shipment.DELIVERY_SCHEDULED
. The delivery was scheduled for the shipment.DELIVERY_FAILED
. The delivery failed for the shipment.INRETURN
. The shipment is being returned.IN_PROCESS
. The shipment is in process.NEW
. The shipment is new.VOID
. If the shipment is cancelled for any reason, its state is void.PROCESSED
. The shipment was processed.NOT_SHIPPED
. The shipment was not shipped.
transaction_id
string
required
The PayPal transaction ID.
carrier
enum
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_other_name
toOTHER
. For allowed values, see Carriers.The possible values are:
ACOMMERCE
. aCommerce.PHL_2GO
. 2GO PhilippinesAU_DHL_EXPRESS
. DHL Express Australia.BEL_DHL
. DHL Belgium.DE_DHL_DEUTSHCE_POST_INTL_SHIPMENTS
. Deutsche Post DHL Post International GermanyIE_AN_POST_REGISTERED
. Post Registered IrelandAU_AU_POST
. Australian Postal Corporation.SPEEDEXCOURIER
. Speedex Courier.UK_ROYALMAIL_SPECIAL
. Royal Mail Special Delivery UKFR_COLIS
. Colis France.VNPOST_EMS
. Post EMS Vietnam.NL_FEDEX
. Federal Express NetherlandsCN_EMS
. EMS China.IT_POSTE_ITALIANE
. Poste Italiane.HK_DHL_ECOMMERCE
. DHL eCommerce Hong Kong.ARAMEX
. Aramex.AU_OTHER
. Other - Australia.TW_CHUNGHWA_POST
. Chunghwa POST TaiwanDPEX
. DPEX Worldwide.POST_SERBIA
. Pošta Srbije.PL_POCZTEX
. PocztexCNEXPS
. CN Express China.DIRECTLOG
. Directlog.ES_CORREOS_DE_ESPANA
. Correos de EspanaBE_KIALA
. Kiala Point BelgiumALPHAFAST
. Alphafast.UKR_POSHTA
. Ukrposhta - Ukraine's National Post.CN_FEDEX
. Federal Express ChinaBUYLOGIC
. Buylogic.IT_DHL_ECOMMERCE
. DHL eCommerce Italy.NINJAVAN_MY
. Ninjavan Malaysia.JPN_YAMATO
. Yamato Japan.POSTNORD_LOGISTICS
. Post Nord Logistics.US_DHL_GLOBALFORWARDING
. DHL Global Forwarding US.IT_SGT
. SGT Corriere Espresso Italy.NINJAVAN_PHILIPPINES
. Ninja Van Philippines.EKART
. Ekart.IDN_WAHANA
. Wahana Indonesia.FR_GLS
. General Logistics Systems (GLS) France.IDN_POS_INT
. Pos Indonesia International.DE_HERMES
. Hermes Germany.PRT_CHRONOPOST
. Chronopost Portugal.MYS_MYS_POST
. Pos Malaysia.WEBINTERPRET
. WebInterpret.BG_BULGARIAN_POST
. Bulgarian Post.NL_TPG
. TPG Post NetherlandsCA_CANPAR
. Canpar Courier CanadaMYS_AIRPAK
. Airpak Malaysia.MEX_SENDA
. Senda Mexico.LANDMARK_GLOBAL
. Landmark Global.UK_NIGHTLINE
. Nightline UK.JP_UPS
. United Parcel Service JapanUK_DHL
. DHL UK.SG_SG_POST
. Singapore Post.PHL_AIRSPEED
. Airspeed Philippines.DHL
. DHL Express.KR_KOREA_POST
. Korea PostJP_KURO_NEKO_YAMATO_UNYUU
. Kuro Neko Yamato Unyuu JapanIE_AN_POST_SWIFTPOST
. Swift Post IrelandCUCKOOEXPRESS
. Cuckoo Express.FR_OTHER
. Other - France.FASTRAK_TH
. Fastrak Thailand.AU_DHL_ECOMMERCE
. DHL eCommerce Australia.DE_UPS
. United Parcel Service GermanyESHOPWORLD
. EShopWorld.INTERNATIONAL_BRIDGE
. International Bridge.FR_COLIPOSTE
. Coliposte FranceAU_AUSTRIAN_POST
. Austrian Post.IND_DELHIVERY
. Delhivery India.DE_TNT
. TNT Germany.GLOBAL_DHL
. DHL Global.US_DHL_PARCEL
. DHL Parcel US.NL_UPS
. United Parcel Service NetherlandsGB_APC
. APC Overnight UK.IDN_TIKI
. Tiki Indonesia.HERMES
. Hermes.ESP_NACEX
. Nacex Spain.NL_TNT
. TNT Netherlands.DE_FEDEX
. Federal Express GermanyOTHER
. Other.BONDSCOURIERS
. Bonds Couriers.IT_DHL_GLOBALFORWARDING
. DHL Global Forwarding Italy.IDN_LION_PARCEL
. Lion Parcel Indonesia.UK_YODEL
. Yodel UK.IT_DHL_EXPRESS
. DHL Express Italy.PL_DHL_GLOBALFORWARDING
. DHL Global Forwarding PolandDPD_POLAND
. DPD Poland.AU_AUSTRALIA_POST_EXPRESS_POST_PLATINUM
. Australia Post Express Post PlatinumES_TNT
. TNT Spain.CN_DHL_EXPRESS
. DHL Express Canada.DE_DPD
. DPD Germany.DE_DPD_DELISTRACK
. DPD Delistrack GermanyCN_DHL_ECOMMERCE
. DHL eCommerce China.JP_TNT
. TNT Japan.PRT_CTT
. CTT Expresso Portugal.UK_INTERLINK_EXPRESS
. Interlink Express UK.NLD_POSTNL
. PostNL Netherlands.CA_DHL_ECOMMERCE
. DHL eCommerce Canada.SWIFTAIR
. Swift Air.NOR_POSTEN
. Posten Norge.MEX_REDPACK
. Redpack Mexico.PL_MASTERLINK
. Masterlink PolandPL_TNT
. TNT Express PolandNIM_EXPRESS
. Nim Express.PL_UPS
. United Parcel Service PolandUKR_NOVA
. Nova Poshta.QUANTIUM
. Quantium.SENDLE
. Sendle.SG_PARCELPOST
. Parcel Post Singapore.SG_NINJAVAN
. Ninjavan Singapore.BQC_EXPRESS
. BQC Express.RPD2MAN
. RPD2man DeliveriesTHA_KERRY
. Kerry Thailand.MEX_AEROFLASH
. Aeroflash Mexico.SPREADEL
. Spreadel.ESP_REDUR
. Redur Spain.JP_JAPANPOST
. Japan PostARE_EMIRATES_POST
. Emirates Post Group.CN_CHINA_POST_EMS
. China Post EMS Express Mail ServiceUK_DHL_GLOBALFORWARDING
. DHL Global Forwarding UK.CN_SF_EXPRESS
. SF Express China.UK_FEDEX
. Federal Express UKPOL_POCZTA
. Poczta Poland.YANWEN
. Yanwen Express.KOR_CJ
. CJ Korea.DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET
. Deutsche Post DHL Tracknet GermanyIND_XPRESSBEES
. XpressBees India.UK_TNT
. TNT UK.CJ_KOREA_THAI
. CJ Logistics in Thailand.CN_OTHER
. Other - China.IDN_POS
. Indonesia Post.ABC_MAIL
. ABC Mail.UK_UPS
. United Parcel Service UKCHINA_POST
. China Post.PL_DHL_EXPRESS
. DHL Express Poland.ESP_SPANISH_SEUR
. Spanish Seur SpainSG_ZALORA
. Zalora Singapore.MATKAHUOLTO
. Matkahuoloto.FR_LAPOSTE
. Laposte France.KANGAROO_MY
. Kangaroo Express Malaysia.ESP_CORREOS
. Sociedad Estatal Correos y Telégrafos.NL_KIALA
. KIALA NetherlandsIND_BLUEDART
. Blue Dart Express DHL.TUR_PTT
. PTT Turkey.CA_CANNOT_PROVIDE_TRACKING
. Cannot provide tracking - Canada.JPN_SAGAWA
. Sagawa Japan.MYS_SKYNET
. Skynet Malaysia.IT_FERCAM
. Fercam Italy.UK_AIRBORNE_EXPRESS
. Airborne Express UK.CA_OTHER
. Other - Canada.DE_DEUTSHCE_POST_DHL_TRACK_TRACE_EXPRESS
. Deutsche Post DHL Track Trace Express GermanyCORREOS_DE_MEXICO
. Mex Post Correos de Mexico.FR_DHL_GLOBALFORWARDING
. DHL Global Forwarding France.GLOBAL_SKYNET
. Skynet Global.AU_DHL_GLOBALFORWARDING
. DHL Global Forwarding Australia.DE_DHL_GLOBALFORWARDING
. DHL Global Forwarding Germany.SFC_LOGISTICS
. SFC Logistics.US_GLOBEGISTICS
. Globeistics US.CA_DHL_GLOBALFORWARDING
. DHL Global Forwarding Canada.OMNIPARCEL
. Omni Parcel.PHL_AIR21
. Air21 PhilippinesCBL_LOGISTICA
. CBL Logística.FR_MONDIAL
. Mondial France.DE_DHL_ECOMMERCE
. DHL eCommerce Germany.ADICIONAL
. Adicional.CH_SWISS_POST_PRIORITY
. Swiss Post PriorityNL_INTANGIBLE_DIGITAL_SERVICES
. Intangible Digital ServicesDE_ASENDIA
. Asendia Germany.NL_ABC_MAIL
. ABC Mail NetherlandsUK_DELTEC
. Deltec UK.ONE_WORLD
. One World.AIRBORNE_EXPRESS
. Airborne Express.ES_OTHER
. Other - Spain.US_DHL_ECOMMERCE
. DHL eCommerce US.US_ENSENDA
. Ensenda US.CPACKET
. Cpacket.AXL
. AXL Express & Logistics.IND_REDEXPRESS
. Red Express India.NL_LOCAL_PICKUP
. Local PickUp NetherlandsUK_ROYALMAIL_AIRSURE
. Royal Mail AirSure UKFR_TNT
. TNT France.USPS
. United States Postal Service (USPS).RINCOS
. Rincos.B2CEUROPE
. B2C EuropePHL_LBC
. LBC Philippines.SG_TAQBIN
. TA-Q-BIN Parcel Singapore.GR_ELTA
. Elta Greece.WINIT
. WinIt.NLD_DHL
. DHL Netherlands.FR_GEODIS
. Geodis France.DE_DHL_PACKET
. DHL Packet Germany.ARG_OCA
. OCA Argentia.JP_DHL
. DHL Japan.RUSSIAN_POST
. Russian Post.TW_TAIWAN_POST
. Chunghwa Post.UPS
. United Parcel Service of America, Inc..BE_BPOST
. Bpost BelgiumJP_SAGAWA_KYUU_BIN
. Sagawa Kyuu Bin JapanNATIONWIDE_MY
. Nationwide Malaysia.TNT
. TNT Portugal.COURIERS_PLEASE
. Couriers Please.DMM_NETWORK
. DMM Network.TOLL
. Toll.NONE
. NoneIDN_FIRST_LOGISTICS
. First Logistics Indonesia.BH_POSTA
. BH POŠTA.SENDIT
. SendIt.US_DHL_EXPRESS
. DHL Express US.FEDEX
. FedEx.SWE_POSTNORD
. PostNord Sverige.PHL_XEND_EXPRESS
. Xend Express Philippines.POSTI
. Posti.CA_CANADA_POST
. Canada Post.PL_FEXEX
. Fexex PolandCN_EC
. EC China.HK_TAQBIN
. TA-Q-BIN Parcel Hong Kong.UK_AN_POST
. AddressPay UK.WISELOADS
. Wiseloads.PRT_SEUR
. Seur Portugal.US_ONTRAC
. Ontrac US.THA_THAILAND_POST
. Thailand Post.DPE_EXPRESS
. DPE Express.UK_DHL_EXPRESS
. DHL Express UK.NL_DHL
. DHL NetherlandsHK_FLYT_EXPRESS
. Flyt Express Hong KongUK_HERMESWORLD
. Hermesworld UK.IT_REGISTER_MAIL
. Registered Mail Italy.ARG_CORREO
. Correo Argentino.CA_LOOMIS
. Loomis Express CanadaDTDC_AU
. DTDC Australia.DPD
. DPD Global.ASENDIA_HK
. Asendia Hong Kong.UK_ROYALMAIL_RECORDED
. Royal Mail Recorded UKPL_POCZTA_POLSKA
. Poczta PolskaEU_IMX
. IMX EUIDN_PANDU
. Pandu Indonesia.MEX_ESTAFETA
. Estafeta Mexico.SREKOREA
. SRE Korea.CYP_CYPRUS_POST
. Cyprus Post.NZ_COURIER_POST
. CourierPost New Zealand.CN_EMPS
. EMPS China.AU_TNT
. TNT Australia.UK_CANNOT_PROVIDE_TRACKING
. Cannot provide tracking - UK.ES_DHL
. DHL Spain.CONTINENTAL
. Continental.IND_DTDC
. DTDC India.DE_GLS
. General Logistics Systems (GLS) Germany.NLD_GLS
. General Logistics Systems (GLS) Netherlands.UK_DPD
. DPD UK.IT_TNT
. TNT Italy.PL_DHL
. DHL Portugal.JP_NITTSU_PELICAN_BIN
. Nittsu Pelican Bin JapanTHA_DYNAMIC_LOGISTICS
. Dynamic Logistics Thailand.IT_POSTE_ITALIA
. Poste ItaliaUK_ROYALMAIL_INTER_SIGNED
. Royal Mail International Signed UKHERMES_IT
. Hermes Italy.FR_BERT
. Bert France.IND_PROFESSIONAL_COURIERS
. Professional Couriers India.POL_SIODEMKA
. Siodemka Poland.IE_AN_POST_SDS_PRIORITY
. Post SDS Priority IrelandADSONE
. ADSone Cumulus.BRA_CORREIOS
. Correios Brazil.UBI_LOGISTICS
. UBI Logistics.ES_CORREOS
. Sociedad Estatal Correos y Telégrafos.NGA_NIPOST
. Nigerian Postal Service.AUT_AUSTRIAN_POST
. Austrian Post.AU_FASTWAY
. Fastway Australia.AUS_TOLL
. Toll Australia.CA_CANPAR_COURIER
. Canpar Courier Canada.SWE_DIRECTLINK
. Direct Link Sweden.CZE_CESKA
. Česká pošta.ROYAL_MAIL
. Royal Mail.SG_SINGPOST
. SingPost SingaporeIT_OTHER
. Other - Italy.ZA_FASTWAY
. Fastway Couriers (South Africa).SEKOLOGISTICS
. Seko Logistics.CN_UPS
. CN_UPSHUNTER_EXPRESS
. Hunter Express.DE_DHL_PARCEL
. DHL Parcel Germany.NLD_TRANSMISSION
. Transmission Netherlands.CN_TNT
. TNT China.DE_DEUTSCHE
. Deutsche Post Germany.AIRSURE
. Airsure.UK_PARCELFORCE
. Parcelforce UK.SWE_DB
. DB Schenker Sweden.CN_CHINA_POST
. China PostPL_GLS
. General Logistics Systems PolandEU_BPOST
. bpost.RELAIS_COLIS
. Relais Colis.UK_DHL_PARCEL
. DHL Parcel UK.AUS_STARTRACK
. StarTrack AustraliaAU_TOLL_IPEC
. Toll IPEC AustraliaCORREOS_CHILE
. CorreosChile.CH_SWISS_POST_EXPRES
. Swiss Post ExpressMYS_TAQBIN
. TA-Q-BIN Parcel Malaysia.JET_SHIP
. Jetship.HK_DHL_EXPRESS
. DHL Express Hong Kong.IT_SDA
. SDA Express Courier.DE_DHL_DEUTSCHEPOST
. DHL Deutsche Post Germany.HK_DHL_GLOBALFORWARDING
. DHL Global Forwarding Hong Kong.PHL_RAF
. RAF Philippines.IT_GLS
. General Logistics Systems (GLS) Italy.PANTOS
. Pantos.KOR_ECARGO
. Ecargo Korea.AT_AUSTRIAN_POST_EMS
. EMS Express Mail Service AustriaIT_BRT
. BRT Corriere Espresso Italy.CHE_SWISS_POST
. Swiss Post.FASTWAY_NZ
. Fastway New Zealand.IT_EBOOST_SDA
. IT_EBOOST_SDAASENDIA_UK
. Asendia UK.RRDONNELLEY
. RR Donnelley.US_RL
. RL US.GR_GENIKI
. Geniki Greece.DE_DHL_EXPRESS
. DHL Express Germany.CA_GREYHOUND
. Greyhound Canada.UK_COLLECTPLUS
. CollectPlus UK.NINJAVAN_THAI
. Ninjavan Thailand.RABEN_GROUP
. Raben Group.CA_DHL_EXPRESS
. DHL Express Canada.GLOBAL_TNT
. TNT Global.IN_INDIAPOST
. India PostITIS
. ITIS InternationalPHL_JAMEXPRESS
. JamExpress Philippines.PRT_INT_SEUR
. Internationational Seur Portugal.ESP_ASM
. Parcel Monitor Spain.NINJAVAN_ID
. Ninjavan Indonesia.JP_FEDEX
. Federal Express JapanFR_CHRONOPOST
. Chronopost France.FR_SUIVI
. Suivi FedEx FranceFR_TELIWAY
. Teliway France.JPN_JAPAN_POST
. Japan Post.HRV_HRVATSKA
. Hrvatska Pošta.AT_AUSTRIAN_POST_PAKET_PRIME
. Austrian Post Paket PrimeDE_OTHER
. Other - Germany.HK_HONGKONG_POST
. Hong Kong Post.GRC_ACS
. ACS Greece.HUN_MAGYAR
. Magyar Posta.FR_DHL_PARCEL
. DHL Parcel France.UK_OTHER
. Other - UK.LWE_HK
. LWE Hong Kong.EFS
. Enterprise Freight Systems (EFS).PL_DHL_PARCEL
. DHL Parcel Poland.PARCELFORCE
. Parcel Force.AU_AUSTRALIA_POST_EMS
. Australia Post EMSUS_ASCENDIA
. Ascendia US.ROU_POSTA
. Poșta Română.NZ_NZ_POST
. New Zealand Post Limited (NZ).RPX
. RPX International.POSTUR_IS
. Postur.IE_AN_POST_SDS_EMS
. Post SDS EMS Express Mail Service IrelandUK_UK_MAIL
. UK Mail.UK_FASTWAY
. Fastway UK.CORREOS_DE_COSTA_RICA
. Correos de Costa Rica.MYS_CITYLINK
. Citylink Malaysia.PUROLATOR
. Purolator.IND_DOTZOT
. DotZot India.NG_COURIERPLUS
. Courier Plus Nigeria.HK_FOUR_PX_EXPRESS
. 4PX Express Hong KongROCKETPARCEL
. Rocket Parcel International.CN_DHL_GLOBALFORWARDING
. DHL Global Forwarding China.EPARCEL_KR
. EParcel Korea.INPOST_PACZKOMATY
. InPost Paczkomaty.KOR_KOREA_POST
. Korea Post.CA_PUROLATOR
. Purolator CanadaAPR_72
. APR 72.FR_DHL_EXPRESS
. DHL Express France.IDN_JNE
. JNE Indonesia.AU_AUSTRALIA_POST_EPARCEL
. Australia Post EparcelGLOBAL_ESTES
. Estes Global.LTU_LIETUVOS
. Lietuvos paštas Lithuania.THECOURIERGUY
. The Courier Guy.BE_CHRONOPOST
. Chronopost Belgium.VNM_VIETNAM_POST
. Vietnam Post.AU_STAR_TRACK_EXPRESS
. StarTrack Express AustraliaRAM
. JP RAM Shipping.
carrier_name_other
string
The name of the carrier for the shipment. Provide this value only if the carrier parameter is
OTHER
.last_updated_time
The date and time when the tracking information was last updated, in Internet date and time format.
links
array (contains the link_description object)
An array of request-related HATEOAS links.
notify_buyer
boolean
If
true
, sends an email notification to the buyer of the PayPal transaction. The email contains the tracking information that was uploaded through the API.postage_payment_id
string
The postage payment ID.
quantity
integer
The quantity of items shipped.
shipment_date
The date when the shipment occurred, in Internet date and time format.
tracking_number
string
The tracking number for the shipment.
tracking_number_type
enum
The type of tracking number.
The possible values are:
CARRIER_PROVIDED
. A merchant-provided tracking number.E2E_PARTNER_PROVIDED
. A marketplace-provided tracking number.
tracking_number_validated
boolean
Indicates whether the carrier validated the tracking number.
Sample Request
curl -v -X PUT https://api-m.sandbox.paypal.com/v1/shipping/trackers/8MC585209K746392H-443844607820 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
"transaction_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"status": "SHIPPED",
"carrier": "FEDEX"
}'
Response
204 OK
status code with no JSON response body.Sample Response
204 No Content
Show tracking information
Path parameters
id
string
required
The ID of the tracker in the
transaction_id-tracking_number
format.
Sample Request
curl -v -X GET https://api-m.sandbox.paypal.com/v1/shipping/trackers/8MC585209K746392H-443844607820 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token"
Response
200 OK
status code and a JSON response body that shows tracking information.carrier
enum
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_other_name
toOTHER
. For allowed values, see Carriers.The possible values are:
ACOMMERCE
. aCommerce.PHL_2GO
. 2GO PhilippinesAU_DHL_EXPRESS
. DHL Express Australia.BEL_DHL
. DHL Belgium.DE_DHL_DEUTSHCE_POST_INTL_SHIPMENTS
. Deutsche Post DHL Post International GermanyIE_AN_POST_REGISTERED
. Post Registered IrelandAU_AU_POST
. Australian Postal Corporation.SPEEDEXCOURIER
. Speedex Courier.UK_ROYALMAIL_SPECIAL
. Royal Mail Special Delivery UKFR_COLIS
. Colis France.VNPOST_EMS
. Post EMS Vietnam.NL_FEDEX
. Federal Express NetherlandsCN_EMS
. EMS China.IT_POSTE_ITALIANE
. Poste Italiane.HK_DHL_ECOMMERCE
. DHL eCommerce Hong Kong.ARAMEX
. Aramex.AU_OTHER
. Other - Australia.TW_CHUNGHWA_POST
. Chunghwa POST TaiwanDPEX
. DPEX Worldwide.POST_SERBIA
. Pošta Srbije.PL_POCZTEX
. PocztexCNEXPS
. CN Express China.DIRECTLOG
. Directlog.ES_CORREOS_DE_ESPANA
. Correos de EspanaBE_KIALA
. Kiala Point BelgiumALPHAFAST
. Alphafast.UKR_POSHTA
. Ukrposhta - Ukraine's National Post.CN_FEDEX
. Federal Express ChinaBUYLOGIC
. Buylogic.IT_DHL_ECOMMERCE
. DHL eCommerce Italy.NINJAVAN_MY
. Ninjavan Malaysia.JPN_YAMATO
. Yamato Japan.POSTNORD_LOGISTICS
. Post Nord Logistics.US_DHL_GLOBALFORWARDING
. DHL Global Forwarding US.IT_SGT
. SGT Corriere Espresso Italy.NINJAVAN_PHILIPPINES
. Ninja Van Philippines.EKART
. Ekart.IDN_WAHANA
. Wahana Indonesia.FR_GLS
. General Logistics Systems (GLS) France.IDN_POS_INT
. Pos Indonesia International.DE_HERMES
. Hermes Germany.PRT_CHRONOPOST
. Chronopost Portugal.MYS_MYS_POST
. Pos Malaysia.WEBINTERPRET
. WebInterpret.BG_BULGARIAN_POST
. Bulgarian Post.NL_TPG
. TPG Post NetherlandsCA_CANPAR
. Canpar Courier CanadaMYS_AIRPAK
. Airpak Malaysia.MEX_SENDA
. Senda Mexico.LANDMARK_GLOBAL
. Landmark Global.UK_NIGHTLINE
. Nightline UK.JP_UPS
. United Parcel Service JapanUK_DHL
. DHL UK.SG_SG_POST
. Singapore Post.PHL_AIRSPEED
. Airspeed Philippines.DHL
. DHL Express.KR_KOREA_POST
. Korea PostJP_KURO_NEKO_YAMATO_UNYUU
. Kuro Neko Yamato Unyuu JapanIE_AN_POST_SWIFTPOST
. Swift Post IrelandCUCKOOEXPRESS
. Cuckoo Express.FR_OTHER
. Other - France.FASTRAK_TH
. Fastrak Thailand.AU_DHL_ECOMMERCE
. DHL eCommerce Australia.DE_UPS
. United Parcel Service GermanyESHOPWORLD
. EShopWorld.INTERNATIONAL_BRIDGE
. International Bridge.FR_COLIPOSTE
. Coliposte FranceAU_AUSTRIAN_POST
. Austrian Post.IND_DELHIVERY
. Delhivery India.DE_TNT
. TNT Germany.GLOBAL_DHL
. DHL Global.US_DHL_PARCEL
. DHL Parcel US.NL_UPS
. United Parcel Service NetherlandsGB_APC
. APC Overnight UK.IDN_TIKI
. Tiki Indonesia.HERMES
. Hermes.ESP_NACEX
. Nacex Spain.NL_TNT
. TNT Netherlands.DE_FEDEX
. Federal Express GermanyOTHER
. Other.BONDSCOURIERS
. Bonds Couriers.IT_DHL_GLOBALFORWARDING
. DHL Global Forwarding Italy.IDN_LION_PARCEL
. Lion Parcel Indonesia.UK_YODEL
. Yodel UK.IT_DHL_EXPRESS
. DHL Express Italy.PL_DHL_GLOBALFORWARDING
. DHL Global Forwarding PolandDPD_POLAND
. DPD Poland.AU_AUSTRALIA_POST_EXPRESS_POST_PLATINUM
. Australia Post Express Post PlatinumES_TNT
. TNT Spain.CN_DHL_EXPRESS
. DHL Express Canada.DE_DPD
. DPD Germany.DE_DPD_DELISTRACK
. DPD Delistrack GermanyCN_DHL_ECOMMERCE
. DHL eCommerce China.JP_TNT
. TNT Japan.PRT_CTT
. CTT Expresso Portugal.UK_INTERLINK_EXPRESS
. Interlink Express UK.NLD_POSTNL
. PostNL Netherlands.CA_DHL_ECOMMERCE
. DHL eCommerce Canada.SWIFTAIR
. Swift Air.NOR_POSTEN
. Posten Norge.MEX_REDPACK
. Redpack Mexico.PL_MASTERLINK
. Masterlink PolandPL_TNT
. TNT Express PolandNIM_EXPRESS
. Nim Express.PL_UPS
. United Parcel Service PolandUKR_NOVA
. Nova Poshta.QUANTIUM
. Quantium.SENDLE
. Sendle.SG_PARCELPOST
. Parcel Post Singapore.SG_NINJAVAN
. Ninjavan Singapore.BQC_EXPRESS
. BQC Express.RPD2MAN
. RPD2man DeliveriesTHA_KERRY
. Kerry Thailand.MEX_AEROFLASH
. Aeroflash Mexico.SPREADEL
. Spreadel.ESP_REDUR
. Redur Spain.JP_JAPANPOST
. Japan PostARE_EMIRATES_POST
. Emirates Post Group.CN_CHINA_POST_EMS
. China Post EMS Express Mail ServiceUK_DHL_GLOBALFORWARDING
. DHL Global Forwarding UK.CN_SF_EXPRESS
. SF Express China.UK_FEDEX
. Federal Express UKPOL_POCZTA
. Poczta Poland.YANWEN
. Yanwen Express.KOR_CJ
. CJ Korea.DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET
. Deutsche Post DHL Tracknet GermanyIND_XPRESSBEES
. XpressBees India.UK_TNT
. TNT UK.CJ_KOREA_THAI
. CJ Logistics in Thailand.CN_OTHER
. Other - China.IDN_POS
. Indonesia Post.ABC_MAIL
. ABC Mail.UK_UPS
. United Parcel Service UKCHINA_POST
. China Post.PL_DHL_EXPRESS
. DHL Express Poland.ESP_SPANISH_SEUR
. Spanish Seur SpainSG_ZALORA
. Zalora Singapore.MATKAHUOLTO
. Matkahuoloto.FR_LAPOSTE
. Laposte France.KANGAROO_MY
. Kangaroo Express Malaysia.ESP_CORREOS
. Sociedad Estatal Correos y Telégrafos.NL_KIALA
. KIALA NetherlandsIND_BLUEDART
. Blue Dart Express DHL.TUR_PTT
. PTT Turkey.CA_CANNOT_PROVIDE_TRACKING
. Cannot provide tracking - Canada.JPN_SAGAWA
. Sagawa Japan.MYS_SKYNET
. Skynet Malaysia.IT_FERCAM
. Fercam Italy.UK_AIRBORNE_EXPRESS
. Airborne Express UK.CA_OTHER
. Other - Canada.DE_DEUTSHCE_POST_DHL_TRACK_TRACE_EXPRESS
. Deutsche Post DHL Track Trace Express GermanyCORREOS_DE_MEXICO
. Mex Post Correos de Mexico.FR_DHL_GLOBALFORWARDING
. DHL Global Forwarding France.GLOBAL_SKYNET
. Skynet Global.AU_DHL_GLOBALFORWARDING
. DHL Global Forwarding Australia.DE_DHL_GLOBALFORWARDING
. DHL Global Forwarding Germany.SFC_LOGISTICS
. SFC Logistics.US_GLOBEGISTICS
. Globeistics US.CA_DHL_GLOBALFORWARDING
. DHL Global Forwarding Canada.OMNIPARCEL
. Omni Parcel.PHL_AIR21
. Air21 PhilippinesCBL_LOGISTICA
. CBL Logística.FR_MONDIAL
. Mondial France.DE_DHL_ECOMMERCE
. DHL eCommerce Germany.ADICIONAL
. Adicional.CH_SWISS_POST_PRIORITY
. Swiss Post PriorityNL_INTANGIBLE_DIGITAL_SERVICES
. Intangible Digital ServicesDE_ASENDIA
. Asendia Germany.NL_ABC_MAIL
. ABC Mail NetherlandsUK_DELTEC
. Deltec UK.ONE_WORLD
. One World.AIRBORNE_EXPRESS
. Airborne Express.ES_OTHER
. Other - Spain.US_DHL_ECOMMERCE
. DHL eCommerce US.US_ENSENDA
. Ensenda US.CPACKET
. Cpacket.AXL
. AXL Express & Logistics.IND_REDEXPRESS
. Red Express India.NL_LOCAL_PICKUP
. Local PickUp NetherlandsUK_ROYALMAIL_AIRSURE
. Royal Mail AirSure UKFR_TNT
. TNT France.USPS
. United States Postal Service (USPS).RINCOS
. Rincos.B2CEUROPE
. B2C EuropePHL_LBC
. LBC Philippines.SG_TAQBIN
. TA-Q-BIN Parcel Singapore.GR_ELTA
. Elta Greece.WINIT
. WinIt.NLD_DHL
. DHL Netherlands.FR_GEODIS
. Geodis France.DE_DHL_PACKET
. DHL Packet Germany.ARG_OCA
. OCA Argentia.JP_DHL
. DHL Japan.RUSSIAN_POST
. Russian Post.TW_TAIWAN_POST
. Chunghwa Post.UPS
. United Parcel Service of America, Inc..BE_BPOST
. Bpost BelgiumJP_SAGAWA_KYUU_BIN
. Sagawa Kyuu Bin JapanNATIONWIDE_MY
. Nationwide Malaysia.TNT
. TNT Portugal.COURIERS_PLEASE
. Couriers Please.DMM_NETWORK
. DMM Network.TOLL
. Toll.NONE
. NoneIDN_FIRST_LOGISTICS
. First Logistics Indonesia.BH_POSTA
. BH POŠTA.SENDIT
. SendIt.US_DHL_EXPRESS
. DHL Express US.FEDEX
. FedEx.SWE_POSTNORD
. PostNord Sverige.PHL_XEND_EXPRESS
. Xend Express Philippines.POSTI
. Posti.CA_CANADA_POST
. Canada Post.PL_FEXEX
. Fexex PolandCN_EC
. EC China.HK_TAQBIN
. TA-Q-BIN Parcel Hong Kong.UK_AN_POST
. AddressPay UK.WISELOADS
. Wiseloads.PRT_SEUR
. Seur Portugal.US_ONTRAC
. Ontrac US.THA_THAILAND_POST
. Thailand Post.DPE_EXPRESS
. DPE Express.UK_DHL_EXPRESS
. DHL Express UK.NL_DHL
. DHL NetherlandsHK_FLYT_EXPRESS
. Flyt Express Hong KongUK_HERMESWORLD
. Hermesworld UK.IT_REGISTER_MAIL
. Registered Mail Italy.ARG_CORREO
. Correo Argentino.CA_LOOMIS
. Loomis Express CanadaDTDC_AU
. DTDC Australia.DPD
. DPD Global.ASENDIA_HK
. Asendia Hong Kong.UK_ROYALMAIL_RECORDED
. Royal Mail Recorded UKPL_POCZTA_POLSKA
. Poczta PolskaEU_IMX
. IMX EUIDN_PANDU
. Pandu Indonesia.MEX_ESTAFETA
. Estafeta Mexico.SREKOREA
. SRE Korea.CYP_CYPRUS_POST
. Cyprus Post.NZ_COURIER_POST
. CourierPost New Zealand.CN_EMPS
. EMPS China.AU_TNT
. TNT Australia.UK_CANNOT_PROVIDE_TRACKING
. Cannot provide tracking - UK.ES_DHL
. DHL Spain.CONTINENTAL
. Continental.IND_DTDC
. DTDC India.DE_GLS
. General Logistics Systems (GLS) Germany.NLD_GLS
. General Logistics Systems (GLS) Netherlands.UK_DPD
. DPD UK.IT_TNT
. TNT Italy.PL_DHL
. DHL Portugal.JP_NITTSU_PELICAN_BIN
. Nittsu Pelican Bin JapanTHA_DYNAMIC_LOGISTICS
. Dynamic Logistics Thailand.IT_POSTE_ITALIA
. Poste ItaliaUK_ROYALMAIL_INTER_SIGNED
. Royal Mail International Signed UKHERMES_IT
. Hermes Italy.FR_BERT
. Bert France.IND_PROFESSIONAL_COURIERS
. Professional Couriers India.POL_SIODEMKA
. Siodemka Poland.IE_AN_POST_SDS_PRIORITY
. Post SDS Priority IrelandADSONE
. ADSone Cumulus.BRA_CORREIOS
. Correios Brazil.UBI_LOGISTICS
. UBI Logistics.ES_CORREOS
. Sociedad Estatal Correos y Telégrafos.NGA_NIPOST
. Nigerian Postal Service.AUT_AUSTRIAN_POST
. Austrian Post.AU_FASTWAY
. Fastway Australia.AUS_TOLL
. Toll Australia.CA_CANPAR_COURIER
. Canpar Courier Canada.SWE_DIRECTLINK
. Direct Link Sweden.CZE_CESKA
. Česká pošta.ROYAL_MAIL
. Royal Mail.SG_SINGPOST
. SingPost SingaporeIT_OTHER
. Other - Italy.ZA_FASTWAY
. Fastway Couriers (South Africa).SEKOLOGISTICS
. Seko Logistics.CN_UPS
. CN_UPSHUNTER_EXPRESS
. Hunter Express.DE_DHL_PARCEL
. DHL Parcel Germany.NLD_TRANSMISSION
. Transmission Netherlands.CN_TNT
. TNT China.DE_DEUTSCHE
. Deutsche Post Germany.AIRSURE
. Airsure.UK_PARCELFORCE
. Parcelforce UK.SWE_DB
. DB Schenker Sweden.CN_CHINA_POST
. China PostPL_GLS
. General Logistics Systems PolandEU_BPOST
. bpost.RELAIS_COLIS
. Relais Colis.UK_DHL_PARCEL
. DHL Parcel UK.AUS_STARTRACK
. StarTrack AustraliaAU_TOLL_IPEC
. Toll IPEC AustraliaCORREOS_CHILE
. CorreosChile.CH_SWISS_POST_EXPRES
. Swiss Post ExpressMYS_TAQBIN
. TA-Q-BIN Parcel Malaysia.JET_SHIP
. Jetship.HK_DHL_EXPRESS
. DHL Express Hong Kong.IT_SDA
. SDA Express Courier.DE_DHL_DEUTSCHEPOST
. DHL Deutsche Post Germany.HK_DHL_GLOBALFORWARDING
. DHL Global Forwarding Hong Kong.PHL_RAF
. RAF Philippines.IT_GLS
. General Logistics Systems (GLS) Italy.PANTOS
. Pantos.KOR_ECARGO
. Ecargo Korea.AT_AUSTRIAN_POST_EMS
. EMS Express Mail Service AustriaIT_BRT
. BRT Corriere Espresso Italy.CHE_SWISS_POST
. Swiss Post.FASTWAY_NZ
. Fastway New Zealand.IT_EBOOST_SDA
. IT_EBOOST_SDAASENDIA_UK
. Asendia UK.RRDONNELLEY
. RR Donnelley.US_RL
. RL US.GR_GENIKI
. Geniki Greece.DE_DHL_EXPRESS
. DHL Express Germany.CA_GREYHOUND
. Greyhound Canada.UK_COLLECTPLUS
. CollectPlus UK.NINJAVAN_THAI
. Ninjavan Thailand.RABEN_GROUP
. Raben Group.CA_DHL_EXPRESS
. DHL Express Canada.GLOBAL_TNT
. TNT Global.IN_INDIAPOST
. India PostITIS
. ITIS InternationalPHL_JAMEXPRESS
. JamExpress Philippines.PRT_INT_SEUR
. Internationational Seur Portugal.ESP_ASM
. Parcel Monitor Spain.NINJAVAN_ID
. Ninjavan Indonesia.JP_FEDEX
. Federal Express JapanFR_CHRONOPOST
. Chronopost France.FR_SUIVI
. Suivi FedEx FranceFR_TELIWAY
. Teliway France.JPN_JAPAN_POST
. Japan Post.HRV_HRVATSKA
. Hrvatska Pošta.AT_AUSTRIAN_POST_PAKET_PRIME
. Austrian Post Paket PrimeDE_OTHER
. Other - Germany.HK_HONGKONG_POST
. Hong Kong Post.GRC_ACS
. ACS Greece.HUN_MAGYAR
. Magyar Posta.FR_DHL_PARCEL
. DHL Parcel France.UK_OTHER
. Other - UK.LWE_HK
. LWE Hong Kong.EFS
. Enterprise Freight Systems (EFS).PL_DHL_PARCEL
. DHL Parcel Poland.PARCELFORCE
. Parcel Force.AU_AUSTRALIA_POST_EMS
. Australia Post EMSUS_ASCENDIA
. Ascendia US.ROU_POSTA
. Poșta Română.NZ_NZ_POST
. New Zealand Post Limited (NZ).RPX
. RPX International.POSTUR_IS
. Postur.IE_AN_POST_SDS_EMS
. Post SDS EMS Express Mail Service IrelandUK_UK_MAIL
. UK Mail.UK_FASTWAY
. Fastway UK.CORREOS_DE_COSTA_RICA
. Correos de Costa Rica.MYS_CITYLINK
. Citylink Malaysia.PUROLATOR
. Purolator.IND_DOTZOT
. DotZot India.NG_COURIERPLUS
. Courier Plus Nigeria.HK_FOUR_PX_EXPRESS
. 4PX Express Hong KongROCKETPARCEL
. Rocket Parcel International.CN_DHL_GLOBALFORWARDING
. DHL Global Forwarding China.EPARCEL_KR
. EParcel Korea.INPOST_PACZKOMATY
. InPost Paczkomaty.KOR_KOREA_POST
. Korea Post.CA_PUROLATOR
. Purolator CanadaAPR_72
. APR 72.FR_DHL_EXPRESS
. DHL Express France.IDN_JNE
. JNE Indonesia.AU_AUSTRALIA_POST_EPARCEL
. Australia Post EparcelGLOBAL_ESTES
. Estes Global.LTU_LIETUVOS
. Lietuvos paštas Lithuania.THECOURIERGUY
. The Courier Guy.BE_CHRONOPOST
. Chronopost Belgium.VNM_VIETNAM_POST
. Vietnam Post.AU_STAR_TRACK_EXPRESS
. StarTrack Express AustraliaRAM
. JP RAM Shipping.
carrier_name_other
string
The name of the carrier for the shipment. Provide this value only if the carrier parameter is
OTHER
.last_updated_time
The date and time when the tracking information was last updated, in Internet date and time format.
links
array (contains the link_description object)
An array of request-related HATEOAS links.
notify_buyer
boolean
If
true
, sends an email notification to the buyer of the PayPal transaction. The email contains the tracking information that was uploaded through the API.postage_payment_id
string
The postage payment ID.
quantity
integer
The quantity of items shipped.
shipment_date
The date when the shipment occurred, in Internet date and time format.
status
enum
The status of the item shipment. For allowed values, see Shipping Statuses.
The possible values are:
CANCELLED
. The shipment was cancelled and the tracking number no longer applies.DELIVERED
. The item was already delivered when the tracking number was uploaded.LOCAL_PICKUP
. Either the buyer physically picked up the item or the seller delivered the item in person without involving any couriers or postal companies.ON_HOLD
. The item is on hold. Its shipment was temporarily stopped due to bad weather, a strike, customs, or another reason.SHIPPED
. The item was shipped and is on the way.SHIPMENT_CREATED
. The shipment was created.DROPPED_OFF
. The shipment was dropped off.IN_TRANSIT
. The shipment is in transit on its way to the buyer.RETURNED
. The shipment was returned.LABEL_PRINTED
. The label was printed for the shipment.ERROR
. An error occurred with the shipment.UNCONFIRMED
. The shipment is unconfirmed.PICKUP_FAILED
. Pick-up failed for the shipment.DELIVERY_DELAYED
. The delivery was delayed for the shipment.DELIVERY_SCHEDULED
. The delivery was scheduled for the shipment.DELIVERY_FAILED
. The delivery failed for the shipment.INRETURN
. The shipment is being returned.IN_PROCESS
. The shipment is in process.NEW
. The shipment is new.VOID
. If the shipment is cancelled for any reason, its state is void.PROCESSED
. The shipment was processed.NOT_SHIPPED
. The shipment was not shipped.
tracking_number
string
The tracking number for the shipment.
tracking_number_type
enum
The type of tracking number.
The possible values are:
CARRIER_PROVIDED
. A merchant-provided tracking number.E2E_PARTNER_PROVIDED
. A marketplace-provided tracking number.
tracking_number_validated
boolean
Indicates whether the carrier validated the tracking number.
transaction_id
string
The PayPal transaction ID.
Sample Response
{
"transaction_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"status": "SHIPPED",
"carrier": "FEDEX",
"links": [
{
"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/8MC585209K746392H-443844607820",
"rel": "self"
},
{
"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/8MC585209K746392H-443844607820",
"rel": "replace",
"method": "PUT"
},
{
"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers-batch",
"rel": "create",
"method": "POST"
}
]
}
Trackers batch (resource group)
Use the /trackers-batch
resource to add tracking information for multiple PayPal transactions.
Add tracking information for multiple PayPal transactions
Request body
links
array (contains the link_description object)
An array of request-related HATEOAS links.
trackers
array (contains the tracker object)
An array of tracking information for shipments.
Sample Request
curl -v -X POST https://api-m.sandbox.paypal.com/v1/shipping/trackers-batch \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Access-Token" \
-d '{
"trackers": [
{
"transaction_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"status": "SHIPPED",
"carrier": "FEDEX"
},
{
"transaction_id": "53Y56775AE587553X",
"tracking_number": "443844607821",
"status": "SHIPPED",
"carrier": "FEDEX"
}
]
}'
Response
200 OK
status code and a JSON response body that shows tracking information.errors
array (contains the error object)
An array of error responses.
links
array (contains the link_description object)
An array of request-related HATEOAS links.
tracker_identifiers
array (contains the tracker_identifier object)
The batch header.
Sample Response
{
"tracker_identifiers": [
{
"transaction_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"links": [
{
"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/8MC585209K746392H-443844607820",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/8MC585209K746392H-443844607820",
"rel": "replace",
"method": "PUT"
}
]
},
{
"transaction_id": "53Y56775AE587553X",
"tracking_number": "443844607821",
"links": [
{
"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/53Y56775AE587553X-443844607821",
"rel": "self",
"method": "GET"
},
{
"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/53Y56775AE587553X-443844607821",
"rel": "replace",
"method": "PUT"
}
]
}
],
"errors": [
{
"name": "RESOURCE_NOT_FOUND",
"debug_id": "46735c7461f3d",
"message": "The specified resource does not exist.",
"details": [
{
"field": "/trackers/0/transaction_id",
"value": "8MC585309K746392H",
"location": "body",
"issue": "INVALID_TRANSACTION_ID"
}
]
}
],
"links": [
{
"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers-batch",
"rel": "self",
"method": "POST"
}
]
}
Common object definitions
batch_tracker_collection
errors
array (contains the error object)
An array of error responses.
links
array (contains the link_description object)
An array of request-related HATEOAS links.
tracker_identifiers
array (contains the tracker_identifier object)
The batch header.
carrier
carrier
enum
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_other_name
toOTHER
. For allowed values, see Carriers.The possible values are:
ACOMMERCE
. aCommerce.PHL_2GO
. 2GO PhilippinesAU_DHL_EXPRESS
. DHL Express Australia.BEL_DHL
. DHL Belgium.DE_DHL_DEUTSHCE_POST_INTL_SHIPMENTS
. Deutsche Post DHL Post International GermanyIE_AN_POST_REGISTERED
. Post Registered IrelandAU_AU_POST
. Australian Postal Corporation.SPEEDEXCOURIER
. Speedex Courier.UK_ROYALMAIL_SPECIAL
. Royal Mail Special Delivery UKFR_COLIS
. Colis France.VNPOST_EMS
. Post EMS Vietnam.NL_FEDEX
. Federal Express NetherlandsCN_EMS
. EMS China.IT_POSTE_ITALIANE
. Poste Italiane.HK_DHL_ECOMMERCE
. DHL eCommerce Hong Kong.ARAMEX
. Aramex.AU_OTHER
. Other - Australia.TW_CHUNGHWA_POST
. Chunghwa POST TaiwanDPEX
. DPEX Worldwide.POST_SERBIA
. Pošta Srbije.PL_POCZTEX
. PocztexCNEXPS
. CN Express China.DIRECTLOG
. Directlog.ES_CORREOS_DE_ESPANA
. Correos de EspanaBE_KIALA
. Kiala Point BelgiumALPHAFAST
. Alphafast.UKR_POSHTA
. Ukrposhta - Ukraine's National Post.CN_FEDEX
. Federal Express ChinaBUYLOGIC
. Buylogic.IT_DHL_ECOMMERCE
. DHL eCommerce Italy.NINJAVAN_MY
. Ninjavan Malaysia.JPN_YAMATO
. Yamato Japan.POSTNORD_LOGISTICS
. Post Nord Logistics.US_DHL_GLOBALFORWARDING
. DHL Global Forwarding US.IT_SGT
. SGT Corriere Espresso Italy.NINJAVAN_PHILIPPINES
. Ninja Van Philippines.EKART
. Ekart.IDN_WAHANA
. Wahana Indonesia.FR_GLS
. General Logistics Systems (GLS) France.IDN_POS_INT
. Pos Indonesia International.DE_HERMES
. Hermes Germany.PRT_CHRONOPOST
. Chronopost Portugal.MYS_MYS_POST
. Pos Malaysia.WEBINTERPRET
. WebInterpret.BG_BULGARIAN_POST
. Bulgarian Post.NL_TPG
. TPG Post NetherlandsCA_CANPAR
. Canpar Courier CanadaMYS_AIRPAK
. Airpak Malaysia.MEX_SENDA
. Senda Mexico.LANDMARK_GLOBAL
. Landmark Global.UK_NIGHTLINE
. Nightline UK.JP_UPS
. United Parcel Service JapanUK_DHL
. DHL UK.SG_SG_POST
. Singapore Post.PHL_AIRSPEED
. Airspeed Philippines.DHL
. DHL Express.KR_KOREA_POST
. Korea PostJP_KURO_NEKO_YAMATO_UNYUU
. Kuro Neko Yamato Unyuu JapanIE_AN_POST_SWIFTPOST
. Swift Post IrelandCUCKOOEXPRESS
. Cuckoo Express.FR_OTHER
. Other - France.FASTRAK_TH
. Fastrak Thailand.AU_DHL_ECOMMERCE
. DHL eCommerce Australia.DE_UPS
. United Parcel Service GermanyESHOPWORLD
. EShopWorld.INTERNATIONAL_BRIDGE
. International Bridge.FR_COLIPOSTE
. Coliposte FranceAU_AUSTRIAN_POST
. Austrian Post.IND_DELHIVERY
. Delhivery India.DE_TNT
. TNT Germany.GLOBAL_DHL
. DHL Global.US_DHL_PARCEL
. DHL Parcel US.NL_UPS
. United Parcel Service NetherlandsGB_APC
. APC Overnight UK.IDN_TIKI
. Tiki Indonesia.HERMES
. Hermes.ESP_NACEX
. Nacex Spain.NL_TNT
. TNT Netherlands.DE_FEDEX
. Federal Express GermanyOTHER
. Other.BONDSCOURIERS
. Bonds Couriers.IT_DHL_GLOBALFORWARDING
. DHL Global Forwarding Italy.IDN_LION_PARCEL
. Lion Parcel Indonesia.UK_YODEL
. Yodel UK.IT_DHL_EXPRESS
. DHL Express Italy.PL_DHL_GLOBALFORWARDING
. DHL Global Forwarding PolandDPD_POLAND
. DPD Poland.AU_AUSTRALIA_POST_EXPRESS_POST_PLATINUM
. Australia Post Express Post PlatinumES_TNT
. TNT Spain.CN_DHL_EXPRESS
. DHL Express Canada.DE_DPD
. DPD Germany.DE_DPD_DELISTRACK
. DPD Delistrack GermanyCN_DHL_ECOMMERCE
. DHL eCommerce China.JP_TNT
. TNT Japan.PRT_CTT
. CTT Expresso Portugal.UK_INTERLINK_EXPRESS
. Interlink Express UK.NLD_POSTNL
. PostNL Netherlands.CA_DHL_ECOMMERCE
. DHL eCommerce Canada.SWIFTAIR
. Swift Air.NOR_POSTEN
. Posten Norge.MEX_REDPACK
. Redpack Mexico.PL_MASTERLINK
. Masterlink PolandPL_TNT
. TNT Express PolandNIM_EXPRESS
. Nim Express.PL_UPS
. United Parcel Service PolandUKR_NOVA
. Nova Poshta.QUANTIUM
. Quantium.SENDLE
. Sendle.SG_PARCELPOST
. Parcel Post Singapore.SG_NINJAVAN
. Ninjavan Singapore.BQC_EXPRESS
. BQC Express.RPD2MAN
. RPD2man DeliveriesTHA_KERRY
. Kerry Thailand.MEX_AEROFLASH
. Aeroflash Mexico.SPREADEL
. Spreadel.ESP_REDUR
. Redur Spain.JP_JAPANPOST
. Japan PostARE_EMIRATES_POST
. Emirates Post Group.CN_CHINA_POST_EMS
. China Post EMS Express Mail ServiceUK_DHL_GLOBALFORWARDING
. DHL Global Forwarding UK.CN_SF_EXPRESS
. SF Express China.UK_FEDEX
. Federal Express UKPOL_POCZTA
. Poczta Poland.YANWEN
. Yanwen Express.KOR_CJ
. CJ Korea.DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET
. Deutsche Post DHL Tracknet GermanyIND_XPRESSBEES
. XpressBees India.UK_TNT
. TNT UK.CJ_KOREA_THAI
. CJ Logistics in Thailand.CN_OTHER
. Other - China.IDN_POS
. Indonesia Post.ABC_MAIL
. ABC Mail.UK_UPS
. United Parcel Service UKCHINA_POST
. China Post.PL_DHL_EXPRESS
. DHL Express Poland.ESP_SPANISH_SEUR
. Spanish Seur SpainSG_ZALORA
. Zalora Singapore.MATKAHUOLTO
. Matkahuoloto.FR_LAPOSTE
. Laposte France.KANGAROO_MY
. Kangaroo Express Malaysia.ESP_CORREOS
. Sociedad Estatal Correos y Telégrafos.NL_KIALA
. KIALA NetherlandsIND_BLUEDART
. Blue Dart Express DHL.TUR_PTT
. PTT Turkey.CA_CANNOT_PROVIDE_TRACKING
. Cannot provide tracking - Canada.JPN_SAGAWA
. Sagawa Japan.MYS_SKYNET
. Skynet Malaysia.IT_FERCAM
. Fercam Italy.UK_AIRBORNE_EXPRESS
. Airborne Express UK.CA_OTHER
. Other - Canada.DE_DEUTSHCE_POST_DHL_TRACK_TRACE_EXPRESS
. Deutsche Post DHL Track Trace Express GermanyCORREOS_DE_MEXICO
. Mex Post Correos de Mexico.FR_DHL_GLOBALFORWARDING
. DHL Global Forwarding France.GLOBAL_SKYNET
. Skynet Global.AU_DHL_GLOBALFORWARDING
. DHL Global Forwarding Australia.DE_DHL_GLOBALFORWARDING
. DHL Global Forwarding Germany.SFC_LOGISTICS
. SFC Logistics.US_GLOBEGISTICS
. Globeistics US.CA_DHL_GLOBALFORWARDING
. DHL Global Forwarding Canada.OMNIPARCEL
. Omni Parcel.PHL_AIR21
. Air21 PhilippinesCBL_LOGISTICA
. CBL Logística.FR_MONDIAL
. Mondial France.DE_DHL_ECOMMERCE
. DHL eCommerce Germany.ADICIONAL
. Adicional.CH_SWISS_POST_PRIORITY
. Swiss Post PriorityNL_INTANGIBLE_DIGITAL_SERVICES
. Intangible Digital ServicesDE_ASENDIA
. Asendia Germany.NL_ABC_MAIL
. ABC Mail NetherlandsUK_DELTEC
. Deltec UK.ONE_WORLD
. One World.AIRBORNE_EXPRESS
. Airborne Express.ES_OTHER
. Other - Spain.US_DHL_ECOMMERCE
. DHL eCommerce US.US_ENSENDA
. Ensenda US.CPACKET
. Cpacket.AXL
. AXL Express & Logistics.IND_REDEXPRESS
. Red Express India.NL_LOCAL_PICKUP
. Local PickUp NetherlandsUK_ROYALMAIL_AIRSURE
. Royal Mail AirSure UKFR_TNT
. TNT France.USPS
. United States Postal Service (USPS).RINCOS
. Rincos.B2CEUROPE
. B2C EuropePHL_LBC
. LBC Philippines.SG_TAQBIN
. TA-Q-BIN Parcel Singapore.GR_ELTA
. Elta Greece.WINIT
. WinIt.NLD_DHL
. DHL Netherlands.FR_GEODIS
. Geodis France.DE_DHL_PACKET
. DHL Packet Germany.ARG_OCA
. OCA Argentia.JP_DHL
. DHL Japan.RUSSIAN_POST
. Russian Post.TW_TAIWAN_POST
. Chunghwa Post.UPS
. United Parcel Service of America, Inc..BE_BPOST
. Bpost BelgiumJP_SAGAWA_KYUU_BIN
. Sagawa Kyuu Bin JapanNATIONWIDE_MY
. Nationwide Malaysia.TNT
. TNT Portugal.COURIERS_PLEASE
. Couriers Please.DMM_NETWORK
. DMM Network.TOLL
. Toll.NONE
. NoneIDN_FIRST_LOGISTICS
. First Logistics Indonesia.BH_POSTA
. BH POŠTA.SENDIT
. SendIt.US_DHL_EXPRESS
. DHL Express US.FEDEX
. FedEx.SWE_POSTNORD
. PostNord Sverige.PHL_XEND_EXPRESS
. Xend Express Philippines.POSTI
. Posti.CA_CANADA_POST
. Canada Post.PL_FEXEX
. Fexex PolandCN_EC
. EC China.HK_TAQBIN
. TA-Q-BIN Parcel Hong Kong.UK_AN_POST
. AddressPay UK.WISELOADS
. Wiseloads.PRT_SEUR
. Seur Portugal.US_ONTRAC
. Ontrac US.THA_THAILAND_POST
. Thailand Post.DPE_EXPRESS
. DPE Express.UK_DHL_EXPRESS
. DHL Express UK.NL_DHL
. DHL NetherlandsHK_FLYT_EXPRESS
. Flyt Express Hong KongUK_HERMESWORLD
. Hermesworld UK.IT_REGISTER_MAIL
. Registered Mail Italy.ARG_CORREO
. Correo Argentino.CA_LOOMIS
. Loomis Express CanadaDTDC_AU
. DTDC Australia.DPD
. DPD Global.ASENDIA_HK
. Asendia Hong Kong.UK_ROYALMAIL_RECORDED
. Royal Mail Recorded UKPL_POCZTA_POLSKA
. Poczta PolskaEU_IMX
. IMX EUIDN_PANDU
. Pandu Indonesia.MEX_ESTAFETA
. Estafeta Mexico.SREKOREA
. SRE Korea.CYP_CYPRUS_POST
. Cyprus Post.NZ_COURIER_POST
. CourierPost New Zealand.CN_EMPS
. EMPS China.AU_TNT
. TNT Australia.UK_CANNOT_PROVIDE_TRACKING
. Cannot provide tracking - UK.ES_DHL
. DHL Spain.CONTINENTAL
. Continental.IND_DTDC
. DTDC India.DE_GLS
. General Logistics Systems (GLS) Germany.NLD_GLS
. General Logistics Systems (GLS) Netherlands.UK_DPD
. DPD UK.IT_TNT
. TNT Italy.PL_DHL
. DHL Portugal.JP_NITTSU_PELICAN_BIN
. Nittsu Pelican Bin JapanTHA_DYNAMIC_LOGISTICS
. Dynamic Logistics Thailand.IT_POSTE_ITALIA
. Poste ItaliaUK_ROYALMAIL_INTER_SIGNED
. Royal Mail International Signed UKHERMES_IT
. Hermes Italy.FR_BERT
. Bert France.IND_PROFESSIONAL_COURIERS
. Professional Couriers India.POL_SIODEMKA
. Siodemka Poland.IE_AN_POST_SDS_PRIORITY
. Post SDS Priority IrelandADSONE
. ADSone Cumulus.BRA_CORREIOS
. Correios Brazil.UBI_LOGISTICS
. UBI Logistics.ES_CORREOS
. Sociedad Estatal Correos y Telégrafos.NGA_NIPOST
. Nigerian Postal Service.AUT_AUSTRIAN_POST
. Austrian Post.AU_FASTWAY
. Fastway Australia.AUS_TOLL
. Toll Australia.CA_CANPAR_COURIER
. Canpar Courier Canada.SWE_DIRECTLINK
. Direct Link Sweden.CZE_CESKA
. Česká pošta.ROYAL_MAIL
. Royal Mail.SG_SINGPOST
. SingPost SingaporeIT_OTHER
. Other - Italy.ZA_FASTWAY
. Fastway Couriers (South Africa).SEKOLOGISTICS
. Seko Logistics.CN_UPS
. CN_UPSHUNTER_EXPRESS
. Hunter Express.DE_DHL_PARCEL
. DHL Parcel Germany.NLD_TRANSMISSION
. Transmission Netherlands.CN_TNT
. TNT China.DE_DEUTSCHE
. Deutsche Post Germany.AIRSURE
. Airsure.UK_PARCELFORCE
. Parcelforce UK.SWE_DB
. DB Schenker Sweden.CN_CHINA_POST
. China PostPL_GLS
. General Logistics Systems PolandEU_BPOST
. bpost.RELAIS_COLIS
. Relais Colis.UK_DHL_PARCEL
. DHL Parcel UK.AUS_STARTRACK
. StarTrack AustraliaAU_TOLL_IPEC
. Toll IPEC AustraliaCORREOS_CHILE
. CorreosChile.CH_SWISS_POST_EXPRES
. Swiss Post ExpressMYS_TAQBIN
. TA-Q-BIN Parcel Malaysia.JET_SHIP
. Jetship.HK_DHL_EXPRESS
. DHL Express Hong Kong.IT_SDA
. SDA Express Courier.DE_DHL_DEUTSCHEPOST
. DHL Deutsche Post Germany.HK_DHL_GLOBALFORWARDING
. DHL Global Forwarding Hong Kong.PHL_RAF
. RAF Philippines.IT_GLS
. General Logistics Systems (GLS) Italy.PANTOS
. Pantos.KOR_ECARGO
. Ecargo Korea.AT_AUSTRIAN_POST_EMS
. EMS Express Mail Service AustriaIT_BRT
. BRT Corriere Espresso Italy.CHE_SWISS_POST
. Swiss Post.FASTWAY_NZ
. Fastway New Zealand.IT_EBOOST_SDA
. IT_EBOOST_SDAASENDIA_UK
. Asendia UK.RRDONNELLEY
. RR Donnelley.US_RL
. RL US.GR_GENIKI
. Geniki Greece.DE_DHL_EXPRESS
. DHL Express Germany.CA_GREYHOUND
. Greyhound Canada.UK_COLLECTPLUS
. CollectPlus UK.NINJAVAN_THAI
. Ninjavan Thailand.RABEN_GROUP
. Raben Group.CA_DHL_EXPRESS
. DHL Express Canada.GLOBAL_TNT
. TNT Global.IN_INDIAPOST
. India PostITIS
. ITIS InternationalPHL_JAMEXPRESS
. JamExpress Philippines.PRT_INT_SEUR
. Internationational Seur Portugal.ESP_ASM
. Parcel Monitor Spain.NINJAVAN_ID
. Ninjavan Indonesia.JP_FEDEX
. Federal Express JapanFR_CHRONOPOST
. Chronopost France.FR_SUIVI
. Suivi FedEx FranceFR_TELIWAY
. Teliway France.JPN_JAPAN_POST
. Japan Post.HRV_HRVATSKA
. Hrvatska Pošta.AT_AUSTRIAN_POST_PAKET_PRIME
. Austrian Post Paket PrimeDE_OTHER
. Other - Germany.HK_HONGKONG_POST
. Hong Kong Post.GRC_ACS
. ACS Greece.HUN_MAGYAR
. Magyar Posta.FR_DHL_PARCEL
. DHL Parcel France.UK_OTHER
. Other - UK.LWE_HK
. LWE Hong Kong.EFS
. Enterprise Freight Systems (EFS).PL_DHL_PARCEL
. DHL Parcel Poland.PARCELFORCE
. Parcel Force.AU_AUSTRALIA_POST_EMS
. Australia Post EMSUS_ASCENDIA
. Ascendia US.ROU_POSTA
. Poșta Română.NZ_NZ_POST
. New Zealand Post Limited (NZ).RPX
. RPX International.POSTUR_IS
. Postur.IE_AN_POST_SDS_EMS
. Post SDS EMS Express Mail Service IrelandUK_UK_MAIL
. UK Mail.UK_FASTWAY
. Fastway UK.CORREOS_DE_COSTA_RICA
. Correos de Costa Rica.MYS_CITYLINK
. Citylink Malaysia.PUROLATOR
. Purolator.IND_DOTZOT
. DotZot India.NG_COURIERPLUS
. Courier Plus Nigeria.HK_FOUR_PX_EXPRESS
. 4PX Express Hong KongROCKETPARCEL
. Rocket Parcel International.CN_DHL_GLOBALFORWARDING
. DHL Global Forwarding China.EPARCEL_KR
. EParcel Korea.INPOST_PACZKOMATY
. InPost Paczkomaty.KOR_KOREA_POST
. Korea Post.CA_PUROLATOR
. Purolator CanadaAPR_72
. APR 72.FR_DHL_EXPRESS
. DHL Express France.IDN_JNE
. JNE Indonesia.AU_AUSTRALIA_POST_EPARCEL
. Australia Post EparcelGLOBAL_ESTES
. Estes Global.LTU_LIETUVOS
. Lietuvos paštas Lithuania.THECOURIERGUY
. The Courier Guy.BE_CHRONOPOST
. Chronopost Belgium.VNM_VIETNAM_POST
. Vietnam Post.AU_STAR_TRACK_EXPRESS
. StarTrack Express AustraliaRAM
. JP RAM Shipping.
date_no_time
date_no_time
string
The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard
date_time
type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
date_time
date_time
string
The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
error
debug_id
string
required
The PayPal internal ID. Used for correlation purposes.
message
string
required
The message that describes the error.
name
string
required
The human-readable, unique name of the error.
details
array (contains the error_details object)
An array of additional details about the error.
information_link
string
The information link, or URI, that shows detailed information about this error for the developer.
links
array (contains the link_description object)
An array of request-related HATEOAS links.
error_details
issue
string
required
The unique, fine-grained application-level error code.
description
string
The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value.
field
string
The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors.
location
string
The location of the field that caused the error. Value is
body
,path
, orquery
.value
string
The value of the field that caused the error.
link_description
href
string
required
The complete target URL. To make the related call, combine the method with this link, in URI template format. Include the
$
,(
, and)
characters for pre-processing. Thehref
is the key HATEOAS component that links a completed call with a subsequent call.rel
string
required
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
enum
The HTTP method required to make the related call.
link_description
href
string
required
The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the
$
,(
, and)
characters. Thehref
is the key HATEOAS component that links a completed call with a subsequent call.rel
string
required
The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method
enum
The HTTP method required to make the related call.
patch
op
enum
required
The operation.
The possible values are:
add
. Depending on the target location reference, completes one of these functions:- The target location is an array index. Inserts a new value into the array at the specified index.
- The target location is an object parameter that does not already exist. Adds a new parameter to the object.
- The target location is an object parameter that does exist. Replaces that parameter's value.
value
parameter defines the value to add. For more information, see 4.1. add.remove
. Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.replace
. Replaces the value at the target location with a new value. The operation object must contain avalue
parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.move
. Removes the value at a specified location and adds it to the target location. The operation object must contain afrom
parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, thefrom
location must exist. For more information, see 4.4. move.copy
. Copies the value at a specified location to the target location. The operation object must contain afrom
parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, thefrom
location must exist. For more information, see 4.5. copy.test
. Tests that a value at the target location is equal to a specified value. The operation object must contain avalue
parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to thevalue
value. For test,equal
indicates that the value at the target location and the value thatvalue
defines are of the same JSON type. The data type of the value determines how equality is defined:
For more information, see 4.6. test.Type Considered equal if both values strings Contain the same number of Unicode characters and their code points are byte-by-byte equal. numbers Are numerically equal. arrays Contain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules. objects Contain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules). literals ( false
,true
, andnull
)Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
from
string
The JSON Pointer to the target document location from which to move the value. Required for the
move
operation.path
string
The JSON Pointer to the target document location at which to complete the operation.
value
number,integer,string,boolean,null,array,object
The value to apply. The
remove
operation does not require a value.
patch_request
patch_request
array (contains the patch object)
An array of JSON patch objects to apply partial updates to resources.
tracker
status
enum
required
The status of the item shipment. For allowed values, see Shipping Statuses.
The possible values are:
CANCELLED
. The shipment was cancelled and the tracking number no longer applies.DELIVERED
. The item was already delivered when the tracking number was uploaded.LOCAL_PICKUP
. Either the buyer physically picked up the item or the seller delivered the item in person without involving any couriers or postal companies.ON_HOLD
. The item is on hold. Its shipment was temporarily stopped due to bad weather, a strike, customs, or another reason.SHIPPED
. The item was shipped and is on the way.SHIPMENT_CREATED
. The shipment was created.DROPPED_OFF
. The shipment was dropped off.IN_TRANSIT
. The shipment is in transit on its way to the buyer.RETURNED
. The shipment was returned.LABEL_PRINTED
. The label was printed for the shipment.ERROR
. An error occurred with the shipment.UNCONFIRMED
. The shipment is unconfirmed.PICKUP_FAILED
. Pick-up failed for the shipment.DELIVERY_DELAYED
. The delivery was delayed for the shipment.DELIVERY_SCHEDULED
. The delivery was scheduled for the shipment.DELIVERY_FAILED
. The delivery failed for the shipment.INRETURN
. The shipment is being returned.IN_PROCESS
. The shipment is in process.NEW
. The shipment is new.VOID
. If the shipment is cancelled for any reason, its state is void.PROCESSED
. The shipment was processed.NOT_SHIPPED
. The shipment was not shipped.
transaction_id
string
required
The PayPal transaction ID.
carrier
enum
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_other_name
toOTHER
. For allowed values, see Carriers.The possible values are:
ACOMMERCE
. aCommerce.PHL_2GO
. 2GO PhilippinesAU_DHL_EXPRESS
. DHL Express Australia.BEL_DHL
. DHL Belgium.DE_DHL_DEUTSHCE_POST_INTL_SHIPMENTS
. Deutsche Post DHL Post International GermanyIE_AN_POST_REGISTERED
. Post Registered IrelandAU_AU_POST
. Australian Postal Corporation.SPEEDEXCOURIER
. Speedex Courier.UK_ROYALMAIL_SPECIAL
. Royal Mail Special Delivery UKFR_COLIS
. Colis France.VNPOST_EMS
. Post EMS Vietnam.NL_FEDEX
. Federal Express NetherlandsCN_EMS
. EMS China.IT_POSTE_ITALIANE
. Poste Italiane.HK_DHL_ECOMMERCE
. DHL eCommerce Hong Kong.ARAMEX
. Aramex.AU_OTHER
. Other - Australia.TW_CHUNGHWA_POST
. Chunghwa POST TaiwanDPEX
. DPEX Worldwide.POST_SERBIA
. Pošta Srbije.PL_POCZTEX
. PocztexCNEXPS
. CN Express China.DIRECTLOG
. Directlog.ES_CORREOS_DE_ESPANA
. Correos de EspanaBE_KIALA
. Kiala Point BelgiumALPHAFAST
. Alphafast.UKR_POSHTA
. Ukrposhta - Ukraine's National Post.CN_FEDEX
. Federal Express ChinaBUYLOGIC
. Buylogic.IT_DHL_ECOMMERCE
. DHL eCommerce Italy.NINJAVAN_MY
. Ninjavan Malaysia.JPN_YAMATO
. Yamato Japan.POSTNORD_LOGISTICS
. Post Nord Logistics.US_DHL_GLOBALFORWARDING
. DHL Global Forwarding US.IT_SGT
. SGT Corriere Espresso Italy.NINJAVAN_PHILIPPINES
. Ninja Van Philippines.EKART
. Ekart.IDN_WAHANA
. Wahana Indonesia.FR_GLS
. General Logistics Systems (GLS) France.IDN_POS_INT
. Pos Indonesia International.DE_HERMES
. Hermes Germany.PRT_CHRONOPOST
. Chronopost Portugal.MYS_MYS_POST
. Pos Malaysia.WEBINTERPRET
. WebInterpret.BG_BULGARIAN_POST
. Bulgarian Post.NL_TPG
. TPG Post NetherlandsCA_CANPAR
. Canpar Courier CanadaMYS_AIRPAK
. Airpak Malaysia.MEX_SENDA
. Senda Mexico.LANDMARK_GLOBAL
. Landmark Global.UK_NIGHTLINE
. Nightline UK.JP_UPS
. United Parcel Service JapanUK_DHL
. DHL UK.SG_SG_POST
. Singapore Post.PHL_AIRSPEED
. Airspeed Philippines.DHL
. DHL Express.KR_KOREA_POST
. Korea PostJP_KURO_NEKO_YAMATO_UNYUU
. Kuro Neko Yamato Unyuu JapanIE_AN_POST_SWIFTPOST
. Swift Post IrelandCUCKOOEXPRESS
. Cuckoo Express.FR_OTHER
. Other - France.FASTRAK_TH
. Fastrak Thailand.AU_DHL_ECOMMERCE
. DHL eCommerce Australia.DE_UPS
. United Parcel Service GermanyESHOPWORLD
. EShopWorld.INTERNATIONAL_BRIDGE
. International Bridge.FR_COLIPOSTE
. Coliposte FranceAU_AUSTRIAN_POST
. Austrian Post.IND_DELHIVERY
. Delhivery India.DE_TNT
. TNT Germany.GLOBAL_DHL
. DHL Global.US_DHL_PARCEL
. DHL Parcel US.NL_UPS
. United Parcel Service NetherlandsGB_APC
. APC Overnight UK.IDN_TIKI
. Tiki Indonesia.HERMES
. Hermes.ESP_NACEX
. Nacex Spain.NL_TNT
. TNT Netherlands.DE_FEDEX
. Federal Express GermanyOTHER
. Other.BONDSCOURIERS
. Bonds Couriers.IT_DHL_GLOBALFORWARDING
. DHL Global Forwarding Italy.IDN_LION_PARCEL
. Lion Parcel Indonesia.UK_YODEL
. Yodel UK.IT_DHL_EXPRESS
. DHL Express Italy.PL_DHL_GLOBALFORWARDING
. DHL Global Forwarding PolandDPD_POLAND
. DPD Poland.AU_AUSTRALIA_POST_EXPRESS_POST_PLATINUM
. Australia Post Express Post PlatinumES_TNT
. TNT Spain.CN_DHL_EXPRESS
. DHL Express Canada.DE_DPD
. DPD Germany.DE_DPD_DELISTRACK
. DPD Delistrack GermanyCN_DHL_ECOMMERCE
. DHL eCommerce China.JP_TNT
. TNT Japan.PRT_CTT
. CTT Expresso Portugal.UK_INTERLINK_EXPRESS
. Interlink Express UK.NLD_POSTNL
. PostNL Netherlands.CA_DHL_ECOMMERCE
. DHL eCommerce Canada.SWIFTAIR
. Swift Air.NOR_POSTEN
. Posten Norge.MEX_REDPACK
. Redpack Mexico.PL_MASTERLINK
. Masterlink PolandPL_TNT
. TNT Express PolandNIM_EXPRESS
. Nim Express.PL_UPS
. United Parcel Service PolandUKR_NOVA
. Nova Poshta.QUANTIUM
. Quantium.SENDLE
. Sendle.SG_PARCELPOST
. Parcel Post Singapore.SG_NINJAVAN
. Ninjavan Singapore.BQC_EXPRESS
. BQC Express.RPD2MAN
. RPD2man DeliveriesTHA_KERRY
. Kerry Thailand.MEX_AEROFLASH
. Aeroflash Mexico.SPREADEL
. Spreadel.ESP_REDUR
. Redur Spain.JP_JAPANPOST
. Japan PostARE_EMIRATES_POST
. Emirates Post Group.CN_CHINA_POST_EMS
. China Post EMS Express Mail ServiceUK_DHL_GLOBALFORWARDING
. DHL Global Forwarding UK.CN_SF_EXPRESS
. SF Express China.UK_FEDEX
. Federal Express UKPOL_POCZTA
. Poczta Poland.YANWEN
. Yanwen Express.KOR_CJ
. CJ Korea.DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET
. Deutsche Post DHL Tracknet GermanyIND_XPRESSBEES
. XpressBees India.UK_TNT
. TNT UK.CJ_KOREA_THAI
. CJ Logistics in Thailand.CN_OTHER
. Other - China.IDN_POS
. Indonesia Post.ABC_MAIL
. ABC Mail.UK_UPS
. United Parcel Service UKCHINA_POST
. China Post.PL_DHL_EXPRESS
. DHL Express Poland.ESP_SPANISH_SEUR
. Spanish Seur SpainSG_ZALORA
. Zalora Singapore.MATKAHUOLTO
. Matkahuoloto.FR_LAPOSTE
. Laposte France.KANGAROO_MY
. Kangaroo Express Malaysia.ESP_CORREOS
. Sociedad Estatal Correos y Telégrafos.NL_KIALA
. KIALA NetherlandsIND_BLUEDART
. Blue Dart Express DHL.TUR_PTT
. PTT Turkey.CA_CANNOT_PROVIDE_TRACKING
. Cannot provide tracking - Canada.JPN_SAGAWA
. Sagawa Japan.MYS_SKYNET
. Skynet Malaysia.IT_FERCAM
. Fercam Italy.UK_AIRBORNE_EXPRESS
. Airborne Express UK.CA_OTHER
. Other - Canada.DE_DEUTSHCE_POST_DHL_TRACK_TRACE_EXPRESS
. Deutsche Post DHL Track Trace Express GermanyCORREOS_DE_MEXICO
. Mex Post Correos de Mexico.FR_DHL_GLOBALFORWARDING
. DHL Global Forwarding France.GLOBAL_SKYNET
. Skynet Global.AU_DHL_GLOBALFORWARDING
. DHL Global Forwarding Australia.DE_DHL_GLOBALFORWARDING
. DHL Global Forwarding Germany.SFC_LOGISTICS
. SFC Logistics.US_GLOBEGISTICS
. Globeistics US.CA_DHL_GLOBALFORWARDING
. DHL Global Forwarding Canada.OMNIPARCEL
. Omni Parcel.PHL_AIR21
. Air21 PhilippinesCBL_LOGISTICA
. CBL Logística.FR_MONDIAL
. Mondial France.DE_DHL_ECOMMERCE
. DHL eCommerce Germany.ADICIONAL
. Adicional.CH_SWISS_POST_PRIORITY
. Swiss Post PriorityNL_INTANGIBLE_DIGITAL_SERVICES
. Intangible Digital ServicesDE_ASENDIA
. Asendia Germany.NL_ABC_MAIL
. ABC Mail NetherlandsUK_DELTEC
. Deltec UK.ONE_WORLD
. One World.AIRBORNE_EXPRESS
. Airborne Express.ES_OTHER
. Other - Spain.US_DHL_ECOMMERCE
. DHL eCommerce US.US_ENSENDA
. Ensenda US.CPACKET
. Cpacket.AXL
. AXL Express & Logistics.IND_REDEXPRESS
. Red Express India.NL_LOCAL_PICKUP
. Local PickUp NetherlandsUK_ROYALMAIL_AIRSURE
. Royal Mail AirSure UKFR_TNT
. TNT France.USPS
. United States Postal Service (USPS).RINCOS
. Rincos.B2CEUROPE
. B2C EuropePHL_LBC
. LBC Philippines.SG_TAQBIN
. TA-Q-BIN Parcel Singapore.GR_ELTA
. Elta Greece.WINIT
. WinIt.NLD_DHL
. DHL Netherlands.FR_GEODIS
. Geodis France.DE_DHL_PACKET
. DHL Packet Germany.ARG_OCA
. OCA Argentia.JP_DHL
. DHL Japan.RUSSIAN_POST
. Russian Post.TW_TAIWAN_POST
. Chunghwa Post.UPS
. United Parcel Service of America, Inc..BE_BPOST
. Bpost BelgiumJP_SAGAWA_KYUU_BIN
. Sagawa Kyuu Bin JapanNATIONWIDE_MY
. Nationwide Malaysia.TNT
. TNT Portugal.COURIERS_PLEASE
. Couriers Please.DMM_NETWORK
. DMM Network.TOLL
. Toll.NONE
. NoneIDN_FIRST_LOGISTICS
. First Logistics Indonesia.BH_POSTA
. BH POŠTA.SENDIT
. SendIt.US_DHL_EXPRESS
. DHL Express US.FEDEX
. FedEx.SWE_POSTNORD
. PostNord Sverige.PHL_XEND_EXPRESS
. Xend Express Philippines.POSTI
. Posti.CA_CANADA_POST
. Canada Post.PL_FEXEX
. Fexex PolandCN_EC
. EC China.HK_TAQBIN
. TA-Q-BIN Parcel Hong Kong.UK_AN_POST
. AddressPay UK.WISELOADS
. Wiseloads.PRT_SEUR
. Seur Portugal.US_ONTRAC
. Ontrac US.THA_THAILAND_POST
. Thailand Post.DPE_EXPRESS
. DPE Express.UK_DHL_EXPRESS
. DHL Express UK.NL_DHL
. DHL NetherlandsHK_FLYT_EXPRESS
. Flyt Express Hong KongUK_HERMESWORLD
. Hermesworld UK.IT_REGISTER_MAIL
. Registered Mail Italy.ARG_CORREO
. Correo Argentino.CA_LOOMIS
. Loomis Express CanadaDTDC_AU
. DTDC Australia.DPD
. DPD Global.ASENDIA_HK
. Asendia Hong Kong.UK_ROYALMAIL_RECORDED
. Royal Mail Recorded UKPL_POCZTA_POLSKA
. Poczta PolskaEU_IMX
. IMX EUIDN_PANDU
. Pandu Indonesia.MEX_ESTAFETA
. Estafeta Mexico.SREKOREA
. SRE Korea.CYP_CYPRUS_POST
. Cyprus Post.NZ_COURIER_POST
. CourierPost New Zealand.CN_EMPS
. EMPS China.AU_TNT
. TNT Australia.UK_CANNOT_PROVIDE_TRACKING
. Cannot provide tracking - UK.ES_DHL
. DHL Spain.CONTINENTAL
. Continental.IND_DTDC
. DTDC India.DE_GLS
. General Logistics Systems (GLS) Germany.NLD_GLS
. General Logistics Systems (GLS) Netherlands.UK_DPD
. DPD UK.IT_TNT
. TNT Italy.PL_DHL
. DHL Portugal.JP_NITTSU_PELICAN_BIN
. Nittsu Pelican Bin JapanTHA_DYNAMIC_LOGISTICS
. Dynamic Logistics Thailand.IT_POSTE_ITALIA
. Poste ItaliaUK_ROYALMAIL_INTER_SIGNED
. Royal Mail International Signed UKHERMES_IT
. Hermes Italy.FR_BERT
. Bert France.IND_PROFESSIONAL_COURIERS
. Professional Couriers India.POL_SIODEMKA
. Siodemka Poland.IE_AN_POST_SDS_PRIORITY
. Post SDS Priority IrelandADSONE
. ADSone Cumulus.BRA_CORREIOS
. Correios Brazil.UBI_LOGISTICS
. UBI Logistics.ES_CORREOS
. Sociedad Estatal Correos y Telégrafos.NGA_NIPOST
. Nigerian Postal Service.AUT_AUSTRIAN_POST
. Austrian Post.AU_FASTWAY
. Fastway Australia.AUS_TOLL
. Toll Australia.CA_CANPAR_COURIER
. Canpar Courier Canada.SWE_DIRECTLINK
. Direct Link Sweden.CZE_CESKA
. Česká pošta.ROYAL_MAIL
. Royal Mail.SG_SINGPOST
. SingPost SingaporeIT_OTHER
. Other - Italy.ZA_FASTWAY
. Fastway Couriers (South Africa).SEKOLOGISTICS
. Seko Logistics.CN_UPS
. CN_UPSHUNTER_EXPRESS
. Hunter Express.DE_DHL_PARCEL
. DHL Parcel Germany.NLD_TRANSMISSION
. Transmission Netherlands.CN_TNT
. TNT China.DE_DEUTSCHE
. Deutsche Post Germany.AIRSURE
. Airsure.UK_PARCELFORCE
. Parcelforce UK.SWE_DB
. DB Schenker Sweden.CN_CHINA_POST
. China PostPL_GLS
. General Logistics Systems PolandEU_BPOST
. bpost.RELAIS_COLIS
. Relais Colis.UK_DHL_PARCEL
. DHL Parcel UK.AUS_STARTRACK
. StarTrack AustraliaAU_TOLL_IPEC
. Toll IPEC AustraliaCORREOS_CHILE
. CorreosChile.CH_SWISS_POST_EXPRES
. Swiss Post ExpressMYS_TAQBIN
. TA-Q-BIN Parcel Malaysia.JET_SHIP
. Jetship.HK_DHL_EXPRESS
. DHL Express Hong Kong.IT_SDA
. SDA Express Courier.DE_DHL_DEUTSCHEPOST
. DHL Deutsche Post Germany.HK_DHL_GLOBALFORWARDING
. DHL Global Forwarding Hong Kong.PHL_RAF
. RAF Philippines.IT_GLS
. General Logistics Systems (GLS) Italy.PANTOS
. Pantos.KOR_ECARGO
. Ecargo Korea.AT_AUSTRIAN_POST_EMS
. EMS Express Mail Service AustriaIT_BRT
. BRT Corriere Espresso Italy.CHE_SWISS_POST
. Swiss Post.FASTWAY_NZ
. Fastway New Zealand.IT_EBOOST_SDA
. IT_EBOOST_SDAASENDIA_UK
. Asendia UK.RRDONNELLEY
. RR Donnelley.US_RL
. RL US.GR_GENIKI
. Geniki Greece.DE_DHL_EXPRESS
. DHL Express Germany.CA_GREYHOUND
. Greyhound Canada.UK_COLLECTPLUS
. CollectPlus UK.NINJAVAN_THAI
. Ninjavan Thailand.RABEN_GROUP
. Raben Group.CA_DHL_EXPRESS
. DHL Express Canada.GLOBAL_TNT
. TNT Global.IN_INDIAPOST
. India PostITIS
. ITIS InternationalPHL_JAMEXPRESS
. JamExpress Philippines.PRT_INT_SEUR
. Internationational Seur Portugal.ESP_ASM
. Parcel Monitor Spain.NINJAVAN_ID
. Ninjavan Indonesia.JP_FEDEX
. Federal Express JapanFR_CHRONOPOST
. Chronopost France.FR_SUIVI
. Suivi FedEx FranceFR_TELIWAY
. Teliway France.JPN_JAPAN_POST
. Japan Post.HRV_HRVATSKA
. Hrvatska Pošta.AT_AUSTRIAN_POST_PAKET_PRIME
. Austrian Post Paket PrimeDE_OTHER
. Other - Germany.HK_HONGKONG_POST
. Hong Kong Post.GRC_ACS
. ACS Greece.HUN_MAGYAR
. Magyar Posta.FR_DHL_PARCEL
. DHL Parcel France.UK_OTHER
. Other - UK.LWE_HK
. LWE Hong Kong.EFS
. Enterprise Freight Systems (EFS).PL_DHL_PARCEL
. DHL Parcel Poland.PARCELFORCE
. Parcel Force.AU_AUSTRALIA_POST_EMS
. Australia Post EMSUS_ASCENDIA
. Ascendia US.ROU_POSTA
. Poșta Română.NZ_NZ_POST
. New Zealand Post Limited (NZ).RPX
. RPX International.POSTUR_IS
. Postur.IE_AN_POST_SDS_EMS
. Post SDS EMS Express Mail Service IrelandUK_UK_MAIL
. UK Mail.UK_FASTWAY
. Fastway UK.CORREOS_DE_COSTA_RICA
. Correos de Costa Rica.MYS_CITYLINK
. Citylink Malaysia.PUROLATOR
. Purolator.IND_DOTZOT
. DotZot India.NG_COURIERPLUS
. Courier Plus Nigeria.HK_FOUR_PX_EXPRESS
. 4PX Express Hong KongROCKETPARCEL
. Rocket Parcel International.CN_DHL_GLOBALFORWARDING
. DHL Global Forwarding China.EPARCEL_KR
. EParcel Korea.INPOST_PACZKOMATY
. InPost Paczkomaty.KOR_KOREA_POST
. Korea Post.CA_PUROLATOR
. Purolator CanadaAPR_72
. APR 72.FR_DHL_EXPRESS
. DHL Express France.IDN_JNE
. JNE Indonesia.AU_AUSTRALIA_POST_EPARCEL
. Australia Post EparcelGLOBAL_ESTES
. Estes Global.LTU_LIETUVOS
. Lietuvos paštas Lithuania.THECOURIERGUY
. The Courier Guy.BE_CHRONOPOST
. Chronopost Belgium.VNM_VIETNAM_POST
. Vietnam Post.AU_STAR_TRACK_EXPRESS
. StarTrack Express AustraliaRAM
. JP RAM Shipping.
carrier_name_other
string
The name of the carrier for the shipment. Provide this value only if the carrier parameter is
OTHER
.last_updated_time
The date and time when the tracking information was last updated, in Internet date and time format.
links
array (contains the link_description object)
An array of request-related HATEOAS links.
notify_buyer
boolean
If
true
, sends an email notification to the buyer of the PayPal transaction. The email contains the tracking information that was uploaded through the API.postage_payment_id
string
The postage payment ID.
quantity
integer
The quantity of items shipped.
shipment_date
The date when the shipment occurred, in Internet date and time format.
tracking_number
string
The tracking number for the shipment.
tracking_number_type
enum
The type of tracking number.
The possible values are:
CARRIER_PROVIDED
. A merchant-provided tracking number.E2E_PARTNER_PROVIDED
. A marketplace-provided tracking number.
tracking_number_validated
boolean
Indicates whether the carrier validated the tracking number.
tracker_collection
links
array (contains the link_description object)
An array of request-related HATEOAS links.
trackers
array (contains the tracker object)
An array of tracking information for shipments.
tracker_identifier
transaction_id
string
required
The PayPal transaction ID.
links
array (contains the link_description object)
An array of request-related HATEOAS links.
tracking_number
string
The tracking number for the shipment.
tracker_identifier_collection
links
array (contains the link_description object)
An array of request-related HATEOAS links.
tracker_identifiers
array (contains the tracker_identifier object)
An array of tracking IDs.
tracking_number_type
tracking_number_type
enum
The tracking number type.
The possible values are:
CARRIER_PROVIDED
. A merchant-provided tracking number.E2E_PARTNER_PROVIDED
. A marketplace-provided tracking number.
tracking_status
tracking_status
enum
The status of the item shipment. For allowed values, see Shipping Statuses.
The possible values are:
CANCELLED
. The shipment was cancelled and the tracking number no longer applies.DELIVERED
. The item was already delivered when the tracking number was uploaded.LOCAL_PICKUP
. Either the buyer physically picked up the item or the seller delivered the item in person without involving any couriers or postal companies.ON_HOLD
. The item is on hold. Its shipment was temporarily stopped due to bad weather, a strike, customs, or another reason.SHIPPED
. The item was shipped and is on the way.SHIPMENT_CREATED
. The shipment was created.DROPPED_OFF
. The shipment was dropped off.IN_TRANSIT
. The shipment is in transit on its way to the buyer.RETURNED
. The shipment was returned.LABEL_PRINTED
. The label was printed for the shipment.ERROR
. An error occurred with the shipment.UNCONFIRMED
. The shipment is unconfirmed.PICKUP_FAILED
. Pick-up failed for the shipment.DELIVERY_DELAYED
. The delivery was delayed for the shipment.DELIVERY_SCHEDULED
. The delivery was scheduled for the shipment.DELIVERY_FAILED
. The delivery failed for the shipment.INRETURN
. The shipment is being returned.IN_PROCESS
. The shipment is in process.NEW
. The shipment is new.VOID
. If the shipment is cancelled for any reason, its state is void.PROCESSED
. The shipment was processed.NOT_SHIPPED
. The shipment was not shipped.
Additional API information
Error messages
In addition to the common HTTP status codes that the REST APIs return, the Add Tracking API can return the following errors.