Shipment Tracking
Merchants can use the PayPal Add Tracking API to manage tracking information. Merchants can add tracking numbers and associated information to PayPal. There…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
Endpoints 5
trackers
- GETList tracking information
/v1/shipping/trackers?transaction_id=string&tracking_number=string&account_id=stringLists tracking information that meet search criteria. The tracking ID is required but the tracking number is optional. - POSTAdd tracking information for PayPal transaction
/v1/shipping/trackersAdds tracking information for a PayPal transaction. - GETShow tracking information
/v1/shipping/trackers/:id?account_id=stringShows tracking information, by tracker ID, for a PayPal transaction. - PUTUpdate or cancel tracking information for PayPal transaction
/v1/shipping/trackers/:idUpdates or cancels the tracking information for a PayPal transaction, by ID. To cancel tracking information, call this method and set the status to CANCELLED.…
trackers-batch
- POSTAdd tracking information for multiple PayPal transactions
/v1/shipping/trackers-batch<blockquote><strong>Deprecation notice:</strong> Adding tracking details for an order through <code>/v1/shipping/trackers-batch</code> is deprecated as its a…
API details
- Base URL
https://api-m.sandbox.paypal.comhttps://api-m.paypal.com- Authentication
- OAuth 2.0 (client credentials flow) with 2 scopes
- Operations
- 5 operations on 3 pathsGET 2POST 2PUT 1
- Main resources
- trackers 4trackers-batch 1
- Response formats
application/json- Description format
- OpenAPI 3.0.3, API version
1.9 - Links
- Documentation · OpenAPI document
- Listed from
- PayPal's published OpenAPI description (paypal/paypal-rest-api-specifications) (Apache-2.0)
How to test the Shipment Tracking in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Shipment Tracking collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (client credentials flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List tracking information” (GET /v1/shipping/trackers?transaction_id=string&tracking_number=string&account_id=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Shipment Tracking?
Merchants can use the PayPal Add Tracking API to manage tracking information. Merchants can add tracking numbers and associated information to PayPal. There… It is listed under Payments and has 5 endpoints.
Who publishes the Shipment Tracking?
It is listed from PayPal's public API description (an OpenAPI document), not published by PayPal on Swastik Codes. Anyone who controls paypal.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Shipment Tracking?
Its description lists 2 base URLs: https://api-m.sandbox.paypal.com, https://api-m.paypal.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Shipment Tracking?
With OAuth 2.0 (client credentials flow) with 2 scopes.
How many endpoints does the Shipment Tracking have?
5 operations on 3 paths (2 GET, 2 POST, 1 PUT). The largest groups are trackers, trackers-batch.
Is forking the Shipment Tracking free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.