Appearance
Shipment Tracking(1)
?This API is currently not supported by our SDK
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.
operation/trackers-batch.post Add tracking information for multiple PayPal transactions
post/v1/shipping/trackers-batch
Try it
Deprecation notice: Adding tracking details for an order through
/v1/shipping/trackers-batchis 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/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json
| trackers | 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
application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json
Sample 1 - 201 - Add Tracking InformationSample 1 - 201 - Add Tracking Information
Copy
Expand allCollapse all
`{"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
- 201
application/json
Sample 1 - 201 - Add Tracking InformationSample 1 - 201 - Add Tracking Information
Copy
Expand allCollapse all
`{"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"
}
]
}
]
}`
operation/trackers.post Add tracking information for PayPal transaction
post/v1/shipping/trackers
Try it
Adds tracking information for a PayPal transaction.
SecurityOauth2
Request
Request Body schema: application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json
| trackers | 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
application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json
Sample 1 - 201 - Add Tracking InformationSample 1 - 201 - Add Tracking Information
Copy
Expand allCollapse all
`{"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
- 201
application/json
Sample 1 - 201 - Add Tracking InformationSample 1 - 201 - Add Tracking Information
Copy
Expand allCollapse all
`{"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"
}
]
}`
operation/trackers-batch.get List tracking information
get/v1/shipping/trackers
Try it
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/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/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
application/jsonmultipart/relatedmultipart/form-datamultipart/mixedapplication/json
Copy
{ }
Response samples
- 200
application/json
Sample 1 - 200 - Show Tracking InformationSample 1 - 200 - Show Tracking Information
Copy
Expand allCollapse all
`{"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"
}
]
}`
operation/trackers.put Update or cancel tracking information for PayPal transaction
put/v1/shipping/trackers/
Try it
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. A maximum of 5 updates are allowed for each tracking information. For more information, see Update or cancel tracking information.
SecurityOauth2
Request
path Parameters
| id 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. This property supports only ASCII characters and does not allow URL, phone number, or email formats. Carrier information (carrier) is required if a 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. |
| fulfillment_provider | string[ 1 .. 64 ] characters^.*$ Indicates the fulfillment service used to deliver an order. |
| 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]|...Show pattern 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. |
| 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]|...Show pattern 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
Sample 1 - 204 - Cancel Tracking InformationSample 1 - 204 - Cancel Tracking Information
Copy
`{"transaction_id": "8MC585209K746392H",
"tracking_number": "443844607820",
"status": "CANCELLED",
"carrier": "FEDEX"
}`
Response samples
- 204
application/json
Sample 1 - 204 - Cancel Tracking InformationSample 1 - 204 - Cancel Tracking Information
Copy
{ }
operation/trackers.get Show tracking information
get/v1/shipping/trackers/
Try it
Shows tracking information, by tracker ID, for a PayPal transaction.
SecurityOauth2
Request
path Parameters
| id 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
Copy
curl -v -X GET https://api-m.sandbox.paypal.com/v1/shipping/trackers/8MC585209K746392H-443844607820?account_id=TELFDNSFY96RY \
-H 'Content-Type: application/json'Response samples
- 200
application/json
Sample 1 - 200 - Show Tracking InformationSample 1 - 200 - Show Tracking Information
Copy
Expand allCollapse all
`{"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"
}
]
}`
tag/Errors Errors
section/INPUT_VALIDATION_ERROR INPUT_VALIDATION_ERROR
Message:
Transaction ID specified is invalid.
Description: Re-check the transaction ID.
section/INTERNAL_SERVER_ERROR 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.
section/NOT_AUTHORIZED NOT_AUTHORIZED
Message:
Authorization failed due to insufficient permissions.
Description: The caller does not have the correct permissions to authorize the payment.
section/RESOURCE_NOT_FOUND RESOURCE_NOT_FOUND
Message:
The specified resource does not exist.
Description: The resource does not exist.
tag/Definitions Definitions
schema/aggregator_carrier_details Aggregator carrier details
Defines the aggregator carrier details associated with the PayPal supported shipping carrier.
| provider_carrier_name | string[ 1 .. 150 ] characters^[a-zA-Z]+(-[a-zA-Z]+)*$
The unique name of the carrier provided by the aggregator. | | mandatory_fields | Array of strings[ 1 .. 10 ] items
A list of essential fields that are required for tracking the carrier’s shipments. | | active | boolean
Indicates whether the carrier is currently active and available for use. | | shipping_data_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. |
Copy
Expand allCollapse all
`{"provider_carrier_name": "string",
"mandatory_fields": ["string"
],
"active": true,
"shipping_data_provider_name": "AFTERSHIP"
}`
schema/batch_tracker_collection batch_tracker_collection
The add tracking information for multiple PayPal transactions response details.
| tracker_identifiers | Array of objects (tracker_identifier) [ 1 .. 100 ] items The batch header. |
| errors | Array of objects (Error) [ 1 .. 100 ] items An array of error responses. |
| links | Array of objects (Link Description) = 1 items An array of request-related HATEOAS links. |
Copy
Expand allCollapse all
`{"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"
}
]
}`
schema/carrier carrier
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.
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.
Copy
"string"
schema/shipping_carrier Carrier Detail
Detail about the carrier.
| id | string[ 1 .. 64 ] characters^.*$ Unique identifier for a carrier. |
| carrier_name | string[ 1 .. 150 ] characters^[A-Z0-9_]+$ The unique name of the shipping carrier, typically derived from the associated aggregator's slug. |
| name | string[ 1 .. 150 ] characters^.*$ Universal name for a carrier. |
| logo_url | string<uri>[ 1 .. 100 ] characters^.*$ Logo URL Information. |
| country_codes | Array of strings<ppaas_common_country_code_v2> (country_code) [ 1 .. 20 ] items An array of country codes representing the countries where the carrier operates or provides services. |
| active | boolean Indicates whether the carrier is currently active and available for use. |
| aggregator_carrier_details | Array of objects (Aggregator carrier details) [ 1 .. 10 ] items Defines the aggregator carrier details associated with the PayPal supported shipping carrier. |
| carrier_contact | object (Contact Info) Carrier contact information. |
| contact_info | object (Contact Info) Comprehensive contact information of the carrier for support or operational inquiries. |
Copy
Expand allCollapse all
`{"id": "string",
"carrier_name": "string",
"name": "string",
"logo_url": "http://example.com",
"country_codes": ["string"
],
"active": true,
"aggregator_carrier_details": [{"provider_carrier_name": "string",
"mandatory_fields": ["string"
],
"active": true,
"shipping_data_provider_name": "AFTERSHIP"
}
],
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
},
"contact_info": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
}`
schema/carrier_contact Contact Info
Contact detail about the carrier.
| contact_numbers | 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. |
Copy
Expand allCollapse all
`{"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}`
schema/country_code country_code
The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain is
GBand notUKas used in the top-level domain names for that country. Use theC2country 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
GBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
Copy
"st"
schema/date_no_time date_no_time
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.
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]|...Show pattern
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.
Copy
"stringstri"
schema/date_time 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]|...Show pattern
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.
Copy
"stringstringstringst"
schema/date_time_v4 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]|...Show pattern
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.
Copy
"stringstringstringst"
schema/error 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. |
| details | Array of objects (Error Details) An array of additional details about the error. |
| links | Array of objects (Link Description) An array of request-related HATEOAS links. |
Copy
Expand allCollapse all
`{"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"
}
]
}`
schema/error_details 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. |
| links | 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. |
Copy
Expand allCollapse all
`{"field": "string",
"value": "string",
"location": "body",
"issue": "string",
"description": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}`
schema/estimated_delivery_date 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]|...Show pattern
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]|...Show pattern
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
. | | earliest_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]|...Show pattern
The earliest possible delivery date and time when the shipment is expected to arrive at the delivery location Following is possible format:
- YYYY-MM-DD
- YYYY-MM-DDTHH:mm:ss
- YYYY-MM-DDTHH:mm:ssZ
. | | latest_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]|...Show pattern
The latest possible delivery date and time when the shipment is expected to arrive at the delivery location. 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. |
Copy
`{"estimated_delivery_date": "string",
"estimated_delivery_time": "string",
"earliest_delivery_time": "string",
"latest_delivery_time": "string",
"provider_type": "CARRIER"
}`
schema/intent 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 |
Copy
"CONSUMER_SHIPMENT_TRACKING"
schema/link_description 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" |
Copy
`{"href": "string",
"rel": "string",
"method": "GET"
}`
schema/link_description_v3 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" |
Copy
`{"href": "string",
"rel": "string",
"method": "GET"
}`
schema/patch Patch
The JSON patch object to apply partial updates to resources.
| op
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. |
Copy
`{"op": "add",
"path": "string",
"value": null,
"from": "string"
}`
schema/account_id 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.
Copy
"stringstrings"
schema/phone 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. |
Copy
`{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}`
schema/address_portable 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. |
| address_details | 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. |
Copy
Expand allCollapse all
`{"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"
}
}`
schema/provider_type 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. |
Copy
"CARRIER"
schema/shipment_scan 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_description | string[ 1 .. 255 ] characters^[\S\s]*$
A detailed textual description of the status of the shipment 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. |
| scanned_address | 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]|...Show pattern Date and time at which the scan was made. |
Copy
Expand allCollapse all
`{"description": "string",
"status_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"
}`
schema/shipment_data_provider 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. |
Copy
`{"provider_type": "CARRIER",
"provider_name": "AFTERSHIP"
}`
schema/shipment_data_provider_name 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. |
Copy
"AFTERSHIP"
schema/shipment_data_provider_type 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. |
Copy
"CARRIER"
schema/shipment 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. | | estimated_delivery_dates | 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. | | shipment_status_description | string[ 1 .. 255 ] characters^[\S\s]*$
Descriptive status of the shipment. | | fulfillment_provider | string[ 1 .. 64 ] characters^.*$
Indicates the fulfillment service used to deliver an order. | | shipment_scan | 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. | | shipping_carrier | 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. | | recommended_shipping_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]|...Show pattern
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]|...Show pattern
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]|...Show pattern
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. |
| sender_address | object (Portable Postal Address (Medium-Grained)) Sender address of the shipment. |
| destination_address | object (Portable Postal Address (Medium-Grained)) Destination address of the shipment. |
| origin_scan_detail | object (Scan Details) Details of the origin scan or the origin hub where the shipment scanned first. |
| destination_scan_detail | 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]|...Show pattern 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]|...Show pattern 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]|...Show pattern 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]|...Show pattern date of the shipment updated. |
Copy
Expand allCollapse all
`{"transaction_id": "string",
"tracking_id": "string",
"package_name": "string",
"estimated_delivery_dates": [{"estimated_delivery_date": "string",
"estimated_delivery_time": "string",
"earliest_delivery_time": "string",
"latest_delivery_time": "string",
"provider_type": "CARRIER"
}
],
"shipment_status_description": "string",
"fulfillment_provider": "string",
"shipment_scan": [{"description": "string",
"status_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",
"carrier_name": "string",
"name": "string",
"logo_url": "http://example.com",
"country_codes": ["string"
],
"active": true,
"aggregator_carrier_details": [{"provider_carrier_name": "string",
"mandatory_fields": ["string"
],
"active": true,
"shipping_data_provider_name": "AFTERSHIP"
}
],
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
},
"contact_info": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
},
"recommended_shipping_carrier": {"id": "string",
"carrier_name": "string",
"name": "string",
"logo_url": "http://example.com",
"country_codes": ["string"
],
"active": true,
"aggregator_carrier_details": [{"provider_carrier_name": "string",
"mandatory_fields": ["string"
],
"active": true,
"shipping_data_provider_name": "AFTERSHIP"
}
],
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
},
"contact_info": {"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_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_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"
}`
schema/shipment_status 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. |
Copy
"PENDING"
schema/shipment_tracking_response Shipment Tracking
Shipment info and its status indicating success or failure of the operation.
| shipment_tracking | object (Shipment Tracking) Shipment tracking Info. |
| status | object (Status) The information about the success or failure of the operation. |
Copy
Expand allCollapse all
`{"shipment_tracking": {"transaction_id": "string",
"shipment_id": "string",
"tracking_number": "string",
"carrier": "string"
},
"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"
}
]
}
}
}`
schema/shipment_tracking 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. |
Copy
`{"transaction_id": "string",
"shipment_id": "string",
"tracking_number": "string",
"carrier": "string"
}`
schema/shipment_tracker shipment_tracker
Real Time Tracking Details of the Shipment.
| package_id | string[ 1 .. 64 ] characters^[a-zA-Z0-9]+$
Tracking number for the shipment. | | id | string[ 1 .. 64 ] characters^[a-zA-Z0-9]+$
Reference number for the shipment to track. | | status_description | string[ 1 .. 255 ] characters^[\S\s]*$
Descriptive status of the shipment. | | estimated_delivery_dates | 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. | | scans | 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. | | fulfillment_provider | string[ 1 .. 64 ] characters^.*$
Indicates the fulfillment service used to deliver an order. | | 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. |
| provided_carrier | 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. |
| recommended_shipping_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. |
| package_specification | 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]|...Show pattern 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]|...Show pattern 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]|...Show pattern The reattempted date for the package. |
| destination_address | object (Portable Postal Address (Medium-Grained)) The destination address of the shipment. |
| sender_address | object (Portable Postal Address (Medium-Grained)) The sender address for the shipment. |
| provider_details | 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]|...Show pattern 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]|...Show pattern 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]|...Show pattern 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]|...Show pattern Date and Time when the shipment is last updated. |
Copy
Expand allCollapse all
`{"package_id": "string",
"id": "string",
"status_description": "string",
"estimated_delivery_dates": [{"estimated_delivery_date": "string",
"estimated_delivery_time": "string",
"earliest_delivery_time": "string",
"latest_delivery_time": "string",
"provider_type": "CARRIER"
}
],
"receiver_name": "string",
"service_name": "string",
"carrier_tracking_link": "http://example.com",
"scans": [{"description": "string",
"status_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",
"fulfillment_provider": "string",
"return_to_sender": "TRUE",
"shipment_id": "string",
"provided_carrier": {"id": "string",
"carrier_name": "string",
"name": "string",
"logo_url": "http://example.com",
"country_codes": ["string"
],
"active": true,
"aggregator_carrier_details": [{"provider_carrier_name": "string",
"mandatory_fields": ["string"
],
"active": true,
"shipping_data_provider_name": "AFTERSHIP"
}
],
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
},
"contact_info": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
},
"recommended_shipping_carrier": {"id": "string",
"carrier_name": "string",
"name": "string",
"logo_url": "http://example.com",
"country_codes": ["string"
],
"active": true,
"aggregator_carrier_details": [{"provider_carrier_name": "string",
"mandatory_fields": ["string"
],
"active": true,
"shipping_data_provider_name": "AFTERSHIP"
}
],
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
},
"contact_info": {"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"
}`
schema/shipment_tracking_request 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 |
Copy
`{"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"
}`
schema/track_shipment_response shipment_trackings_response
Real time tracking information of a shipment.
| shipment | object (shipment_tracker) Latest Shipment information. |
| error | object (Error) Details on the failure if the tracking attempt failed. |
Copy
Expand allCollapse all
`{"shipment": {"package_id": "string",
"id": "string",
"status_description": "string",
"estimated_delivery_dates": [{"estimated_delivery_date": "string",
"estimated_delivery_time": "string",
"earliest_delivery_time": "string",
"latest_delivery_time": "string",
"provider_type": "CARRIER"
}
],
"receiver_name": "string",
"service_name": "string",
"carrier_tracking_link": "http://example.com",
"scans": [{"description": "string",
"status_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",
"fulfillment_provider": "string",
"return_to_sender": "TRUE",
"shipment_id": "string",
"provided_carrier": {"id": "string",
"carrier_name": "string",
"name": "string",
"logo_url": "http://example.com",
"country_codes": ["string"
],
"active": true,
"aggregator_carrier_details": [{"provider_carrier_name": "string",
"mandatory_fields": ["string"
],
"active": true,
"shipping_data_provider_name": "AFTERSHIP"
}
],
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
},
"contact_info": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
}
},
"recommended_shipping_carrier": {"id": "string",
"carrier_name": "string",
"name": "string",
"logo_url": "http://example.com",
"country_codes": ["string"
],
"active": true,
"aggregator_carrier_details": [{"provider_carrier_name": "string",
"mandatory_fields": ["string"
],
"active": true,
"shipping_data_provider_name": "AFTERSHIP"
}
],
"carrier_contact": {"contact_numbers": [{"country_code": "str",
"national_number": "string",
"extension_number": "string"
}
],
"website_url": "http://example.com"
},
"contact_info": {"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"
}
]
}
}`
schema/shipping_package_specification 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. |
Copy
`{"weight": "string",
"package_count": "string",
"weight_units": "LBS"
}`
schema/status 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. |
| error | object (Error) The error details on failure of unsubscription. |
Copy
Expand allCollapse all
`{"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"
}
]
}
}`
schema/tracker 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. This property supports only ASCII characters and does not allow URL, phone number, or email formats. Carrier information (carrier) is required if a 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. |
| fulfillment_provider | string[ 1 .. 64 ] characters^.*$ Indicates the fulfillment service used to deliver an order. |
| links | 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]|...Show pattern 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. |
| 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]|...Show pattern 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. |
Copy
Expand allCollapse all
`{"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",
"fulfillment_provider": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
],
"tracking_number_type": "CARRIER_PROVIDED",
"status": "CANCELLED",
"shipment_date": "string",
"carrier": "string",
"last_updated_time": "string"
}`
schema/tracker_collection tracker_collection
The add tracking information for one or more transactions response details.
| trackers | Array of objects (tracker) [ 1 .. 20 ] items An array of tracking information for shipments. |
| links | Array of objects (Link Description) [ 1 .. 2 ] items An array of request-related HATEOAS links. |
Copy
Expand allCollapse all
`{"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",
"fulfillment_provider": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
],
"tracking_number_type": "CARRIER_PROVIDED",
"status": "CANCELLED",
"shipment_date": "string",
"carrier": "string",
"last_updated_time": "string"
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}`
schema/tracker_identifier 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. |
| links | Array of objects (Link Description) [ 1 .. 2 ] items An array of request-related HATEOAS links. |
Copy
Expand allCollapse all
`{"transaction_id": "string",
"tracking_number": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}`
schema/tracker_identifier_collection tracker_identifier_collection
The add tracking information for a PayPal transaction response details.
| tracker_identifiers | Array of objects (tracker_identifier) [ 1 .. 100 ] items An array of tracking IDs. |
| links | Array of objects (Link Description) = 1 items An array of request-related HATEOAS links. |
Copy
Expand allCollapse all
`{"tracker_identifiers": [{"transaction_id": "string",
"tracking_number": "string",
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}
],
"links": [{"href": "string",
"rel": "string",
"method": "GET"
}
]
}`
schema/tracking_number_type 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. |
Copy
"CARRIER_PROVIDED"
schema/tracking_status 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. |
Copy
"CANCELLED"