AfterShip Tracking API library for Ruby
This library allows you to quickly and easily use the AfterShip Tracking API via Ruby.
For updates to this library, see our GitHub release page.
If you need support using AfterShip products, please contact [email protected].
Table of Contents
Before you begin
Before you begin to integrate:
- Create an AfterShip account.
- Create an API key.
- Install Ruby version Ruby 2.7 or later.
API and SDK Version
Each SDK version is designed to work with a specific API version. Please refer to the table below to identify the supported API versions for each SDK version, ensuring you select the appropriate SDK version for the API version you intend to use.
| SDK Version | Supported API Version | Branch |
|---|---|---|
| 9.x.x | 2024-10 | https://github.com/AfterShip/tracking-sdk-ruby/tree/2024-10 |
| 8.x.x | 2024-07 | https://github.com/AfterShip/tracking-sdk-ruby/tree/2024-07 |
| 7.x.x | 2024-04 | https://github.com/AfterShip/tracking-sdk-ruby/tree/2024-04 |
| <=6.x.x | Legacy API | https://github.com/AfterShip/aftership-sdk-ruby |
Quick Start
Installation
bash
gem install aftership-tracking-sdk
Or add a line to your Gemfile
bash
gem 'aftership-tracking-sdk', '~> 9.0.0'
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
```ruby require ‘aftership-tracking-sdk’
AftershipAPI.configure do |config| config.as_api_key = “YOUR_API_KEY” end
begin resp = AftershipAPI::Tracking.get_trackings p resp rescue AftershipAPI::ApiError => e p e.message end ```
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/couriers 2. 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
```ruby
begin
req = AftershipAPI::Model::CreateTrackingRequest. new
req.tracking_number = “
resp = AftershipAPI::Tracking.create_tracking(body: req)
p resp rescue AftershipAPI::ApiError => e
p e.message end ```
DELETE /trackings/:id
ruby
resp = AftershipAPI::Tracking.delete_tracking_by_id(id: "<tracking_id>")
p resp.to_json
GET /trackings
ruby
resp = AftershipAPI::Tracking.get_trackings(opts: {keyword: "123"})
p resp.to_json
GET /trackings/:id
ruby
resp = AftershipAPI::Tracking.get_tracking_by_id(id: "<tracking_id>")
p resp.to_json
PUT /trackings/:id
ruby
req = AftershipAPI::Model::UpdateTrackingByIdRequest.new
req.note = "test update"
resp = AftershipAPI::Tracking.update_tracking_by_id(id: "<tracking_id>", body: req)
p resp.to_json
POST /trackings/:id/retrack
ruby
resp = AftershipAPI::Tracking.retrack_tracking_by_id(id: "<tracking_id>")
p resp.to_json
POST /trackings/:id/mark-as-completed
ruby
req = AftershipAPI::Model::MarkTrackingCompletedByIdRequest.new
req.reason = "DELIVERED"
resp = AftershipAPI::Tracking.mark_tracking_completed_by_id(id: "<tracking_id>", body: req)
p resp.to_json
/couriers
GET /couriers
ruby
resp = AftershipAPI::Courier.get_user_couriers()
p resp.to_json
GET /couriers/all
ruby
resp = AftershipAPI::Courier.get_all_couriers()
p resp.to_json
POST /couriers/detect
ruby
req = AftershipAPI::Model::DetectCourierRequest.new
req.tracking_number = "<tracking_number>"
resp = AftershipAPI::Courier.detect_courier(body: req)
p resp.to_json
/estimated-delivery-date
POST /estimated-delivery-date/predict-batch
```ruby
edd = AftershipAPI::Model::EstimatedDeliveryDateRequest.new
edd.slug = “
dest = AftershipAPI::Model::DestinationAddressEstimatedDeliveryDateRequest.new dest.country = “<ISO 3166-1 country/region code>” dest.state = “<ISO 3166-1 country/region code>”
edd.origin_address = origin edd.destination_address = dest
req = AftershipAPI::Model::PredictBatchRequest.new req.estimated_delivery_dates = [edd] resp = AftershipAPI::EstimatedDeliveryDate.predict_batch(body: req) p resp.to_json ```
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.