Shipment Tracking (1)

Merchants can use the PayPal Add Tracking API to manage tracking information. Merchants can add tracking numbers and associated information to PayPal. There are 2 ways in which tracking details can be shared to PayPal. If you have a legacy integration that doesn't use the Orders v2 API, share tracking details through the Add Shipping Tracking API. If you are using the Orders v2 API, share tracking details through the Orders v2 API.After adding these details to PayPal, merchants can:

Update tracking details.
Show tracking details.
Cancel tracking numbers.

For more information, see the Add Tracking API Overview and Add Tracking API Integration Guide.

Add tracking information for multiple PayPal transactions

post/v1/shipping/trackers-batch

Deprecation notice: Adding tracking details for an order through /v1/shipping/trackers-batch is deprecated as its a legacy way of integration. Use the new Orders v2 API to share tracking details with PayPal.

Adds tracking information, with or without tracking numbers, for multiple PayPal transactions. Accepts up to 20 tracking IDs. For more information, see Add tracking information with tracking numbers and Add tracking information without tracking numbers.

SecurityOauth2

Request

Request Body schema:
application/json

Array of objects (tracker) [ 1 .. 20 ] items

An array of tracking information for shipments.

Responses

201

Created

Request samples

Payload
cURL
Node.js
Java
Python

{"trackers": [{"account_id": "TELFDNSFY96RY",
"transaction_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"status": "SHIPPED",
"carrier": "FEDEX",
"shipment_direction": "FORWARD",
"tracking_url": "http://yjcx.chinapost.com.cn/"
},
{"account_id": "TELFDNSFY96RY",
"transaction_id": "53Y56775AE587553X",
"tracking_number": "443844607821",
"status": "SHIPPED",
"tracking_url": "http://yjcx.chinapost.com.cn/",
"carrier": "FEDEX"
}
]
}

Response samples

application/json

{"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": "update",
"method": "PUT"
},
{"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/8MC585209K746392H-443844607820",
"rel": "patch",
"method": "PATCH"
}
]
},
{"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"
},
{"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/53Y56775AE587553X-443844607821",
"rel": "edit",
"method": "PATCH"
}
]
}
]
}

Add tracking information for PayPal transaction

post/v1/shipping/trackers

Adds tracking information for a PayPal transaction.

SecurityOauth2

Request

Request Body schema:
application/json

Array of objects (tracker) [ 1 .. 20 ] items

An array of tracking information for shipments.

Responses

201

Created

Request samples

Payload
cURL
Node.js
Java
Python

{"trackers": [{"account_id": "TELFDNSFY96RY",
"transaction_id": "5VC048998N237502P",
"status": "SHIPPED",
"tracking_number": "672314721",
"carrier": "OTHER",
"carrier_name_other": "Toll Priority",
"notify_buyer": false,
"tracking_url": "http://yjcx.chinapost.com.cn/",
"links": [ ]
},
{"account_id": "TELFDNSFY96RY",
"transaction_id": "5VC048998N237502P",
"status": "SHIPPED",
"tracking_number": "672314722",
"carrier": "OTHER",
"carrier_name_other": "Toll Priority",
"notify_buyer": false,
"tracking_url": "http://yjcx.chinapost.com.cn/",
"links": [ ]
}
]
}

Response samples

application/json

{"tracker_identifiers": [{"transaction_id": "5VC048998N237502P",
"tracking_number": "672314721",
"links": [{"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/5VC048998N237502P-672314721",
"rel": "self",
"method": "GET"
},
{"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/5VC048998N237502P-672314721",
"rel": "replace",
"method": "PUT"
},
{"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/5VC048998N237502P-672314721",
"rel": "edit",
"method": "PATCH"
}
]
},
{"transaction_id": "5VC048998N237502P",
"tracking_number": "672314722",
"links": [{"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/5VC048998N237502P-672314722",
"rel": "self",
"method": "GET"
},
{"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/5VC048998N237502P-672314722",
"rel": "replace",
"method": "PUT"
},
{"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/5VC048998N237502P-672314722",
"rel": "edit",
"method": "PATCH"
}
]
}
],
"links": [{"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers",
"rel": "self",
"method": "POST"
}
]
}

List tracking information

get/v1/shipping/trackers

Lists tracking information that meet search criteria. The tracking ID is required but the tracking number is optional.

SecurityOauth2

Request

query Parameters

transaction_id required	string Filters the tracking information that appears in the response by a PayPal transaction ID.
tracking_number	string Filters the tracking information that appears in the response by a tracking number.
account_id	string = 13 characters ^[2-9A-HJ-NP-Z]{13}$ Encrypted PayPal Account ID of the buyer or seller.

Request Body schema:
application/json

any

Responses

200

A successful request returns the HTTP 200 OK status code and a JSON response body that lists tracking information that meets search criteria.

Request samples

Payload
cURL
Node.js
Java
Python

{ }

Response samples

application/json

{"transaction_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"status": "SHIPPED",
"carrier": "FEDEX",
"shipment_direction": "FORWARD",
"shipment_uploader": "PARTNER",
"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/8MC585209K746392H-443844607820",
"rel": "edit",
"method": "PATCH"
},
{"href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers-batch",
"rel": "create",
"method": "POST"
}
]
}

Update or cancel tracking information for PayPal transaction

put/v1/shipping/trackers/{id}

Updates or cancels the tracking information for a PayPal transaction, by ID. To cancel tracking information, call this method and set the status to CANCELLED. For more information, see Update or cancel tracking information.

SecurityOauth2

Request

path Parameters

required

string [ 1 .. 100 ] characters ^[a-zA-Z0-9-_]*$

The ID of the tracker in the transaction_id-tracking_number format.

Request Body schema: application/json

transaction_id

required

string [ 1 .. 50 ] characters ^[a-zA-Z0-9]*$

The PayPal transaction ID.

tracking_number

string [ 1 .. 64 ] characters ^.*$

The tracking number for the shipment. Carrier information, carrier is required if tracking_number is provided.

carrier_name_other

string [ 1 .. 64 ] characters ^.*$

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

notify_buyer

boolean

Default: false

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.

shipment_direction

string [ 1 .. 50 ] characters ^[A-Z]*$

To denote whether the shipment is sent forward to the receiver or returned back.

Enum Value	Description
FORWARD	The shipment is sent forward to the receiver.
RETURN	The shipment was returned back.

tracking_url

string <uri> [ 1 .. 250 ] characters ^.*$

Tracking Link of the shipment.

tracking_number_type

string (tracking_number_type) [ 1 .. 64 ] characters ^[0-9A-Z_]+$

The type of tracking number.

Enum Value	Description
CARRIER_PROVIDED	A merchant-provided tracking number.
E2E_PARTNER_PROVIDED	A marketplace-provided tracking number.

status

required

string (tracking_status) [ 1 .. 64 ] characters ^[A-Z_]+$

The status of the item shipment. For allowed values, see Shipping Statuses.

Enum Value	Description
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_date

string <ppaas_date_notime_v2> (date_no_time) = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

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.

carrier

string (carrier) [ 1 .. 64 ] characters ^.*$

The carrier for the shipment. Carrier information is required when tracking_number is provided. 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.

Enum Value	Description
2EBOX	2ebox courier.
360LION	360 Lion Express.
3JMSLOGISTICS	3JMS Logistics.
4_72	4-72 Entregando
6LS	6ls.com.
A1POST	A1Post.
AAA_COOPER	AAA Cooper.
ABCUSTOM	AB Custom Group.
ABXEXPRESS_MY	ABX Express.
ACOMMMERCE	aCommerce.
ACSWORLDWIDE	ACS Worldwide Express.
ACS_GR	ACS Courier.
ADERONLINE	Ader couriers.
ADICIONAL	Adicional Logistics.
ADSONE	ADSone.
ADUIEPYLE	A Duie Pyle.
AERONET	Aeronet couriers.
AEX	AEX Group.
AFLLOG_FTP	AFL LOGISTICS.
AGILITY	Agility.
AIRMEE_WEBHOOK	Airmee couriers.
AIR_CANADA_GLOBAL	Rivo (Air canada).
ALFATREX	AlfaTrex.
ALLIEDEXPRESS	Allied Express.
ALLJOY	ALLJOY SUPPLY CHAIN.
ALPHAFAST	Alphafast (www.alphafast.com).
ALWAYS_EXPRESS	Always Express.
AMAZON	Amazon Shipping.
AMAZON_FBA_SWISHIP	Swiship UK.
AMAZON_SHIP_MCF	Amazon Shipping + Amazon MCF.
AMSTAN	Amstan Logistics.
AMS_GRP	AMS Group.
ANDREANI	Grupo logistico Andreani.
ANICAM_BOX	ANICAM BOX EXPRESS.
ANJUN	Anjun couriers.
ANSERX	ANSERX courier.
AN_POST	An Post.
AO_COURIER	AO Logistics.
AO_DEUTSCHLAND	AO Deutschland.
APC_OVERNIGHT	APC overnight (apc-overnight.com).
APC_OVERNIGHT_CONNUM	APC Overnight Consignment.
APG	APG eCommerce Solutions.
APRISAEXPRESS	Aprisa Express.
AQUILINE	Aquiline.
ARAMEX	Aramex.
ARAMEX_AU	Aramex Australia (formerly Fastway AU).
ARCO_SPEDIZIONI	Arco Spedizioni SP.
ARE_EMIRATES_POST	Emirates Post.
ARG_OCA	OCA Argentina.
ARK_LOGISTICS	ARK Logistics.
ASE	ASE KARGO.
ASENDIA_HK	Asendia HonKong.
ASENDIA_UK	Asendia UK.
ASENDIA_USA	Asendia USA.
ASIGNA	ASIGNA courier.
AUPOST_CN	AuPost China.
AUSTRIAN_POST_EXPRESS	austrian post.
AUS_STARTRACK	StarTrack (startrack.com.au).
AUS_TOLL	TOLL Australia.
AU_AUSTRIAN_POST	Austrian Post (Registered).
AU_AU_POST	Australia Post.
AU_TNT	TNT Australia.
AVERITT	Averitt Express.
BEL_DHL	DHL Benelux.
BEL_RS	BEL North Russia.
BESTWAYPARCEL	Best Way Parcel.
BE_BPOST	Bpost (www.bpost.be).
BE_KIALA	Kiala.
BG_BULGARIAN_POST	Bulgarian Posts.
BH_POSTA	BH Posta (www.posta.ba).
BH_WORLDWIDE	B&H Worldwide.
BIRDSYSTEM	BirdSystem.
BJSHOMEDELIVERY	BJS Distribution courier.
BLINKLASTMILE	Blink.
BLR_BELPOST	Belpost.
BLUECARE	Bluecare Express Ltd.
BLUESTAR	Blue Star.
BLUEX	Blue Express.
BNEED	Bneed courier.
BOMBINOEXP	Bombino Express Pvt.
BOND	Bond courier.
BONDSCOURIERS	Bonds Courier Service (bondscouriers.com.au).
BORDEREXPRESS	Border Express.
BOX_BERRY	Boxberry courier.
BPOST_INT	Bpost international.
BRA_CORREIOS	Correios Brazil.
BRING	Bring.
BROUWER_TRANSPORT	Brouwer Transport en Logistiek.
BRT_IT	BRT couriers Italy (www.brt.it).
BRT_IT_PARCELID	BRT Bartolini(Parcel ID).
BRT_IT_SENDER_REF	BRT Bartolini(Sender Reference).
BUDBEE_WEBHOOK	Budbee courier.
BUYLOGIC	buylogic.
B_TWO_C_EUROPE	B2C courier Europe.
CAE_DELIVERS	CAE Delivers.
CAINIAO	AliExpress Standard Shipping.
CARIBOU	Caribou.
CARRIERS	Carriers courier.
CARRY_FLAP	Carry-Flap Co..
CA_CANADA_POST	Canada Post.
CA_CANPAR	Canpar Courier.
CA_GREYHOUND	Greyhound.
CA_PUROLATOR	Purolator.
CBL_LOGISTICA	CBL Logistica.
CDEK	CDEK courier.
CDEK_TR	CDEK TR.
CELERITAS	Celeritas Transporte.
CELLO_SQUARE	Cello Square.
CESKA_CZ	Czech Post.
CEVA	CEVA LOGISTICS.
CFL_LOGISTICS	CFL Logistics.
CGS_EXPRESS	CGS Express.
CHAMPION_LOGISTICS	Champion Logistics.
CHITCHATS	Chit Chats.
CHOIR_EXP	Choir Express Indonesia.
CHROBINSON	C.H. Robinson Worldwide.
CHRONOPOST_FR	Chronopost france (www.chronopost.fr).
CHUKOU1	Chukou1.
CH_SWISS_POST_PRIORITY	Swiss Post.
CITYLINK_MY	City-Link Express.
CJPACKET	CJ Packet.
CJ_CENTURY	CJ Century.
CJ_GLS	CJ GLS.
CJ_HK_INTERNATIONAL	CJ Logistics International(Hong Kong).
CJ_INT_MY	CJ International malaysia.
CJ_KR	CJ Korea Express.
CJ_LOGISTICS	CJ Logistics International.
CJ_TH	CJ Transnational Philippines.
CLEVY_LINKS	Clevy Links.
CLE_LOGISTICS	CL E-Logistics Solutions Limited.
CLOUDWISH_ASIA	Cloudwish Asia.
CNDEXPRESS	CND Express.
CNEXPS	CNE Express.
CNWANGTONG	cnwangtong.
CN_17POST	17 Post Service.
CN_BESTEXPRESS	Best Express.
CN_BOXC	BoxC courier.
CN_CHINA_POST_EMS	China Post.
CN_DPEX	DPEX.
CN_EMS	EMS China (www.ems.post).
CN_EQUICK	Equick China.
CN_JCEX	JCEX courier.
CN_PAYPAL_PACKAGE	PayPal Package.
CN_POST56	Post56.
CN_SF_EXPRESS	SF Express (www.sf-express.com).
CN_STO	STO Express.
CN_WEDO	WeDo Logistics.
CN_WISHPOST	WishPost.
CN_YUNDA	Yunda Express.
COLIS_PRIVE	Colis Privé.
COLLECTCO	CollectCo.
COLLIVERY	MDS Collivery Pty (Ltd).
COMET_TECH	CometTech.
CONTINENTAL	Continental.
CON_WAY	Con-way Freight.
COORDINADORA	Coordinadora.
COPA_COURIER	Copa Airlines Courier.
COPE	Cope Sensitive Freight.
CORPORATECOURIERS_WEBHOOK	Corporate Couriers.
CORREOS_DE_MEXICO	correos mexico.
CORREOS_ES	correos Express (www.correos.es).
CORREOS_EXPRESS	Correos Express.
CORREO_UY	Correo Uruguayo.
COSTMETICSNOW	Cosmetics Now.
COURANT_PLUS	Courant Plus.
COUREX	Urbanfox.
COURIERS_PLEASE	CouriersPlease (couriersplease.com.au).
CPACKET	Cpacket couriers.
CPEX	Captain Express International.
CROSHOT	Croshot.
CSE	CSE courier.
CTC_EXPRESS	CTC Express.
CUBYN	Cubyn.
CUCKOOEXPRESS	Cuckoo Express.
CYPRUS_POST_CYP	cyprus post.
DAIGLOBALTRACK	DAI Post.
DAJIN	Shanghai Aqrum Chemical Logistics Co.Ltd.
DANSKE_FRAGT	Danske Fragtaend.
DAWN_WING	Dawn Wing.
DAYTON_FREIGHT	Dayton Freight.
DBSCHENKER_B2B	DB Schenker B2B.
DBSCHENKER_SE	DB Schenker (www.dbschenker.com).
DBSCHENKER_SV	DB Schenker Sweden.
DDEXPRESS	DD Express Courier.
DEALERSEND	DealerSend.
DELIVERYONTIME	DELIVERYONTIME LOGISTICS PVT LTD.
DELNEXT	Delnext.
DELTEC_UK	Deltec Courier.
DEMANDSHIP	DemandShip.
DESCARTES	Innovel courier.
DESIGNERTRANSPORT_WEBHOOK	Designer Transport.
DESTINY	Destiny Transportation.
DEX_I	DEX-I courier.
DE_ASENDIA	Asendia Germany.
DE_DEUTSCHE	Deutsche post.
DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET	Deutsche Post DHL.
DE_DHL_EXPRESS	DHL Express.
DE_DPD_DELISTRACK	DPD Germany.
DE_GLS	GLS parcel services (www.gls-group.eu).
DHL	dhl Global.
DHL_ACTIVE_TRACING	DHL Active Tracing.
DHL_AU	DHL Supply Chain Australia.
DHL_BENELUX	dhl benelux.
DHL_ECOMERCE_ASA	DHL eCommerce Asia (API).
DHL_ES	DHL Spain(www.dhl.com).
DHL_FR	DHL France (www.dhl.com).
DHL_FREIGHT	DHL Freight.
DHL_GLOBAL_MAIL_ASIA	DHL Global Mail Asia (www.dhl.com).
DHL_HK	DHL HonKong.
DHL_JP	DHL Japan.
DHL_PARCEL_ES	DHL parcel Spain(www.dhl.com).
DHL_PARCEL_NL	DHL Parcel NL.
DHL_PARCEL_RU	DHL Parcel Russia.
DHL_PL	DHL Poland.
DHL_REFR	DHl (Reference number).
DHL_SG	dhl Singapore.
DHL_SUPPLY_CHAIN	DHL Supply Chain APAC.
DHL_UK	dhl UK.
DIAMOND_EUROGISTICS	Diamond Eurogistics Limited.
DICOM	GLS Logistic Systems Canada Ltd./Dicom.
DIDADI	DIDADI Logistics tech.
DIMERCO	Dimerco Express Group.
DIRECTCOURIERS	Direct Couriers.
DIRECTLOG	Directlog (www.directlog.com.br).
DIRECTPARCELS	Direct Parcels.
DMM_NETWORK	DMM Network.
DMS_MATRIX	DMSMatrix.
DOBROPOST	DobroPost.
DOORA	Doora Logistics.
DOORDASH_WEBHOOK	DoorDash.
DPD	DPD.
DPD_DELISTRACK	DPD delistrack.
DPD_FR	DPD France.
DPD_HGRY	DPD Hungary.
DPD_HK	DPD HongKong.
DPD_IR	DPD Ireland.
DPD_LOCAL	DPD Local.
DPD_LOCAL_REF	DPD Local reference.
DPD_POLAND	DPD Poland.
DPD_RO	DPD Romania.
DPD_RU	DPD Russia.
DPEX	DPEX (www.dpex.com).
DPE_EXPRESS	DPE Express.
DPE_SOUTH_AFRC	DPE South Africa.
DSV	DSV courier.
DTDC_AU	DTDC Australia.
DTDC_EXPRESS	DTDC express.
DTDC_IN	DTDC India.
DTD_EXPR	DTD Express.
DX_SFTP	DX (SFTP).
DYLT	Daylight Transport.
DYNALOGIC	Dynamic Logistics.
EASY_MAIL	Easy Mail.
ECEXPRESS	ECexpress.
ECHO	Echo courier.
ECMS	ECMS International Logistics Co..
ECOSCOOTING	ECOSCOOTING.
EFEX	eFEx (E-Commerce Fulfillment & Express).
EFS	EFS (E-commerce Fulfillment Service).
EKART	Ekart logistics (ekartlogistics.com).
ELIAN_POST	Yilian (Elian) Supply Chain.
EMPS_CN	EMPS Express.
ENDEAVOUR_DELIVERY	Endeavour Delivery.
ENVIALIA_REFERENCE	Envialia Reference.
EPARCEL_KR	eParcel Korea.
EPST_GLBL	ePost Global
EP_BOX	EP-Box courier.
ESHIPPING	Eshipping.
ESP_ASM	ASM(GLS Spain).
ESP_ENVIALIA	Envialia.
ESP_MRW	MRW spain.
ESP_NACEX	NACEX Spain.
ESP_PACKLINK	Packlink.
ESP_REDUR	Redur Spain.
ETOMARS	Etomars.
ETOTAL	eTotal Solution Limited.
ETS_EXPRESS	RETS express.
EU_FLEET_SOLUTIONS	EU Fleet Solutions.
EU_IMX	IMX Mail.
EXPRESSSALE	Expresssale.
FARGOOD	FarGood.
FAR_INTERNATIONAL	FAR international.
FASTRACK	Fasttrack.
FASTRK_SERV	Fastrak Services.
FASTWAY_IR	Fastway Ireland.
FASTWAY_NZ	Fastway New Zealand.
FDSEXPRESS	FDSEXPRESS.
FEDEX	Fedex.
FEDEX_CROSSBORDER	FedEx Cross Border.
FEDEX_FR	FedEx® Freight.
FEDEX_INTL_MLSERV	FedEx International MailService.
FEDEX_POLAND	FedEx® Poland Domestic.
FEDEX_UK	FedEx® UK.
FETCHR_WEBHOOK	Mena 360 (Fetchr).
FIEGE	Fiege Logistics.
FIEGE_NL	Fiege Netherlands.
FIRSTMILE	FirstMile.
FLASHEXPRESS	Flash Express.
FMX	FMX.
FONSEN	Fonsen Logistics.
FORRUN	forrun Pvt Ltd (Arpatech Venture).
FREIGHTQUOTE	Freightquote by C.H. Robinson.
FRETERAPIDO	Frete Rapido.
FR_BERT	Bert Transport.
FR_COLIS	Colissimo.
FR_EXAPAQ	DPD France (formerly exapaq).
FR_GEODIS	GEODIS - Distribution & Express.
FR_GLS	GLS france.
FULFILLA	Fulfilla.
FULFILLME	Fulfillme.
FURDECO	Furdeco.
GAC	GAC.
GANGBAO	GANGBAO Supplychain.
GBA	GBA Services Ltd.
GBS_BROKER	GBS-Broker.
GB_APC	APC postal logistics germany.
GB_ARROW	Arrow XL.
GB_NORSK	Norsk Global.
GB_PANTHER	Panther.
GB_TUFFNELLS	Tuffnells Parcels Express.
GEIS	Geis CZ.
GEL_EXPRESS	Gel Express Logistik.
GEMWORLDWIDE	GEM Worldwide.
GENERAL_OVERNIGHT	Go!Express and logistics.
GENIKI_GR	Geniki Taxydromiki.
GEODIS_ESPACE	Geodis E-space.
GESWL	GESWL Express.
GIAO_HANG	Giao hàng nhanh.
GIO_EXPRESS	Gio Express.
GLOBALTRANZ	GlobalTranz.
GLOBAL_ABF	ABF Freight.
GLOBAL_ESTES	Estes Express Lines.
GLOBAL_EXPRESS	Tai Wan Global Business.
GLOBAL_IPARCEL	i-parcel.
GLOBAL_TNT	TNT global.
GLOBAVEND	Globavend.
GLS_CROTIA	GLS Croatia.
GLS_CZ	GLS Czech Republic.
GLS_IT	GLS Italy.
GLS_ITALY	GLS Italy.
GLS_SLOV	GLS General Logistics Systems Slovakia s.r.o..
GLS_SLOVEN	GLS Slovenia.
GOGLOBALPOST	Global Post.
GOJEK	Gojek.
GRAB_WEBHOOK	Grab courier.
GRUPO	Grupo ampm.
GR_ELTA	ELTA Hellenic Post.
GSI_EXPRESS	GSI EXPRESS.
GSO	GSO(GLS-USA).
HAPPY2POINT	Happy 2ThePoint
HCT_LOGISTICS	HCT LOGISTICS CO.LTD..
HDB	Haidaibao.
HDB_BOX	Haidaibao (BOX).
HELLMANN	Hellmann Worldwide Logistics.
HELTHJEM	Helthjem.
HEPPNER	Heppner Internationale Spedition GmbH & Co..
HEPPNER_FR	Heppner France.
HERMES	HermesWorld UK.
HERMES_2MANN_HANDLING	Hermes Einrichtungs Service GmbH & Co. KG.
HERMES_DE	Hermes Germany.
HH_EXP	Hua Han Logistics.
HIPSHIPPER	Hipshipper.
HKD	Qingdao HKD International Logistics.
HK_FLYT_EXPRESS	FLYT express.
HK_FOUR_PX_EXPRESS	4PX (fourPX).
HK_POST	Hongkong Post (www.hongkongpost.hk).
HK_TGX	Kerry Express Hong Kong.
HOLISOL	Holisol.
HOME_DELIVERY_SOLUTIONS	Home Delivery Solutions Ltd.
HOUNDEXPRESS	Hound Express.
HRPARCEL	HR Parcel.
HRV_HRVATSKA	Hrvatska posta.
HUAHAN_EXPRESS	HUAHANG EXPRESS.
HUNTER_EXPRESS	Hunter Express.
HUODULL	Huodull.
HX_EXPRESS	HX Express.
IBEONE	Beone Logistics.
ICUMULUS	iCumulus.
IDEXPRESS	IDEX courier.
IDN_JNE	JNE Express (Jalur Nugraha Ekakurir).
IDN_LION_PARCEL	Lion Parcel.
IDN_PANDU	pandu Logistics (pandulogistics.com).
IML	IML courier.
INDOPAKET	INDOPAKET.
IND_BLUEDART	Bluedart.
IND_DELHIVERY	Delhivery India.
IND_DELIVREE	deliverE.
IND_DOTZOT	Dotzot.
IND_ECOM	Ecom Express.
IND_FIRSTFLIGHT	First Flight Couriers.
IND_GATI	Gati-KWE.
IND_GOJAVAS	GoJavas.
IND_PROFESSIONAL_COURIERS	Professional Couriers.
IND_SAFEEXPRESS	Safexpress.
IND_XPRESSBEES	Xpressbees (www.xpressbees.com).
INPOST_PACZKOMATY	InPost Paczkomaty.
INTEGRA2_FTP	Integra2.
INTELIPOST	Intelipost (TMS for LATAM).
INTEL_VALLEY	Intel-Valley Supply chain (ShenZhen) Co. Ltd.
INTERPARCEL_AU	Interparcel Australia.
INTERPARCEL_NZ	Interparcel New Zealand.
INTERPARCEL_UK	Interparcel UK.
INTEXPRESS	Internet Express.
ISRAEL_POST	Israel Post.
ISR_POST_DOMESTIC	Israel Post Domestic.
IT_DHL_ECOMMERCE	DHL International.
IT_FERCAM	FERCAM Logistics & Transport.
IT_NEXIVE	Nexive (TNT Post Italy).
IT_POSTE_ITALIA	Poste italiane (www.poste.it).
IT_TNT	TNT Italy.
IVOY_WEBHOOK	Ivoy courier.
I_DIKA	i-dika.
JANCO	Janco Ecommerce.
JANIO	Janio Asia.
JERSEY_POST	Jersey Post.
JET_SHIP	Jet-Ship Worldwide.
JINDOUYUN	jindouyun courier.
JINSUNG	JINSUNG TRADING.
JOCOM	Jocom.
JOOM_LOGIS	Joom Logistics.
JOYING_BOX	Joying Box.
JPN_JAPAN_POST	Japan Post.
JPN_SAGAWA	Sagawa Express Japan.
JP_KURO_NEKO_YAMATO_UNYUU	Yamato transport (www.kuronekoyamato.co.jp).
JS_EXPRESS	JS EXPRESS.
JTEXPRESS	J&T EXPRESS MALAYSIA.
JTEXPRESS_VN	J&T Express Vietnam.
JX	JX courier.
J_NET	J-Net.
K1_EXPRESS	K1 Express.
KANGAROO_MY	Kangaroo Worldwide Express.
KEC	KEC courier.
KERRYTJ	Kerry TJ Logistics.
KERRYTTC_VN	Kerry Express (Vietnam) Co Ltd.
KERRY_ECOMMERCE	Kerry eCommerce.
KGMHUB	KGM Hub.
KHM_CAMBODIA_POST	Cambodia Post.
KOR_ECARGO	Ecargo.
KPOST	Korea Post.
KR_KOREA_POST	Koreapost (www.koreapost.go.kr).
KUEHNE	Kuehne + Nagel.
KURASI	KURASI.
KWE_GLOBAL	KWE Global.
KWT	Shenzhen Jinghuada Logistics Co..
KYUNGDONG_PARCEL	Kyungdong Parcel.
KY_EXPRESS	Kua Yue Express.
LALAMOVE	Lalamove.
LANDMARK_GLOBAL	Landmark Global.
LANDMARK_GLOBAL_REFERENCE	Landmark Global Reference.
LATVIJAS_PASTS	Latvijas Pasts.
LA_POSTE_SUIVI	La Poste.
LBCEXPRESS_FTP	LBC EXPRESS INC..
LEADER	leader.
LEGION_EXPRESS	Legion Express.
LEXSHIP	LexShip.
LHT_EXPRESS	LHT Express.
LICCARDI_EXPRESS	LICCARDI EXPRESS COURIER.
LIEFERY	liefery.
LINE	Line Clear Express & Logistics Sdn Bhd.
LINKBRIDGE	Link Bridge(BeiJing)international logistics co..
LOCUS_WEBHOOK	Locus courier.
LOGISTERS	Logisters.
LOGISTICSWORLDWIDE_HK	Logistic Worldwide Express (LWE Honkong).
LOGISTIKA	Logistika.
LOGISTYX_TRANSGROUP	Transgroup courier.
LONESTAR	Lone Star Overnight.
LOOMIS_EXPRESS	Loomis Express.
LOTTE	Lotte Global Logistics.
LTIANEXP	LTIAN EXP.
LTL	LTL COURIER.
LTU_LIETUVOS	Lietuvos pastas.
MAGYAR_HU	Magyar Post.
MAILAMERICAS	MailAmericas.
MAILPLUS_JPN	MailPlus (Japan).
MAIL_PLUS	MailPlus.
MAINFREIGHT	Mainfreight.
MAINWAY	Mainway.
MATDESPATCH	Matdespatch.
MATKAHUOLTO	Matkahuolto.
MBW	MBW Courier Inc..
MEX_AEROFLASH	Aeroflash Mexico.
MEX_ESTAFETA	Estafeta (www.estafeta.com).
MEX_REDPACK	Redpack.
MEX_SENDA	mexico senda express.
MGLOBAL	PT MGLOBAL LOGISTICS INDONESIA.
MIKROPAKKET	Mikropakket.
MIKROPAKKET_BE	Mikropakket Belgium.
MILKMAN	Milkman courier.
MORE_LINK	Morelink.
MORNING_EXPRESS	Morning Express.
MRW_FTP	MRW courier.
MXE	MXE Express.
MX_CARGO	M&X cargo.
MYHERMES	MyHermes UK.
MYS_AIRPAK	Airpak Express.
MYS_EMS	Malaysia Post EMS / Pos Laju.
MYS_GDEX	GDEX courier.
MYS_MYPOST_ONLINE	Mypostonline.
MYS_MYS_POST	Malaysia Post.
MYS_SKYNET	Skynet Malaysia.
M_XPRESS	M Xpress Sdn Bhd.
NACEX	NACEX.
NACEX_ES	NACEX Spain.
NANJINGWOYUAN	Nanjing Woyuan.
NATIONAL_SAMEDAY	National Sameday.
NATIONEX	Nationex courier.
NATIONWIDE_MY	Nationwide Express Courier Services Bhd (www.nationwide.com.my).
NEWAY	Neway Transport.
NEWEGGEXPRESS	Newegg Express.
NEWGISTICS	Newgistics.
NEWZEALAND_COURIERS	NEW ZEALAND COURIERS.
NG_COURIERPLUS	Courier Plus.
NHANS_SOLUTIONS	Nhans Solutions.
NIM_EXPRESS	Nim Express.
NINJAVAN_MY	ninja van (www.ninjavan.co).
NINJAVAN_SG	Ninja van Singapore.
NINJAVAN_THAI	Ninja van Thai.
NINJAVAN_WB	Ninjavan Webhook.
NIPOST_NG	NIpost (www.nipost.gov.ng).
NLD_DHL	DHL Netherland.
NLD_GLS	GLS Netherland.
NLD_POSTNL	PostNL International.
NLD_TRANSMISSION	TransMission.
NOVA_POSHTA	Nova Poshta (novaposhta.ua).
NOVA_POSHTA_INT	Nova Poshta (International).
NOX_NACHTEXPRESS	Innight Express Germany GmbH (nox NachtExpress).
NOX_NIGHT_TIME_EXPRESS	NOX NightTimeExpress.
NTLOGISTICS_VN	Nhat Tin Logistics.
NZ_COURIER_POST	CourierPost Newsland.
NZ_NZ_POST	New Zealand Post.
OCS	OCS ANA Group.
OCS_WORLDWIDE	OCS WORLDWIDE.
OKAYPARCEL	OkayParcel.
OMNIPARCEL	Omni Parcel.
OMNIVA	Omniva.
ONECLICK	One click delivery services.
ONEWORLDEXPRESS	One World Express.
ORANGE_DS	OrangeDS (Orange Distribution Solutions Inc).
OSM_WORLDWIDE	OSM Worldwide.
OVERSE_EXP	Overseas Express.
P2P_TRC	P2P TrakPak.
PAACK_WEBHOOK	Paack courier.
PADTF	padtf.com.
PAGO	Pago Logistics.
PALEXPRESS	PAL Express Limited.
PALLETWAYS	Palletways.
PALLET_NETWORK	The Pallet Network.
PANTHER_REFERENCE	Panther Reference.
PAN_ASIA	Pan-Asia International.
PAPERFLY	Paperfly Private Limited.
PAPER_EXPRESS	Paper Express.
PAQUETEXPRESS	Paquetexpress.
PARCEL2GO	Parcel2Go.
PARCELINKLOGISTICS	Parcelink Logistics.
PARCELLED_IN	Parcelled.in.
PARCELONE	PARCEL ONE.
PARCELPAL_WEBHOOK	ParcelPal.
PARCELPOINT	Parcelpoint.
PARCELPOST_SG	Parcel Post Singapore.
PARCEL_2_POST	Parcel To Post.
PARKNPARCEL	Park N Parcel.
PCFCORP	PCF Final Mile.
PFCEXPRESS	PFC Express.
PFLOGISTICS	PFL.
PHL_AIR21	AIR21 courier.
PHL_AIRSPEED	Airspeed International.
PHL_JAMEXPRESS	Jam Express Philippines.
PICKRR	Pickrr.
PICKUP	Pickupp.
PICKUPP_MYS	PICK UPP.
PICKUPP_SGP	PICK UPP (Singapore).
PILOT_FREIGHT	Pilot Freight Services.
PIL_LOGISTICS	PIL Logistics (China) Co..
PITNEY_BOWES	Pitney Bowes.
PITTOHIO	PITT OHIO.
PIXSELL	PIXSELL LOGISTICS.
PLANZER	Planzer Group.
PLUS_LOG_UK	Plus UK Logistics.
PL_POCZTA_POLSKA	Poczta Polska (www.poczta-polska.pl).
POL_SIODEMKA	Siodemka.
PONY_EXPRESS	Pony express.
POSTA_PLUS	Posta Plus.
POSTA_RO	Post Roman (www.posta-romana.ro).
POSTA_UKR	UkrPoshta.
POSTEN_NORGE	Posten Norge (www.posten.no).
POSTI	Posti courier.
POSTNL_INTL_3S	PostNL International 3S.
POSTNL_INT_3_S	PostNL International.
POSTNORD_LOGISTICS	PostNord Logistics.
POSTNORD_LOGISTICS_DK	ostnord denmark.
POSTUR_IS	Iceland Post.
POST_SERBIA	Posta Serbia.
POST_SLOVENIA	Post of Slovenia.
PRESIDENT_TRANS	PRESIDENT TRANSNET CORP.
PRESSIODE	Pressio.
PRIMAMULTICIPTA	PT Prima Multi Cipta.
PROMEDDELIVERY	ProMed Delivery.
PRT_CHRONOPOST	Chronopost Portugal.
PRT_CTT	CTT Portugal.
PRT_INT_SEUR	SEUR International.
PRT_SEUR	SEUR portugal.
PTS	PTS courier.
PTT_POST	PTT Post.
QUANTIUM	Quantium.
QWINTRY	Qwintry Logistics.
RABEN_GROUP	Raben Group.
RAF_PH	RAF Philippines.
RAIDEREX	RaidereX.
RAM	RAM courier.
RCL	Red Carpet Logistics.
RINCOS	Rincos.
RL_US	RL Carriers.
ROADBULL	Red Carpet Logistics.
ROADRUNNER_FREIGHT	Roadbull Logistics.
ROCKET_PARCEL	Rocket Parcel International.
ROUTIFIC_WEBHOOK	Routific.
ROYAL_MAIL	RoyalShipments.
RPD2MAN	RPD2man Deliveries.
RPX	RPX Online.
RPXLOGISTICS	RPX Logistics.
RPX_ID	RPX Indonesia.
RUSSIAN_POST	Russian post.
RUSTON	Ruston.
RZYEXPRESS	RZY Express.
SAIA_FREIGHT	Saia LTL Freight.
SAILPOST	SAILPOST.
SAP_EXPRESS	SAP EXPRESS.
SAU_SAUDI_POST	Saudi Post.
SCUDEX_EXPRESS	Scudex Express.
SDA_IT	SDA Italy.
SDH_SCM	lightning monkey
SEFL	Southeastern Freight Lines.
SEINO	Seino.
SEKOLOGISTICS	SEKO Logistics.
SEKO_SFTP	SEKO Worldwide.
SENDING	Sending Transporte Urgente y Comunicacion.
SENDIT	Sendit.
SENDLE	Sendle.
SEUR_ES	Seur Spain.
SEUR_SP_API	Spanish Seur API.
SFB2C	SF International.
SFCSERVICE	SFC Service.
SFC_LOGISTICS	SFC.
SFPLUS_WEBHOOK	Zeek courier.
SF_EX	SF Express.
SG_DETRACK	Detrack.
SG_QXPRESS	Qxpress.
SG_SG_POST	Singapore Post.
SG_SPEEDPOST	Singapore Speedpost.
SG_TAQBIN	Taqbin Singapore.
SHENZHEN	shenzhen 1st International Logistics(Group)Co.
SHIPENTEGRA	ShipEntegra.
SHIPPIT	Shippit.
SHIPTER	SHIPTER.
SHIPTOR	Shiptor.
SHIP_GATE	ShipGate.
SHIP_IT_ASIA	Ship It Asia.
SHOPFANS	ShopfansRU LLC.
SHREENANDANCOURIER	SHREE NANDAN COURIER.
SHREETIRUPATI	SHREE TIRUPATI COURIER SERVICES PVT. LTD..
SHREE_ANJANI_COURIER	Shree Anjani Courier.
SHREE_MARUTI	Shree Maruti Courier Services Pvt Ltd.
SIMPLYPOST	J&T Express Singapore.
SINOTRANS	Sinotrans.
SIN_GLBL	Sin Global Express.
SKYBOX	SKYBOX.
SKYNET_UAE	SKYNET UAE.
SKYNET_UK	Skynet UK.
SKYNET_WORLDWIDE	SkyNet Worldwide Express.
SKYNET_ZA	Skynet World Wide Express South Africa.
SKY_POSTAL	SkyPostal.
SK_POSTA	Slovenska pošta.
SMG_EXPRESS	SMG Direct.
SMOOTH	Smooth Couriers.
SMSA_EXPRESS	SMSA Express.
SONICTL	Sonic Transportation & Logistics.
SOUTH_AFRICAN_POST_OFFICE	South African Post Office.
SPEEDCOURIERS_GR	Speed Couriers.
SPEEDEE	Spee-Dee Delivery.
SPEEDEXCOURIER	SPEEDEX couriers.
SPOTON	SPOTON Logistics Pvt Ltd.
SPRING_GDS	Spring GDS.
SRE_KOREA	SRE Korea (www.srekorea.co.kr).
STALLIONEXPRESS	Stallion Express.
STARKEN	STARKEN couriers.
STAR_TRACK_EXPRESS	Star Track Express.
STAR_TRACK_NEXT_FLIGHT	Star Track Next Flight.
STEPFORWARDFS	STEP FORWARD FREIGHT SERVICE CO LTD.
STONE3PL	STONE3PL.
STRECK_TRANSPORT	Streck Transport.
SUTTON	Sutton Transport.
SWE_POSTNORD	Postnord sweden.
SWISHIP_DE	Swiship DE.
SWISS_POST_FTP	Swiss Post FTP.
SYPOST	Sunyou Post.
SZENDEX	SZENDEX.
TAQBIN_HK	TAQBIN Hong Kong.
TAQBIN_MY	TAQBIN Malaysia.
TARRIVE	TONDA GLOBAL.
TAZMANIAN_FREIGHT	Tazmanian Freight Systems.
TCK_EXPRESS	TCK Express.
TCS	TCS courier.
TFM	TFM Xpress.
TFORCE_FINALMILE	TForce Final Mile.
THABIT_LOGISTICS	Thabit Logistics.
THA_DYNAMIC_LOGISTICS	Dynamic Logistics.
THA_KERRY	Kerry Express Thailand.
THA_THAILAND_POST	Thailand Post (www.thailandpost.co.th).
THECOURIERGUY	The Courier Guy.
THEDELIVERYGROUP	TDG – The Delivery Group.
THENILE_WEBHOOK	SortHub courier.
TIGFREIGHT	TIG Freight.
TIKI_ID	Tiki shipment.
TIPSA	TIPSA courier.
TNT	TNT Express.
TNT_CLICK_IT	TNT-Click Italy.
TNT_FR	TNT France.
TNT_NL	THT Netherland.
TNT_REFR	TNT Reference.
TNT_UK	TNT UK Limited (www.tnt.com).
TNT_UK_REFR	TNT UK Reference.
TOLL	Toll IPEC.
TOLL_NZ	Toll New Zealand.
TOLOS	Tolos courier.
TOPHATTEREXPRESS	Tophatter Express.
TOPYOU	TopYou.
TOTAL_EXPRESS	Total Express.
TOURLINE	tourline.
TRACKON	Trackon Couriers Pvt. Ltd.
TRANS_KARGO	Trans Kargo Internasional.
TRUMPCARD	TRUMPCARD LLC.
TRUNKRS_WEBHOOK	Trunkrs courier.
TUFFNELLS_REFERENCE	Tuffnells Parcels Express- Reference.
TWO_GO	2GO Courier.
TW_TAIWAN_POST	Taiwan Post.
UBI_LOGISTICS	UBI Smart Parcel.
UC_EXPRE	ucexpress.
UDS	United Delivery Service.
UK_COLLECTPLUS	Collect plus.
UK_DPD	DPD UK.
UK_NIGHTLINE	Nightline(www.nightline.ie).
UK_PARCELFORCE	Parcel Force.
UK_UK_MAIL	UK mail (ukmail.com).
UK_XDP	XDP Express.
UK_YODEL	Yodel (www.yodel.co.uk).
UPS	United Parcel Service.
UPS_FREIGHT	UPS Freight.
UPS_MAIL_INNOVATIONS	UPS Mail Innovations.
UPS_REFERENCE	UPS Reference.
USF_REDDAWAY	USF Reddaway.
USHIP	uShip courier.
USPS	United States Postal Service.
US_GLOBEGISTICS	Globegistics US.
US_LASERSHIP	LaserShip.
US_OLD_DOMINION	Old Dominion Freight Line.
US_ONTRAC	OnTrac Logistics.
US_YRC	YRC courier.
VAMOX	VAMOX.
VENIPAK	Venipak.
VIAEUROPE	ViaEurope.
VIA_EXPRESS	Viaxpress.
VIRTRANSPORT	VIR Transport.
VIWO	VIWO IoT.
VNM_VIETNAM_POST	Vietnam Post.
VNM_VIETTELPOST	ViettelPost.
WAHANA_ID	Wahana express (www.wahana.com).
WANBEXPRESS	WanbExpress.
WEASHIP	Weaship.
WEPOST	WePost Sdn Bhd.
WESTBANK_COURIER	West Bank Courier.
WESTGATE_GL	Westgate Global.
WHISTL	Whistl.
WINIT	WinIt.
WISELOADS	Wiseloads.
WISE_EXPRESS	Wise Express.
WIZMO	Wizmo.
WMG	WMG Delivery.
WNDIRECT	wnDirect.
WYNGS	Wyngs.
XDE_WEBHOOK	Ximex Delivery Express.
XDP_UK_REFERENCE	XDP Express Reference.
XL_EXPRESS	XL Express.
XPERT_DELIVERY	Xpert Delivery.
XPOST	Xpost.ph.
XPO_LOGISTICS	XPO logistics.
XPRESSEN_DK	Xpressen courier.
XQ_EXPRESS	XQ Express.
YAKIT	Yakit courier.
YANWEN	Yanwen Logistics.
YDH_EXPRESS	YDH express.
YINGNUO_LOGISTICS	yingnuo logistics.
YODEL_DIR	Yodel Direct.
YODEL_INTNL	Yodel International.
YTO	YTO Express.
YUNEXPRESS	YunExpress.
YURTICI_KARGO	Yurtici Kargo.
YUSEN	Yusen Logistics.
ZAJIL_EXPRESS	Zajil Express Company.
ZA_COURIERIT	Courier IT.
ZA_FASTWAY	fastway New Zealand.
ZA_SPECIALISED_FREIGHT	Specialised Freight.
ZEEK_2_DOOR	Zeek2Door.
ZELERIS	Zeleris.
ZEPTO_EXPRESS	ZeptoExpress.
ZES_EXPRESS	Eshun international Logistic.
ZIINGFINALMILE	Ziing Final Mile Inc.
ZINC	Zinc courier.
ZJS_EXPRESS	ZJS International.
ZTO_EXPRESS	ZTO Express.
ZYLLEM	Zyllem.

last_updated_time

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

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.

Responses

204

A successful request returns the HTTP 204 OK status code with no JSON response body.

Request samples

Payload
cURL
Node.js
Java
Python

application/json

{"transaction_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"status": "CANCELLED",
"carrier": "FEDEX"
}

Response samples

application/json

{ }

Show tracking information

get/v1/shipping/trackers/{id}

Shows tracking information, by tracker ID, for a PayPal transaction.

SecurityOauth2

Request

path Parameters

required

string [ 1 .. 100 ] characters ^[a-zA-Z0-9-_]*$

The ID of the tracker in the transaction_id-tracking_number format.

query Parameters

account_id

string = 13 characters ^[2-9A-HJ-NP-Z]{13}$

Encrypted PayPal Account ID of the buyer or seller.

Responses

200

A successful request returns the HTTP 200 OK status code and a JSON response body that shows tracking information.

Request samples

cURL
Node.js
Java
Python

Response samples

application/json

{"transaction_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"status": "SHIPPED",
"carrier": "FEDEX",
"shipment_direction": "FORWARD",
"shipment_uploader": "MERCHANT",
"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"
}
]
}

Errors

INPUT_VALIDATION_ERROR

Message:
Transaction ID specified is invalid.

Description: Re-check the transaction ID.

INTERNAL_SERVER_ERROR

Message:
Internal server error. Please check logs for more details.

Description: An internal server error prevented the request from being processed. Try again later.

NOT_AUTHORIZED

Message:
Authorization failed due to insufficient permissions.

Description: The caller does not have the correct permissions to authorize the payment.

RESOURCE_NOT_FOUND

Message:
The specified resource does not exist.

Description: The resource does not exist.

Definitions

batch_tracker_collection

The add tracking information for multiple PayPal transactions response details.

	Array of objects (tracker_identifier) [ 1 .. 100 ] items The batch header.
	Array of objects (Error) [ 1 .. 100 ] items An array of error responses.
	Array of objects (Link Description) = 1 items An array of request-related HATEOAS links.

{"tracker_identifiers": [{"transaction_id": "string",
"tracking_number": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
],
"errors": [{"name": "string",
"message": "string",
"debug_id": "string",
"information_link": "string",
"details": [{"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}

carrier

string (carrier) [ 1 .. 64 ] characters ^.*$

Enum Value	Description
2EBOX	2ebox courier.
360LION	360 Lion Express.
3JMSLOGISTICS	3JMS Logistics.
4_72	4-72 Entregando
6LS	6ls.com.
A1POST	A1Post.
AAA_COOPER	AAA Cooper.
ABCUSTOM	AB Custom Group.
ABXEXPRESS_MY	ABX Express.
ACOMMMERCE	aCommerce.
ACSWORLDWIDE	ACS Worldwide Express.
ACS_GR	ACS Courier.
ADERONLINE	Ader couriers.
ADICIONAL	Adicional Logistics.
ADSONE	ADSone.
ADUIEPYLE	A Duie Pyle.
AERONET	Aeronet couriers.
AEX	AEX Group.
AFLLOG_FTP	AFL LOGISTICS.
AGILITY	Agility.
AIRMEE_WEBHOOK	Airmee couriers.
AIR_CANADA_GLOBAL	Rivo (Air canada).
ALFATREX	AlfaTrex.
ALLIEDEXPRESS	Allied Express.
ALLJOY	ALLJOY SUPPLY CHAIN.
ALPHAFAST	Alphafast (www.alphafast.com).
ALWAYS_EXPRESS	Always Express.
AMAZON	Amazon Shipping.
AMAZON_FBA_SWISHIP	Swiship UK.
AMAZON_SHIP_MCF	Amazon Shipping + Amazon MCF.
AMSTAN	Amstan Logistics.
AMS_GRP	AMS Group.
ANDREANI	Grupo logistico Andreani.
ANICAM_BOX	ANICAM BOX EXPRESS.
ANJUN	Anjun couriers.
ANSERX	ANSERX courier.
AN_POST	An Post.
AO_COURIER	AO Logistics.
AO_DEUTSCHLAND	AO Deutschland.
APC_OVERNIGHT	APC overnight (apc-overnight.com).
APC_OVERNIGHT_CONNUM	APC Overnight Consignment.
APG	APG eCommerce Solutions.
APRISAEXPRESS	Aprisa Express.
AQUILINE	Aquiline.
ARAMEX	Aramex.
ARAMEX_AU	Aramex Australia (formerly Fastway AU).
ARCO_SPEDIZIONI	Arco Spedizioni SP.
ARE_EMIRATES_POST	Emirates Post.
ARG_OCA	OCA Argentina.
ARK_LOGISTICS	ARK Logistics.
ASE	ASE KARGO.
ASENDIA_HK	Asendia HonKong.
ASENDIA_UK	Asendia UK.
ASENDIA_USA	Asendia USA.
ASIGNA	ASIGNA courier.
AUPOST_CN	AuPost China.
AUSTRIAN_POST_EXPRESS	austrian post.
AUS_STARTRACK	StarTrack (startrack.com.au).
AUS_TOLL	TOLL Australia.
AU_AUSTRIAN_POST	Austrian Post (Registered).
AU_AU_POST	Australia Post.
AU_TNT	TNT Australia.
AVERITT	Averitt Express.
BEL_DHL	DHL Benelux.
BEL_RS	BEL North Russia.
BESTWAYPARCEL	Best Way Parcel.
BE_BPOST	Bpost (www.bpost.be).
BE_KIALA	Kiala.
BG_BULGARIAN_POST	Bulgarian Posts.
BH_POSTA	BH Posta (www.posta.ba).
BH_WORLDWIDE	B&H Worldwide.
BIRDSYSTEM	BirdSystem.
BJSHOMEDELIVERY	BJS Distribution courier.
BLINKLASTMILE	Blink.
BLR_BELPOST	Belpost.
BLUECARE	Bluecare Express Ltd.
BLUESTAR	Blue Star.
BLUEX	Blue Express.
BNEED	Bneed courier.
BOMBINOEXP	Bombino Express Pvt.
BOND	Bond courier.
BONDSCOURIERS	Bonds Courier Service (bondscouriers.com.au).
BORDEREXPRESS	Border Express.
BOX_BERRY	Boxberry courier.
BPOST_INT	Bpost international.
BRA_CORREIOS	Correios Brazil.
BRING	Bring.
BROUWER_TRANSPORT	Brouwer Transport en Logistiek.
BRT_IT	BRT couriers Italy (www.brt.it).
BRT_IT_PARCELID	BRT Bartolini(Parcel ID).
BRT_IT_SENDER_REF	BRT Bartolini(Sender Reference).
BUDBEE_WEBHOOK	Budbee courier.
BUYLOGIC	buylogic.
B_TWO_C_EUROPE	B2C courier Europe.
CAE_DELIVERS	CAE Delivers.
CAINIAO	AliExpress Standard Shipping.
CARIBOU	Caribou.
CARRIERS	Carriers courier.
CARRY_FLAP	Carry-Flap Co..
CA_CANADA_POST	Canada Post.
CA_CANPAR	Canpar Courier.
CA_GREYHOUND	Greyhound.
CA_PUROLATOR	Purolator.
CBL_LOGISTICA	CBL Logistica.
CDEK	CDEK courier.
CDEK_TR	CDEK TR.
CELERITAS	Celeritas Transporte.
CELLO_SQUARE	Cello Square.
CESKA_CZ	Czech Post.
CEVA	CEVA LOGISTICS.
CFL_LOGISTICS	CFL Logistics.
CGS_EXPRESS	CGS Express.
CHAMPION_LOGISTICS	Champion Logistics.
CHITCHATS	Chit Chats.
CHOIR_EXP	Choir Express Indonesia.
CHROBINSON	C.H. Robinson Worldwide.
CHRONOPOST_FR	Chronopost france (www.chronopost.fr).
CHUKOU1	Chukou1.
CH_SWISS_POST_PRIORITY	Swiss Post.
CITYLINK_MY	City-Link Express.
CJPACKET	CJ Packet.
CJ_CENTURY	CJ Century.
CJ_GLS	CJ GLS.
CJ_HK_INTERNATIONAL	CJ Logistics International(Hong Kong).
CJ_INT_MY	CJ International malaysia.
CJ_KR	CJ Korea Express.
CJ_LOGISTICS	CJ Logistics International.
CJ_TH	CJ Transnational Philippines.
CLEVY_LINKS	Clevy Links.
CLE_LOGISTICS	CL E-Logistics Solutions Limited.
CLOUDWISH_ASIA	Cloudwish Asia.
CNDEXPRESS	CND Express.
CNEXPS	CNE Express.
CNWANGTONG	cnwangtong.
CN_17POST	17 Post Service.
CN_BESTEXPRESS	Best Express.
CN_BOXC	BoxC courier.
CN_CHINA_POST_EMS	China Post.
CN_DPEX	DPEX.
CN_EMS	EMS China (www.ems.post).
CN_EQUICK	Equick China.
CN_JCEX	JCEX courier.
CN_PAYPAL_PACKAGE	PayPal Package.
CN_POST56	Post56.
CN_SF_EXPRESS	SF Express (www.sf-express.com).
CN_STO	STO Express.
CN_WEDO	WeDo Logistics.
CN_WISHPOST	WishPost.
CN_YUNDA	Yunda Express.
COLIS_PRIVE	Colis Privé.
COLLECTCO	CollectCo.
COLLIVERY	MDS Collivery Pty (Ltd).
COMET_TECH	CometTech.
CONTINENTAL	Continental.
CON_WAY	Con-way Freight.
COORDINADORA	Coordinadora.
COPA_COURIER	Copa Airlines Courier.
COPE	Cope Sensitive Freight.
CORPORATECOURIERS_WEBHOOK	Corporate Couriers.
CORREOS_DE_MEXICO	correos mexico.
CORREOS_ES	correos Express (www.correos.es).
CORREOS_EXPRESS	Correos Express.
CORREO_UY	Correo Uruguayo.
COSTMETICSNOW	Cosmetics Now.
COURANT_PLUS	Courant Plus.
COUREX	Urbanfox.
COURIERS_PLEASE	CouriersPlease (couriersplease.com.au).
CPACKET	Cpacket couriers.
CPEX	Captain Express International.
CROSHOT	Croshot.
CSE	CSE courier.
CTC_EXPRESS	CTC Express.
CUBYN	Cubyn.
CUCKOOEXPRESS	Cuckoo Express.
CYPRUS_POST_CYP	cyprus post.
DAIGLOBALTRACK	DAI Post.
DAJIN	Shanghai Aqrum Chemical Logistics Co.Ltd.
DANSKE_FRAGT	Danske Fragtaend.
DAWN_WING	Dawn Wing.
DAYTON_FREIGHT	Dayton Freight.
DBSCHENKER_B2B	DB Schenker B2B.
DBSCHENKER_SE	DB Schenker (www.dbschenker.com).
DBSCHENKER_SV	DB Schenker Sweden.
DDEXPRESS	DD Express Courier.
DEALERSEND	DealerSend.
DELIVERYONTIME	DELIVERYONTIME LOGISTICS PVT LTD.
DELNEXT	Delnext.
DELTEC_UK	Deltec Courier.
DEMANDSHIP	DemandShip.
DESCARTES	Innovel courier.
DESIGNERTRANSPORT_WEBHOOK	Designer Transport.
DESTINY	Destiny Transportation.
DEX_I	DEX-I courier.
DE_ASENDIA	Asendia Germany.
DE_DEUTSCHE	Deutsche post.
DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET	Deutsche Post DHL.
DE_DHL_EXPRESS	DHL Express.
DE_DPD_DELISTRACK	DPD Germany.
DE_GLS	GLS parcel services (www.gls-group.eu).
DHL	dhl Global.
DHL_ACTIVE_TRACING	DHL Active Tracing.
DHL_AU	DHL Supply Chain Australia.
DHL_BENELUX	dhl benelux.
DHL_ECOMERCE_ASA	DHL eCommerce Asia (API).
DHL_ES	DHL Spain(www.dhl.com).
DHL_FR	DHL France (www.dhl.com).
DHL_FREIGHT	DHL Freight.
DHL_GLOBAL_MAIL_ASIA	DHL Global Mail Asia (www.dhl.com).
DHL_HK	DHL HonKong.
DHL_JP	DHL Japan.
DHL_PARCEL_ES	DHL parcel Spain(www.dhl.com).
DHL_PARCEL_NL	DHL Parcel NL.
DHL_PARCEL_RU	DHL Parcel Russia.
DHL_PL	DHL Poland.
DHL_REFR	DHl (Reference number).
DHL_SG	dhl Singapore.
DHL_SUPPLY_CHAIN	DHL Supply Chain APAC.
DHL_UK	dhl UK.
DIAMOND_EUROGISTICS	Diamond Eurogistics Limited.
DICOM	GLS Logistic Systems Canada Ltd./Dicom.
DIDADI	DIDADI Logistics tech.
DIMERCO	Dimerco Express Group.
DIRECTCOURIERS	Direct Couriers.
DIRECTLOG	Directlog (www.directlog.com.br).
DIRECTPARCELS	Direct Parcels.
DMM_NETWORK	DMM Network.
DMS_MATRIX	DMSMatrix.
DOBROPOST	DobroPost.
DOORA	Doora Logistics.
DOORDASH_WEBHOOK	DoorDash.
DPD	DPD.
DPD_DELISTRACK	DPD delistrack.
DPD_FR	DPD France.
DPD_HGRY	DPD Hungary.
DPD_HK	DPD HongKong.
DPD_IR	DPD Ireland.
DPD_LOCAL	DPD Local.
DPD_LOCAL_REF	DPD Local reference.
DPD_POLAND	DPD Poland.
DPD_RO	DPD Romania.
DPD_RU	DPD Russia.
DPEX	DPEX (www.dpex.com).
DPE_EXPRESS	DPE Express.
DPE_SOUTH_AFRC	DPE South Africa.
DSV	DSV courier.
DTDC_AU	DTDC Australia.
DTDC_EXPRESS	DTDC express.
DTDC_IN	DTDC India.
DTD_EXPR	DTD Express.
DX_SFTP	DX (SFTP).
DYLT	Daylight Transport.
DYNALOGIC	Dynamic Logistics.
EASY_MAIL	Easy Mail.
ECEXPRESS	ECexpress.
ECHO	Echo courier.
ECMS	ECMS International Logistics Co..
ECOSCOOTING	ECOSCOOTING.
EFEX	eFEx (E-Commerce Fulfillment & Express).
EFS	EFS (E-commerce Fulfillment Service).
EKART	Ekart logistics (ekartlogistics.com).
ELIAN_POST	Yilian (Elian) Supply Chain.
EMPS_CN	EMPS Express.
ENDEAVOUR_DELIVERY	Endeavour Delivery.
ENVIALIA_REFERENCE	Envialia Reference.
EPARCEL_KR	eParcel Korea.
EPST_GLBL	ePost Global
EP_BOX	EP-Box courier.
ESHIPPING	Eshipping.
ESP_ASM	ASM(GLS Spain).
ESP_ENVIALIA	Envialia.
ESP_MRW	MRW spain.
ESP_NACEX	NACEX Spain.
ESP_PACKLINK	Packlink.
ESP_REDUR	Redur Spain.
ETOMARS	Etomars.
ETOTAL	eTotal Solution Limited.
ETS_EXPRESS	RETS express.
EU_FLEET_SOLUTIONS	EU Fleet Solutions.
EU_IMX	IMX Mail.
EXPRESSSALE	Expresssale.
FARGOOD	FarGood.
FAR_INTERNATIONAL	FAR international.
FASTRACK	Fasttrack.
FASTRK_SERV	Fastrak Services.
FASTWAY_IR	Fastway Ireland.
FASTWAY_NZ	Fastway New Zealand.
FDSEXPRESS	FDSEXPRESS.
FEDEX	Fedex.
FEDEX_CROSSBORDER	FedEx Cross Border.
FEDEX_FR	FedEx® Freight.
FEDEX_INTL_MLSERV	FedEx International MailService.
FEDEX_POLAND	FedEx® Poland Domestic.
FEDEX_UK	FedEx® UK.
FETCHR_WEBHOOK	Mena 360 (Fetchr).
FIEGE	Fiege Logistics.
FIEGE_NL	Fiege Netherlands.
FIRSTMILE	FirstMile.
FLASHEXPRESS	Flash Express.
FMX	FMX.
FONSEN	Fonsen Logistics.
FORRUN	forrun Pvt Ltd (Arpatech Venture).
FREIGHTQUOTE	Freightquote by C.H. Robinson.
FRETERAPIDO	Frete Rapido.
FR_BERT	Bert Transport.
FR_COLIS	Colissimo.
FR_EXAPAQ	DPD France (formerly exapaq).
FR_GEODIS	GEODIS - Distribution & Express.
FR_GLS	GLS france.
FULFILLA	Fulfilla.
FULFILLME	Fulfillme.
FURDECO	Furdeco.
GAC	GAC.
GANGBAO	GANGBAO Supplychain.
GBA	GBA Services Ltd.
GBS_BROKER	GBS-Broker.
GB_APC	APC postal logistics germany.
GB_ARROW	Arrow XL.
GB_NORSK	Norsk Global.
GB_PANTHER	Panther.
GB_TUFFNELLS	Tuffnells Parcels Express.
GEIS	Geis CZ.
GEL_EXPRESS	Gel Express Logistik.
GEMWORLDWIDE	GEM Worldwide.
GENERAL_OVERNIGHT	Go!Express and logistics.
GENIKI_GR	Geniki Taxydromiki.
GEODIS_ESPACE	Geodis E-space.
GESWL	GESWL Express.
GIAO_HANG	Giao hàng nhanh.
GIO_EXPRESS	Gio Express.
GLOBALTRANZ	GlobalTranz.
GLOBAL_ABF	ABF Freight.
GLOBAL_ESTES	Estes Express Lines.
GLOBAL_EXPRESS	Tai Wan Global Business.
GLOBAL_IPARCEL	i-parcel.
GLOBAL_TNT	TNT global.
GLOBAVEND	Globavend.
GLS_CROTIA	GLS Croatia.
GLS_CZ	GLS Czech Republic.
GLS_IT	GLS Italy.
GLS_ITALY	GLS Italy.
GLS_SLOV	GLS General Logistics Systems Slovakia s.r.o..
GLS_SLOVEN	GLS Slovenia.
GOGLOBALPOST	Global Post.
GOJEK	Gojek.
GRAB_WEBHOOK	Grab courier.
GRUPO	Grupo ampm.
GR_ELTA	ELTA Hellenic Post.
GSI_EXPRESS	GSI EXPRESS.
GSO	GSO(GLS-USA).
HAPPY2POINT	Happy 2ThePoint
HCT_LOGISTICS	HCT LOGISTICS CO.LTD..
HDB	Haidaibao.
HDB_BOX	Haidaibao (BOX).
HELLMANN	Hellmann Worldwide Logistics.
HELTHJEM	Helthjem.
HEPPNER	Heppner Internationale Spedition GmbH & Co..
HEPPNER_FR	Heppner France.
HERMES	HermesWorld UK.
HERMES_2MANN_HANDLING	Hermes Einrichtungs Service GmbH & Co. KG.
HERMES_DE	Hermes Germany.
HH_EXP	Hua Han Logistics.
HIPSHIPPER	Hipshipper.
HKD	Qingdao HKD International Logistics.
HK_FLYT_EXPRESS	FLYT express.
HK_FOUR_PX_EXPRESS	4PX (fourPX).
HK_POST	Hongkong Post (www.hongkongpost.hk).
HK_TGX	Kerry Express Hong Kong.
HOLISOL	Holisol.
HOME_DELIVERY_SOLUTIONS	Home Delivery Solutions Ltd.
HOUNDEXPRESS	Hound Express.
HRPARCEL	HR Parcel.
HRV_HRVATSKA	Hrvatska posta.
HUAHAN_EXPRESS	HUAHANG EXPRESS.
HUNTER_EXPRESS	Hunter Express.
HUODULL	Huodull.
HX_EXPRESS	HX Express.
IBEONE	Beone Logistics.
ICUMULUS	iCumulus.
IDEXPRESS	IDEX courier.
IDN_JNE	JNE Express (Jalur Nugraha Ekakurir).
IDN_LION_PARCEL	Lion Parcel.
IDN_PANDU	pandu Logistics (pandulogistics.com).
IML	IML courier.
INDOPAKET	INDOPAKET.
IND_BLUEDART	Bluedart.
IND_DELHIVERY	Delhivery India.
IND_DELIVREE	deliverE.
IND_DOTZOT	Dotzot.
IND_ECOM	Ecom Express.
IND_FIRSTFLIGHT	First Flight Couriers.
IND_GATI	Gati-KWE.
IND_GOJAVAS	GoJavas.
IND_PROFESSIONAL_COURIERS	Professional Couriers.
IND_SAFEEXPRESS	Safexpress.
IND_XPRESSBEES	Xpressbees (www.xpressbees.com).
INPOST_PACZKOMATY	InPost Paczkomaty.
INTEGRA2_FTP	Integra2.
INTELIPOST	Intelipost (TMS for LATAM).
INTEL_VALLEY	Intel-Valley Supply chain (ShenZhen) Co. Ltd.
INTERPARCEL_AU	Interparcel Australia.
INTERPARCEL_NZ	Interparcel New Zealand.
INTERPARCEL_UK	Interparcel UK.
INTEXPRESS	Internet Express.
ISRAEL_POST	Israel Post.
ISR_POST_DOMESTIC	Israel Post Domestic.
IT_DHL_ECOMMERCE	DHL International.
IT_FERCAM	FERCAM Logistics & Transport.
IT_NEXIVE	Nexive (TNT Post Italy).
IT_POSTE_ITALIA	Poste italiane (www.poste.it).
IT_TNT	TNT Italy.
IVOY_WEBHOOK	Ivoy courier.
I_DIKA	i-dika.
JANCO	Janco Ecommerce.
JANIO	Janio Asia.
JERSEY_POST	Jersey Post.
JET_SHIP	Jet-Ship Worldwide.
JINDOUYUN	jindouyun courier.
JINSUNG	JINSUNG TRADING.
JOCOM	Jocom.
JOOM_LOGIS	Joom Logistics.
JOYING_BOX	Joying Box.
JPN_JAPAN_POST	Japan Post.
JPN_SAGAWA	Sagawa Express Japan.
JP_KURO_NEKO_YAMATO_UNYUU	Yamato transport (www.kuronekoyamato.co.jp).
JS_EXPRESS	JS EXPRESS.
JTEXPRESS	J&T EXPRESS MALAYSIA.
JTEXPRESS_VN	J&T Express Vietnam.
JX	JX courier.
J_NET	J-Net.
K1_EXPRESS	K1 Express.
KANGAROO_MY	Kangaroo Worldwide Express.
KEC	KEC courier.
KERRYTJ	Kerry TJ Logistics.
KERRYTTC_VN	Kerry Express (Vietnam) Co Ltd.
KERRY_ECOMMERCE	Kerry eCommerce.
KGMHUB	KGM Hub.
KHM_CAMBODIA_POST	Cambodia Post.
KOR_ECARGO	Ecargo.
KPOST	Korea Post.
KR_KOREA_POST	Koreapost (www.koreapost.go.kr).
KUEHNE	Kuehne + Nagel.
KURASI	KURASI.
KWE_GLOBAL	KWE Global.
KWT	Shenzhen Jinghuada Logistics Co..
KYUNGDONG_PARCEL	Kyungdong Parcel.
KY_EXPRESS	Kua Yue Express.
LALAMOVE	Lalamove.
LANDMARK_GLOBAL	Landmark Global.
LANDMARK_GLOBAL_REFERENCE	Landmark Global Reference.
LATVIJAS_PASTS	Latvijas Pasts.
LA_POSTE_SUIVI	La Poste.
LBCEXPRESS_FTP	LBC EXPRESS INC..
LEADER	leader.
LEGION_EXPRESS	Legion Express.
LEXSHIP	LexShip.
LHT_EXPRESS	LHT Express.
LICCARDI_EXPRESS	LICCARDI EXPRESS COURIER.
LIEFERY	liefery.
LINE	Line Clear Express & Logistics Sdn Bhd.
LINKBRIDGE	Link Bridge(BeiJing)international logistics co..
LOCUS_WEBHOOK	Locus courier.
LOGISTERS	Logisters.
LOGISTICSWORLDWIDE_HK	Logistic Worldwide Express (LWE Honkong).
LOGISTIKA	Logistika.
LOGISTYX_TRANSGROUP	Transgroup courier.
LONESTAR	Lone Star Overnight.
LOOMIS_EXPRESS	Loomis Express.
LOTTE	Lotte Global Logistics.
LTIANEXP	LTIAN EXP.
LTL	LTL COURIER.
LTU_LIETUVOS	Lietuvos pastas.
MAGYAR_HU	Magyar Post.
MAILAMERICAS	MailAmericas.
MAILPLUS_JPN	MailPlus (Japan).
MAIL_PLUS	MailPlus.
MAINFREIGHT	Mainfreight.
MAINWAY	Mainway.
MATDESPATCH	Matdespatch.
MATKAHUOLTO	Matkahuolto.
MBW	MBW Courier Inc..
MEX_AEROFLASH	Aeroflash Mexico.
MEX_ESTAFETA	Estafeta (www.estafeta.com).
MEX_REDPACK	Redpack.
MEX_SENDA	mexico senda express.
MGLOBAL	PT MGLOBAL LOGISTICS INDONESIA.
MIKROPAKKET	Mikropakket.
MIKROPAKKET_BE	Mikropakket Belgium.
MILKMAN	Milkman courier.
MORE_LINK	Morelink.
MORNING_EXPRESS	Morning Express.
MRW_FTP	MRW courier.
MXE	MXE Express.
MX_CARGO	M&X cargo.
MYHERMES	MyHermes UK.
MYS_AIRPAK	Airpak Express.
MYS_EMS	Malaysia Post EMS / Pos Laju.
MYS_GDEX	GDEX courier.
MYS_MYPOST_ONLINE	Mypostonline.
MYS_MYS_POST	Malaysia Post.
MYS_SKYNET	Skynet Malaysia.
M_XPRESS	M Xpress Sdn Bhd.
NACEX	NACEX.
NACEX_ES	NACEX Spain.
NANJINGWOYUAN	Nanjing Woyuan.
NATIONAL_SAMEDAY	National Sameday.
NATIONEX	Nationex courier.
NATIONWIDE_MY	Nationwide Express Courier Services Bhd (www.nationwide.com.my).
NEWAY	Neway Transport.
NEWEGGEXPRESS	Newegg Express.
NEWGISTICS	Newgistics.
NEWZEALAND_COURIERS	NEW ZEALAND COURIERS.
NG_COURIERPLUS	Courier Plus.
NHANS_SOLUTIONS	Nhans Solutions.
NIM_EXPRESS	Nim Express.
NINJAVAN_MY	ninja van (www.ninjavan.co).
NINJAVAN_SG	Ninja van Singapore.
NINJAVAN_THAI	Ninja van Thai.
NINJAVAN_WB	Ninjavan Webhook.
NIPOST_NG	NIpost (www.nipost.gov.ng).
NLD_DHL	DHL Netherland.
NLD_GLS	GLS Netherland.
NLD_POSTNL	PostNL International.
NLD_TRANSMISSION	TransMission.
NOVA_POSHTA	Nova Poshta (novaposhta.ua).
NOVA_POSHTA_INT	Nova Poshta (International).
NOX_NACHTEXPRESS	Innight Express Germany GmbH (nox NachtExpress).
NOX_NIGHT_TIME_EXPRESS	NOX NightTimeExpress.
NTLOGISTICS_VN	Nhat Tin Logistics.
NZ_COURIER_POST	CourierPost Newsland.
NZ_NZ_POST	New Zealand Post.
OCS	OCS ANA Group.
OCS_WORLDWIDE	OCS WORLDWIDE.
OKAYPARCEL	OkayParcel.
OMNIPARCEL	Omni Parcel.
OMNIVA	Omniva.
ONECLICK	One click delivery services.
ONEWORLDEXPRESS	One World Express.
ORANGE_DS	OrangeDS (Orange Distribution Solutions Inc).
OSM_WORLDWIDE	OSM Worldwide.
OVERSE_EXP	Overseas Express.
P2P_TRC	P2P TrakPak.
PAACK_WEBHOOK	Paack courier.
PADTF	padtf.com.
PAGO	Pago Logistics.
PALEXPRESS	PAL Express Limited.
PALLETWAYS	Palletways.
PALLET_NETWORK	The Pallet Network.
PANTHER_REFERENCE	Panther Reference.
PAN_ASIA	Pan-Asia International.
PAPERFLY	Paperfly Private Limited.
PAPER_EXPRESS	Paper Express.
PAQUETEXPRESS	Paquetexpress.
PARCEL2GO	Parcel2Go.
PARCELINKLOGISTICS	Parcelink Logistics.
PARCELLED_IN	Parcelled.in.
PARCELONE	PARCEL ONE.
PARCELPAL_WEBHOOK	ParcelPal.
PARCELPOINT	Parcelpoint.
PARCELPOST_SG	Parcel Post Singapore.
PARCEL_2_POST	Parcel To Post.
PARKNPARCEL	Park N Parcel.
PCFCORP	PCF Final Mile.
PFCEXPRESS	PFC Express.
PFLOGISTICS	PFL.
PHL_AIR21	AIR21 courier.
PHL_AIRSPEED	Airspeed International.
PHL_JAMEXPRESS	Jam Express Philippines.
PICKRR	Pickrr.
PICKUP	Pickupp.
PICKUPP_MYS	PICK UPP.
PICKUPP_SGP	PICK UPP (Singapore).
PILOT_FREIGHT	Pilot Freight Services.
PIL_LOGISTICS	PIL Logistics (China) Co..
PITNEY_BOWES	Pitney Bowes.
PITTOHIO	PITT OHIO.
PIXSELL	PIXSELL LOGISTICS.
PLANZER	Planzer Group.
PLUS_LOG_UK	Plus UK Logistics.
PL_POCZTA_POLSKA	Poczta Polska (www.poczta-polska.pl).
POL_SIODEMKA	Siodemka.
PONY_EXPRESS	Pony express.
POSTA_PLUS	Posta Plus.
POSTA_RO	Post Roman (www.posta-romana.ro).
POSTA_UKR	UkrPoshta.
POSTEN_NORGE	Posten Norge (www.posten.no).
POSTI	Posti courier.
POSTNL_INTL_3S	PostNL International 3S.
POSTNL_INT_3_S	PostNL International.
POSTNORD_LOGISTICS	PostNord Logistics.
POSTNORD_LOGISTICS_DK	ostnord denmark.
POSTUR_IS	Iceland Post.
POST_SERBIA	Posta Serbia.
POST_SLOVENIA	Post of Slovenia.
PRESIDENT_TRANS	PRESIDENT TRANSNET CORP.
PRESSIODE	Pressio.
PRIMAMULTICIPTA	PT Prima Multi Cipta.
PROMEDDELIVERY	ProMed Delivery.
PRT_CHRONOPOST	Chronopost Portugal.
PRT_CTT	CTT Portugal.
PRT_INT_SEUR	SEUR International.
PRT_SEUR	SEUR portugal.
PTS	PTS courier.
PTT_POST	PTT Post.
QUANTIUM	Quantium.
QWINTRY	Qwintry Logistics.
RABEN_GROUP	Raben Group.
RAF_PH	RAF Philippines.
RAIDEREX	RaidereX.
RAM	RAM courier.
RCL	Red Carpet Logistics.
RINCOS	Rincos.
RL_US	RL Carriers.
ROADBULL	Red Carpet Logistics.
ROADRUNNER_FREIGHT	Roadbull Logistics.
ROCKET_PARCEL	Rocket Parcel International.
ROUTIFIC_WEBHOOK	Routific.
ROYAL_MAIL	RoyalShipments.
RPD2MAN	RPD2man Deliveries.
RPX	RPX Online.
RPXLOGISTICS	RPX Logistics.
RPX_ID	RPX Indonesia.
RUSSIAN_POST	Russian post.
RUSTON	Ruston.
RZYEXPRESS	RZY Express.
SAIA_FREIGHT	Saia LTL Freight.
SAILPOST	SAILPOST.
SAP_EXPRESS	SAP EXPRESS.
SAU_SAUDI_POST	Saudi Post.
SCUDEX_EXPRESS	Scudex Express.
SDA_IT	SDA Italy.
SDH_SCM	lightning monkey
SEFL	Southeastern Freight Lines.
SEINO	Seino.
SEKOLOGISTICS	SEKO Logistics.
SEKO_SFTP	SEKO Worldwide.
SENDING	Sending Transporte Urgente y Comunicacion.
SENDIT	Sendit.
SENDLE	Sendle.
SEUR_ES	Seur Spain.
SEUR_SP_API	Spanish Seur API.
SFB2C	SF International.
SFCSERVICE	SFC Service.
SFC_LOGISTICS	SFC.
SFPLUS_WEBHOOK	Zeek courier.
SF_EX	SF Express.
SG_DETRACK	Detrack.
SG_QXPRESS	Qxpress.
SG_SG_POST	Singapore Post.
SG_SPEEDPOST	Singapore Speedpost.
SG_TAQBIN	Taqbin Singapore.
SHENZHEN	shenzhen 1st International Logistics(Group)Co.
SHIPENTEGRA	ShipEntegra.
SHIPPIT	Shippit.
SHIPTER	SHIPTER.
SHIPTOR	Shiptor.
SHIP_GATE	ShipGate.
SHIP_IT_ASIA	Ship It Asia.
SHOPFANS	ShopfansRU LLC.
SHREENANDANCOURIER	SHREE NANDAN COURIER.
SHREETIRUPATI	SHREE TIRUPATI COURIER SERVICES PVT. LTD..
SHREE_ANJANI_COURIER	Shree Anjani Courier.
SHREE_MARUTI	Shree Maruti Courier Services Pvt Ltd.
SIMPLYPOST	J&T Express Singapore.
SINOTRANS	Sinotrans.
SIN_GLBL	Sin Global Express.
SKYBOX	SKYBOX.
SKYNET_UAE	SKYNET UAE.
SKYNET_UK	Skynet UK.
SKYNET_WORLDWIDE	SkyNet Worldwide Express.
SKYNET_ZA	Skynet World Wide Express South Africa.
SKY_POSTAL	SkyPostal.
SK_POSTA	Slovenska pošta.
SMG_EXPRESS	SMG Direct.
SMOOTH	Smooth Couriers.
SMSA_EXPRESS	SMSA Express.
SONICTL	Sonic Transportation & Logistics.
SOUTH_AFRICAN_POST_OFFICE	South African Post Office.
SPEEDCOURIERS_GR	Speed Couriers.
SPEEDEE	Spee-Dee Delivery.
SPEEDEXCOURIER	SPEEDEX couriers.
SPOTON	SPOTON Logistics Pvt Ltd.
SPRING_GDS	Spring GDS.
SRE_KOREA	SRE Korea (www.srekorea.co.kr).
STALLIONEXPRESS	Stallion Express.
STARKEN	STARKEN couriers.
STAR_TRACK_EXPRESS	Star Track Express.
STAR_TRACK_NEXT_FLIGHT	Star Track Next Flight.
STEPFORWARDFS	STEP FORWARD FREIGHT SERVICE CO LTD.
STONE3PL	STONE3PL.
STRECK_TRANSPORT	Streck Transport.
SUTTON	Sutton Transport.
SWE_POSTNORD	Postnord sweden.
SWISHIP_DE	Swiship DE.
SWISS_POST_FTP	Swiss Post FTP.
SYPOST	Sunyou Post.
SZENDEX	SZENDEX.
TAQBIN_HK	TAQBIN Hong Kong.
TAQBIN_MY	TAQBIN Malaysia.
TARRIVE	TONDA GLOBAL.
TAZMANIAN_FREIGHT	Tazmanian Freight Systems.
TCK_EXPRESS	TCK Express.
TCS	TCS courier.
TFM	TFM Xpress.
TFORCE_FINALMILE	TForce Final Mile.
THABIT_LOGISTICS	Thabit Logistics.
THA_DYNAMIC_LOGISTICS	Dynamic Logistics.
THA_KERRY	Kerry Express Thailand.
THA_THAILAND_POST	Thailand Post (www.thailandpost.co.th).
THECOURIERGUY	The Courier Guy.
THEDELIVERYGROUP	TDG – The Delivery Group.
THENILE_WEBHOOK	SortHub courier.
TIGFREIGHT	TIG Freight.
TIKI_ID	Tiki shipment.
TIPSA	TIPSA courier.
TNT	TNT Express.
TNT_CLICK_IT	TNT-Click Italy.
TNT_FR	TNT France.
TNT_NL	THT Netherland.
TNT_REFR	TNT Reference.
TNT_UK	TNT UK Limited (www.tnt.com).
TNT_UK_REFR	TNT UK Reference.
TOLL	Toll IPEC.
TOLL_NZ	Toll New Zealand.
TOLOS	Tolos courier.
TOPHATTEREXPRESS	Tophatter Express.
TOPYOU	TopYou.
TOTAL_EXPRESS	Total Express.
TOURLINE	tourline.
TRACKON	Trackon Couriers Pvt. Ltd.
TRANS_KARGO	Trans Kargo Internasional.
TRUMPCARD	TRUMPCARD LLC.
TRUNKRS_WEBHOOK	Trunkrs courier.
TUFFNELLS_REFERENCE	Tuffnells Parcels Express- Reference.
TWO_GO	2GO Courier.
TW_TAIWAN_POST	Taiwan Post.
UBI_LOGISTICS	UBI Smart Parcel.
UC_EXPRE	ucexpress.
UDS	United Delivery Service.
UK_COLLECTPLUS	Collect plus.
UK_DPD	DPD UK.
UK_NIGHTLINE	Nightline(www.nightline.ie).
UK_PARCELFORCE	Parcel Force.
UK_UK_MAIL	UK mail (ukmail.com).
UK_XDP	XDP Express.
UK_YODEL	Yodel (www.yodel.co.uk).
UPS	United Parcel Service.
UPS_FREIGHT	UPS Freight.
UPS_MAIL_INNOVATIONS	UPS Mail Innovations.
UPS_REFERENCE	UPS Reference.
USF_REDDAWAY	USF Reddaway.
USHIP	uShip courier.
USPS	United States Postal Service.
US_GLOBEGISTICS	Globegistics US.
US_LASERSHIP	LaserShip.
US_OLD_DOMINION	Old Dominion Freight Line.
US_ONTRAC	OnTrac Logistics.
US_YRC	YRC courier.
VAMOX	VAMOX.
VENIPAK	Venipak.
VIAEUROPE	ViaEurope.
VIA_EXPRESS	Viaxpress.
VIRTRANSPORT	VIR Transport.
VIWO	VIWO IoT.
VNM_VIETNAM_POST	Vietnam Post.
VNM_VIETTELPOST	ViettelPost.
WAHANA_ID	Wahana express (www.wahana.com).
WANBEXPRESS	WanbExpress.
WEASHIP	Weaship.
WEPOST	WePost Sdn Bhd.
WESTBANK_COURIER	West Bank Courier.
WESTGATE_GL	Westgate Global.
WHISTL	Whistl.
WINIT	WinIt.
WISELOADS	Wiseloads.
WISE_EXPRESS	Wise Express.
WIZMO	Wizmo.
WMG	WMG Delivery.
WNDIRECT	wnDirect.
WYNGS	Wyngs.
XDE_WEBHOOK	Ximex Delivery Express.
XDP_UK_REFERENCE	XDP Express Reference.
XL_EXPRESS	XL Express.
XPERT_DELIVERY	Xpert Delivery.
XPOST	Xpost.ph.
XPO_LOGISTICS	XPO logistics.
XPRESSEN_DK	Xpressen courier.
XQ_EXPRESS	XQ Express.
YAKIT	Yakit courier.
YANWEN	Yanwen Logistics.
YDH_EXPRESS	YDH express.
YINGNUO_LOGISTICS	yingnuo logistics.
YODEL_DIR	Yodel Direct.
YODEL_INTNL	Yodel International.
YTO	YTO Express.
YUNEXPRESS	YunExpress.
YURTICI_KARGO	Yurtici Kargo.
YUSEN	Yusen Logistics.
ZAJIL_EXPRESS	Zajil Express Company.
ZA_COURIERIT	Courier IT.
ZA_FASTWAY	fastway New Zealand.
ZA_SPECIALISED_FREIGHT	Specialised Freight.
ZEEK_2_DOOR	Zeek2Door.
ZELERIS	Zeleris.
ZEPTO_EXPRESS	ZeptoExpress.
ZES_EXPRESS	Eshun international Logistic.
ZIINGFINALMILE	Ziing Final Mile Inc.
ZINC	Zinc courier.
ZJS_EXPRESS	ZJS International.
ZTO_EXPRESS	ZTO Express.
ZYLLEM	Zyllem.

"2EBOX"

Carrier Detail

Detail about the carrier.

id	string [ 1 .. 64 ] characters ^.*$ Unique identifier for a carrier.
name	string [ 1 .. 150 ] characters ^.*$ Universal name for a carrier.
logo_url	string <uri> [ 1 .. 100 ] characters ^.*$ Logo URL Information.
	object (Contact Info) Carrier contact information.

{"id": "string",
"name": "string",
"logo_url": "http://example.com",
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
}

Contact Info

Contact detail about the carrier.

	Array of objects (Phone) [ 1 .. 10 ] items An contact numbers of the carrier.
website_url	string <uri> [ 1 .. 150 ] characters ^.*$ URL of the specified carrier.

{"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}

country_code

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}|C2)$

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

"st"

date_no_time

string <ppaas_date_notime_v2> (date_no_time) = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

"stringstri"

date_time

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.

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

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.

"stringstringstringst"

date_time

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.

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

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.

"stringstringstringst"

Error

The error details.

name required	string The human-readable, unique name of the error.
message required	string The message that describes the error.
debug_id required	string The PayPal internal ID. Used for correlation purposes.
information_link	string The information link, or URI, that shows detailed information about this error for the developer.
	Array of objects (Error Details) An array of additional details about the error.
	Array of objects (Link Description) An array of request-related HATEOAS links.

{"name": "string",
"message": "string",
"debug_id": "string",
"information_link": "string",
"details": [{"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}

Error Details

The error details. Required for client-side 4XX errors.

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.
value	string The value of the field that caused the error.
location	string Default: "body" The location of the field that caused the error. Value is `body`, `path`, or `query`.
issue required	string 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.
	Array of objects (Link Description) [ 1 .. 4 ] items An array of request-related HATEOAS links that are either relevant to the issue by providing additional information or offering potential resolutions.

{"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}

Estimated Delivery date

The estimated Delivery date of shipment.

estimated_delivery_date

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date when the shipment is expected to be delivered in the local time zone Following is possible format:

YYYY-MM-DD
YYYY-MM-DDTHH:mm:ss
YYYY-MM-DDTHH:mm:ssZ

estimated_delivery_time

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date when the shipment is expected to be delivered in the local time zone Following is possible format:

YYYY-MM-DD
YYYY-MM-DDTHH:mm:ss
YYYY-MM-DDTHH:mm:ssZ

provider_type

string (Provider Type) [ 2 .. 20 ] characters ^[A-Z_]+$

The type of entity that provided the estimated delivery date. It could be an aggregator or carrier .

Enum Value	Description
CARRIER	Provider Type Carrier.
AGGREGATOR	Provider Type Aggregator.

{"estimated_delivery_date": "string",
"estimated_delivery_time": "string",
"provider_type": "CARRIER"
}

Intent Type

The type of intent.

string (Intent Type) [ 2 .. 40 ] characters ^[A-Z_]+$

The type of intent.

Enum Value	Description
CONSUMER_SHIPMENT_TRACKING	Consumer tracking the shipment of goods.
RISK_EVALUATION	Tracking the shipment of goods by Risk Domains to evaluate the risk

"CONSUMER_SHIPMENT_TRACKING"

Link Description

A request-related HATEOAS link.

href required	string 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. The `href` is the key HATEOAS component that links a completed call with a subsequent call.
rel required	string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method	string The HTTP method required to make the related call. Enum: "GET" "POST" "PUT" "DELETE" "HEAD" "CONNECT" "OPTIONS" "PATCH"

{"href": "string",
"rel": "string",
"method": "GET"
}

Link Description

The request-related HATEOAS link information.

href required	string 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. The `href` is the key HATEOAS component that links a completed call with a subsequent call.
rel required	string The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
method	string The HTTP method required to make the related call. Enum: "GET" "POST" "PUT" "DELETE" "HEAD" "CONNECT" "OPTIONS" "PATCH"

{"href": "string",
"rel": "string",
"method": "GET"
}

Patch

The JSON patch object to apply partial updates to resources.

required

string

The operation.

Enum Value Description

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.

The 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 a value 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 a from 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, the from 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 a from 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, the from 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 a value 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 the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:

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`, and `null`)	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.

For more information, see 4.6. test.

path

string

The JSON Pointer to the target document location at which to complete the operation.

value

any (Patch Value)

The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified.

from

string

The JSON Pointer to the target document location from which to move the value. Required for the move operation.

{"op": "add",
"path": "string",
"value": null,
"from": "string"
}

PayPal Account Identifier

The account identifier for a PayPal account.

string <ppaas_payer_id_v3> (PayPal Account Identifier) = 13 characters ^[2-9A-HJ-NP-Z]{13}$

The account identifier for a PayPal account.

"stringstrings"

Phone

The phone number, in its canonical international E.164 numbering plan format.

country_code required	string [ 1 .. 3 ] characters ^[0-9]{1,3}?$ The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_number required	string [ 1 .. 14 ] characters ^[0-9]{1,14}?$ The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_number	string [ 1 .. 15 ] characters ^[0-9]{1,15}?$ The extension number.

{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}

Portable Postal Address (Medium-Grained)

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

address_line_1	string <= 300 characters The first line of the address. For example, number or street. For example, `173 Drury Lane`. Required for data entry and compliance and risk checks. Must contain the full address.
address_line_2	string <= 300 characters The second line of the address. For example, suite or apartment number.
address_line_3	string <= 100 characters The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.
admin_area_4	string <= 100 characters The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is: The postal sorting code for Guernsey and many French territories, such as French Guiana. The fine-grained administrative levels in China.
admin_area_3	string <= 100 characters A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is: Brazil. Suburb, bairro, or neighborhood. India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.
admin_area_2	string <= 120 characters A city, town, or village. Smaller than `admin_area_level_1`.
admin_area_1	string <= 300 characters The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, `CA` and not `California`. Value, by country, is: UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A kanton.
postal_code	string <= 60 characters The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
country_code required	string <ppaas_common_country_code_v2> (country_code) = 2 characters ^([A-Z]{2}\|C2)$ The two-character ISO 3166-1 code that identifies the country or region. Note: The country code for Great Britain is `GB` and not `UK` as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
	object (Address Details) The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields. For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`.

{"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
}

Provider Type

The type of entity that provided the info. It could be an aggregator or carrier.

string (Provider Type) [ 2 .. 20 ] characters ^[A-Z_]+$

The type of entity that provided the info. It could be an aggregator or carrier.

Enum Value	Description
CARRIER	Provider Type Carrier.
AGGREGATOR	Provider Type Aggregator.

"CARRIER"

Scan Details

Information about scan made on the shipment for each of the checkpoints.

description

string [ 1 .. 1000 ] characters ^.*$

Message given when the scan was made.

status

string (Shipment status) [ 7 .. 50 ] characters ^[A-Z_]+$

Status of the shipment when the scan was made.

Enum Value	Description
PENDING	Tracking information is not yet available for the shipment.
INFORMATION_RECEIVED	Carrier has received information about the shipment, but not yet picked up.
READY_FOR_PICKUP	Shipment is ready for pick up by the carrier.
PICKUP_MISSED	Pickup for the shipment was missed by the carrier.
PICKED_UP	Shipment has been picked up by carrier.
MANIFEST	Shipment is prepared to be sent to the destination from the shipping point, a step before transportation.
IN_TRANSIT	Shipment is on its way to its final destination.
EXCEPTION	An exception occured while delivery of the shipment like custom hold, returned to sender etc. This is not a terminal status and can be succeeded by other lifecycle states.
OUT_FOR_DELIVERY	Shipment is out for delivery
ATTEMPT_FAILED	The delivery for the shipment failed. This is not a terminal status and can be succeeded by other lifecycle states.
DELIVERED	Shipment is delivered.
EXPIRED	Shipment goes into expired state after a defined SLA.
UNDEFINED	Shipment state cannot be captured in any of the other states.

object (Portable Postal Address (Medium-Grained))

The address details when the scan was made.

date_time

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date and time at which the scan was made.

{"description": "string",
"status": "PENDING",
"scanned_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"date_time": "string"
}

Shipment Data Provider

Shipment data provider information.

provider_type

string (Shipment Data Provider Type) [ 7 .. 10 ] characters ^[A-Z]+$

Type of the shipment data provider.

Enum Value	Description
CARRIER	Shipment information provided by the variant of carrier.
AGGREGATOR	Shipment information provided by the variant of aggregator.

provider_name

string (Shipment Data Provider Name) [ 4 .. 15 ] characters ^[A-Z_]+$

Name of the shipment data provider.

Enum Value	Description
AFTERSHIP	Shipment information provided by the aftership aggregator.
PITNEY_BOWES	Shipment information provided by the pitney bowes aggregator.
USPS	Shipment information provided by the usps carrier.

{"provider_type": "CARRIER",
"provider_name": "AFTERSHIP"
}

Shipment Data Provider Name

Name of the shipment data provider.

string (Shipment Data Provider Name) [ 4 .. 15 ] characters ^[A-Z_]+$

Name of the shipment data provider.

Enum Value	Description
AFTERSHIP	Shipment information provided by the aftership aggregator.
PITNEY_BOWES	Shipment information provided by the pitney bowes aggregator.
USPS	Shipment information provided by the usps carrier.

"AFTERSHIP"

Shipment Data Provider Type

Type of the shipment data provider.

string (Shipment Data Provider Type) [ 7 .. 10 ] characters ^[A-Z]+$

Type of the shipment data provider.

Enum Value	Description
CARRIER	Shipment information provided by the variant of carrier.
AGGREGATOR	Shipment information provided by the variant of aggregator.

"CARRIER"

Shipment Details

The consolidated details of the shipment.

transaction_id

string [ 1 .. 64 ] characters ^.*$

Unique transaction ID associated with this shipment.

tracking_id

string [ 1 .. 100 ] characters ^.*$

Tracking id for the shipment.

package_name

string [ 1 .. 100 ] characters ^.*$

Package name given to the shipment.

Array of objects (Estimated Delivery date) [ 1 .. 2 ] items

Estimated delivery details of carrier and aggregator. The attributes delivery_date and estimated_delivery_dates are mutually exclusive, so one of them will be available.

Array of objects (Scan Details) [ 1 .. 100 ] items

The scan details for each checkpoint or the hub where the shipment crosses.

carrier_tracking_link

string [ 1 .. 2048 ] characters ^.*$

Tracking link of the shipment provided by the carrier to track the shipment in carrier website.

signed_for_by

string [ 1 .. 250 ] characters ^.*$

Description of the person or proof of delivery while the shipment delivery.

service_code

string [ 1 .. 50 ] characters ^.*$

Service code of the carrier for the shipment.

service_name

string [ 1 .. 50 ] characters ^.*$

Service name of the carrier respective to service code for the shipment.

weight

string [ 1 .. 3 ] characters ^.*$

Weight of the shipment.

weight_units

string [ 1 .. 5 ] characters ^.*$

Weight unit of the shipment.

delivery_location

string [ 1 .. 100 ] characters ^.*$

Delivery location of the shipment.

object (Carrier Detail)

Carrier provided by the requester to track the shipment. It will be corrected if it is wrong. Refer recommended_shipping_carrier for corrected carrier.

object (Carrier Detail)

Recommended carrier if the shipping_carrier provided by the requester is incorrect or not provided.

estimated_delivery_date

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date when the shipment is expected to be delivered.

delivery_date

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date when the shipment got delivered.

ship_date

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date when the shipment was shipped.

shipment_status

string (Shipment status) [ 7 .. 50 ] characters ^[A-Z_]+$

Status of the shipment.

Enum Value	Description
PENDING	Tracking information is not yet available for the shipment.
INFORMATION_RECEIVED	Carrier has received information about the shipment, but not yet picked up.
READY_FOR_PICKUP	Shipment is ready for pick up by the carrier.
PICKUP_MISSED	Pickup for the shipment was missed by the carrier.
PICKED_UP	Shipment has been picked up by carrier.
MANIFEST	Shipment is prepared to be sent to the destination from the shipping point, a step before transportation.
IN_TRANSIT	Shipment is on its way to its final destination.
EXCEPTION	An exception occured while delivery of the shipment like custom hold, returned to sender etc. This is not a terminal status and can be succeeded by other lifecycle states.
OUT_FOR_DELIVERY	Shipment is out for delivery
ATTEMPT_FAILED	The delivery for the shipment failed. This is not a terminal status and can be succeeded by other lifecycle states.
DELIVERED	Shipment is delivered.
EXPIRED	Shipment goes into expired state after a defined SLA.
UNDEFINED	Shipment state cannot be captured in any of the other states.

object (Portable Postal Address (Medium-Grained))

Sender address of the shipment.

object (Portable Postal Address (Medium-Grained))

Destination address of the shipment.

object (Scan Details)

Details of the origin scan or the origin hub where the shipment scanned first.

object (Scan Details)

Details of the destination scan or the destination hub where the scanned last.

reattempt_timestamp

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date of the shipment reattempted to deliver in case of delivery exception.

reattempt_time

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date and time when the shipment is reattempted to deliver in case of delivery exception.

created_date

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date of the shipment created.

updated_date

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

date of the shipment updated.

{"transaction_id": "string",
"tracking_id": "string",
"package_name": "string",
"estimated_delivery_dates": [{"estimated_delivery_date": "string",
"estimated_delivery_time": "string",
"provider_type": "CARRIER"
}
],
"shipment_scan": [{"description": "string",
"status": "PENDING",
"scanned_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"date_time": "string"
}
],
"carrier_tracking_link": "string",
"signed_for_by": "string",
"service_code": "string",
"service_name": "string",
"weight": "str",
"weight_units": "strin",
"delivery_location": "string",
"shipping_carrier": {"id": "string",
"name": "string",
"logo_url": "http://example.com",
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
},
"recommended_shipping_carrier": {"id": "string",
"name": "string",
"logo_url": "http://example.com",
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
},
"estimated_delivery_date": "string",
"delivery_date": "string",
"ship_date": "string",
"shipment_status": "PENDING",
"sender_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"destination_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"origin_scan_detail": {"description": "string",
"status": "PENDING",
"scanned_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"date_time": "string"
},
"destination_scan_detail": {"description": "string",
"status": "PENDING",
"scanned_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"date_time": "string"
},
"reattempt_timestamp": "string",
"reattempt_time": "string",
"created_date": "string",
"updated_date": "string"
}

Shipment status

Status for the shipment.

string (Shipment status) [ 7 .. 50 ] characters ^[A-Z_]+$

Status for the shipment.

Enum Value	Description
PENDING	Tracking information is not yet available for the shipment.
INFORMATION_RECEIVED	Carrier has received information about the shipment, but not yet picked up.
READY_FOR_PICKUP	Shipment is ready for pick up by the carrier.
PICKUP_MISSED	Pickup for the shipment was missed by the carrier.
PICKED_UP	Shipment has been picked up by carrier.
MANIFEST	Shipment is prepared to be sent to the destination from the shipping point, a step before transportation.
IN_TRANSIT	Shipment is on its way to its final destination.
EXCEPTION	An exception occured while delivery of the shipment like custom hold, returned to sender etc. This is not a terminal status and can be succeeded by other lifecycle states.
OUT_FOR_DELIVERY	Shipment is out for delivery
ATTEMPT_FAILED	The delivery for the shipment failed. This is not a terminal status and can be succeeded by other lifecycle states.
DELIVERED	Shipment is delivered.
EXPIRED	Shipment goes into expired state after a defined SLA.
UNDEFINED	Shipment state cannot be captured in any of the other states.

"PENDING"

Shipment Tracking

Shipment info and its status indicating success or failure of the operation.

	object (Shipment Tracking) Shipment tracking Info.
	object (Status) The information about the success or failure of the operation.

{"shipment_tracking": {"transaction_id": "string",
"shipment_id": "string",
"tracking_number": "string",
"carrier": "2EBOX"
},
"status": {"code": "str",
"error": {"name": "string",
"message": "string",
"debug_id": "string",
"information_link": "string",
"details": [{"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
}
}

Shipment Tracking

Tracking details required to track shipment.

transaction_id

string [ 1 .. 50 ] characters ^[a-zA-Z0-9]*$

The PayPal transaction ID.

shipment_id

string [ 1 .. 64 ] characters ^[a-zA-Z0-9-]+$

The identifier of the shipment.

tracking_number

string [ 1 .. 64 ] characters ^.*$

The tracking number for the shipment.

carrier

string (carrier) [ 1 .. 64 ] characters ^.*$

Carrier Name of the shipment.

Enum Value	Description
2EBOX	2ebox courier.
360LION	360 Lion Express.
3JMSLOGISTICS	3JMS Logistics.
4_72	4-72 Entregando
6LS	6ls.com.
A1POST	A1Post.
AAA_COOPER	AAA Cooper.
ABCUSTOM	AB Custom Group.
ABXEXPRESS_MY	ABX Express.
ACOMMMERCE	aCommerce.
ACSWORLDWIDE	ACS Worldwide Express.
ACS_GR	ACS Courier.
ADERONLINE	Ader couriers.
ADICIONAL	Adicional Logistics.
ADSONE	ADSone.
ADUIEPYLE	A Duie Pyle.
AERONET	Aeronet couriers.
AEX	AEX Group.
AFLLOG_FTP	AFL LOGISTICS.
AGILITY	Agility.
AIRMEE_WEBHOOK	Airmee couriers.
AIR_CANADA_GLOBAL	Rivo (Air canada).
ALFATREX	AlfaTrex.
ALLIEDEXPRESS	Allied Express.
ALLJOY	ALLJOY SUPPLY CHAIN.
ALPHAFAST	Alphafast (www.alphafast.com).
ALWAYS_EXPRESS	Always Express.
AMAZON	Amazon Shipping.
AMAZON_FBA_SWISHIP	Swiship UK.
AMAZON_SHIP_MCF	Amazon Shipping + Amazon MCF.
AMSTAN	Amstan Logistics.
AMS_GRP	AMS Group.
ANDREANI	Grupo logistico Andreani.
ANICAM_BOX	ANICAM BOX EXPRESS.
ANJUN	Anjun couriers.
ANSERX	ANSERX courier.
AN_POST	An Post.
AO_COURIER	AO Logistics.
AO_DEUTSCHLAND	AO Deutschland.
APC_OVERNIGHT	APC overnight (apc-overnight.com).
APC_OVERNIGHT_CONNUM	APC Overnight Consignment.
APG	APG eCommerce Solutions.
APRISAEXPRESS	Aprisa Express.
AQUILINE	Aquiline.
ARAMEX	Aramex.
ARAMEX_AU	Aramex Australia (formerly Fastway AU).
ARCO_SPEDIZIONI	Arco Spedizioni SP.
ARE_EMIRATES_POST	Emirates Post.
ARG_OCA	OCA Argentina.
ARK_LOGISTICS	ARK Logistics.
ASE	ASE KARGO.
ASENDIA_HK	Asendia HonKong.
ASENDIA_UK	Asendia UK.
ASENDIA_USA	Asendia USA.
ASIGNA	ASIGNA courier.
AUPOST_CN	AuPost China.
AUSTRIAN_POST_EXPRESS	austrian post.
AUS_STARTRACK	StarTrack (startrack.com.au).
AUS_TOLL	TOLL Australia.
AU_AUSTRIAN_POST	Austrian Post (Registered).
AU_AU_POST	Australia Post.
AU_TNT	TNT Australia.
AVERITT	Averitt Express.
BEL_DHL	DHL Benelux.
BEL_RS	BEL North Russia.
BESTWAYPARCEL	Best Way Parcel.
BE_BPOST	Bpost (www.bpost.be).
BE_KIALA	Kiala.
BG_BULGARIAN_POST	Bulgarian Posts.
BH_POSTA	BH Posta (www.posta.ba).
BH_WORLDWIDE	B&H Worldwide.
BIRDSYSTEM	BirdSystem.
BJSHOMEDELIVERY	BJS Distribution courier.
BLINKLASTMILE	Blink.
BLR_BELPOST	Belpost.
BLUECARE	Bluecare Express Ltd.
BLUESTAR	Blue Star.
BLUEX	Blue Express.
BNEED	Bneed courier.
BOMBINOEXP	Bombino Express Pvt.
BOND	Bond courier.
BONDSCOURIERS	Bonds Courier Service (bondscouriers.com.au).
BORDEREXPRESS	Border Express.
BOX_BERRY	Boxberry courier.
BPOST_INT	Bpost international.
BRA_CORREIOS	Correios Brazil.
BRING	Bring.
BROUWER_TRANSPORT	Brouwer Transport en Logistiek.
BRT_IT	BRT couriers Italy (www.brt.it).
BRT_IT_PARCELID	BRT Bartolini(Parcel ID).
BRT_IT_SENDER_REF	BRT Bartolini(Sender Reference).
BUDBEE_WEBHOOK	Budbee courier.
BUYLOGIC	buylogic.
B_TWO_C_EUROPE	B2C courier Europe.
CAE_DELIVERS	CAE Delivers.
CAINIAO	AliExpress Standard Shipping.
CARIBOU	Caribou.
CARRIERS	Carriers courier.
CARRY_FLAP	Carry-Flap Co..
CA_CANADA_POST	Canada Post.
CA_CANPAR	Canpar Courier.
CA_GREYHOUND	Greyhound.
CA_PUROLATOR	Purolator.
CBL_LOGISTICA	CBL Logistica.
CDEK	CDEK courier.
CDEK_TR	CDEK TR.
CELERITAS	Celeritas Transporte.
CELLO_SQUARE	Cello Square.
CESKA_CZ	Czech Post.
CEVA	CEVA LOGISTICS.
CFL_LOGISTICS	CFL Logistics.
CGS_EXPRESS	CGS Express.
CHAMPION_LOGISTICS	Champion Logistics.
CHITCHATS	Chit Chats.
CHOIR_EXP	Choir Express Indonesia.
CHROBINSON	C.H. Robinson Worldwide.
CHRONOPOST_FR	Chronopost france (www.chronopost.fr).
CHUKOU1	Chukou1.
CH_SWISS_POST_PRIORITY	Swiss Post.
CITYLINK_MY	City-Link Express.
CJPACKET	CJ Packet.
CJ_CENTURY	CJ Century.
CJ_GLS	CJ GLS.
CJ_HK_INTERNATIONAL	CJ Logistics International(Hong Kong).
CJ_INT_MY	CJ International malaysia.
CJ_KR	CJ Korea Express.
CJ_LOGISTICS	CJ Logistics International.
CJ_TH	CJ Transnational Philippines.
CLEVY_LINKS	Clevy Links.
CLE_LOGISTICS	CL E-Logistics Solutions Limited.
CLOUDWISH_ASIA	Cloudwish Asia.
CNDEXPRESS	CND Express.
CNEXPS	CNE Express.
CNWANGTONG	cnwangtong.
CN_17POST	17 Post Service.
CN_BESTEXPRESS	Best Express.
CN_BOXC	BoxC courier.
CN_CHINA_POST_EMS	China Post.
CN_DPEX	DPEX.
CN_EMS	EMS China (www.ems.post).
CN_EQUICK	Equick China.
CN_JCEX	JCEX courier.
CN_PAYPAL_PACKAGE	PayPal Package.
CN_POST56	Post56.
CN_SF_EXPRESS	SF Express (www.sf-express.com).
CN_STO	STO Express.
CN_WEDO	WeDo Logistics.
CN_WISHPOST	WishPost.
CN_YUNDA	Yunda Express.
COLIS_PRIVE	Colis Privé.
COLLECTCO	CollectCo.
COLLIVERY	MDS Collivery Pty (Ltd).
COMET_TECH	CometTech.
CONTINENTAL	Continental.
CON_WAY	Con-way Freight.
COORDINADORA	Coordinadora.
COPA_COURIER	Copa Airlines Courier.
COPE	Cope Sensitive Freight.
CORPORATECOURIERS_WEBHOOK	Corporate Couriers.
CORREOS_DE_MEXICO	correos mexico.
CORREOS_ES	correos Express (www.correos.es).
CORREOS_EXPRESS	Correos Express.
CORREO_UY	Correo Uruguayo.
COSTMETICSNOW	Cosmetics Now.
COURANT_PLUS	Courant Plus.
COUREX	Urbanfox.
COURIERS_PLEASE	CouriersPlease (couriersplease.com.au).
CPACKET	Cpacket couriers.
CPEX	Captain Express International.
CROSHOT	Croshot.
CSE	CSE courier.
CTC_EXPRESS	CTC Express.
CUBYN	Cubyn.
CUCKOOEXPRESS	Cuckoo Express.
CYPRUS_POST_CYP	cyprus post.
DAIGLOBALTRACK	DAI Post.
DAJIN	Shanghai Aqrum Chemical Logistics Co.Ltd.
DANSKE_FRAGT	Danske Fragtaend.
DAWN_WING	Dawn Wing.
DAYTON_FREIGHT	Dayton Freight.
DBSCHENKER_B2B	DB Schenker B2B.
DBSCHENKER_SE	DB Schenker (www.dbschenker.com).
DBSCHENKER_SV	DB Schenker Sweden.
DDEXPRESS	DD Express Courier.
DEALERSEND	DealerSend.
DELIVERYONTIME	DELIVERYONTIME LOGISTICS PVT LTD.
DELNEXT	Delnext.
DELTEC_UK	Deltec Courier.
DEMANDSHIP	DemandShip.
DESCARTES	Innovel courier.
DESIGNERTRANSPORT_WEBHOOK	Designer Transport.
DESTINY	Destiny Transportation.
DEX_I	DEX-I courier.
DE_ASENDIA	Asendia Germany.
DE_DEUTSCHE	Deutsche post.
DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET	Deutsche Post DHL.
DE_DHL_EXPRESS	DHL Express.
DE_DPD_DELISTRACK	DPD Germany.
DE_GLS	GLS parcel services (www.gls-group.eu).
DHL	dhl Global.
DHL_ACTIVE_TRACING	DHL Active Tracing.
DHL_AU	DHL Supply Chain Australia.
DHL_BENELUX	dhl benelux.
DHL_ECOMERCE_ASA	DHL eCommerce Asia (API).
DHL_ES	DHL Spain(www.dhl.com).
DHL_FR	DHL France (www.dhl.com).
DHL_FREIGHT	DHL Freight.
DHL_GLOBAL_MAIL_ASIA	DHL Global Mail Asia (www.dhl.com).
DHL_HK	DHL HonKong.
DHL_JP	DHL Japan.
DHL_PARCEL_ES	DHL parcel Spain(www.dhl.com).
DHL_PARCEL_NL	DHL Parcel NL.
DHL_PARCEL_RU	DHL Parcel Russia.
DHL_PL	DHL Poland.
DHL_REFR	DHl (Reference number).
DHL_SG	dhl Singapore.
DHL_SUPPLY_CHAIN	DHL Supply Chain APAC.
DHL_UK	dhl UK.
DIAMOND_EUROGISTICS	Diamond Eurogistics Limited.
DICOM	GLS Logistic Systems Canada Ltd./Dicom.
DIDADI	DIDADI Logistics tech.
DIMERCO	Dimerco Express Group.
DIRECTCOURIERS	Direct Couriers.
DIRECTLOG	Directlog (www.directlog.com.br).
DIRECTPARCELS	Direct Parcels.
DMM_NETWORK	DMM Network.
DMS_MATRIX	DMSMatrix.
DOBROPOST	DobroPost.
DOORA	Doora Logistics.
DOORDASH_WEBHOOK	DoorDash.
DPD	DPD.
DPD_DELISTRACK	DPD delistrack.
DPD_FR	DPD France.
DPD_HGRY	DPD Hungary.
DPD_HK	DPD HongKong.
DPD_IR	DPD Ireland.
DPD_LOCAL	DPD Local.
DPD_LOCAL_REF	DPD Local reference.
DPD_POLAND	DPD Poland.
DPD_RO	DPD Romania.
DPD_RU	DPD Russia.
DPEX	DPEX (www.dpex.com).
DPE_EXPRESS	DPE Express.
DPE_SOUTH_AFRC	DPE South Africa.
DSV	DSV courier.
DTDC_AU	DTDC Australia.
DTDC_EXPRESS	DTDC express.
DTDC_IN	DTDC India.
DTD_EXPR	DTD Express.
DX_SFTP	DX (SFTP).
DYLT	Daylight Transport.
DYNALOGIC	Dynamic Logistics.
EASY_MAIL	Easy Mail.
ECEXPRESS	ECexpress.
ECHO	Echo courier.
ECMS	ECMS International Logistics Co..
ECOSCOOTING	ECOSCOOTING.
EFEX	eFEx (E-Commerce Fulfillment & Express).
EFS	EFS (E-commerce Fulfillment Service).
EKART	Ekart logistics (ekartlogistics.com).
ELIAN_POST	Yilian (Elian) Supply Chain.
EMPS_CN	EMPS Express.
ENDEAVOUR_DELIVERY	Endeavour Delivery.
ENVIALIA_REFERENCE	Envialia Reference.
EPARCEL_KR	eParcel Korea.
EPST_GLBL	ePost Global
EP_BOX	EP-Box courier.
ESHIPPING	Eshipping.
ESP_ASM	ASM(GLS Spain).
ESP_ENVIALIA	Envialia.
ESP_MRW	MRW spain.
ESP_NACEX	NACEX Spain.
ESP_PACKLINK	Packlink.
ESP_REDUR	Redur Spain.
ETOMARS	Etomars.
ETOTAL	eTotal Solution Limited.
ETS_EXPRESS	RETS express.
EU_FLEET_SOLUTIONS	EU Fleet Solutions.
EU_IMX	IMX Mail.
EXPRESSSALE	Expresssale.
FARGOOD	FarGood.
FAR_INTERNATIONAL	FAR international.
FASTRACK	Fasttrack.
FASTRK_SERV	Fastrak Services.
FASTWAY_IR	Fastway Ireland.
FASTWAY_NZ	Fastway New Zealand.
FDSEXPRESS	FDSEXPRESS.
FEDEX	Fedex.
FEDEX_CROSSBORDER	FedEx Cross Border.
FEDEX_FR	FedEx® Freight.
FEDEX_INTL_MLSERV	FedEx International MailService.
FEDEX_POLAND	FedEx® Poland Domestic.
FEDEX_UK	FedEx® UK.
FETCHR_WEBHOOK	Mena 360 (Fetchr).
FIEGE	Fiege Logistics.
FIEGE_NL	Fiege Netherlands.
FIRSTMILE	FirstMile.
FLASHEXPRESS	Flash Express.
FMX	FMX.
FONSEN	Fonsen Logistics.
FORRUN	forrun Pvt Ltd (Arpatech Venture).
FREIGHTQUOTE	Freightquote by C.H. Robinson.
FRETERAPIDO	Frete Rapido.
FR_BERT	Bert Transport.
FR_COLIS	Colissimo.
FR_EXAPAQ	DPD France (formerly exapaq).
FR_GEODIS	GEODIS - Distribution & Express.
FR_GLS	GLS france.
FULFILLA	Fulfilla.
FULFILLME	Fulfillme.
FURDECO	Furdeco.
GAC	GAC.
GANGBAO	GANGBAO Supplychain.
GBA	GBA Services Ltd.
GBS_BROKER	GBS-Broker.
GB_APC	APC postal logistics germany.
GB_ARROW	Arrow XL.
GB_NORSK	Norsk Global.
GB_PANTHER	Panther.
GB_TUFFNELLS	Tuffnells Parcels Express.
GEIS	Geis CZ.
GEL_EXPRESS	Gel Express Logistik.
GEMWORLDWIDE	GEM Worldwide.
GENERAL_OVERNIGHT	Go!Express and logistics.
GENIKI_GR	Geniki Taxydromiki.
GEODIS_ESPACE	Geodis E-space.
GESWL	GESWL Express.
GIAO_HANG	Giao hàng nhanh.
GIO_EXPRESS	Gio Express.
GLOBALTRANZ	GlobalTranz.
GLOBAL_ABF	ABF Freight.
GLOBAL_ESTES	Estes Express Lines.
GLOBAL_EXPRESS	Tai Wan Global Business.
GLOBAL_IPARCEL	i-parcel.
GLOBAL_TNT	TNT global.
GLOBAVEND	Globavend.
GLS_CROTIA	GLS Croatia.
GLS_CZ	GLS Czech Republic.
GLS_IT	GLS Italy.
GLS_ITALY	GLS Italy.
GLS_SLOV	GLS General Logistics Systems Slovakia s.r.o..
GLS_SLOVEN	GLS Slovenia.
GOGLOBALPOST	Global Post.
GOJEK	Gojek.
GRAB_WEBHOOK	Grab courier.
GRUPO	Grupo ampm.
GR_ELTA	ELTA Hellenic Post.
GSI_EXPRESS	GSI EXPRESS.
GSO	GSO(GLS-USA).
HAPPY2POINT	Happy 2ThePoint
HCT_LOGISTICS	HCT LOGISTICS CO.LTD..
HDB	Haidaibao.
HDB_BOX	Haidaibao (BOX).
HELLMANN	Hellmann Worldwide Logistics.
HELTHJEM	Helthjem.
HEPPNER	Heppner Internationale Spedition GmbH & Co..
HEPPNER_FR	Heppner France.
HERMES	HermesWorld UK.
HERMES_2MANN_HANDLING	Hermes Einrichtungs Service GmbH & Co. KG.
HERMES_DE	Hermes Germany.
HH_EXP	Hua Han Logistics.
HIPSHIPPER	Hipshipper.
HKD	Qingdao HKD International Logistics.
HK_FLYT_EXPRESS	FLYT express.
HK_FOUR_PX_EXPRESS	4PX (fourPX).
HK_POST	Hongkong Post (www.hongkongpost.hk).
HK_TGX	Kerry Express Hong Kong.
HOLISOL	Holisol.
HOME_DELIVERY_SOLUTIONS	Home Delivery Solutions Ltd.
HOUNDEXPRESS	Hound Express.
HRPARCEL	HR Parcel.
HRV_HRVATSKA	Hrvatska posta.
HUAHAN_EXPRESS	HUAHANG EXPRESS.
HUNTER_EXPRESS	Hunter Express.
HUODULL	Huodull.
HX_EXPRESS	HX Express.
IBEONE	Beone Logistics.
ICUMULUS	iCumulus.
IDEXPRESS	IDEX courier.
IDN_JNE	JNE Express (Jalur Nugraha Ekakurir).
IDN_LION_PARCEL	Lion Parcel.
IDN_PANDU	pandu Logistics (pandulogistics.com).
IML	IML courier.
INDOPAKET	INDOPAKET.
IND_BLUEDART	Bluedart.
IND_DELHIVERY	Delhivery India.
IND_DELIVREE	deliverE.
IND_DOTZOT	Dotzot.
IND_ECOM	Ecom Express.
IND_FIRSTFLIGHT	First Flight Couriers.
IND_GATI	Gati-KWE.
IND_GOJAVAS	GoJavas.
IND_PROFESSIONAL_COURIERS	Professional Couriers.
IND_SAFEEXPRESS	Safexpress.
IND_XPRESSBEES	Xpressbees (www.xpressbees.com).
INPOST_PACZKOMATY	InPost Paczkomaty.
INTEGRA2_FTP	Integra2.
INTELIPOST	Intelipost (TMS for LATAM).
INTEL_VALLEY	Intel-Valley Supply chain (ShenZhen) Co. Ltd.
INTERPARCEL_AU	Interparcel Australia.
INTERPARCEL_NZ	Interparcel New Zealand.
INTERPARCEL_UK	Interparcel UK.
INTEXPRESS	Internet Express.
ISRAEL_POST	Israel Post.
ISR_POST_DOMESTIC	Israel Post Domestic.
IT_DHL_ECOMMERCE	DHL International.
IT_FERCAM	FERCAM Logistics & Transport.
IT_NEXIVE	Nexive (TNT Post Italy).
IT_POSTE_ITALIA	Poste italiane (www.poste.it).
IT_TNT	TNT Italy.
IVOY_WEBHOOK	Ivoy courier.
I_DIKA	i-dika.
JANCO	Janco Ecommerce.
JANIO	Janio Asia.
JERSEY_POST	Jersey Post.
JET_SHIP	Jet-Ship Worldwide.
JINDOUYUN	jindouyun courier.
JINSUNG	JINSUNG TRADING.
JOCOM	Jocom.
JOOM_LOGIS	Joom Logistics.
JOYING_BOX	Joying Box.
JPN_JAPAN_POST	Japan Post.
JPN_SAGAWA	Sagawa Express Japan.
JP_KURO_NEKO_YAMATO_UNYUU	Yamato transport (www.kuronekoyamato.co.jp).
JS_EXPRESS	JS EXPRESS.
JTEXPRESS	J&T EXPRESS MALAYSIA.
JTEXPRESS_VN	J&T Express Vietnam.
JX	JX courier.
J_NET	J-Net.
K1_EXPRESS	K1 Express.
KANGAROO_MY	Kangaroo Worldwide Express.
KEC	KEC courier.
KERRYTJ	Kerry TJ Logistics.
KERRYTTC_VN	Kerry Express (Vietnam) Co Ltd.
KERRY_ECOMMERCE	Kerry eCommerce.
KGMHUB	KGM Hub.
KHM_CAMBODIA_POST	Cambodia Post.
KOR_ECARGO	Ecargo.
KPOST	Korea Post.
KR_KOREA_POST	Koreapost (www.koreapost.go.kr).
KUEHNE	Kuehne + Nagel.
KURASI	KURASI.
KWE_GLOBAL	KWE Global.
KWT	Shenzhen Jinghuada Logistics Co..
KYUNGDONG_PARCEL	Kyungdong Parcel.
KY_EXPRESS	Kua Yue Express.
LALAMOVE	Lalamove.
LANDMARK_GLOBAL	Landmark Global.
LANDMARK_GLOBAL_REFERENCE	Landmark Global Reference.
LATVIJAS_PASTS	Latvijas Pasts.
LA_POSTE_SUIVI	La Poste.
LBCEXPRESS_FTP	LBC EXPRESS INC..
LEADER	leader.
LEGION_EXPRESS	Legion Express.
LEXSHIP	LexShip.
LHT_EXPRESS	LHT Express.
LICCARDI_EXPRESS	LICCARDI EXPRESS COURIER.
LIEFERY	liefery.
LINE	Line Clear Express & Logistics Sdn Bhd.
LINKBRIDGE	Link Bridge(BeiJing)international logistics co..
LOCUS_WEBHOOK	Locus courier.
LOGISTERS	Logisters.
LOGISTICSWORLDWIDE_HK	Logistic Worldwide Express (LWE Honkong).
LOGISTIKA	Logistika.
LOGISTYX_TRANSGROUP	Transgroup courier.
LONESTAR	Lone Star Overnight.
LOOMIS_EXPRESS	Loomis Express.
LOTTE	Lotte Global Logistics.
LTIANEXP	LTIAN EXP.
LTL	LTL COURIER.
LTU_LIETUVOS	Lietuvos pastas.
MAGYAR_HU	Magyar Post.
MAILAMERICAS	MailAmericas.
MAILPLUS_JPN	MailPlus (Japan).
MAIL_PLUS	MailPlus.
MAINFREIGHT	Mainfreight.
MAINWAY	Mainway.
MATDESPATCH	Matdespatch.
MATKAHUOLTO	Matkahuolto.
MBW	MBW Courier Inc..
MEX_AEROFLASH	Aeroflash Mexico.
MEX_ESTAFETA	Estafeta (www.estafeta.com).
MEX_REDPACK	Redpack.
MEX_SENDA	mexico senda express.
MGLOBAL	PT MGLOBAL LOGISTICS INDONESIA.
MIKROPAKKET	Mikropakket.
MIKROPAKKET_BE	Mikropakket Belgium.
MILKMAN	Milkman courier.
MORE_LINK	Morelink.
MORNING_EXPRESS	Morning Express.
MRW_FTP	MRW courier.
MXE	MXE Express.
MX_CARGO	M&X cargo.
MYHERMES	MyHermes UK.
MYS_AIRPAK	Airpak Express.
MYS_EMS	Malaysia Post EMS / Pos Laju.
MYS_GDEX	GDEX courier.
MYS_MYPOST_ONLINE	Mypostonline.
MYS_MYS_POST	Malaysia Post.
MYS_SKYNET	Skynet Malaysia.
M_XPRESS	M Xpress Sdn Bhd.
NACEX	NACEX.
NACEX_ES	NACEX Spain.
NANJINGWOYUAN	Nanjing Woyuan.
NATIONAL_SAMEDAY	National Sameday.
NATIONEX	Nationex courier.
NATIONWIDE_MY	Nationwide Express Courier Services Bhd (www.nationwide.com.my).
NEWAY	Neway Transport.
NEWEGGEXPRESS	Newegg Express.
NEWGISTICS	Newgistics.
NEWZEALAND_COURIERS	NEW ZEALAND COURIERS.
NG_COURIERPLUS	Courier Plus.
NHANS_SOLUTIONS	Nhans Solutions.
NIM_EXPRESS	Nim Express.
NINJAVAN_MY	ninja van (www.ninjavan.co).
NINJAVAN_SG	Ninja van Singapore.
NINJAVAN_THAI	Ninja van Thai.
NINJAVAN_WB	Ninjavan Webhook.
NIPOST_NG	NIpost (www.nipost.gov.ng).
NLD_DHL	DHL Netherland.
NLD_GLS	GLS Netherland.
NLD_POSTNL	PostNL International.
NLD_TRANSMISSION	TransMission.
NOVA_POSHTA	Nova Poshta (novaposhta.ua).
NOVA_POSHTA_INT	Nova Poshta (International).
NOX_NACHTEXPRESS	Innight Express Germany GmbH (nox NachtExpress).
NOX_NIGHT_TIME_EXPRESS	NOX NightTimeExpress.
NTLOGISTICS_VN	Nhat Tin Logistics.
NZ_COURIER_POST	CourierPost Newsland.
NZ_NZ_POST	New Zealand Post.
OCS	OCS ANA Group.
OCS_WORLDWIDE	OCS WORLDWIDE.
OKAYPARCEL	OkayParcel.
OMNIPARCEL	Omni Parcel.
OMNIVA	Omniva.
ONECLICK	One click delivery services.
ONEWORLDEXPRESS	One World Express.
ORANGE_DS	OrangeDS (Orange Distribution Solutions Inc).
OSM_WORLDWIDE	OSM Worldwide.
OVERSE_EXP	Overseas Express.
P2P_TRC	P2P TrakPak.
PAACK_WEBHOOK	Paack courier.
PADTF	padtf.com.
PAGO	Pago Logistics.
PALEXPRESS	PAL Express Limited.
PALLETWAYS	Palletways.
PALLET_NETWORK	The Pallet Network.
PANTHER_REFERENCE	Panther Reference.
PAN_ASIA	Pan-Asia International.
PAPERFLY	Paperfly Private Limited.
PAPER_EXPRESS	Paper Express.
PAQUETEXPRESS	Paquetexpress.
PARCEL2GO	Parcel2Go.
PARCELINKLOGISTICS	Parcelink Logistics.
PARCELLED_IN	Parcelled.in.
PARCELONE	PARCEL ONE.
PARCELPAL_WEBHOOK	ParcelPal.
PARCELPOINT	Parcelpoint.
PARCELPOST_SG	Parcel Post Singapore.
PARCEL_2_POST	Parcel To Post.
PARKNPARCEL	Park N Parcel.
PCFCORP	PCF Final Mile.
PFCEXPRESS	PFC Express.
PFLOGISTICS	PFL.
PHL_AIR21	AIR21 courier.
PHL_AIRSPEED	Airspeed International.
PHL_JAMEXPRESS	Jam Express Philippines.
PICKRR	Pickrr.
PICKUP	Pickupp.
PICKUPP_MYS	PICK UPP.
PICKUPP_SGP	PICK UPP (Singapore).
PILOT_FREIGHT	Pilot Freight Services.
PIL_LOGISTICS	PIL Logistics (China) Co..
PITNEY_BOWES	Pitney Bowes.
PITTOHIO	PITT OHIO.
PIXSELL	PIXSELL LOGISTICS.
PLANZER	Planzer Group.
PLUS_LOG_UK	Plus UK Logistics.
PL_POCZTA_POLSKA	Poczta Polska (www.poczta-polska.pl).
POL_SIODEMKA	Siodemka.
PONY_EXPRESS	Pony express.
POSTA_PLUS	Posta Plus.
POSTA_RO	Post Roman (www.posta-romana.ro).
POSTA_UKR	UkrPoshta.
POSTEN_NORGE	Posten Norge (www.posten.no).
POSTI	Posti courier.
POSTNL_INTL_3S	PostNL International 3S.
POSTNL_INT_3_S	PostNL International.
POSTNORD_LOGISTICS	PostNord Logistics.
POSTNORD_LOGISTICS_DK	ostnord denmark.
POSTUR_IS	Iceland Post.
POST_SERBIA	Posta Serbia.
POST_SLOVENIA	Post of Slovenia.
PRESIDENT_TRANS	PRESIDENT TRANSNET CORP.
PRESSIODE	Pressio.
PRIMAMULTICIPTA	PT Prima Multi Cipta.
PROMEDDELIVERY	ProMed Delivery.
PRT_CHRONOPOST	Chronopost Portugal.
PRT_CTT	CTT Portugal.
PRT_INT_SEUR	SEUR International.
PRT_SEUR	SEUR portugal.
PTS	PTS courier.
PTT_POST	PTT Post.
QUANTIUM	Quantium.
QWINTRY	Qwintry Logistics.
RABEN_GROUP	Raben Group.
RAF_PH	RAF Philippines.
RAIDEREX	RaidereX.
RAM	RAM courier.
RCL	Red Carpet Logistics.
RINCOS	Rincos.
RL_US	RL Carriers.
ROADBULL	Red Carpet Logistics.
ROADRUNNER_FREIGHT	Roadbull Logistics.
ROCKET_PARCEL	Rocket Parcel International.
ROUTIFIC_WEBHOOK	Routific.
ROYAL_MAIL	RoyalShipments.
RPD2MAN	RPD2man Deliveries.
RPX	RPX Online.
RPXLOGISTICS	RPX Logistics.
RPX_ID	RPX Indonesia.
RUSSIAN_POST	Russian post.
RUSTON	Ruston.
RZYEXPRESS	RZY Express.
SAIA_FREIGHT	Saia LTL Freight.
SAILPOST	SAILPOST.
SAP_EXPRESS	SAP EXPRESS.
SAU_SAUDI_POST	Saudi Post.
SCUDEX_EXPRESS	Scudex Express.
SDA_IT	SDA Italy.
SDH_SCM	lightning monkey
SEFL	Southeastern Freight Lines.
SEINO	Seino.
SEKOLOGISTICS	SEKO Logistics.
SEKO_SFTP	SEKO Worldwide.
SENDING	Sending Transporte Urgente y Comunicacion.
SENDIT	Sendit.
SENDLE	Sendle.
SEUR_ES	Seur Spain.
SEUR_SP_API	Spanish Seur API.
SFB2C	SF International.
SFCSERVICE	SFC Service.
SFC_LOGISTICS	SFC.
SFPLUS_WEBHOOK	Zeek courier.
SF_EX	SF Express.
SG_DETRACK	Detrack.
SG_QXPRESS	Qxpress.
SG_SG_POST	Singapore Post.
SG_SPEEDPOST	Singapore Speedpost.
SG_TAQBIN	Taqbin Singapore.
SHENZHEN	shenzhen 1st International Logistics(Group)Co.
SHIPENTEGRA	ShipEntegra.
SHIPPIT	Shippit.
SHIPTER	SHIPTER.
SHIPTOR	Shiptor.
SHIP_GATE	ShipGate.
SHIP_IT_ASIA	Ship It Asia.
SHOPFANS	ShopfansRU LLC.
SHREENANDANCOURIER	SHREE NANDAN COURIER.
SHREETIRUPATI	SHREE TIRUPATI COURIER SERVICES PVT. LTD..
SHREE_ANJANI_COURIER	Shree Anjani Courier.
SHREE_MARUTI	Shree Maruti Courier Services Pvt Ltd.
SIMPLYPOST	J&T Express Singapore.
SINOTRANS	Sinotrans.
SIN_GLBL	Sin Global Express.
SKYBOX	SKYBOX.
SKYNET_UAE	SKYNET UAE.
SKYNET_UK	Skynet UK.
SKYNET_WORLDWIDE	SkyNet Worldwide Express.
SKYNET_ZA	Skynet World Wide Express South Africa.
SKY_POSTAL	SkyPostal.
SK_POSTA	Slovenska pošta.
SMG_EXPRESS	SMG Direct.
SMOOTH	Smooth Couriers.
SMSA_EXPRESS	SMSA Express.
SONICTL	Sonic Transportation & Logistics.
SOUTH_AFRICAN_POST_OFFICE	South African Post Office.
SPEEDCOURIERS_GR	Speed Couriers.
SPEEDEE	Spee-Dee Delivery.
SPEEDEXCOURIER	SPEEDEX couriers.
SPOTON	SPOTON Logistics Pvt Ltd.
SPRING_GDS	Spring GDS.
SRE_KOREA	SRE Korea (www.srekorea.co.kr).
STALLIONEXPRESS	Stallion Express.
STARKEN	STARKEN couriers.
STAR_TRACK_EXPRESS	Star Track Express.
STAR_TRACK_NEXT_FLIGHT	Star Track Next Flight.
STEPFORWARDFS	STEP FORWARD FREIGHT SERVICE CO LTD.
STONE3PL	STONE3PL.
STRECK_TRANSPORT	Streck Transport.
SUTTON	Sutton Transport.
SWE_POSTNORD	Postnord sweden.
SWISHIP_DE	Swiship DE.
SWISS_POST_FTP	Swiss Post FTP.
SYPOST	Sunyou Post.
SZENDEX	SZENDEX.
TAQBIN_HK	TAQBIN Hong Kong.
TAQBIN_MY	TAQBIN Malaysia.
TARRIVE	TONDA GLOBAL.
TAZMANIAN_FREIGHT	Tazmanian Freight Systems.
TCK_EXPRESS	TCK Express.
TCS	TCS courier.
TFM	TFM Xpress.
TFORCE_FINALMILE	TForce Final Mile.
THABIT_LOGISTICS	Thabit Logistics.
THA_DYNAMIC_LOGISTICS	Dynamic Logistics.
THA_KERRY	Kerry Express Thailand.
THA_THAILAND_POST	Thailand Post (www.thailandpost.co.th).
THECOURIERGUY	The Courier Guy.
THEDELIVERYGROUP	TDG – The Delivery Group.
THENILE_WEBHOOK	SortHub courier.
TIGFREIGHT	TIG Freight.
TIKI_ID	Tiki shipment.
TIPSA	TIPSA courier.
TNT	TNT Express.
TNT_CLICK_IT	TNT-Click Italy.
TNT_FR	TNT France.
TNT_NL	THT Netherland.
TNT_REFR	TNT Reference.
TNT_UK	TNT UK Limited (www.tnt.com).
TNT_UK_REFR	TNT UK Reference.
TOLL	Toll IPEC.
TOLL_NZ	Toll New Zealand.
TOLOS	Tolos courier.
TOPHATTEREXPRESS	Tophatter Express.
TOPYOU	TopYou.
TOTAL_EXPRESS	Total Express.
TOURLINE	tourline.
TRACKON	Trackon Couriers Pvt. Ltd.
TRANS_KARGO	Trans Kargo Internasional.
TRUMPCARD	TRUMPCARD LLC.
TRUNKRS_WEBHOOK	Trunkrs courier.
TUFFNELLS_REFERENCE	Tuffnells Parcels Express- Reference.
TWO_GO	2GO Courier.
TW_TAIWAN_POST	Taiwan Post.
UBI_LOGISTICS	UBI Smart Parcel.
UC_EXPRE	ucexpress.
UDS	United Delivery Service.
UK_COLLECTPLUS	Collect plus.
UK_DPD	DPD UK.
UK_NIGHTLINE	Nightline(www.nightline.ie).
UK_PARCELFORCE	Parcel Force.
UK_UK_MAIL	UK mail (ukmail.com).
UK_XDP	XDP Express.
UK_YODEL	Yodel (www.yodel.co.uk).
UPS	United Parcel Service.
UPS_FREIGHT	UPS Freight.
UPS_MAIL_INNOVATIONS	UPS Mail Innovations.
UPS_REFERENCE	UPS Reference.
USF_REDDAWAY	USF Reddaway.
USHIP	uShip courier.
USPS	United States Postal Service.
US_GLOBEGISTICS	Globegistics US.
US_LASERSHIP	LaserShip.
US_OLD_DOMINION	Old Dominion Freight Line.
US_ONTRAC	OnTrac Logistics.
US_YRC	YRC courier.
VAMOX	VAMOX.
VENIPAK	Venipak.
VIAEUROPE	ViaEurope.
VIA_EXPRESS	Viaxpress.
VIRTRANSPORT	VIR Transport.
VIWO	VIWO IoT.
VNM_VIETNAM_POST	Vietnam Post.
VNM_VIETTELPOST	ViettelPost.
WAHANA_ID	Wahana express (www.wahana.com).
WANBEXPRESS	WanbExpress.
WEASHIP	Weaship.
WEPOST	WePost Sdn Bhd.
WESTBANK_COURIER	West Bank Courier.
WESTGATE_GL	Westgate Global.
WHISTL	Whistl.
WINIT	WinIt.
WISELOADS	Wiseloads.
WISE_EXPRESS	Wise Express.
WIZMO	Wizmo.
WMG	WMG Delivery.
WNDIRECT	wnDirect.
WYNGS	Wyngs.
XDE_WEBHOOK	Ximex Delivery Express.
XDP_UK_REFERENCE	XDP Express Reference.
XL_EXPRESS	XL Express.
XPERT_DELIVERY	Xpert Delivery.
XPOST	Xpost.ph.
XPO_LOGISTICS	XPO logistics.
XPRESSEN_DK	Xpressen courier.
XQ_EXPRESS	XQ Express.
YAKIT	Yakit courier.
YANWEN	Yanwen Logistics.
YDH_EXPRESS	YDH express.
YINGNUO_LOGISTICS	yingnuo logistics.
YODEL_DIR	Yodel Direct.
YODEL_INTNL	Yodel International.
YTO	YTO Express.
YUNEXPRESS	YunExpress.
YURTICI_KARGO	Yurtici Kargo.
YUSEN	Yusen Logistics.
ZAJIL_EXPRESS	Zajil Express Company.
ZA_COURIERIT	Courier IT.
ZA_FASTWAY	fastway New Zealand.
ZA_SPECIALISED_FREIGHT	Specialised Freight.
ZEEK_2_DOOR	Zeek2Door.
ZELERIS	Zeleris.
ZEPTO_EXPRESS	ZeptoExpress.
ZES_EXPRESS	Eshun international Logistic.
ZIINGFINALMILE	Ziing Final Mile Inc.
ZINC	Zinc courier.
ZJS_EXPRESS	ZJS International.
ZTO_EXPRESS	ZTO Express.
ZYLLEM	Zyllem.

{"transaction_id": "string",
"shipment_id": "string",
"tracking_number": "string",
"carrier": "2EBOX"
}

shipment_tracker

Real Time Tracking Details of the Shipment.

package_id

string [ 1 .. 64 ] characters ^[a-zA-Z0-9]+$

Tracking number for the shipment.

string [ 1 .. 64 ] characters ^[a-zA-Z0-9]+$

Reference number for the shipment to track.

Array of objects (Estimated Delivery date) [ 1 .. 2 ] items

Estimated delivery details of carrier and aggregator. The attributes delivery_date and estimated_delivery_dates are mutually exclusive, so one of them will be available.

receiver_name

string [ 1 .. 140 ] characters ^[a-zA-Z0-9]+$

Name of the person who received and signed the package at destination.

service_name

string [ 1 .. 140 ] characters ^[a-zA-Z0-9]+$

Mail class as described by the carrier.

carrier_tracking_link

string <uri> [ 1 .. 2048 ] characters

Tracking link for the given shipment as provided by carrier.

Array of objects (Scan Details) [ 1 .. 100 ] items

The scan details for each checkpoint.

fulfilment_duration

string [ 1 .. 3 ] characters ^[0-9]+$

Total duration in days for the package to reach from source to destination.

return_to_sender

string [ 1 .. 5 ] characters ^[A-Z]+$

Indicates whether or not the shipment has been returned to the sender.

Enum Value	Description
TRUE	The shipment is returned/returning back to the sender.
FALSE	The shipment is moving towards the destination.

shipment_id

string [ 1 .. 36 ] characters ^[a-zA-Z0-9-]+$

The identifier of the shipment sent by the clients.

object (Carrier Detail)

Carrier provided by the requester to track the shipment. It will be corrected if it is wrong. Refer recommended_shipping_carrier for corrected carrier.

object (Carrier Detail)

Recommended carrier if the shipping_carrier provided by the requester is incorrect or not provided.

status

string (Shipment status) [ 7 .. 50 ] characters ^[A-Z_]+$

Status of the shipment.

Enum Value	Description
PENDING	Tracking information is not yet available for the shipment.
INFORMATION_RECEIVED	Carrier has received information about the shipment, but not yet picked up.
READY_FOR_PICKUP	Shipment is ready for pick up by the carrier.
PICKUP_MISSED	Pickup for the shipment was missed by the carrier.
PICKED_UP	Shipment has been picked up by carrier.
MANIFEST	Shipment is prepared to be sent to the destination from the shipping point, a step before transportation.
IN_TRANSIT	Shipment is on its way to its final destination.
EXCEPTION	An exception occured while delivery of the shipment like custom hold, returned to sender etc. This is not a terminal status and can be succeeded by other lifecycle states.
OUT_FOR_DELIVERY	Shipment is out for delivery
ATTEMPT_FAILED	The delivery for the shipment failed. This is not a terminal status and can be succeeded by other lifecycle states.
DELIVERED	Shipment is delivered.
EXPIRED	Shipment goes into expired state after a defined SLA.
UNDEFINED	Shipment state cannot be captured in any of the other states.

object (Shipping Package Specification)

Shipping package specification details.

ship_date_time

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

The date at the origin when the package was shipped.

delivery_date_time

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

The shipment delivery date for the package.

reattempt_date

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

The reattempted date for the package.

object (Portable Postal Address (Medium-Grained))

The destination address of the shipment.

object (Portable Postal Address (Medium-Grained))

The sender address for the shipment.

object (Shipment Data Provider)

Shipment data provider details.

created_date

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date at which the shipment is created.

updated_date

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date at which the shipment is last updated.

created_time

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date and Time when the shipment is created.

updated_time

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

Date and Time when the shipment is last updated.

{"package_id": "string",
"id": "string",
"estimated_delivery_dates": [{"estimated_delivery_date": "string",
"estimated_delivery_time": "string",
"provider_type": "CARRIER"
}
],
"receiver_name": "string",
"service_name": "string",
"carrier_tracking_link": "http://example.com",
"scans": [{"description": "string",
"status": "PENDING",
"scanned_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"date_time": "string"
}
],
"fulfilment_duration": "str",
"return_to_sender": "TRUE",
"shipment_id": "string",
"provided_carrier": {"id": "string",
"name": "string",
"logo_url": "http://example.com",
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
},
"recommended_shipping_carrier": {"id": "string",
"name": "string",
"logo_url": "http://example.com",
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
},
"status": "PENDING",
"package_specification": {"weight": "string",
"package_count": "string",
"weight_units": "LBS"
},
"ship_date_time": "stringstringstringst",
"delivery_date_time": "stringstringstringst",
"reattempt_date": "stringstringstringst",
"destination_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"sender_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"provider_details": {"provider_type": "CARRIER",
"provider_name": "AFTERSHIP"
},
"created_date": "string",
"updated_date": "string",
"created_time": "string",
"updated_time": "string"
}

shipment_tracking_request

Tracking details required to track shipment.

shipment_id

string [ 1 .. 64 ] characters ^[a-zA-Z0-9-]+$

The identifier of the shipment.

carrier_code

string [ 1 .. 36 ] characters ^[a-zA-Z0-9_]+$

The carrier code of the shipment.

package_id

string [ 1 .. 64 ] characters ^[a-zA-Z0-9]+$

Tracking number for the shipment.

shipment_reference_id

string [ 1 .. 100 ] characters ^[a-zA-Z0-9]+$

Reference identifier of the shipment which determines the aggregator that the shipment belongs to.

dest_country_code

string = 3 characters ^[a-zA-Z]+$

The destination country of the package.

dest_postal_code

string [ 1 .. 60 ] characters ^.*$

The destination postal code of the package.

dest_state

string [ 1 .. 300 ] characters ^[a-zA-Z0-9]+$

The destination state of the package.

intent

string (Intent Type) [ 2 .. 40 ] characters ^[A-Z_]+$

Intent of the client for requesting shipment tracking details.

Enum Value	Description
CONSUMER_SHIPMENT_TRACKING	Consumer tracking the shipment of goods.
RISK_EVALUATION	Tracking the shipment of goods by Risk Domains to evaluate the risk

{"shipment_id": "string",
"carrier_code": "string",
"package_id": "string",
"shipment_reference_id": "string",
"dest_country_code": "str",
"dest_postal_code": "string",
"dest_state": "string",
"intent": "CONSUMER_SHIPMENT_TRACKING"
}

shipment_trackings_response

Real time tracking information of a shipment.

	object (shipment_tracker) Latest Shipment information.
	object (Error) Details on the failure if the tracking attempt failed.

{"shipment": {"package_id": "string",
"id": "string",
"estimated_delivery_dates": [{"estimated_delivery_date": "string",
"estimated_delivery_time": "string",
"provider_type": "CARRIER"
}
],
"receiver_name": "string",
"service_name": "string",
"carrier_tracking_link": "http://example.com",
"scans": [{"description": "string",
"status": "PENDING",
"scanned_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"date_time": "string"
}
],
"fulfilment_duration": "str",
"return_to_sender": "TRUE",
"shipment_id": "string",
"provided_carrier": {"id": "string",
"name": "string",
"logo_url": "http://example.com",
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
},
"recommended_shipping_carrier": {"id": "string",
"name": "string",
"logo_url": "http://example.com",
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
},
"status": "PENDING",
"package_specification": {"weight": "string",
"package_count": "string",
"weight_units": "LBS"
},
"ship_date_time": "stringstringstringst",
"delivery_date_time": "stringstringstringst",
"reattempt_date": "stringstringstringst",
"destination_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"sender_address": {"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"admin_area_4": "string",
"admin_area_3": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "st",
"address_details": {"street_number": "string",
"street_name": "string",
"street_type": "string",
"delivery_service": "string",
"building_name": "string",
"sub_building": "string"
}
},
"provider_details": {"provider_type": "CARRIER",
"provider_name": "AFTERSHIP"
},
"created_date": "string",
"updated_date": "string",
"created_time": "string",
"updated_time": "string"
},
"error": {"name": "string",
"message": "string",
"debug_id": "string",
"information_link": "string",
"details": [{"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
}

Shipping Package Specification

Shipping Package Specification details.

weight

string [ 1 .. 32 ] characters ^(-?[0-9]+|-?([0-9]+)?[.][0-9]+)$

Weight of the package delivered.

package_count

string [ 1 .. 22 ] characters ^[0-9]+$

Number of packages in the shipment.

weight_units

string [ 1 .. 10 ] characters ^[0-9A-Z_]+$

Unit of measurement for the package’s weight.

Enum Value	Description
LBS	The unit of measurement for the weight is lbs (pounds).
KGS	The unit of measurement for the weight is kgs.

{"weight": "string",
"package_count": "string",
"weight_units": "LBS"
}

Status

The HTTP status code corresponds to the response for the operation result within the batch request.

code	string = 3 characters ^([1-9]\|[0-9][0-9]*)$ The HTTP status code corresponds to the response for the operation result within the batch request.
	object (Error) The error details on failure of unsubscription.

{"code": "str",
"error": {"name": "string",
"message": "string",
"debug_id": "string",
"information_link": "string",
"details": [{"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
}

tracker

The tracking information for a shipment.

transaction_id

required

string [ 1 .. 50 ] characters ^[a-zA-Z0-9]*$

The PayPal transaction ID.

tracking_number

string [ 1 .. 64 ] characters ^.*$

The tracking number for the shipment. Carrier information, carrier is required if tracking_number is provided.

carrier_name_other

string [ 1 .. 64 ] characters ^.*$

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

postage_payment_id

string [ 1 .. 64 ] characters ^.*$

The postage payment ID.

notify_buyer

boolean

Default: false

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.

quantity

integer [ 1 .. 22 ]

The quantity of items shipped.

tracking_number_validated

boolean

Indicates whether the carrier validated the tracking number.

shipment_direction

string [ 1 .. 50 ] characters ^[A-Z]*$

To denote whether the shipment is sent forward to the receiver or returned back.

Enum Value	Description
FORWARD	The shipment is sent forward to the receiver.
RETURN	The shipment was returned back.

shipment_uploader

string [ 1 .. 50 ] characters ^[A-Z]*$

To denote which party uploaded the shipment tracking info.

Enum Value	Description
MERCHANT	The tracking info uploader is the merchant selling the goods and shipping it to the buyer or the payment receiver of the transaction.
CONSUMER	The tracking info uploader is the consumer receiving the goods that was shipped by the merchant or the payment sender of the transaction.
PARTNER	The tracking info uploader is the partner or marketplace or shipment facilitator who is uploading the tracking info on behalf of the merchant or consumer.

account_id

string = 13 characters ^[2-9A-HJ-NP-Z]{13}$

Encrypted PayPal Account ID of the buyer or seller.

tracking_url

string <uri> [ 1 .. 250 ] characters ^.*$

Tracking Link of the shipment.

Array of objects (Link Description) [ 1 .. 2 ] items

An array of request-related HATEOAS links.

tracking_number_type

string (tracking_number_type) [ 1 .. 64 ] characters ^[0-9A-Z_]+$

The type of tracking number.

Enum Value	Description
CARRIER_PROVIDED	A merchant-provided tracking number.
E2E_PARTNER_PROVIDED	A marketplace-provided tracking number.

status

required

string (tracking_status) [ 1 .. 64 ] characters ^[A-Z_]+$

The status of the item shipment. For allowed values, see Shipping Statuses.

Enum Value	Description
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_date

string <ppaas_date_notime_v2> (date_no_time) = 10 characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

carrier

string (carrier) [ 1 .. 64 ] characters ^.*$

Enum Value	Description
2EBOX	2ebox courier.
360LION	360 Lion Express.
3JMSLOGISTICS	3JMS Logistics.
4_72	4-72 Entregando
6LS	6ls.com.
A1POST	A1Post.
AAA_COOPER	AAA Cooper.
ABCUSTOM	AB Custom Group.
ABXEXPRESS_MY	ABX Express.
ACOMMMERCE	aCommerce.
ACSWORLDWIDE	ACS Worldwide Express.
ACS_GR	ACS Courier.
ADERONLINE	Ader couriers.
ADICIONAL	Adicional Logistics.
ADSONE	ADSone.
ADUIEPYLE	A Duie Pyle.
AERONET	Aeronet couriers.
AEX	AEX Group.
AFLLOG_FTP	AFL LOGISTICS.
AGILITY	Agility.
AIRMEE_WEBHOOK	Airmee couriers.
AIR_CANADA_GLOBAL	Rivo (Air canada).
ALFATREX	AlfaTrex.
ALLIEDEXPRESS	Allied Express.
ALLJOY	ALLJOY SUPPLY CHAIN.
ALPHAFAST	Alphafast (www.alphafast.com).
ALWAYS_EXPRESS	Always Express.
AMAZON	Amazon Shipping.
AMAZON_FBA_SWISHIP	Swiship UK.
AMAZON_SHIP_MCF	Amazon Shipping + Amazon MCF.
AMSTAN	Amstan Logistics.
AMS_GRP	AMS Group.
ANDREANI	Grupo logistico Andreani.
ANICAM_BOX	ANICAM BOX EXPRESS.
ANJUN	Anjun couriers.
ANSERX	ANSERX courier.
AN_POST	An Post.
AO_COURIER	AO Logistics.
AO_DEUTSCHLAND	AO Deutschland.
APC_OVERNIGHT	APC overnight (apc-overnight.com).
APC_OVERNIGHT_CONNUM	APC Overnight Consignment.
APG	APG eCommerce Solutions.
APRISAEXPRESS	Aprisa Express.
AQUILINE	Aquiline.
ARAMEX	Aramex.
ARAMEX_AU	Aramex Australia (formerly Fastway AU).
ARCO_SPEDIZIONI	Arco Spedizioni SP.
ARE_EMIRATES_POST	Emirates Post.
ARG_OCA	OCA Argentina.
ARK_LOGISTICS	ARK Logistics.
ASE	ASE KARGO.
ASENDIA_HK	Asendia HonKong.
ASENDIA_UK	Asendia UK.
ASENDIA_USA	Asendia USA.
ASIGNA	ASIGNA courier.
AUPOST_CN	AuPost China.
AUSTRIAN_POST_EXPRESS	austrian post.
AUS_STARTRACK	StarTrack (startrack.com.au).
AUS_TOLL	TOLL Australia.
AU_AUSTRIAN_POST	Austrian Post (Registered).
AU_AU_POST	Australia Post.
AU_TNT	TNT Australia.
AVERITT	Averitt Express.
BEL_DHL	DHL Benelux.
BEL_RS	BEL North Russia.
BESTWAYPARCEL	Best Way Parcel.
BE_BPOST	Bpost (www.bpost.be).
BE_KIALA	Kiala.
BG_BULGARIAN_POST	Bulgarian Posts.
BH_POSTA	BH Posta (www.posta.ba).
BH_WORLDWIDE	B&H Worldwide.
BIRDSYSTEM	BirdSystem.
BJSHOMEDELIVERY	BJS Distribution courier.
BLINKLASTMILE	Blink.
BLR_BELPOST	Belpost.
BLUECARE	Bluecare Express Ltd.
BLUESTAR	Blue Star.
BLUEX	Blue Express.
BNEED	Bneed courier.
BOMBINOEXP	Bombino Express Pvt.
BOND	Bond courier.
BONDSCOURIERS	Bonds Courier Service (bondscouriers.com.au).
BORDEREXPRESS	Border Express.
BOX_BERRY	Boxberry courier.
BPOST_INT	Bpost international.
BRA_CORREIOS	Correios Brazil.
BRING	Bring.
BROUWER_TRANSPORT	Brouwer Transport en Logistiek.
BRT_IT	BRT couriers Italy (www.brt.it).
BRT_IT_PARCELID	BRT Bartolini(Parcel ID).
BRT_IT_SENDER_REF	BRT Bartolini(Sender Reference).
BUDBEE_WEBHOOK	Budbee courier.
BUYLOGIC	buylogic.
B_TWO_C_EUROPE	B2C courier Europe.
CAE_DELIVERS	CAE Delivers.
CAINIAO	AliExpress Standard Shipping.
CARIBOU	Caribou.
CARRIERS	Carriers courier.
CARRY_FLAP	Carry-Flap Co..
CA_CANADA_POST	Canada Post.
CA_CANPAR	Canpar Courier.
CA_GREYHOUND	Greyhound.
CA_PUROLATOR	Purolator.
CBL_LOGISTICA	CBL Logistica.
CDEK	CDEK courier.
CDEK_TR	CDEK TR.
CELERITAS	Celeritas Transporte.
CELLO_SQUARE	Cello Square.
CESKA_CZ	Czech Post.
CEVA	CEVA LOGISTICS.
CFL_LOGISTICS	CFL Logistics.
CGS_EXPRESS	CGS Express.
CHAMPION_LOGISTICS	Champion Logistics.
CHITCHATS	Chit Chats.
CHOIR_EXP	Choir Express Indonesia.
CHROBINSON	C.H. Robinson Worldwide.
CHRONOPOST_FR	Chronopost france (www.chronopost.fr).
CHUKOU1	Chukou1.
CH_SWISS_POST_PRIORITY	Swiss Post.
CITYLINK_MY	City-Link Express.
CJPACKET	CJ Packet.
CJ_CENTURY	CJ Century.
CJ_GLS	CJ GLS.
CJ_HK_INTERNATIONAL	CJ Logistics International(Hong Kong).
CJ_INT_MY	CJ International malaysia.
CJ_KR	CJ Korea Express.
CJ_LOGISTICS	CJ Logistics International.
CJ_TH	CJ Transnational Philippines.
CLEVY_LINKS	Clevy Links.
CLE_LOGISTICS	CL E-Logistics Solutions Limited.
CLOUDWISH_ASIA	Cloudwish Asia.
CNDEXPRESS	CND Express.
CNEXPS	CNE Express.
CNWANGTONG	cnwangtong.
CN_17POST	17 Post Service.
CN_BESTEXPRESS	Best Express.
CN_BOXC	BoxC courier.
CN_CHINA_POST_EMS	China Post.
CN_DPEX	DPEX.
CN_EMS	EMS China (www.ems.post).
CN_EQUICK	Equick China.
CN_JCEX	JCEX courier.
CN_PAYPAL_PACKAGE	PayPal Package.
CN_POST56	Post56.
CN_SF_EXPRESS	SF Express (www.sf-express.com).
CN_STO	STO Express.
CN_WEDO	WeDo Logistics.
CN_WISHPOST	WishPost.
CN_YUNDA	Yunda Express.
COLIS_PRIVE	Colis Privé.
COLLECTCO	CollectCo.
COLLIVERY	MDS Collivery Pty (Ltd).
COMET_TECH	CometTech.
CONTINENTAL	Continental.
CON_WAY	Con-way Freight.
COORDINADORA	Coordinadora.
COPA_COURIER	Copa Airlines Courier.
COPE	Cope Sensitive Freight.
CORPORATECOURIERS_WEBHOOK	Corporate Couriers.
CORREOS_DE_MEXICO	correos mexico.
CORREOS_ES	correos Express (www.correos.es).
CORREOS_EXPRESS	Correos Express.
CORREO_UY	Correo Uruguayo.
COSTMETICSNOW	Cosmetics Now.
COURANT_PLUS	Courant Plus.
COUREX	Urbanfox.
COURIERS_PLEASE	CouriersPlease (couriersplease.com.au).
CPACKET	Cpacket couriers.
CPEX	Captain Express International.
CROSHOT	Croshot.
CSE	CSE courier.
CTC_EXPRESS	CTC Express.
CUBYN	Cubyn.
CUCKOOEXPRESS	Cuckoo Express.
CYPRUS_POST_CYP	cyprus post.
DAIGLOBALTRACK	DAI Post.
DAJIN	Shanghai Aqrum Chemical Logistics Co.Ltd.
DANSKE_FRAGT	Danske Fragtaend.
DAWN_WING	Dawn Wing.
DAYTON_FREIGHT	Dayton Freight.
DBSCHENKER_B2B	DB Schenker B2B.
DBSCHENKER_SE	DB Schenker (www.dbschenker.com).
DBSCHENKER_SV	DB Schenker Sweden.
DDEXPRESS	DD Express Courier.
DEALERSEND	DealerSend.
DELIVERYONTIME	DELIVERYONTIME LOGISTICS PVT LTD.
DELNEXT	Delnext.
DELTEC_UK	Deltec Courier.
DEMANDSHIP	DemandShip.
DESCARTES	Innovel courier.
DESIGNERTRANSPORT_WEBHOOK	Designer Transport.
DESTINY	Destiny Transportation.
DEX_I	DEX-I courier.
DE_ASENDIA	Asendia Germany.
DE_DEUTSCHE	Deutsche post.
DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET	Deutsche Post DHL.
DE_DHL_EXPRESS	DHL Express.
DE_DPD_DELISTRACK	DPD Germany.
DE_GLS	GLS parcel services (www.gls-group.eu).
DHL	dhl Global.
DHL_ACTIVE_TRACING	DHL Active Tracing.
DHL_AU	DHL Supply Chain Australia.
DHL_BENELUX	dhl benelux.
DHL_ECOMERCE_ASA	DHL eCommerce Asia (API).
DHL_ES	DHL Spain(www.dhl.com).
DHL_FR	DHL France (www.dhl.com).
DHL_FREIGHT	DHL Freight.
DHL_GLOBAL_MAIL_ASIA	DHL Global Mail Asia (www.dhl.com).
DHL_HK	DHL HonKong.
DHL_JP	DHL Japan.
DHL_PARCEL_ES	DHL parcel Spain(www.dhl.com).
DHL_PARCEL_NL	DHL Parcel NL.
DHL_PARCEL_RU	DHL Parcel Russia.
DHL_PL	DHL Poland.
DHL_REFR	DHl (Reference number).
DHL_SG	dhl Singapore.
DHL_SUPPLY_CHAIN	DHL Supply Chain APAC.
DHL_UK	dhl UK.
DIAMOND_EUROGISTICS	Diamond Eurogistics Limited.
DICOM	GLS Logistic Systems Canada Ltd./Dicom.
DIDADI	DIDADI Logistics tech.
DIMERCO	Dimerco Express Group.
DIRECTCOURIERS	Direct Couriers.
DIRECTLOG	Directlog (www.directlog.com.br).
DIRECTPARCELS	Direct Parcels.
DMM_NETWORK	DMM Network.
DMS_MATRIX	DMSMatrix.
DOBROPOST	DobroPost.
DOORA	Doora Logistics.
DOORDASH_WEBHOOK	DoorDash.
DPD	DPD.
DPD_DELISTRACK	DPD delistrack.
DPD_FR	DPD France.
DPD_HGRY	DPD Hungary.
DPD_HK	DPD HongKong.
DPD_IR	DPD Ireland.
DPD_LOCAL	DPD Local.
DPD_LOCAL_REF	DPD Local reference.
DPD_POLAND	DPD Poland.
DPD_RO	DPD Romania.
DPD_RU	DPD Russia.
DPEX	DPEX (www.dpex.com).
DPE_EXPRESS	DPE Express.
DPE_SOUTH_AFRC	DPE South Africa.
DSV	DSV courier.
DTDC_AU	DTDC Australia.
DTDC_EXPRESS	DTDC express.
DTDC_IN	DTDC India.
DTD_EXPR	DTD Express.
DX_SFTP	DX (SFTP).
DYLT	Daylight Transport.
DYNALOGIC	Dynamic Logistics.
EASY_MAIL	Easy Mail.
ECEXPRESS	ECexpress.
ECHO	Echo courier.
ECMS	ECMS International Logistics Co..
ECOSCOOTING	ECOSCOOTING.
EFEX	eFEx (E-Commerce Fulfillment & Express).
EFS	EFS (E-commerce Fulfillment Service).
EKART	Ekart logistics (ekartlogistics.com).
ELIAN_POST	Yilian (Elian) Supply Chain.
EMPS_CN	EMPS Express.
ENDEAVOUR_DELIVERY	Endeavour Delivery.
ENVIALIA_REFERENCE	Envialia Reference.
EPARCEL_KR	eParcel Korea.
EPST_GLBL	ePost Global
EP_BOX	EP-Box courier.
ESHIPPING	Eshipping.
ESP_ASM	ASM(GLS Spain).
ESP_ENVIALIA	Envialia.
ESP_MRW	MRW spain.
ESP_NACEX	NACEX Spain.
ESP_PACKLINK	Packlink.
ESP_REDUR	Redur Spain.
ETOMARS	Etomars.
ETOTAL	eTotal Solution Limited.
ETS_EXPRESS	RETS express.
EU_FLEET_SOLUTIONS	EU Fleet Solutions.
EU_IMX	IMX Mail.
EXPRESSSALE	Expresssale.
FARGOOD	FarGood.
FAR_INTERNATIONAL	FAR international.
FASTRACK	Fasttrack.
FASTRK_SERV	Fastrak Services.
FASTWAY_IR	Fastway Ireland.
FASTWAY_NZ	Fastway New Zealand.
FDSEXPRESS	FDSEXPRESS.
FEDEX	Fedex.
FEDEX_CROSSBORDER	FedEx Cross Border.
FEDEX_FR	FedEx® Freight.
FEDEX_INTL_MLSERV	FedEx International MailService.
FEDEX_POLAND	FedEx® Poland Domestic.
FEDEX_UK	FedEx® UK.
FETCHR_WEBHOOK	Mena 360 (Fetchr).
FIEGE	Fiege Logistics.
FIEGE_NL	Fiege Netherlands.
FIRSTMILE	FirstMile.
FLASHEXPRESS	Flash Express.
FMX	FMX.
FONSEN	Fonsen Logistics.
FORRUN	forrun Pvt Ltd (Arpatech Venture).
FREIGHTQUOTE	Freightquote by C.H. Robinson.
FRETERAPIDO	Frete Rapido.
FR_BERT	Bert Transport.
FR_COLIS	Colissimo.
FR_EXAPAQ	DPD France (formerly exapaq).
FR_GEODIS	GEODIS - Distribution & Express.
FR_GLS	GLS france.
FULFILLA	Fulfilla.
FULFILLME	Fulfillme.
FURDECO	Furdeco.
GAC	GAC.
GANGBAO	GANGBAO Supplychain.
GBA	GBA Services Ltd.
GBS_BROKER	GBS-Broker.
GB_APC	APC postal logistics germany.
GB_ARROW	Arrow XL.
GB_NORSK	Norsk Global.
GB_PANTHER	Panther.
GB_TUFFNELLS	Tuffnells Parcels Express.
GEIS	Geis CZ.
GEL_EXPRESS	Gel Express Logistik.
GEMWORLDWIDE	GEM Worldwide.
GENERAL_OVERNIGHT	Go!Express and logistics.
GENIKI_GR	Geniki Taxydromiki.
GEODIS_ESPACE	Geodis E-space.
GESWL	GESWL Express.
GIAO_HANG	Giao hàng nhanh.
GIO_EXPRESS	Gio Express.
GLOBALTRANZ	GlobalTranz.
GLOBAL_ABF	ABF Freight.
GLOBAL_ESTES	Estes Express Lines.
GLOBAL_EXPRESS	Tai Wan Global Business.
GLOBAL_IPARCEL	i-parcel.
GLOBAL_TNT	TNT global.
GLOBAVEND	Globavend.
GLS_CROTIA	GLS Croatia.
GLS_CZ	GLS Czech Republic.
GLS_IT	GLS Italy.
GLS_ITALY	GLS Italy.
GLS_SLOV	GLS General Logistics Systems Slovakia s.r.o..
GLS_SLOVEN	GLS Slovenia.
GOGLOBALPOST	Global Post.
GOJEK	Gojek.
GRAB_WEBHOOK	Grab courier.
GRUPO	Grupo ampm.
GR_ELTA	ELTA Hellenic Post.
GSI_EXPRESS	GSI EXPRESS.
GSO	GSO(GLS-USA).
HAPPY2POINT	Happy 2ThePoint
HCT_LOGISTICS	HCT LOGISTICS CO.LTD..
HDB	Haidaibao.
HDB_BOX	Haidaibao (BOX).
HELLMANN	Hellmann Worldwide Logistics.
HELTHJEM	Helthjem.
HEPPNER	Heppner Internationale Spedition GmbH & Co..
HEPPNER_FR	Heppner France.
HERMES	HermesWorld UK.
HERMES_2MANN_HANDLING	Hermes Einrichtungs Service GmbH & Co. KG.
HERMES_DE	Hermes Germany.
HH_EXP	Hua Han Logistics.
HIPSHIPPER	Hipshipper.
HKD	Qingdao HKD International Logistics.
HK_FLYT_EXPRESS	FLYT express.
HK_FOUR_PX_EXPRESS	4PX (fourPX).
HK_POST	Hongkong Post (www.hongkongpost.hk).
HK_TGX	Kerry Express Hong Kong.
HOLISOL	Holisol.
HOME_DELIVERY_SOLUTIONS	Home Delivery Solutions Ltd.
HOUNDEXPRESS	Hound Express.
HRPARCEL	HR Parcel.
HRV_HRVATSKA	Hrvatska posta.
HUAHAN_EXPRESS	HUAHANG EXPRESS.
HUNTER_EXPRESS	Hunter Express.
HUODULL	Huodull.
HX_EXPRESS	HX Express.
IBEONE	Beone Logistics.
ICUMULUS	iCumulus.
IDEXPRESS	IDEX courier.
IDN_JNE	JNE Express (Jalur Nugraha Ekakurir).
IDN_LION_PARCEL	Lion Parcel.
IDN_PANDU	pandu Logistics (pandulogistics.com).
IML	IML courier.
INDOPAKET	INDOPAKET.
IND_BLUEDART	Bluedart.
IND_DELHIVERY	Delhivery India.
IND_DELIVREE	deliverE.
IND_DOTZOT	Dotzot.
IND_ECOM	Ecom Express.
IND_FIRSTFLIGHT	First Flight Couriers.
IND_GATI	Gati-KWE.
IND_GOJAVAS	GoJavas.
IND_PROFESSIONAL_COURIERS	Professional Couriers.
IND_SAFEEXPRESS	Safexpress.
IND_XPRESSBEES	Xpressbees (www.xpressbees.com).
INPOST_PACZKOMATY	InPost Paczkomaty.
INTEGRA2_FTP	Integra2.
INTELIPOST	Intelipost (TMS for LATAM).
INTEL_VALLEY	Intel-Valley Supply chain (ShenZhen) Co. Ltd.
INTERPARCEL_AU	Interparcel Australia.
INTERPARCEL_NZ	Interparcel New Zealand.
INTERPARCEL_UK	Interparcel UK.
INTEXPRESS	Internet Express.
ISRAEL_POST	Israel Post.
ISR_POST_DOMESTIC	Israel Post Domestic.
IT_DHL_ECOMMERCE	DHL International.
IT_FERCAM	FERCAM Logistics & Transport.
IT_NEXIVE	Nexive (TNT Post Italy).
IT_POSTE_ITALIA	Poste italiane (www.poste.it).
IT_TNT	TNT Italy.
IVOY_WEBHOOK	Ivoy courier.
I_DIKA	i-dika.
JANCO	Janco Ecommerce.
JANIO	Janio Asia.
JERSEY_POST	Jersey Post.
JET_SHIP	Jet-Ship Worldwide.
JINDOUYUN	jindouyun courier.
JINSUNG	JINSUNG TRADING.
JOCOM	Jocom.
JOOM_LOGIS	Joom Logistics.
JOYING_BOX	Joying Box.
JPN_JAPAN_POST	Japan Post.
JPN_SAGAWA	Sagawa Express Japan.
JP_KURO_NEKO_YAMATO_UNYUU	Yamato transport (www.kuronekoyamato.co.jp).
JS_EXPRESS	JS EXPRESS.
JTEXPRESS	J&T EXPRESS MALAYSIA.
JTEXPRESS_VN	J&T Express Vietnam.
JX	JX courier.
J_NET	J-Net.
K1_EXPRESS	K1 Express.
KANGAROO_MY	Kangaroo Worldwide Express.
KEC	KEC courier.
KERRYTJ	Kerry TJ Logistics.
KERRYTTC_VN	Kerry Express (Vietnam) Co Ltd.
KERRY_ECOMMERCE	Kerry eCommerce.
KGMHUB	KGM Hub.
KHM_CAMBODIA_POST	Cambodia Post.
KOR_ECARGO	Ecargo.
KPOST	Korea Post.
KR_KOREA_POST	Koreapost (www.koreapost.go.kr).
KUEHNE	Kuehne + Nagel.
KURASI	KURASI.
KWE_GLOBAL	KWE Global.
KWT	Shenzhen Jinghuada Logistics Co..
KYUNGDONG_PARCEL	Kyungdong Parcel.
KY_EXPRESS	Kua Yue Express.
LALAMOVE	Lalamove.
LANDMARK_GLOBAL	Landmark Global.
LANDMARK_GLOBAL_REFERENCE	Landmark Global Reference.
LATVIJAS_PASTS	Latvijas Pasts.
LA_POSTE_SUIVI	La Poste.
LBCEXPRESS_FTP	LBC EXPRESS INC..
LEADER	leader.
LEGION_EXPRESS	Legion Express.
LEXSHIP	LexShip.
LHT_EXPRESS	LHT Express.
LICCARDI_EXPRESS	LICCARDI EXPRESS COURIER.
LIEFERY	liefery.
LINE	Line Clear Express & Logistics Sdn Bhd.
LINKBRIDGE	Link Bridge(BeiJing)international logistics co..
LOCUS_WEBHOOK	Locus courier.
LOGISTERS	Logisters.
LOGISTICSWORLDWIDE_HK	Logistic Worldwide Express (LWE Honkong).
LOGISTIKA	Logistika.
LOGISTYX_TRANSGROUP	Transgroup courier.
LONESTAR	Lone Star Overnight.
LOOMIS_EXPRESS	Loomis Express.
LOTTE	Lotte Global Logistics.
LTIANEXP	LTIAN EXP.
LTL	LTL COURIER.
LTU_LIETUVOS	Lietuvos pastas.
MAGYAR_HU	Magyar Post.
MAILAMERICAS	MailAmericas.
MAILPLUS_JPN	MailPlus (Japan).
MAIL_PLUS	MailPlus.
MAINFREIGHT	Mainfreight.
MAINWAY	Mainway.
MATDESPATCH	Matdespatch.
MATKAHUOLTO	Matkahuolto.
MBW	MBW Courier Inc..
MEX_AEROFLASH	Aeroflash Mexico.
MEX_ESTAFETA	Estafeta (www.estafeta.com).
MEX_REDPACK	Redpack.
MEX_SENDA	mexico senda express.
MGLOBAL	PT MGLOBAL LOGISTICS INDONESIA.
MIKROPAKKET	Mikropakket.
MIKROPAKKET_BE	Mikropakket Belgium.
MILKMAN	Milkman courier.
MORE_LINK	Morelink.
MORNING_EXPRESS	Morning Express.
MRW_FTP	MRW courier.
MXE	MXE Express.
MX_CARGO	M&X cargo.
MYHERMES	MyHermes UK.
MYS_AIRPAK	Airpak Express.
MYS_EMS	Malaysia Post EMS / Pos Laju.
MYS_GDEX	GDEX courier.
MYS_MYPOST_ONLINE	Mypostonline.
MYS_MYS_POST	Malaysia Post.
MYS_SKYNET	Skynet Malaysia.
M_XPRESS	M Xpress Sdn Bhd.
NACEX	NACEX.
NACEX_ES	NACEX Spain.
NANJINGWOYUAN	Nanjing Woyuan.
NATIONAL_SAMEDAY	National Sameday.
NATIONEX	Nationex courier.
NATIONWIDE_MY	Nationwide Express Courier Services Bhd (www.nationwide.com.my).
NEWAY	Neway Transport.
NEWEGGEXPRESS	Newegg Express.
NEWGISTICS	Newgistics.
NEWZEALAND_COURIERS	NEW ZEALAND COURIERS.
NG_COURIERPLUS	Courier Plus.
NHANS_SOLUTIONS	Nhans Solutions.
NIM_EXPRESS	Nim Express.
NINJAVAN_MY	ninja van (www.ninjavan.co).
NINJAVAN_SG	Ninja van Singapore.
NINJAVAN_THAI	Ninja van Thai.
NINJAVAN_WB	Ninjavan Webhook.
NIPOST_NG	NIpost (www.nipost.gov.ng).
NLD_DHL	DHL Netherland.
NLD_GLS	GLS Netherland.
NLD_POSTNL	PostNL International.
NLD_TRANSMISSION	TransMission.
NOVA_POSHTA	Nova Poshta (novaposhta.ua).
NOVA_POSHTA_INT	Nova Poshta (International).
NOX_NACHTEXPRESS	Innight Express Germany GmbH (nox NachtExpress).
NOX_NIGHT_TIME_EXPRESS	NOX NightTimeExpress.
NTLOGISTICS_VN	Nhat Tin Logistics.
NZ_COURIER_POST	CourierPost Newsland.
NZ_NZ_POST	New Zealand Post.
OCS	OCS ANA Group.
OCS_WORLDWIDE	OCS WORLDWIDE.
OKAYPARCEL	OkayParcel.
OMNIPARCEL	Omni Parcel.
OMNIVA	Omniva.
ONECLICK	One click delivery services.
ONEWORLDEXPRESS	One World Express.
ORANGE_DS	OrangeDS (Orange Distribution Solutions Inc).
OSM_WORLDWIDE	OSM Worldwide.
OVERSE_EXP	Overseas Express.
P2P_TRC	P2P TrakPak.
PAACK_WEBHOOK	Paack courier.
PADTF	padtf.com.
PAGO	Pago Logistics.
PALEXPRESS	PAL Express Limited.
PALLETWAYS	Palletways.
PALLET_NETWORK	The Pallet Network.
PANTHER_REFERENCE	Panther Reference.
PAN_ASIA	Pan-Asia International.
PAPERFLY	Paperfly Private Limited.
PAPER_EXPRESS	Paper Express.
PAQUETEXPRESS	Paquetexpress.
PARCEL2GO	Parcel2Go.
PARCELINKLOGISTICS	Parcelink Logistics.
PARCELLED_IN	Parcelled.in.
PARCELONE	PARCEL ONE.
PARCELPAL_WEBHOOK	ParcelPal.
PARCELPOINT	Parcelpoint.
PARCELPOST_SG	Parcel Post Singapore.
PARCEL_2_POST	Parcel To Post.
PARKNPARCEL	Park N Parcel.
PCFCORP	PCF Final Mile.
PFCEXPRESS	PFC Express.
PFLOGISTICS	PFL.
PHL_AIR21	AIR21 courier.
PHL_AIRSPEED	Airspeed International.
PHL_JAMEXPRESS	Jam Express Philippines.
PICKRR	Pickrr.
PICKUP	Pickupp.
PICKUPP_MYS	PICK UPP.
PICKUPP_SGP	PICK UPP (Singapore).
PILOT_FREIGHT	Pilot Freight Services.
PIL_LOGISTICS	PIL Logistics (China) Co..
PITNEY_BOWES	Pitney Bowes.
PITTOHIO	PITT OHIO.
PIXSELL	PIXSELL LOGISTICS.
PLANZER	Planzer Group.
PLUS_LOG_UK	Plus UK Logistics.
PL_POCZTA_POLSKA	Poczta Polska (www.poczta-polska.pl).
POL_SIODEMKA	Siodemka.
PONY_EXPRESS	Pony express.
POSTA_PLUS	Posta Plus.
POSTA_RO	Post Roman (www.posta-romana.ro).
POSTA_UKR	UkrPoshta.
POSTEN_NORGE	Posten Norge (www.posten.no).
POSTI	Posti courier.
POSTNL_INTL_3S	PostNL International 3S.
POSTNL_INT_3_S	PostNL International.
POSTNORD_LOGISTICS	PostNord Logistics.
POSTNORD_LOGISTICS_DK	ostnord denmark.
POSTUR_IS	Iceland Post.
POST_SERBIA	Posta Serbia.
POST_SLOVENIA	Post of Slovenia.
PRESIDENT_TRANS	PRESIDENT TRANSNET CORP.
PRESSIODE	Pressio.
PRIMAMULTICIPTA	PT Prima Multi Cipta.
PROMEDDELIVERY	ProMed Delivery.
PRT_CHRONOPOST	Chronopost Portugal.
PRT_CTT	CTT Portugal.
PRT_INT_SEUR	SEUR International.
PRT_SEUR	SEUR portugal.
PTS	PTS courier.
PTT_POST	PTT Post.
QUANTIUM	Quantium.
QWINTRY	Qwintry Logistics.
RABEN_GROUP	Raben Group.
RAF_PH	RAF Philippines.
RAIDEREX	RaidereX.
RAM	RAM courier.
RCL	Red Carpet Logistics.
RINCOS	Rincos.
RL_US	RL Carriers.
ROADBULL	Red Carpet Logistics.
ROADRUNNER_FREIGHT	Roadbull Logistics.
ROCKET_PARCEL	Rocket Parcel International.
ROUTIFIC_WEBHOOK	Routific.
ROYAL_MAIL	RoyalShipments.
RPD2MAN	RPD2man Deliveries.
RPX	RPX Online.
RPXLOGISTICS	RPX Logistics.
RPX_ID	RPX Indonesia.
RUSSIAN_POST	Russian post.
RUSTON	Ruston.
RZYEXPRESS	RZY Express.
SAIA_FREIGHT	Saia LTL Freight.
SAILPOST	SAILPOST.
SAP_EXPRESS	SAP EXPRESS.
SAU_SAUDI_POST	Saudi Post.
SCUDEX_EXPRESS	Scudex Express.
SDA_IT	SDA Italy.
SDH_SCM	lightning monkey
SEFL	Southeastern Freight Lines.
SEINO	Seino.
SEKOLOGISTICS	SEKO Logistics.
SEKO_SFTP	SEKO Worldwide.
SENDING	Sending Transporte Urgente y Comunicacion.
SENDIT	Sendit.
SENDLE	Sendle.
SEUR_ES	Seur Spain.
SEUR_SP_API	Spanish Seur API.
SFB2C	SF International.
SFCSERVICE	SFC Service.
SFC_LOGISTICS	SFC.
SFPLUS_WEBHOOK	Zeek courier.
SF_EX	SF Express.
SG_DETRACK	Detrack.
SG_QXPRESS	Qxpress.
SG_SG_POST	Singapore Post.
SG_SPEEDPOST	Singapore Speedpost.
SG_TAQBIN	Taqbin Singapore.
SHENZHEN	shenzhen 1st International Logistics(Group)Co.
SHIPENTEGRA	ShipEntegra.
SHIPPIT	Shippit.
SHIPTER	SHIPTER.
SHIPTOR	Shiptor.
SHIP_GATE	ShipGate.
SHIP_IT_ASIA	Ship It Asia.
SHOPFANS	ShopfansRU LLC.
SHREENANDANCOURIER	SHREE NANDAN COURIER.
SHREETIRUPATI	SHREE TIRUPATI COURIER SERVICES PVT. LTD..
SHREE_ANJANI_COURIER	Shree Anjani Courier.
SHREE_MARUTI	Shree Maruti Courier Services Pvt Ltd.
SIMPLYPOST	J&T Express Singapore.
SINOTRANS	Sinotrans.
SIN_GLBL	Sin Global Express.
SKYBOX	SKYBOX.
SKYNET_UAE	SKYNET UAE.
SKYNET_UK	Skynet UK.
SKYNET_WORLDWIDE	SkyNet Worldwide Express.
SKYNET_ZA	Skynet World Wide Express South Africa.
SKY_POSTAL	SkyPostal.
SK_POSTA	Slovenska pošta.
SMG_EXPRESS	SMG Direct.
SMOOTH	Smooth Couriers.
SMSA_EXPRESS	SMSA Express.
SONICTL	Sonic Transportation & Logistics.
SOUTH_AFRICAN_POST_OFFICE	South African Post Office.
SPEEDCOURIERS_GR	Speed Couriers.
SPEEDEE	Spee-Dee Delivery.
SPEEDEXCOURIER	SPEEDEX couriers.
SPOTON	SPOTON Logistics Pvt Ltd.
SPRING_GDS	Spring GDS.
SRE_KOREA	SRE Korea (www.srekorea.co.kr).
STALLIONEXPRESS	Stallion Express.
STARKEN	STARKEN couriers.
STAR_TRACK_EXPRESS	Star Track Express.
STAR_TRACK_NEXT_FLIGHT	Star Track Next Flight.
STEPFORWARDFS	STEP FORWARD FREIGHT SERVICE CO LTD.
STONE3PL	STONE3PL.
STRECK_TRANSPORT	Streck Transport.
SUTTON	Sutton Transport.
SWE_POSTNORD	Postnord sweden.
SWISHIP_DE	Swiship DE.
SWISS_POST_FTP	Swiss Post FTP.
SYPOST	Sunyou Post.
SZENDEX	SZENDEX.
TAQBIN_HK	TAQBIN Hong Kong.
TAQBIN_MY	TAQBIN Malaysia.
TARRIVE	TONDA GLOBAL.
TAZMANIAN_FREIGHT	Tazmanian Freight Systems.
TCK_EXPRESS	TCK Express.
TCS	TCS courier.
TFM	TFM Xpress.
TFORCE_FINALMILE	TForce Final Mile.
THABIT_LOGISTICS	Thabit Logistics.
THA_DYNAMIC_LOGISTICS	Dynamic Logistics.
THA_KERRY	Kerry Express Thailand.
THA_THAILAND_POST	Thailand Post (www.thailandpost.co.th).
THECOURIERGUY	The Courier Guy.
THEDELIVERYGROUP	TDG – The Delivery Group.
THENILE_WEBHOOK	SortHub courier.
TIGFREIGHT	TIG Freight.
TIKI_ID	Tiki shipment.
TIPSA	TIPSA courier.
TNT	TNT Express.
TNT_CLICK_IT	TNT-Click Italy.
TNT_FR	TNT France.
TNT_NL	THT Netherland.
TNT_REFR	TNT Reference.
TNT_UK	TNT UK Limited (www.tnt.com).
TNT_UK_REFR	TNT UK Reference.
TOLL	Toll IPEC.
TOLL_NZ	Toll New Zealand.
TOLOS	Tolos courier.
TOPHATTEREXPRESS	Tophatter Express.
TOPYOU	TopYou.
TOTAL_EXPRESS	Total Express.
TOURLINE	tourline.
TRACKON	Trackon Couriers Pvt. Ltd.
TRANS_KARGO	Trans Kargo Internasional.
TRUMPCARD	TRUMPCARD LLC.
TRUNKRS_WEBHOOK	Trunkrs courier.
TUFFNELLS_REFERENCE	Tuffnells Parcels Express- Reference.
TWO_GO	2GO Courier.
TW_TAIWAN_POST	Taiwan Post.
UBI_LOGISTICS	UBI Smart Parcel.
UC_EXPRE	ucexpress.
UDS	United Delivery Service.
UK_COLLECTPLUS	Collect plus.
UK_DPD	DPD UK.
UK_NIGHTLINE	Nightline(www.nightline.ie).
UK_PARCELFORCE	Parcel Force.
UK_UK_MAIL	UK mail (ukmail.com).
UK_XDP	XDP Express.
UK_YODEL	Yodel (www.yodel.co.uk).
UPS	United Parcel Service.
UPS_FREIGHT	UPS Freight.
UPS_MAIL_INNOVATIONS	UPS Mail Innovations.
UPS_REFERENCE	UPS Reference.
USF_REDDAWAY	USF Reddaway.
USHIP	uShip courier.
USPS	United States Postal Service.
US_GLOBEGISTICS	Globegistics US.
US_LASERSHIP	LaserShip.
US_OLD_DOMINION	Old Dominion Freight Line.
US_ONTRAC	OnTrac Logistics.
US_YRC	YRC courier.
VAMOX	VAMOX.
VENIPAK	Venipak.
VIAEUROPE	ViaEurope.
VIA_EXPRESS	Viaxpress.
VIRTRANSPORT	VIR Transport.
VIWO	VIWO IoT.
VNM_VIETNAM_POST	Vietnam Post.
VNM_VIETTELPOST	ViettelPost.
WAHANA_ID	Wahana express (www.wahana.com).
WANBEXPRESS	WanbExpress.
WEASHIP	Weaship.
WEPOST	WePost Sdn Bhd.
WESTBANK_COURIER	West Bank Courier.
WESTGATE_GL	Westgate Global.
WHISTL	Whistl.
WINIT	WinIt.
WISELOADS	Wiseloads.
WISE_EXPRESS	Wise Express.
WIZMO	Wizmo.
WMG	WMG Delivery.
WNDIRECT	wnDirect.
WYNGS	Wyngs.
XDE_WEBHOOK	Ximex Delivery Express.
XDP_UK_REFERENCE	XDP Express Reference.
XL_EXPRESS	XL Express.
XPERT_DELIVERY	Xpert Delivery.
XPOST	Xpost.ph.
XPO_LOGISTICS	XPO logistics.
XPRESSEN_DK	Xpressen courier.
XQ_EXPRESS	XQ Express.
YAKIT	Yakit courier.
YANWEN	Yanwen Logistics.
YDH_EXPRESS	YDH express.
YINGNUO_LOGISTICS	yingnuo logistics.
YODEL_DIR	Yodel Direct.
YODEL_INTNL	Yodel International.
YTO	YTO Express.
YUNEXPRESS	YunExpress.
YURTICI_KARGO	Yurtici Kargo.
YUSEN	Yusen Logistics.
ZAJIL_EXPRESS	Zajil Express Company.
ZA_COURIERIT	Courier IT.
ZA_FASTWAY	fastway New Zealand.
ZA_SPECIALISED_FREIGHT	Specialised Freight.
ZEEK_2_DOOR	Zeek2Door.
ZELERIS	Zeleris.
ZEPTO_EXPRESS	ZeptoExpress.
ZES_EXPRESS	Eshun international Logistic.
ZIINGFINALMILE	Ziing Final Mile Inc.
ZINC	Zinc courier.
ZJS_EXPRESS	ZJS International.
ZTO_EXPRESS	ZTO Express.
ZYLLEM	Zyllem.

last_updated_time

string <ppaas_date_time_v3> (date_time) [ 20 .. 64 ] characters ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|...

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.

{"transaction_id": "string",
"tracking_number": "string",
"carrier_name_other": "string",
"postage_payment_id": "string",
"notify_buyer": false,
"quantity": 1,
"tracking_number_validated": true,
"shipment_direction": "FORWARD",
"shipment_uploader": "MERCHANT",
"account_id": "stringstrings",
"tracking_url": "http://example.com",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
],
"tracking_number_type": "CARRIER_PROVIDED",
"status": "CANCELLED",
"shipment_date": "string",
"carrier": "2EBOX",
"last_updated_time": "string"
}

tracker_collection

The add tracking information for one or more transactions response details.

	Array of objects (tracker) [ 1 .. 20 ] items An array of tracking information for shipments.
	Array of objects (Link Description) [ 1 .. 2 ] items An array of request-related HATEOAS links.

{"trackers": [{"transaction_id": "string",
"tracking_number": "string",
"carrier_name_other": "string",
"postage_payment_id": "string",
"notify_buyer": false,
"quantity": 1,
"tracking_number_validated": true,
"shipment_direction": "FORWARD",
"shipment_uploader": "MERCHANT",
"account_id": "stringstrings",
"tracking_url": "http://example.com",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
],
"tracking_number_type": "CARRIER_PROVIDED",
"status": "CANCELLED",
"shipment_date": "string",
"carrier": "2EBOX",
"last_updated_time": "string"
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}

tracker_identifier

The tracking identifiers for a shipment.

transaction_id required	string [ 1 .. 50 ] characters ^[a-zA-Z0-9]*$ The PayPal transaction ID.
tracking_number	string [ 1 .. 64 ] characters ^.*$ The tracking number for the shipment.
	Array of objects (Link Description) [ 1 .. 2 ] items An array of request-related HATEOAS links.

{"transaction_id": "string",
"tracking_number": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}

tracker_identifier_collection

The add tracking information for a PayPal transaction response details.

	Array of objects (tracker_identifier) [ 1 .. 100 ] items An array of tracking IDs.
	Array of objects (Link Description) = 1 items An array of request-related HATEOAS links.

{"tracker_identifiers": [{"transaction_id": "string",
"tracking_number": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}

tracking_number_type

The tracking number type.

string (tracking_number_type) [ 1 .. 64 ] characters ^[0-9A-Z_]+$

The tracking number type.

Enum Value	Description
CARRIER_PROVIDED	A merchant-provided tracking number.
E2E_PARTNER_PROVIDED	A marketplace-provided tracking number.

"CARRIER_PROVIDED"

tracking_status

The status of the item shipment. For allowed values, see Shipping Statuses.

string (tracking_status) [ 1 .. 64 ] characters ^[A-Z_]+$

The status of the item shipment. For allowed values, see Shipping Statuses.

Enum Value	Description
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.

"CANCELLED"

Shipment Tracking (1)

Add tracking information for multiple PayPal transactions

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Add tracking information for PayPal transaction

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

List tracking information

query Parameters

Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json

Update or cancel tracking information for PayPal transaction

path Parameters

Request Body schema: application/json

Show tracking information

path Parameters

query Parameters

Errors

INPUT_VALIDATION_ERROR

INTERNAL_SERVER_ERROR

NOT_AUTHORIZED

RESOURCE_NOT_FOUND

Definitions

batch_tracker_collection

carrier

Carrier Detail

Contact Info

country_code

date_no_time

date_time

date_time

Error

Error Details

Estimated Delivery date

Intent Type

Link Description

Link Description

Patch

PayPal Account Identifier

Phone

Portable Postal Address (Medium-Grained)

Provider Type

Scan Details

Shipment Data Provider

Shipment Data Provider Name

Shipment Data Provider Type

Shipment Details

Shipment status

Shipment Tracking

Shipment Tracking

shipment_tracker

shipment_tracking_request

shipment_trackings_response

Shipping Package Specification

Status

tracker

tracker_collection

tracker_identifier

tracker_identifier_collection

tracking_number_type

tracking_status

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json