Merchants can use the PayPal Add Tracking API to manage tracking information. Merchants can add tracking numbers and associated information to PayPal. After adding these details to PayPal, merchants can:
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.
Created
{- "trackers": [
- {
- "account_id": "TELFDNSFY96RY",
- "transaction_id": "8MC585209K746392H",
- "tracking_number": "443844607820",
- "status": "SHIPPED",
- "carrier": "FEDEX",
- "shipment_direction": "FORWARD",
}, - {
- "account_id": "TELFDNSFY96RY",
- "transaction_id": "53Y56775AE587553X",
- "tracking_number": "443844607821",
- "status": "SHIPPED",
- "carrier": "FEDEX"
}
]
}
{- "tracker_identifiers": [
- {
- "transaction_id": "8MC585209K746392H",
- "tracking_number": "443844607820",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "update",
- "method": "PUT"
}, - {
- "rel": "patch",
- "method": "PATCH"
}
]
}, - {
- "transaction_id": "53Y56775AE587553X",
- "tracking_number": "443844607821",
- "links": [
- {
- "rel": "self",
- "method": "GET"
}, - {
- "rel": "replace",
- "method": "PUT"
}, - {
- "rel": "edit",
- "method": "PATCH"
}
]
}
]
}
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.
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_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 To denote whether the shipment is sent forward to the receiver or returned back.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tracking_url | string <uri> [ 1 .. 250 ] characters Tracking Link of the shipment. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tracking_number_type | string (tracking_number_type) [ 1 .. 64 ] characters The type of tracking number.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status required | string (tracking_status) [ 1 .. 64 ] characters The status of the item shipment. For allowed values, see Shipping Statuses.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
carrier | string (carrier) [ 1 .. 64 ] characters The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
A successful request returns the HTTP 204 OK status code with no JSON response body.
{- "transaction_id": "8MC585209K746392H",
- "status": "SHIPPED",
- "tracking_number": "443844607820",
- "carrier": "FEDEX",
- "shipment_direction": "FORWARD",
}
Shows tracking information, by tracker ID, for a PayPal transaction.
A successful request returns the HTTP 200 OK
status code and a JSON response body that shows tracking information.
curl -v -X GET https://api-m.sandbox.paypal.com/v1/shipping/trackers/8MC585209K746392H-443844607820?account_id=TELFDNSFY96RY \ -H 'Authorization: Bearer <Access-Token>' \ -H 'Content-Type: application/json'
{- "transaction_id": "8MC585209K746392H",
- "tracking_number": "443844607820",
- "status": "SHIPPED",
- "carrier": "FEDEX",
- "shipment_direction": "FORWARD",
- "shipment_uploader": "MERCHANT",
- "links": [
- {
- "rel": "self"
}, - {
- "rel": "replace",
- "method": "PUT"
}, - {
- "rel": "create",
- "method": "POST"
}
]
}
Message:
Transaction ID specified is invalid.
Description: Re-check the transaction ID.
Message:
Internal server error. Please check logs for more details.
Description: An internal server error prevented the request from being processed. Try again later.
Message:
Authorization failed due to insufficient permissions.
Description: The caller does not have the correct permissions to authorize the payment.
Message:
The specified resource does not exist.
Description: The resource does not exist.
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) 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"
}
]
}
The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier
to OTHER
and set carrier name in carrier_name_other
. For allowed values, see Carriers.
The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set carrier
to OTHER
and set carrier name in carrier_name_other
. For allowed values, see Carriers.
Enum: | Description |
---|---|
2EBOX | |
360LION | |
3JMSLOGISTICS | |
4_72 | 4-72 Entregando |
6LS | |
A1POST | |
AAA_COOPER | |
ABCUSTOM | |
ABXEXPRESS_MY | |
ACOMMMERCE | |
ACSWORLDWIDE | |
ACS_GR | |
ADERONLINE | |
ADICIONAL | |
ADSONE | |
ADUIEPYLE | |
AERONET | |
AEX | |
AFLLOG_FTP | |
AGILITY | |
AIRMEE_WEBHOOK | |
AIR_CANADA_GLOBAL | |
ALFATREX | |
ALLIEDEXPRESS | |
ALLJOY | |
ALPHAFAST | |
ALWAYS_EXPRESS | |
AMAZON | |
AMAZON_FBA_SWISHIP | |
AMAZON_SHIP_MCF | |
AMSTAN | |
AMS_GRP | |
ANDREANI | |
ANICAM_BOX | |
ANJUN | |
ANSERX | |
AN_POST | |
AO_COURIER | |
AO_DEUTSCHLAND | |
APC_OVERNIGHT | |
APC_OVERNIGHT_CONNUM | |
APG | |
APRISAEXPRESS | |
AQUILINE | |
ARAMEX | |
ARAMEX_AU | |
ARCO_SPEDIZIONI | |
ARE_EMIRATES_POST | |
ARG_OCA | |
ARK_LOGISTICS | |
ASE | |
ASENDIA_HK | |
ASENDIA_UK | |
ASENDIA_USA | |
ASIGNA | |
AUPOST_CN | |
AUSTRIAN_POST_EXPRESS | |
AUS_STARTRACK | |
AUS_TOLL | |
AU_AUSTRIAN_POST | |
AU_AU_POST | |
AU_TNT | |
AVERITT | |
BEL_DHL | |
BEL_RS | |
BESTWAYPARCEL | |
BE_BPOST | |
BE_KIALA | |
BG_BULGARIAN_POST | |
BH_POSTA | |
BH_WORLDWIDE | |
BIRDSYSTEM | |
BJSHOMEDELIVERY | |
BLINKLASTMILE | |
BLR_BELPOST | |
BLUECARE | |
BLUESTAR | |
BLUEX | |
BNEED | |
BOMBINOEXP | |
BOND | |
BONDSCOURIERS | |
BORDEREXPRESS | |
BOX_BERRY | |
BPOST_INT | |
BRA_CORREIOS | |
BRING | |
BROUWER_TRANSPORT | |
BRT_IT | |
BRT_IT_PARCELID | |
BRT_IT_SENDER_REF | |
BUDBEE_WEBHOOK | |
BUYLOGIC | |
B_TWO_C_EUROPE | |
CAE_DELIVERS | |
CAINIAO | |
CARIBOU | |
CARRIERS | |
CARRY_FLAP | |
CA_CANADA_POST | |
CA_CANPAR | |
CA_GREYHOUND | |
CA_PUROLATOR | |
CBL_LOGISTICA | |
CDEK | |
CDEK_TR | |
CELERITAS | |
CELLO_SQUARE | |
CESKA_CZ | |
CEVA | |
CFL_LOGISTICS | |
CGS_EXPRESS | |
CHAMPION_LOGISTICS | |
CHITCHATS | |
CHOIR_EXP | |
CHROBINSON | |
CHRONOPOST_FR | |
CHUKOU1 | |
CH_SWISS_POST_PRIORITY | |
CITYLINK_MY | |
CJPACKET | |
CJ_CENTURY | |
CJ_GLS | |
CJ_HK_INTERNATIONAL | |
CJ_INT_MY | |
CJ_KR | |
CJ_LOGISTICS | |
CJ_TH | |
CLEVY_LINKS | |
CLE_LOGISTICS | |
CLOUDWISH_ASIA | |
CNDEXPRESS | |
CNEXPS | |
CNWANGTONG | |
CN_17POST | |
CN_BESTEXPRESS | |
CN_BOXC | |
CN_CHINA_POST_EMS | |
CN_DPEX | DPEX. |
CN_EMS | |
CN_EQUICK | |
CN_GOFLY | |
CN_JCEX | |
CN_PAYPAL_PACKAGE | |
CN_POST56 | |
CN_SF_EXPRESS | |
CN_STO | |
CN_WEDO | |
CN_WISHPOST | |
CN_YUNDA | |
COLIS_PRIVE | |
COLLECTCO | |
COLLIVERY | |
COMET_TECH | |
CONTINENTAL | |
CON_WAY | |
COORDINADORA | |
COPA_COURIER | |
COPE | |
CORPORATECOURIERS_WEBHOOK | |
CORREOS_DE_MEXICO | |
CORREOS_ES | |
CORREOS_EXPRESS | |
CORREO_UY | |
COSTMETICSNOW | |
COURANT_PLUS | |
COUREX | |
COURIERS_PLEASE | |
CPACKET | |
CPEX | |
CROSHOT | |
CSE | |
CTC_EXPRESS | |
CUBYN | |
CUCKOOEXPRESS | |
CYPRUS_POST_CYP | |
DAIGLOBALTRACK | |
DAJIN | |
DANSKE_FRAGT | |
DAWN_WING | |
DAYTON_FREIGHT | |
DBSCHENKER_B2B | |
DBSCHENKER_SE | |
DBSCHENKER_SV | |
DDEXPRESS | |
DEALERSEND | |
DELIVERYONTIME | |
DELNEXT | |
DELTEC_UK | |
DEMANDSHIP | |
DESCARTES | |
DESIGNERTRANSPORT_WEBHOOK | |
DESTINY | |
DEX_I | |
DE_ASENDIA | |
DE_DEUTSCHE | |
DE_DEUTSCHE_POST_DHL_WITHIN_EUROPE_TRACKNET | |
DE_DHL_EXPRESS | |
DE_DPD_DELISTRACK | |
DE_GLS | |
DHL | |
DHL_ACTIVE_TRACING | |
DHL_AU | |
DHL_BENELUX | |
DHL_ECOMERCE_ASA | |
DHL_ES | |
DHL_FR | |
DHL_FREIGHT | |
DHL_GLOBAL_MAIL_ASIA | |
DHL_HK | |
DHL_JP | |
DHL_PARCEL_ES | |
DHL_PARCEL_NL | |
DHL_PARCEL_RU | |
DHL_PL | |
DHL_REFR | |
DHL_SG | |
DHL_SUPPLY_CHAIN | |
DHL_UK | |
DIAMOND_EUROGISTICS | |
DICOM | |
DIDADI | |
DIMERCO | |
DIRECTCOURIERS | |
DIRECTLOG | |
DIRECTPARCELS | |
DMM_NETWORK | |
DMS_MATRIX | |
DOBROPOST | |
DOORA | |
DOORDASH_WEBHOOK | |
DPD | DPD. |
DPD_DELISTRACK | |
DPD_FR | |
DPD_HGRY | |
DPD_HK | |
DPD_IR | |
DPD_LOCAL | |
DPD_LOCAL_REF | |
DPD_POLAND | |
DPD_RO | |
DPD_RU | |
DPEX | |
DPE_EXPRESS | |
DPE_SOUTH_AFRC | |
DSV | |
DTDC_AU | |
DTDC_EXPRESS | |
DTDC_IN | |
DTD_EXPR | |
DX_SFTP | |
DYLT | |
DYNALOGIC | |
EASY_MAIL | |
ECEXPRESS | |
ECHO | |
ECMS | |
ECOSCOOTING | |
EFEX | |
EFS | |
EKART | |
ELIAN_POST | |
EMPS_CN | |
ENDEAVOUR_DELIVERY | |
ENVIALIA_REFERENCE | |
EPARCEL_KR | |
EPST_GLBL | ePost Global |
EP_BOX | |
ESHIPPING | |
ESP_ASM | |
ESP_ENVIALIA | |
ESP_MRW | |
ESP_NACEX | |
ESP_PACKLINK | |
ESP_REDUR | |
ETOMARS | |
ETOTAL | |
ETS_EXPRESS | |
EU_FLEET_SOLUTIONS | |
EU_IMX | |
EXPRESSSALE | |
EZSHIP | |
FARGOOD | |
FAR_INTERNATIONAL | |
FASTRACK | |
FASTRK_SERV | |
FASTWAY_IR | |
FASTWAY_NZ | |
FDSEXPRESS | |
FEDEX | |
FEDEX_CROSSBORDER | |
FEDEX_FR | |
FEDEX_INTL_MLSERV | |
FEDEX_POLAND | |
FEDEX_UK | |
FETCHR_WEBHOOK | |
FIEGE | |
FIEGE_NL | |
FIRSTMILE | |
FLASHEXPRESS | |
FMX | FMX. |
FONSEN | |
FORRUN | |
FREIGHTQUOTE | |
FRETERAPIDO | |
FR_BERT | |
FR_COLIS | |
FR_EXAPAQ | |
FR_GEODIS | |
FR_GLS | |
FULFILLA | |
FULFILLME | |
FURDECO | |
GAC | GAC. |
GANGBAO | |
GBA | |
GBS_BROKER | |
GB_APC | |
GB_ARROW | |
GB_NORSK | |
GB_PANTHER | |
GB_TUFFNELLS | |
GEIS | |
GEL_EXPRESS | |
GEMWORLDWIDE | |
GENERAL_OVERNIGHT | |
GENIKI_GR | |
GEODIS_ESPACE | |
GESWL | |
GIAO_HANG | |
GIO_EXPRESS | |
GLOBALTRANZ | |
GLOBAL_ABF | |
GLOBAL_ESTES | |
GLOBAL_EXPRESS | |
GLOBAL_IPARCEL | |
GLOBAL_TNT | |
GLOBAVEND | |
GLS_CROTIA | |
GLS_CZ | |
GLS_IT | |
GLS_ITALY | |
GLS_SLOV | |
GLS_SLOVEN | |
GOGLOBALPOST | |
GOJEK | |
GRAB_WEBHOOK | |
GRUPO | |
GR_ELTA | |
GSI_EXPRESS | |
GSO | |
HAPPY2POINT | Happy 2ThePoint |
HCT_LOGISTICS | |
HDB | |
HDB_BOX | |
HELLMANN | |
HELTHJEM | |
HEPPNER | |
HEPPNER_FR | |
HERMES | |
HERMES_2MANN_HANDLING | |
HERMES_DE | |
HH_EXP | |
HIPSHIPPER | |
HKD | |
HK_FLYT_EXPRESS | |
HK_FOUR_PX_EXPRESS | |
HK_POST | |
HK_TGX | |
HOLISOL | |
HOME_DELIVERY_SOLUTIONS | |
HOUNDEXPRESS | |
HRPARCEL | |
HRV_HRVATSKA | |
HUAHAN_EXPRESS | |
HUNTER_EXPRESS | |
HUODULL | |
HX_EXPRESS | |
IBEONE | |
ICUMULUS | |
IDEXPRESS | |
IDN_JNE | |
IDN_LION_PARCEL | |
IDN_PANDU | |
IML | |
INDOPAKET | |
IND_BLUEDART | |
IND_DELHIVERY | |
IND_DELIVREE | |
IND_DOTZOT | |
IND_ECOM | |
IND_FIRSTFLIGHT | |
IND_GATI | |
IND_GOJAVAS | |
IND_JAYONEXPRESS | |
IND_PROFESSIONAL_COURIERS | |
IND_SAFEEXPRESS | |
IND_XPRESSBEES | |
INPOST_PACZKOMATY | |
INTEGRA2_FTP | |
INTELIPOST | |
INTEL_VALLEY | |
INTERPARCEL_AU | |
INTERPARCEL_NZ | |
INTERPARCEL_UK | |
INTEXPRESS | |
ISRAEL_POST | |
ISR_POST_DOMESTIC | |
IT_DHL_ECOMMERCE | |
IT_FERCAM | |
IT_NEXIVE | |
IT_POSTE_ITALIA | |
IT_TNT | |
IVOY_WEBHOOK | |
I_DIKA | |
JANCO | |
JANIO | |
JERSEY_POST | |
JET_SHIP | |
JINDOUYUN | |
JINSUNG | |
JOCOM | |
JOOM_LOGIS | |
JOYING_BOX | |
JPN_JAPAN_POST | |
JPN_SAGAWA | |
JP_KURO_NEKO_YAMATO_UNYUU | |
JS_EXPRESS | |
JTEXPRESS | |
JTEXPRESS_VN | |
JX | |
J_NET | |
K1_EXPRESS | |
KANGAROO_MY | |
KEC | |
KERRYTJ | |
KERRYTTC_VN | |
KERRY_ECOMMERCE | |
KGMHUB | |
KHM_CAMBODIA_POST | |
KOR_ECARGO | |
KPOST | |
KR_KOREA_POST | |
KUEHNE | |
KURASI | |
KWE_GLOBAL | |
KWT | |
KYUNGDONG_PARCEL | |
KY_EXPRESS | |
LALAMOVE | |
LANDMARK_GLOBAL | |
LANDMARK_GLOBAL_REFERENCE | |
LAO_POST | |
LATVIJAS_PASTS | |
LA_POSTE_SUIVI | |
LBCEXPRESS_FTP | |
LEADER | |
LEGION_EXPRESS | |
LEXSHIP | |
LHT_EXPRESS | |
LICCARDI_EXPRESS | |
LIEFERY | |
LINE | |
LINKBRIDGE | |
LOCUS_WEBHOOK | |
LOGISTERS | |
LOGISTICSWORLDWIDE_HK | |
LOGISTIKA | |
LOGISTYX_TRANSGROUP | |
LONESTAR | |
LOOMIS_EXPRESS | |
LOTTE | |
LTIANEXP | |
LTL | |
LTU_LIETUVOS | |
MAGYAR_HU | |
MAILAMERICAS | |
MAILPLUS_JPN | |
MAIL_PLUS | |
MAINFREIGHT | |
MAINWAY | |
MARA_XPRESS | |
MATDESPATCH | |
MATKAHUOLTO | |
MBW | |
MEX_AEROFLASH | |
MEX_ESTAFETA | |
MEX_REDPACK | |
MEX_SENDA | |
MGLOBAL | |
MIKROPAKKET | |
MIKROPAKKET_BE | |
MILKMAN | |
MORE_LINK | |
MORNING_EXPRESS | |
MRW_FTP | |
MXE | |
MX_CARGO | |
MYHERMES | |
MYS_AIRPAK | |
MYS_EMS | |
MYS_GDEX | |
MYS_MYPOST_ONLINE | |
MYS_MYS_POST | |
MYS_SKYNET | |
M_XPRESS | |
NACEX | |
NACEX_ES | |
NANJINGWOYUAN | |
NATIONAL_SAMEDAY | |
NATIONEX | |
NATIONWIDE_MY | Nationwide Express Courier Services Bhd (www.nationwide.com.my). |
NEWAY | |
NEWEGGEXPRESS | |
NEWGISTICS | |
NEWZEALAND_COURIERS | |
NG_COURIERPLUS | |
NHANS_SOLUTIONS | |
NIM_EXPRESS | |
NINJAVAN_ID | |
NINJAVAN_MY | |
NINJAVAN_SG | |
NINJAVAN_THAI | |
NINJAVAN_WB | |
NIPOST_NG | |
NLD_DHL | |
NLD_GLS | |
NLD_POSTNL | |
NLD_TRANSMISSION | |
NOVA_POSHTA | |
NOVA_POSHTA_INT | |
NOX_NACHTEXPRESS | |
NOX_NIGHT_TIME_EXPRESS | |
NTLOGISTICS_VN | |
NZ_COURIER_POST | |
NZ_NZ_POST | |
OCS | |
OCS_WORLDWIDE | |
OKAYPARCEL | |
OMNIPARCEL | |
OMNIVA | |
ONECLICK | |
ONEWORLDEXPRESS | |
ORANGE_DS | |
OSM_WORLDWIDE | |
OVERSE_EXP | |
P2P_TRC | |
PAACK_WEBHOOK | |
PADTF | |
PAGO | |
PALEXPRESS | |
PALLETWAYS | |
PALLET_NETWORK | |
PANTHER_REFERENCE | |
PAN_ASIA | |
PAPERFLY | |
PAPER_EXPRESS | |
PAQUETEXPRESS | |
PARCEL2GO | |
PARCELINKLOGISTICS | |
PARCELLED_IN | |
PARCELONE | |
PARCELPAL_WEBHOOK | |
PARCELPOINT | |
PARCELPOST_SG | |
PARCEL_2_POST | |
PARKNPARCEL | |
PCFCORP | |
PFCEXPRESS | |
PFLOGISTICS | PFL. |
PHL_AIR21 | |
PHL_AIRSPEED | |
PHL_JAMEXPRESS | |
PICKRR | |
PICKUP | |
PICKUPP_MYS | |
PICKUPP_SGP | |
PILOT_FREIGHT | |
PIL_LOGISTICS | |
PITNEY_BOWES | |
PITTOHIO | |
PIXSELL | |
PLANZER | |
PLUS_LOG_UK | |
PL_POCZTA_POLSKA | |
POL_SIODEMKA | |
PONY_EXPRESS | |
POSTA_PLUS | |
POSTA_RO | |
POSTA_UKR | |
POSTEN_NORGE | |
POSTI | |
POSTNL_INTL_3S | |
POSTNL_INT_3_S | |
POSTNORD_LOGISTICS | |
POSTNORD_LOGISTICS_DK | |
POSTUR_IS | |
POST_SERBIA | |
POST_SLOVENIA | |
PRESIDENT_TRANS | |
PRESSIODE | |
PRIMAMULTICIPTA | |
PROMEDDELIVERY | |
PRT_CHRONOPOST | |
PRT_CTT | |
PRT_INT_SEUR | |
PRT_SEUR | |
PTS | |
PTT_POST | |
QUANTIUM | |
QWINTRY | |
RABEN_GROUP | |
RAF_PH | |
RAIDEREX | |
RAM | |
RCL | |
RINCOS | |
RL_US | |
ROADBULL | |
ROADRUNNER_FREIGHT | |
ROCKET_PARCEL | |
ROUTIFIC_WEBHOOK | |
ROYAL_MAIL | |
RPD2MAN | |
RPX | |
RPXLOGISTICS | |
RPX_ID | |
RUSSIAN_POST | |
RUSTON | |
RZYEXPRESS | |
SAIA_FREIGHT | |
SAILPOST | |
SAP_EXPRESS | |
SAU_SAUDI_POST | |
SCUDEX_EXPRESS | |
SDA_IT | |
SDH_SCM | lightning monkey |
SEFL | |
SEINO | |
SEKOLOGISTICS | |
SEKO_SFTP | |
SENDING | |
SENDIT | |
SENDLE | |
SEUR_ES | |
SEUR_SP_API | |
SFB2C | |
SFCSERVICE | |
SFC_LOGISTICS | SFC. |
SFPLUS_WEBHOOK | |
SF_EX | |
SG_DETRACK | |
SG_QXPRESS | |
SG_SG_POST | |
SG_SPEEDPOST | |
SG_TAQBIN | |
SHENZHEN | |
SHIPENTEGRA | |
SHIPPIT | |
SHIPTER | |
SHIPTOR | |
SHIP_GATE | |
SHIP_IT_ASIA | |
SHOPFANS | |
SHREENANDANCOURIER | |
SHREETIRUPATI | |
SHREE_ANJANI_COURIER | |
SHREE_MARUTI | |
SIMPLYPOST | |
SINOTRANS | |
SIN_GLBL | |
SKYBOX | |
SKYNET_UAE | |
SKYNET_UK | |
SKYNET_WORLDWIDE | |
SKYNET_ZA | |
SKY_POSTAL | |
SK_POSTA | |
SMG_EXPRESS | |
SMOOTH | |
SMSA_EXPRESS | |
SONICTL | |
SOUTH_AFRICAN_POST_OFFICE | |
SPEEDCOURIERS_GR | |
SPEEDEE | |
SPEEDEXCOURIER | |
SPOTON | |
SPRING_GDS | |
SRE_KOREA | |
STALLIONEXPRESS | |
STARKEN | |
STAR_TRACK_EXPRESS | |
STAR_TRACK_NEXT_FLIGHT | |
STEPFORWARDFS | |
STONE3PL | |
STRECK_TRANSPORT | |
SUTTON | |
SWE_POSTNORD | |
SWISHIP_DE | |
SWISS_POST_FTP | |
SYPOST | |
SZENDEX | |
TAQBIN_HK | |
TAQBIN_MY | |
TARRIVE | |
TAZMANIAN_FREIGHT | |
TCK_EXPRESS | |
TCS | |
TFM | |
TFORCE_FINALMILE | |
THABIT_LOGISTICS | |
THA_DYNAMIC_LOGISTICS | |
THA_KERRY | |
THA_THAILAND_POST | |
THECOURIERGUY | |
THEDELIVERYGROUP | |
THENILE_WEBHOOK | |
TIGFREIGHT | |
TIKI_ID | |
TIPSA | |
TNT | |
TNT_CLICK_IT | |
TNT_FR | |
TNT_NL | |
TNT_REFR | |
TNT_UK | |
TNT_UK_REFR | |
TOLL | |
TOLL_NZ | |
TOLOS | |
TOPHATTEREXPRESS | |
TOPYOU | |
TOTAL_EXPRESS | |
TOURLINE | |
TRACKON | |
TRANS_KARGO | |
TRUMPCARD | |
TRUNKRS_WEBHOOK | |
TUFFNELLS_REFERENCE | |
TWO_GO | |
TW_TAIWAN_POST | |
UBI_LOGISTICS | |
UC_EXPRE | |
UDS | |
UK_COLLECTPLUS | |
UK_DPD | |
UK_NIGHTLINE | |
UK_PARCELFORCE | |
UK_UK_MAIL | |
UK_XDP | |
UK_YODEL | |
UPS | |
UPS_FREIGHT | |
UPS_MAIL_INNOVATIONS | |
UPS_REFERENCE | |
USF_REDDAWAY | |
USHIP | |
USPS | |
US_ENSENDA | |
US_GLOBEGISTICS | |
US_LASERSHIP | |
US_OLD_DOMINION | |
US_ONTRAC | |
US_YRC | |
VAMOX | |
VENIPAK | |
VIAEUROPE | |
VIA_EXPRESS | |
VIRTRANSPORT | |
VIWO | |
VNM_VIETNAM_POST | |
VNM_VIETTELPOST | |
WAHANA_ID | |
WANBEXPRESS | |
WEASHIP | |
WEPOST | |
WESTBANK_COURIER | |
WESTGATE_GL | |
WHISTL | |
WINIT | |
WISELOADS | |
WISE_EXPRESS | |
WIZMO | |
WMG | |
WNDIRECT | |
WYNGS | |
XDE_WEBHOOK | |
XDP_UK_REFERENCE | |
XL_EXPRESS | |
XPERT_DELIVERY | |
XPOST | |
XPO_LOGISTICS | |
XPRESSEN_DK | |
XQ_EXPRESS | |
YAKIT | |
YANWEN | |
YDH_EXPRESS | |
YINGNUO_LOGISTICS | |
YODEL_DIR | |
YODEL_INTNL | |
YTO | |
YUNEXPRESS | |
YURTICI_KARGO | |
YUSEN | |
ZAJIL_EXPRESS | |
ZA_COURIERIT | |
ZA_FASTWAY | |
ZA_SPECIALISED_FREIGHT | |
ZEEK_2_DOOR | |
ZELERIS | |
ZEPTO_EXPRESS | |
ZES_EXPRESS | |
ZIINGFINALMILE | |
ZINC | |
ZJS_EXPRESS | |
ZTO_EXPRESS | |
ZYLLEM |
"2EBOX"
A date and time, in Internet date and time format.
Note: The regular expression provides guidance but does not reject all invalid dates.
A date and time, in Internet date and time format.
Note: The regular expression provides guidance but does not reject all invalid dates.
"stringstringstringst"
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGB
and notUK
as used in the top-level domain names for that country. Use theC2
country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
"st"
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.
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.
"stringstri"
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.
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"
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.
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"
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"
}
]
}
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 |
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. |
{- "field": "string",
- "value": "string",
- "location": "body",
- "issue": "string",
- "description": "string"
}
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:
| ||||||
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 .
|
{- "estimated_delivery_date": "string",
- "provider_type": "CARRIER"
}
The type of intent.
The type of intent.
Enum: | 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"
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 |
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. |
{- "href": "string",
- "rel": "string",
- "method": "GET"
}
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 |
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. |
{- "href": "string",
- "rel": "string",
- "method": "GET"
}
The JSON patch object to apply partial updates to resources.
op required | string The operation.
| ||||||||||||||||||||||||||
path | string The JSON Pointer to the target document location at which to complete the operation. | ||||||||||||||||||||||||||
value | object (Patch Value) The value to apply. The | ||||||||||||||||||||||||||
from | string The JSON Pointer to the target document location from which to move the value. Required for the |
{- "op": "add",
- "path": "string",
- "value": { },
- "from": "string"
}
The account identifier for a PayPal account.
The account identifier for a PayPal account.
"stringstrings"
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, |
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 |
admin_area_4 | string <= 100 characters The neighborhood, ward, or district. Smaller than
|
admin_area_3 | string <= 100 characters A sub-locality, suburb, neighborhood, or district. Smaller than
|
admin_area_2 | string <= 120 characters A city, town, or village. Smaller than |
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,
|
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 |
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. |
{- "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"
}
}
The type of entity that provided the info. It could be an aggregator or carrier.
The type of entity that provided the info. It could be an aggregator or carrier.
Enum: | Description |
---|---|
CARRIER | Provider Type Carrier. |
AGGREGATOR | Provider Type Aggregator. |
"CARRIER"
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.
| ||||||||||||||||||||||||||||
object (Portable Postal Address (Medium-Grained)) The address details when the scan was made. | |||||||||||||||||||||||||||||
date_time | string <ppaas_date_time_v3> (date_time_v4) [ 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": "stringstringstringst"
}
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. | |||||||||||||||||||||||||||||
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.
| ||||||||||||||||||||||||||||
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",
- "provider_type": "CARRIER"
}
], - "estimated_delivery_date": "string",
- "delivery_date": "string",
- "ship_date": "string",
- "shipment_status": "PENDING",
- "created_date": "string",
- "updated_date": "string"
}
Status for the shipment.
Status for the shipment.
Enum: | 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"
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.
|
{- "weight": "string",
- "package_count": "string",
- "weight_units": "LBS"
}
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_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 To denote whether the shipment is sent forward to the receiver or returned back.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipment_uploader | string [ 1 .. 50 ] characters To denote which party uploaded the shipment tracking info.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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) An array of request-related HATEOAS links. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tracking_number_type | string (tracking_number_type) [ 1 .. 64 ] characters The type of tracking number.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status required | string (tracking_status) [ 1 .. 64 ] characters The status of the item shipment. For allowed values, see Shipping Statuses.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
carrier | string (carrier) [ 1 .. 64 ] characters The carrier for the shipment. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
], - "tracking_number_type": "CARRIER_PROVIDED",
- "status": "CANCELLED",
- "shipment_date": "string",
- "carrier": "2EBOX",
- "last_updated_time": "string"
}
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) 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",
- "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"
}
]
}
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) An array of request-related HATEOAS links. |
{- "transaction_id": "string",
- "tracking_number": "string",
- "links": [
- {
- "href": "string",
- "rel": "string",
- "method": "GET"
}
]
}
The tracking number type.
The tracking number type.
Enum: | Description |
---|---|
CARRIER_PROVIDED | A merchant-provided tracking number. |
E2E_PARTNER_PROVIDED | A marketplace-provided tracking number. |
"CARRIER_PROVIDED"
The status of the item shipment. For allowed values, see Shipping Statuses.
The status of the item shipment. For allowed values, see Shipping Statuses.
Enum: | 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"