Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 417e207

Browse files
committedJun 22, 2024
doc: updated readme.md
1 parent d69cf2e commit 417e207

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed
 

‎README.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This library allows you to quickly and easily use the AfterShip Tracking API via Python.
44

5-
For updates to this library, see our GitHub release page.
5+
For updates to this library, see our [GitHub release page](https://github.com/AfterShip/tracking-sdk-python/releases).
66

77
If you need support using AfterShip products, please contact support@aftership.com.
88

@@ -24,6 +24,7 @@ If you need support using AfterShip products, please contact support@aftership.c
2424
- [/couriers](#couriers)
2525
- [/last\_checkpoint](#last_checkpoint)
2626
- [/notifications](#notifications)
27+
- [/estimated-delivery-date](#estimated-delivery-date)
2728
- [Help](#help)
2829
- [License](#license)
2930

@@ -83,7 +84,7 @@ Create AfterShip instance with options
8384

8485
### Example
8586

86-
```javascript
87+
```python
8788
import tracking
8889

8990
sdk = tracking.Client(
@@ -143,10 +144,11 @@ The SDK will return an error object when there is any error during the request,
143144

144145
The AfterShip instance has the following properties which are exactly the same as the API endpoints:
145146

146-
courier - Get a list of our supported couriers.
147-
tracking - Create trackings, update trackings, and get tracking results.
148-
last_checkpoint - Get tracking information of the last checkpoint of a tracking.
149-
notification - Get, add or remove contacts (sms or email) to be notified when the status of a tracking has changed.
147+
- courier - Get a list of our supported couriers.
148+
- tracking - Create trackings, update trackings, and get tracking results.
149+
- last_checkpoint - Get tracking information of the last checkpoint of a tracking.
150+
- notification - Get, add or remove contacts (sms or email) to be notified when the status of a tracking has changed.
151+
- estimated-delivery-date - Get estimated delivery date for your order.
150152

151153

152154
### /trackings
@@ -194,20 +196,6 @@ result = sdk.tracking.get_tracking_by_id("rft4xu2rs1um1lwhm8j1p02r")
194196
print(result)
195197
```
196198

197-
```python
198-
# GET /trackings/:slug/:tracking_number?tracking_postal_code=:postal_code&tracking_ship_date=:ship_date
199-
result = sdk.tracking.get_tracking_by_slug_tracking_number(slug="usps", tracking_number="9434609105464265845274")
200-
print(result)
201-
```
202-
203-
204-
> Pro Tip: You can always use /:id to replace /:slug/:tracking_number.
205-
```python
206-
# GET /trackings/:id
207-
result = sdk.tracking.get_tracking_by_id("rft4xu2rs1um1lwhm8j1p02r")
208-
print(result)
209-
```
210-
211199
**PUT** /trackings/:id
212200

213201
```python
@@ -293,6 +281,19 @@ result = sdk.notification.delete_notification_by_tracking_id("kponlnb1w64fmlxlak
293281
print(result)
294282
```
295283

284+
### /estimated-delivery-date
285+
286+
**POST** /estimated-delivery-date/predict-batch
287+
288+
```python
289+
req = tracking.PredictBatchRequest()
290+
date = tracking.EstimatedDeliveryDateRequest()
291+
date.slug = 'usps'
292+
req.estimated_delivery_dates = [date]
293+
result = sdk.estimated_delivery_date.predict_batch(req)
294+
print(result)
295+
```
296+
296297
## Help
297298

298299
If you get stuck, we're here to help:

0 commit comments

Comments
 (0)
Please sign in to comment.