aftership-tracking-sdk 7.0.0 → 8.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +66 -82
- data/lib/aftership-tracking-sdk/api/courier.rb +6 -6
- data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb +1 -1
- data/lib/aftership-tracking-sdk/api/tracking.rb +74 -74
- data/lib/aftership-tracking-sdk/configuration.rb +1 -1
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_create_tracking_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_delete_tracking_by_id_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/{get_checkpoint_by_tracking_id_response.rb → aftership_estimated_delivery_date_delete_tracking_by_slug_tracking_number_response.rb} +30 -60
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_get_tracking_by_id_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_get_tracking_by_slug_tracking_number_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/{get_checkpoint_by_slug_tracking_number_response.rb → aftership_estimated_delivery_date_mark_tracking_completed_by_slug_tracking_number_response.rb} +30 -60
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_retrack_tracking_by_id_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_retrack_tracking_by_slug_tracking_number_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_update_tracking_by_id_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_update_tracking_by_slug_tracking_number_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_create_tracking_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_delete_tracking_by_id_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_delete_tracking_by_slug_tracking_number_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_get_tracking_by_id_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_get_tracking_by_slug_tracking_number_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_mark_tracking_completed_by_id_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_mark_tracking_completed_by_slug_tracking_number_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_retrack_tracking_by_id_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_retrack_tracking_by_slug_tracking_number_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_update_tracking_by_id_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/carbon_emissions_update_tracking_by_slug_tracking_number_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/{tracking_create_tracking_request.rb → create_tracking_request.rb} +7 -7
- data/lib/aftership-tracking-sdk/models/create_tracking_response.rb +931 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_create_tracking_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_delete_tracking_by_id_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_delete_tracking_by_slug_tracking_number_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_id_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_slug_tracking_number_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_mark_tracking_completed_by_slug_tracking_number_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_retrack_tracking_by_id_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_retrack_tracking_by_slug_tracking_number_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_update_tracking_by_id_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_update_tracking_by_slug_tracking_number_response.rb +181 -0
- data/lib/aftership-tracking-sdk/models/{custom_fields_tracking_update_tracking_by_slug_tracking_number_request.rb → custom_fields_update_tracking_by_slug_tracking_number_request.rb} +2 -2
- data/lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb +931 -0
- data/lib/aftership-tracking-sdk/models/delete_tracking_by_slug_tracking_number_response.rb +931 -0
- data/lib/aftership-tracking-sdk/models/{tracking_detect_courier_request.rb → detect_courier_request.rb} +3 -3
- data/lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb +10 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_create_tracking_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_id_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_slug_tracking_number_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_get_tracking_by_id_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_get_tracking_by_slug_tracking_number_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_mark_tracking_completed_by_id_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_mark_tracking_completed_by_slug_tracking_number_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_id_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_slug_tracking_number_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_update_tracking_by_id_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/first_estimated_delivery_update_tracking_by_slug_tracking_number_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb +931 -0
- data/lib/aftership-tracking-sdk/models/get_tracking_by_slug_tracking_number_response.rb +931 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_create_tracking_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_id_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_slug_tracking_number_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_id_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_slug_tracking_number_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_id_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_slug_tracking_number_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_id_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_slug_tracking_number_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_id_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_slug_tracking_number_response.rb +191 -0
- data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb +931 -0
- data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_slug_tracking_number_response.rb +931 -0
- data/lib/aftership-tracking-sdk/models/{next_couriers_tracking_create_tracking_request.rb → next_couriers_create_tracking_request.rb} +2 -2
- data/lib/aftership-tracking-sdk/models/{notification_request_v1.rb → next_couriers_create_tracking_response.rb} +26 -16
- data/lib/aftership-tracking-sdk/models/next_couriers_delete_tracking_by_id_response.rb +171 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_delete_tracking_by_slug_tracking_number_response.rb +171 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_get_tracking_by_id_response.rb +171 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_get_tracking_by_slug_tracking_number_response.rb +171 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_mark_tracking_completed_by_id_response.rb +171 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_mark_tracking_completed_by_slug_tracking_number_response.rb +171 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_id_response.rb +171 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_slug_tracking_number_response.rb +171 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_id_response.rb +171 -0
- data/lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_slug_tracking_number_response.rb +171 -0
- data/lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb +931 -0
- data/lib/aftership-tracking-sdk/models/retrack_tracking_by_slug_tracking_number_response.rb +931 -0
- data/lib/aftership-tracking-sdk/models/{tracking_delete_response_v1.rb → shipment_weight_create_tracking_response.rb} +16 -16
- data/lib/aftership-tracking-sdk/models/{data_notification_response_v1.rb → shipment_weight_delete_tracking_by_id_response.rb} +19 -9
- data/lib/aftership-tracking-sdk/models/shipment_weight_delete_tracking_by_slug_tracking_number_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/{notification.rb → shipment_weight_get_tracking_by_id_response.rb} +16 -16
- data/lib/aftership-tracking-sdk/models/shipment_weight_get_tracking_by_slug_tracking_number_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_mark_tracking_completed_by_id_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_mark_tracking_completed_by_slug_tracking_number_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_retrack_tracking_by_id_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_retrack_tracking_by_slug_tracking_number_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/{notification_response_v1.rb → shipment_weight_tracking.rb} +16 -16
- data/lib/aftership-tracking-sdk/models/shipment_weight_update_tracking_by_id_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/shipment_weight_update_tracking_by_slug_tracking_number_response.rb +161 -0
- data/lib/aftership-tracking-sdk/models/tracking.rb +27 -17
- data/lib/aftership-tracking-sdk/models/tracking_response_v1.rb +3 -3
- data/lib/aftership-tracking-sdk/models/{tracking_update_tracking_by_id_request.rb → update_tracking_by_id_request.rb} +3 -3
- data/lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb +931 -0
- data/lib/aftership-tracking-sdk/models/{tracking_update_tracking_by_slug_tracking_number_request.rb → update_tracking_by_slug_tracking_number_request.rb} +5 -5
- data/lib/aftership-tracking-sdk/models/update_tracking_by_slug_tracking_number_response.rb +931 -0
- data/lib/aftership-tracking-sdk/version.rb +1 -1
- metadata +97 -21
- data/lib/aftership-tracking-sdk/api/last_checkpoint.rb +0 -143
- data/lib/aftership-tracking-sdk/api/notification.rb +0 -403
- data/lib/aftership-tracking-sdk/models/data_tracking_delete_response_v1.rb +0 -151
- data/lib/aftership-tracking-sdk/models/data_tracking_response_v1.rb +0 -151
- data/lib/aftership-tracking-sdk/models/partial_delete_tracking.rb +0 -241
- data/lib/aftership-tracking-sdk/models/partial_update_tracking.rb +0 -251
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e157cddb03c0ec7d240d811e1d497fd9b82234c39e0e4487b85963aa73e4add6
|
|
4
|
+
data.tar.gz: de2907f996886f3336adb4dd6b098c74e5bde8e754e12dcb21e21c637cebb26c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c1b8d8cd3350aea149af0be548ebfa7da638761ab46670d5fa8e10d1ec2cec147346633d2d194c5b47712c91ede8e09c6335c3c15eae6dfbb75c367d5492abcd
|
|
7
|
+
data.tar.gz: f679adaf771518221db5100c56cb5a36da3c229de5f6b2568fb51be7bec82623217df014ae4435731470d1276da7f3261985e84fe8e7c0ef91a6075b3e7e79f4
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# AfterShip Tracking API library for Ruby
|
|
2
2
|
|
|
3
|
-
This library allows you to quickly and easily use the AfterShip Tracking API via
|
|
3
|
+
This library allows you to quickly and easily use the AfterShip Tracking API via Ruby.
|
|
4
4
|
|
|
5
5
|
For updates to this library, see our [GitHub release page](https://github.com/AfterShip/tracking-sdk-ruby/releases).
|
|
6
6
|
|
|
@@ -11,6 +11,7 @@ If you need support using AfterShip products, please contact support@aftership.c
|
|
|
11
11
|
- [AfterShip Tracking API library for Ruby](#aftership-tracking-api-library-for-ruby)
|
|
12
12
|
- [Table of Contents](#table-of-contents)
|
|
13
13
|
- [Before you begin](#before-you-begin)
|
|
14
|
+
- [API and SDK Version](#api-and-sdk-version)
|
|
14
15
|
- [Quick Start](#quick-start)
|
|
15
16
|
- [Installation](#installation)
|
|
16
17
|
- [Constructor](#constructor)
|
|
@@ -21,8 +22,6 @@ If you need support using AfterShip products, please contact support@aftership.c
|
|
|
21
22
|
- [Endpoints](#endpoints)
|
|
22
23
|
- [/trackings](#trackings)
|
|
23
24
|
- [/couriers](#couriers)
|
|
24
|
-
- [/last\_checkpoint](#last_checkpoint)
|
|
25
|
-
- [/notifications](#notifications)
|
|
26
25
|
- [/estimated-delivery-date](#estimated-delivery-date)
|
|
27
26
|
- [Help](#help)
|
|
28
27
|
- [License](#license)
|
|
@@ -36,6 +35,17 @@ Before you begin to integrate:
|
|
|
36
35
|
- [Create an API key](https://organization.automizely.com/api-keys).
|
|
37
36
|
- [Install Ruby](https://www.ruby-lang.org/en/) version Ruby 2.7 or later.
|
|
38
37
|
|
|
38
|
+
|
|
39
|
+
### API and SDK Version
|
|
40
|
+
|
|
41
|
+
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.
|
|
42
|
+
|
|
43
|
+
| SDK Version | Supported API Version | Branch |
|
|
44
|
+
| ----------- | --------------------- | ----------------------------------------------------------- |
|
|
45
|
+
| 8.x.x | 2024-07 | https://github.com/AfterShip/tracking-sdk-ruby/tree/2024-07 |
|
|
46
|
+
| 7.x.x | 2024-04 | https://github.com/AfterShip/tracking-sdk-ruby/tree/2024-04 |
|
|
47
|
+
| <=6.x.x | Legacy API | https://github.com/AfterShip/aftership-sdk-ruby |
|
|
48
|
+
|
|
39
49
|
## Quick Start
|
|
40
50
|
|
|
41
51
|
### Installation
|
|
@@ -46,7 +56,7 @@ gem install aftership-tracking-sdk
|
|
|
46
56
|
Or add a line to your Gemfile
|
|
47
57
|
|
|
48
58
|
```bash
|
|
49
|
-
gem 'aftership-tracking-sdk', '~>
|
|
59
|
+
gem 'aftership-tracking-sdk', '~> 8.0.0'
|
|
50
60
|
```
|
|
51
61
|
|
|
52
62
|
## Constructor
|
|
@@ -54,7 +64,7 @@ gem 'aftership-tracking-sdk', '~> 7.0.0'
|
|
|
54
64
|
Create AfterShip instance with options
|
|
55
65
|
|
|
56
66
|
| Name | Type | Required | Description |
|
|
57
|
-
|
|
67
|
+
| ---------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
58
68
|
| api_key | string | ✔ | Your AfterShip API key |
|
|
59
69
|
| auth_type | enum | | Default value: `AuthType.API_KEY` <br > AES authentication: `AuthType.AES` <br > RSA authentication: `AuthType.RSA` |
|
|
60
70
|
| api_secret | string | | Required if the authentication type is `AuthType.AES` or `AuthType.RSA` |
|
|
@@ -76,21 +86,21 @@ end
|
|
|
76
86
|
begin
|
|
77
87
|
resp = AftershipAPI::Tracking.get_trackings
|
|
78
88
|
p resp
|
|
79
|
-
rescue AftershipAPI::
|
|
89
|
+
rescue AftershipAPI::ApiError => e
|
|
80
90
|
p e.message
|
|
81
91
|
end
|
|
82
92
|
```
|
|
83
93
|
|
|
84
94
|
## Rate Limiter
|
|
85
95
|
|
|
86
|
-
See the [Rate Limit](https://www.aftership.com/docs/
|
|
96
|
+
See the [Rate Limit](https://www.aftership.com/docs/tracking/2024-07/quickstart/rate-limit) to understand the AfterShip rate limit policy.
|
|
87
97
|
|
|
88
98
|
## Error Handling
|
|
89
99
|
|
|
90
100
|
The SDK will return an error object when there is any error during the request, with the following specification:
|
|
91
101
|
|
|
92
102
|
| Name | Type | Description |
|
|
93
|
-
|
|
103
|
+
| ------------- | ------ | ------------------------------ |
|
|
94
104
|
| message | string | Detail message of the error |
|
|
95
105
|
| code | enum | Error code enum for API Error. |
|
|
96
106
|
| meta_code | number | API response meta code. |
|
|
@@ -100,30 +110,30 @@ The SDK will return an error object when there is any error during the request,
|
|
|
100
110
|
|
|
101
111
|
### Error List
|
|
102
112
|
|
|
103
|
-
| code | meta_code
|
|
104
|
-
|
|
105
|
-
| INVALID_REQUEST |
|
|
106
|
-
| INVALID_JSON |
|
|
107
|
-
| TRACKING_ALREADY_EXIST |
|
|
108
|
-
| TRACKING_DOES_NOT_EXIST |
|
|
109
|
-
| TRACKING_NUMBER_INVALID |
|
|
110
|
-
| TRACKING_REQUIRED |
|
|
111
|
-
| TRACKING_NUMBER_REQUIRED |
|
|
112
|
-
| VALUE_INVALID |
|
|
113
|
-
| VALUE_REQUIRED |
|
|
114
|
-
| SLUG_INVALID |
|
|
115
|
-
| MISSING_OR_INVALID_REQUIRED_FIELD |
|
|
116
|
-
| BAD_COURIER |
|
|
117
|
-
| INACTIVE_RETRACK_NOT_ALLOWED |
|
|
118
|
-
| NOTIFICATION_REUQIRED |
|
|
119
|
-
| ID_INVALID |
|
|
120
|
-
| RETRACK_ONCE_ALLOWED |
|
|
121
|
-
| TRACKING_NUMBER_FORMAT_INVALID |
|
|
122
|
-
| API_KEY_INVALID |
|
|
123
|
-
| REQUEST_NOT_ALLOWED |
|
|
124
|
-
| NOT_FOUND |
|
|
125
|
-
| TOO_MANY_REQUEST |
|
|
126
|
-
| INTERNAL_ERROR
|
|
113
|
+
| code | meta_code | status_code | message |
|
|
114
|
+
| --------------------------------- | --------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
115
|
+
| INVALID_REQUEST | 400 | 400 | The request was invalid or cannot be otherwise served. |
|
|
116
|
+
| INVALID_JSON | 4001 | 400 | Invalid JSON data. |
|
|
117
|
+
| TRACKING_ALREADY_EXIST | 4003 | 400 | Tracking already exists. |
|
|
118
|
+
| TRACKING_DOES_NOT_EXIST | 4004 | 404 | Tracking does not exist. |
|
|
119
|
+
| TRACKING_NUMBER_INVALID | 4005 | 400 | The value of tracking_number is invalid. |
|
|
120
|
+
| TRACKING_REQUIRED | 4006 | 400 | tracking object is required. |
|
|
121
|
+
| TRACKING_NUMBER_REQUIRED | 4007 | 400 | tracking_number is required. |
|
|
122
|
+
| VALUE_INVALID | 4008 | 400 | The value of [field_name] is invalid. |
|
|
123
|
+
| VALUE_REQUIRED | 4009 | 400 | [field_name] is required. |
|
|
124
|
+
| SLUG_INVALID | 4010 | 400 | The value of slug is invalid. |
|
|
125
|
+
| 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] |
|
|
126
|
+
| BAD_COURIER | 4012 | 400 | The error message will be one of the following:<br/>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<br/>2. Unable to import shipment as we don’t recognize the carrier from this tracking number.<br/>3. Unable to import shipment as the tracking number has an invalid format.<br/>4. Unable to import shipment as this carrier is no longer supported.<br/>5. Unable to import shipment as the tracking number does not belong to a carrier in that group. |
|
|
127
|
+
| INACTIVE_RETRACK_NOT_ALLOWED | 4013 | 400 | Retrack is not allowed. You can only retrack an inactive tracking. |
|
|
128
|
+
| NOTIFICATION_REUQIRED | 4014 | 400 | notification object is required. |
|
|
129
|
+
| ID_INVALID | 4015 | 400 | The value of id is invalid. |
|
|
130
|
+
| RETRACK_ONCE_ALLOWED | 4016 | 400 | Retrack is not allowed. You can only retrack each shipment once. |
|
|
131
|
+
| TRACKING_NUMBER_FORMAT_INVALID | 4017 | 400 | The format of tracking_number is invalid. |
|
|
132
|
+
| API_KEY_INVALID | 401 | 401 | The API key is invalid. |
|
|
133
|
+
| REQUEST_NOT_ALLOWED | 403 | 403 | The request is understood, but it has been refused or access is not allowed. |
|
|
134
|
+
| NOT_FOUND | 404 | 404 | The URI requested is invalid or the resource requested does not exist. |
|
|
135
|
+
| TOO_MANY_REQUEST | 429 | 429 | You have exceeded the API call rate limit. The default limit is 10 requests per second. |
|
|
136
|
+
| INTERNAL_ERROR | 500 502 503 504 | 500 502 503 504 | Something went wrong on AfterShip's end. |
|
|
127
137
|
|
|
128
138
|
## Endpoints
|
|
129
139
|
|
|
@@ -131,8 +141,6 @@ The AfterShip instance has the following properties which are exactly the same a
|
|
|
131
141
|
|
|
132
142
|
- courier - Get a list of our supported couriers.
|
|
133
143
|
- tracking - Create trackings, update trackings, and get tracking results.
|
|
134
|
-
- last_checkpoint - Get tracking information of the last checkpoint of a tracking.
|
|
135
|
-
- notification - Get, add or remove contacts (sms or email) to be notified when the status of a tracking has changed.
|
|
136
144
|
- estimated-delivery-date - Get estimated delivery date for your order.
|
|
137
145
|
|
|
138
146
|
|
|
@@ -142,13 +150,13 @@ The AfterShip instance has the following properties which are exactly the same a
|
|
|
142
150
|
|
|
143
151
|
```ruby
|
|
144
152
|
begin
|
|
145
|
-
req = AftershipAPI::Model::
|
|
146
|
-
req.tracking_number = "
|
|
147
|
-
req.slug = "
|
|
153
|
+
req = AftershipAPI::Model::CreateTrackingRequest. new
|
|
154
|
+
req.tracking_number = "<tracking_number>"
|
|
155
|
+
req.slug = "<slug>"
|
|
148
156
|
|
|
149
157
|
resp = AftershipAPI::Tracking.create_tracking(body: req)
|
|
150
158
|
p resp
|
|
151
|
-
rescue AftershipAPI::
|
|
159
|
+
rescue AftershipAPI::ApiError => e
|
|
152
160
|
p e.message
|
|
153
161
|
end
|
|
154
162
|
```
|
|
@@ -156,7 +164,7 @@ end
|
|
|
156
164
|
**DELETE** /trackings/:id
|
|
157
165
|
|
|
158
166
|
```ruby
|
|
159
|
-
resp = AftershipAPI::Tracking.delete_tracking_by_id(id: "
|
|
167
|
+
resp = AftershipAPI::Tracking.delete_tracking_by_id(id: "<tracking_id>")
|
|
160
168
|
p resp.to_json
|
|
161
169
|
```
|
|
162
170
|
|
|
@@ -170,23 +178,23 @@ p resp.to_json
|
|
|
170
178
|
**GET** /trackings/:id
|
|
171
179
|
|
|
172
180
|
```ruby
|
|
173
|
-
resp = AftershipAPI::Tracking.get_tracking_by_id(id: "
|
|
181
|
+
resp = AftershipAPI::Tracking.get_tracking_by_id(id: "<tracking_id>")
|
|
174
182
|
p resp.to_json
|
|
175
183
|
```
|
|
176
184
|
|
|
177
185
|
**PUT** /trackings/:id
|
|
178
186
|
|
|
179
187
|
```ruby
|
|
180
|
-
req = AftershipAPI::Model::
|
|
188
|
+
req = AftershipAPI::Model::UpdateTrackingByIdRequest.new
|
|
181
189
|
req.note = "test update"
|
|
182
|
-
resp = AftershipAPI::Tracking.update_tracking_by_id(id: "
|
|
190
|
+
resp = AftershipAPI::Tracking.update_tracking_by_id(id: "<tracking_id>", body: req)
|
|
183
191
|
p resp.to_json
|
|
184
192
|
```
|
|
185
193
|
|
|
186
194
|
**POST** /trackings/:id/retrack
|
|
187
195
|
|
|
188
196
|
```ruby
|
|
189
|
-
resp = AftershipAPI::Tracking.retrack_tracking_by_id(id: "
|
|
197
|
+
resp = AftershipAPI::Tracking.retrack_tracking_by_id(id: "<tracking_id>")
|
|
190
198
|
p resp.to_json
|
|
191
199
|
```
|
|
192
200
|
|
|
@@ -195,7 +203,7 @@ p resp.to_json
|
|
|
195
203
|
```ruby
|
|
196
204
|
req = AftershipAPI::Model::MarkTrackingCompletedByIdRequest.new
|
|
197
205
|
req.reason = "DELIVERED"
|
|
198
|
-
resp = AftershipAPI::Tracking.mark_tracking_completed_by_id(id: "
|
|
206
|
+
resp = AftershipAPI::Tracking.mark_tracking_completed_by_id(id: "<tracking_id>", body: req)
|
|
199
207
|
p resp.to_json
|
|
200
208
|
```
|
|
201
209
|
|
|
@@ -218,54 +226,30 @@ p resp.to_json
|
|
|
218
226
|
|
|
219
227
|
```ruby
|
|
220
228
|
req = AftershipAPI::Model::TrackingDetectCourierRequest.new
|
|
221
|
-
req.tracking_number = "
|
|
229
|
+
req.tracking_number = "<tracking_number>"
|
|
222
230
|
resp = AftershipAPI::Courier.detect_courier(body: req)
|
|
223
231
|
p resp.to_json
|
|
224
232
|
```
|
|
225
233
|
|
|
226
|
-
### /last_checkpoint
|
|
227
|
-
|
|
228
|
-
**GET** /last_checkpoint/:id
|
|
229
|
-
|
|
230
|
-
```ruby
|
|
231
|
-
resp = AftershipAPI::LastCheckpoint.get_checkpoint_by_tracking_id(tracking_id: "hphtmivs7jq99lxo378h400e")
|
|
232
|
-
p resp.to_json
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
### /notifications
|
|
236
|
-
|
|
237
|
-
**GET** /notifications/:id
|
|
238
|
-
|
|
239
|
-
```ruby
|
|
240
|
-
resp = AftershipAPI::Notification.get_notification_by_tracking_id(tracking_id: "hphtmivs7jq99lxo378h400e")
|
|
241
|
-
p resp.to_json
|
|
242
|
-
```
|
|
243
|
-
|
|
244
|
-
**POST** /notifications/:id/add
|
|
245
|
-
|
|
246
|
-
```ruby
|
|
247
|
-
req = AftershipAPI::Model::NotificationRequestV1.new
|
|
248
|
-
req.emails = ["your_mail@gmail.com"]
|
|
249
|
-
resp = AftershipAPI::Notification.add_notification_by_tracking_id(tracking_id: "hphtmivs7jq99lxo378h400e",body: req)
|
|
250
|
-
p resp.to_json
|
|
251
|
-
```
|
|
252
|
-
|
|
253
|
-
**POST** /notifications/:id/remove
|
|
254
|
-
|
|
255
|
-
```ruby
|
|
256
|
-
req = AftershipAPI::Model::NotificationRequestV1.new
|
|
257
|
-
req.emails = ["your_mail@gmail.com"]
|
|
258
|
-
resp = AftershipAPI::Notification.delete_notification_by_tracking_id(tracking_id: "hphtmivs7jq99lxo378h400e",body: req)
|
|
259
|
-
p resp.to_json
|
|
260
|
-
```
|
|
261
|
-
|
|
262
234
|
### /estimated-delivery-date
|
|
263
235
|
|
|
264
236
|
**POST** /estimated-delivery-date/predict-batch
|
|
265
237
|
|
|
266
238
|
```ruby
|
|
267
239
|
edd = AftershipAPI::Model::EstimatedDeliveryDateRequest.new
|
|
268
|
-
edd.slug = "
|
|
240
|
+
edd.slug = "<slug>"
|
|
241
|
+
edd.pickup_time = "2024-08-01 06:42:30"
|
|
242
|
+
origin = AftershipAPI::Model::OriginAddressEstimatedDeliveryDateRequest.new
|
|
243
|
+
origin.country = "<ISO 3166-1 country/region code>"
|
|
244
|
+
origin.state = "<ISO 3166-1 country/region code>"
|
|
245
|
+
|
|
246
|
+
dest = AftershipAPI::Model::DestinationAddressEstimatedDeliveryDateRequest.new
|
|
247
|
+
dest.country = "<ISO 3166-1 country/region code>"
|
|
248
|
+
dest.state = "<ISO 3166-1 country/region code>"
|
|
249
|
+
|
|
250
|
+
edd.origin_address = origin
|
|
251
|
+
edd.destination_address = dest
|
|
252
|
+
|
|
269
253
|
req = AftershipAPI::Model::PredictBatchRequest.new
|
|
270
254
|
req.estimated_delivery_dates = [edd]
|
|
271
255
|
resp = AftershipAPI::EstimatedDeliveryDate.predict_batch(body: req)
|
|
@@ -13,12 +13,12 @@ module AftershipAPI
|
|
|
13
13
|
# detect_courier
|
|
14
14
|
# Return a list of matched couriers based on tracking number format and or a list of couriers.
|
|
15
15
|
|
|
16
|
-
# @param body [Model::
|
|
16
|
+
# @param body [Model::DetectCourierRequest]
|
|
17
17
|
# @param [Hash] opts the optional parameters
|
|
18
18
|
# @return [Model::DetectCourierResponse]
|
|
19
19
|
def detect_courier(body:, opts: {})
|
|
20
|
-
if "
|
|
21
|
-
body = { :'
|
|
20
|
+
if "" != ""
|
|
21
|
+
body = { :'' => body }
|
|
22
22
|
end
|
|
23
23
|
opts[:body] = body
|
|
24
24
|
data, _status_code, _headers = detect_courier_with_http_info(opts: opts)
|
|
@@ -33,7 +33,7 @@ module AftershipAPI
|
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
# resource path
|
|
36
|
-
local_var_path = "/tracking/2024-
|
|
36
|
+
local_var_path = "/tracking/2024-07/couriers/detect"
|
|
37
37
|
method = :'POST'
|
|
38
38
|
|
|
39
39
|
# query parameters
|
|
@@ -81,7 +81,7 @@ module AftershipAPI
|
|
|
81
81
|
|
|
82
82
|
|
|
83
83
|
# resource path
|
|
84
|
-
local_var_path = "/tracking/2024-
|
|
84
|
+
local_var_path = "/tracking/2024-07/couriers/all"
|
|
85
85
|
method = :'GET'
|
|
86
86
|
|
|
87
87
|
# query parameters
|
|
@@ -129,7 +129,7 @@ module AftershipAPI
|
|
|
129
129
|
|
|
130
130
|
|
|
131
131
|
# resource path
|
|
132
|
-
local_var_path = "/tracking/2024-
|
|
132
|
+
local_var_path = "/tracking/2024-07/couriers"
|
|
133
133
|
method = :'GET'
|
|
134
134
|
|
|
135
135
|
# query parameters
|