aftership-tracking-sdk 3.0.0

Description:

aftershiptrackingsdk 3.0.0

AfterShip Tracking API library for Python
This library allows you to quickly and easily use the AfterShip Tracking API via Python.
For updates to this library, see our GitHub release page.
If you need support using AfterShip products, please contact [email protected].
Table of Contents

AfterShip Tracking API library for Python

Table of Contents
Before you begin
Quick Start

Installation


Constructor

Example


Rate Limiter
Error Handling

Error List


Endpoints

/trackings
/couriers
/estimated-delivery-date


Help
License



Before you begin
Before you begin to integrate:

Create an AfterShip account.
Create an API key.
Install Python version 3.8 or later.

Quick Start
Installation
pip install aftership-tracking-sdk

Constructor
Create AfterShip instance with options



Name
Type
Required
Description




api_key
string
✔
Your AfterShip API key


auth_type
enum

Default value: AuthType.API_KEY AES authentication: AuthType.AES RSA authentication: AuthType.RSA


api_secret
string

Required if the authentication type is AuthType.AES or AuthType.RSA


domain
string

AfterShip API domain. Default value: https://api.aftership.com


user_agent
string

User-defined user-agent string, please follow RFC9110 format standard.


proxy
string

HTTP proxy URL to use for requests. Default value: null Example: http://192.168.0.100:8888


max_retry
number

Number of retries for each request. Default value: 2. Min is 0, Max is 10.


timeout
number

Timeout for each request in milliseconds.



Example
import tracking
from tracking import exceptions

try:
sdk = tracking.Client(
tracking.Configuration(
api_key="YOUR_API_KEY",
authentication_type=tracking.ApiKey,
)
)
result = sdk.tracking.get_tracking_by_id("<tracking_id>")
print(result)
except exceptions.InvalidOptionError:
pass
except exceptions.InvalidApiKeyError:
pass
except exceptions.RateLimitExceedError:
pass

Rate Limiter
See the Rate Limit to understand the AfterShip rate limit policy.
Error Handling
The SDK will return an error object when there is any error during the request, with the following specification:



Name
Type
Description




message
string
Detail message of the error


code
enum
Error code enum for API Error.


meta_code
number
API response meta code.


status_code
number
HTTP status code.


response_body
string
API response body.



Error List



code
meta_code
status_code
message




INVALID_REQUEST
400
400
The request was invalid or cannot be otherwise served.


INVALID_JSON
4001
400
Invalid JSON data.


TRACKING_ALREADY_EXIST
4003
400
Tracking already exists.


TRACKING_DOES_NOT_EXIST
4004
404
Tracking does not exist.


TRACKING_NUMBER_INVALID
4005
400
The value of tracking_number is invalid.


TRACKING_REQUIRED
4006
400
tracking object is required.


TRACKING_NUMBER_REQUIRED
4007
400
tracking_number is required.


VALUE_INVALID
4008
400
The value of [field_name] is invalid.


VALUE_REQUIRED
4009
400
[field_name] is required.


SLUG_INVALID
4010
400
The value of slug is invalid.


MISSING_OR_INVALID_REQUIRED_FIELD
4011
400
Missing or invalid value of the required fields for this courier. Besides tracking_number, also required: [field_name]


BAD_COURIER
4012
400
The error message will be one of the following:1. Unable to import shipment as the carrier is not on your approved list for carrier auto-detection. Add the carrier here: https://admin.aftership.com/settings/couriers2. Unable to import shipment as we don’t recognize the carrier from this tracking number.3. Unable to import shipment as the tracking number has an invalid format.4. Unable to import shipment as this carrier is no longer supported.5. Unable to import shipment as the tracking number does not belong to a carrier in that group.


INACTIVE_RETRACK_NOT_ALLOWED
4013
400
Retrack is not allowed. You can only retrack an inactive tracking.


NOTIFICATION_REUQIRED
4014
400
notification object is required.


ID_INVALID
4015
400
The value of id is invalid.


RETRACK_ONCE_ALLOWED
4016
400
Retrack is not allowed. You can only retrack each shipment once.


TRACKING_NUMBER_FORMAT_INVALID
4017
400
The format of tracking_number is invalid.


API_KEY_INVALID
401
401
The API key is invalid.


REQUEST_NOT_ALLOWED
403
403
The request is understood, but it has been refused or access is not allowed.


NOT_FOUND
404
404
The URI requested is invalid or the resource requested does not exist.


TOO_MANY_REQUEST
429
429
You have exceeded the API call rate limit. The default limit is 10 requests per second.


INTERNAL_ERROR
500 502 503 504
500 502 503 504
Something went wrong on AfterShip's end.



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

courier - Get a list of our supported couriers.
tracking - Create trackings, update trackings, and get tracking results.
estimated-delivery-date - Get estimated delivery date for your order.

/trackings
POST /trackings
import tracking
from tracking import exceptions

try:
sdk = tracking.Client(
tracking.Configuration(
api_key="YOUR_API_KEY",
api_secret="YOUR_API_SECRET",
authentication_type=tracking.Aes,
)
)
data = tracking.CreateTrackingRequest()
data.tracking_number = "<tracking_number>"
data.slug = "<slug>"
result = sdk.tracking.create_tracking(data)
print(result)
except exceptions.InvalidOptionError:
pass

DELETE /trackings/:id
sdk.tracking.delete_tracking_by_id("<tracking_id>")

GET /trackings
result = sdk.tracking.get_trackings(keyword="1234")
print(result)

GET /trackings/:id
result = sdk.tracking.get_tracking_by_id("<tracking_id>")
print(result)

PUT /trackings/:id
data = tracking.UpdateTrackingByIdRequest()
data.note = "test"
result = sdk.tracking.update_tracking_by_id("<tracking_id>", data)
print(result)

POST /trackings/:id/retrack
result = sdk.tracking.retrack_tracking_by_id("<tracking_id>")
print(result)

POST /trackings/:id/mark-as-completed
data = tracking.MarkTrackingCompletedByIdRequest()
data.reason = "DELIVERED"
result = sdk.tracking.mark_tracking_completed_by_id("<tracking_id>", data)
print(result)

/couriers
GET /couriers
result = sdk.courier.get_user_couriers()
print(result)

GET /couriers/all
result = sdk.courier.get_all_couriers()
print(result)

POST /couriers/detect
data = tracking.DetectCourierRequest()
data.tracking_number = "<tracking_number>"
result = sdk.courier.detect_courier(data)
print(result)

/estimated-delivery-date
POST /estimated-delivery-date/predict-batch
req = tracking.PredictBatchRequest()
date = tracking.EstimatedDeliveryDateRequest()
date.slug = '<slug>'
req.estimated_delivery_dates = [date]
result = sdk.estimated_delivery_date.predict_batch(req)
print(result)

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

Issue Tracker for questions, feature requests, bug reports and general discussion related to this package. Try searching before you create a new issue.
Contact AfterShip official support via [email protected]

License
Copyright (c) 2024 AfterShip
Licensed under the MIT license.