AfterShip (Independent Publisher) (Preview)
AfterShip is a shipment tracking solution. It partners with over 900 carriers across the globe including popular services such as FedEx, DHL etc. This connector allows a user to track and receive notifications on shipments and integrate with other services such as Dynamics 365 and third party services to strengthen your ecommerce or streamline your internal business processes.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Taiki Yoshida |
| URL | https://memo.tyoshida.me/power-platform/connectors/aftership-connector/ |
| tayoshi@microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Taiki Yoshida |
| Website | https://www.aftership.com |
| Privacy policy | https://www.automizely.com/legal/privacy |
| Categories | Commerce |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The app/subscription API key issued by AfterShip | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add a notification |
Add notification receivers to a tracking number. |
| Create Tracking |
Create a tracking. |
| Delete a tracking |
Delete a tracking. |
| Detect courier |
Return a list of matched couriers based on tracking number format and selected couriers or a list of couriers. |
| Get a tracking |
Get tracking results of a single tracking. |
| Get all couriers |
Return a list of all couriers. |
| Get last checkpoint |
Return the tracking information of the last checkpoint of a single tracking. |
| Get tracking notification |
Get contact information for the users to notify when the tracking changes. Please note that only customer receivers will be returned. Any |
| Get trackings |
Get tracking results of multiple trackings. |
| Get user activated couriers |
Return a list of couriers activated at your AfterShip account. |
| Mark tracking as completed |
Mark a tracking as completed. The tracking won't auto update until retrack it. |
| Remove a notification |
Remove notification receivers from a tracking number. |
| Retrack an expired tracking |
Retrack an expired tracking. Max 3 times per tracking. |
| Update a tracking |
Update a tracking. |
Add a notification
Add notification receivers to a tracking number.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Courier slug
|
slug | True | string |
Courier slug |
|
Tracking number
|
tracking_number | True | string |
Enter the tracking number |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
emails
|
data.notification.emails | array of |
Email addresses |
|
smses
|
data.notification.smses | array of string |
SMS |
Create Tracking
Create a tracking.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
slug
|
slug | string |
Courier Name |
|
|
tracking_number
|
tracking_number | string |
Tracking number |
|
|
title
|
title | string |
title |
|
|
smses
|
smses | array of |
SMS |
|
|
emails
|
emails | array of |
Email addresses |
|
|
order_id
|
order_id | string |
Order ID |
|
|
order_id_path
|
order_id_path | string |
Order ID path |
|
|
product_name
|
product_name | string |
product_name |
|
|
product_price
|
product_price | string |
product_price |
|
|
language
|
language | string |
Language |
|
|
order_promised_delivery_date
|
order_promised_delivery_date | string |
order_promised_delivery_date |
|
|
delivery_type
|
delivery_type | string |
delivery_type |
|
|
pickup_location
|
pickup_location | string |
pickup_location |
|
|
pickup_note
|
pickup_note | string |
pickup_note |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
id
|
data.tracking.id | string |
ID |
|
created_at
|
data.tracking.created_at | string |
Created date and time |
|
updated_at
|
data.tracking.updated_at | string |
Updated date and time |
|
last_updated_at
|
data.tracking.last_updated_at | string |
Last updated date and time |
|
tracking_number
|
data.tracking.tracking_number | string |
Tracking number |
|
slug
|
data.tracking.slug | string |
Courier Name |
|
active
|
data.tracking.active | boolean |
Active or inactive tracking |
|
android
|
data.tracking.android | array of |
Android |
|
custom_fields
|
data.tracking.custom_fields | string |
Custom fields |
|
customer_name
|
data.tracking.customer_name | string |
Customer Name |
|
delivery_time
|
data.tracking.delivery_time | integer |
Delivery date and time |
|
destination_country_iso3
|
data.tracking.destination_country_iso3 | string |
Destination country code in ISO 3 format |
|
courier_destination_country_iso3
|
data.tracking.courier_destination_country_iso3 | string |
Courier country code in ISO 3 format |
|
emails
|
data.tracking.emails | array of |
Email addresses |
|
expected_delivery
|
data.tracking.expected_delivery | string |
Expected delivery date and time |
|
ios
|
data.tracking.ios | array of |
iOS |
|
note
|
data.tracking.note | string |
Notes |
|
order_id
|
data.tracking.order_id | string |
Order ID |
|
order_id_path
|
data.tracking.order_id_path | string |
Order ID path |
|
origin_country_iso3
|
data.tracking.origin_country_iso3 | string |
Originating country code in ISO 3 format |
|
shipment_package_count
|
data.tracking.shipment_package_count | integer |
Number of packages in the shipment |
|
shipment_pickup_date
|
data.tracking.shipment_pickup_date | string |
Date and time of packages picked up |
|
shipment_delivery_date
|
data.tracking.shipment_delivery_date | string |
Date and time of packages delivered |
|
shipment_type
|
data.tracking.shipment_type | string |
Type of shipment |
|
shipment_weight
|
data.tracking.shipment_weight | integer |
Weight of shipment |
|
shipment_weight_unit
|
data.tracking.shipment_weight_unit | string |
Unit of shipment weight |
|
signed_by
|
data.tracking.signed_by | string |
Signed by |
|
smses
|
data.tracking.smses | array of |
SMS |
|
source
|
data.tracking.source | string |
Source |
|
tag
|
data.tracking.tag | string |
Tags |
|
subtag
|
data.tracking.subtag | string |
Sub tags |
|
subtag_message
|
data.tracking.subtag_message | string |
Sub tag messages |
|
title
|
data.tracking.title | string |
title |
|
tracked_count
|
data.tracking.tracked_count | integer |
Number of times tracked |
|
last_mile_tracking_supported
|
data.tracking.last_mile_tracking_supported | boolean |
Last mile tracking is supported |
|
language
|
data.tracking.language | string |
Language |
|
unique_token
|
data.tracking.unique_token | string |
Unique token |
|
checkpoints
|
data.tracking.checkpoints | array of |
checkpoints |
|
subscribed_smses
|
data.tracking.subscribed_smses | array of |
subscribed_smses |
|
subscribed_emails
|
data.tracking.subscribed_emails | array of |
subscribed_emails |
|
return_to_sender
|
data.tracking.return_to_sender | boolean |
return_to_sender |
|
tracking_account_number
|
data.tracking.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.tracking.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.tracking.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.tracking.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.tracking.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.tracking.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.tracking.tracking_state | string |
tracking_state |
|
order_promised_delivery_date
|
data.tracking.order_promised_delivery_date | string |
order_promised_delivery_date |
|
delivery_type
|
data.tracking.delivery_type | string |
delivery_type |
|
pickup_location
|
data.tracking.pickup_location | string |
pickup_location |
|
pickup_note
|
data.tracking.pickup_note | string |
pickup_note |
|
courier_tracking_link
|
data.tracking.courier_tracking_link | string |
courier_tracking_link |
|
courier_redirect_link
|
data.tracking.courier_redirect_link | string |
courier_redirect_link |
|
first_attempted_at
|
data.tracking.first_attempted_at | string |
first_attempted_at |
Delete a tracking
Delete a tracking.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Courier slug
|
slug | True | string |
Courier slug |
|
Tracking number
|
tracking_number | True | string |
Enter the tracking number |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
id
|
data.tracking.id | string |
ID |
|
tracking_number
|
data.tracking.tracking_number | string |
Tracking number |
|
slug
|
data.tracking.slug | string |
Courier Name |
|
tracking_account_number
|
data.tracking.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.tracking.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.tracking.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.tracking.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.tracking.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.tracking.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.tracking.tracking_state | string |
tracking_state |
Detect courier
Return a list of matched couriers based on tracking number format and selected couriers or a list of couriers.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
tracking_number
|
tracking_number | string |
Tracking number |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
total
|
data.total | integer |
total |
|
couriers
|
data.couriers | array of object |
Couriers information |
|
slug
|
data.couriers.slug | string |
Courier Name |
|
name
|
data.couriers.name | string |
Name |
|
phone
|
data.couriers.phone | string |
Phone number |
|
other_name
|
data.couriers.other_name | string |
Alternative name |
|
web_url
|
data.couriers.web_url | string |
URL of the website |
|
required_fields
|
data.couriers.required_fields | array of string |
Required fields |
|
optional_fields
|
data.couriers.optional_fields | array of string |
Optional fields |
|
default_language
|
data.couriers.default_language | string |
Default language |
|
support_languages
|
data.couriers.support_languages | array of string |
Supported languages |
|
service_from_country_iso3
|
data.couriers.service_from_country_iso3 | array of string |
Country code of the service in ISO3 format |
Get a tracking
Get tracking results of a single tracking.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Courier slug
|
slug | True | string |
Courier slug |
|
Tracking number
|
tracking_number | True | string |
Enter the tracking number |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
id
|
data.tracking.id | string |
ID |
|
created_at
|
data.tracking.created_at | string |
Created date and time |
|
updated_at
|
data.tracking.updated_at | string |
Updated date and time |
|
last_updated_at
|
data.tracking.last_updated_at | string |
Last updated date and time |
|
tracking_number
|
data.tracking.tracking_number | string |
Tracking number |
|
slug
|
data.tracking.slug | string |
Courier Name |
|
active
|
data.tracking.active | boolean |
Active or inactive tracking |
|
android
|
data.tracking.android | array of |
Android |
|
custom_fields
|
data.tracking.custom_fields | string |
Custom fields |
|
customer_name
|
data.tracking.customer_name | string |
Customer Name |
|
delivery_time
|
data.tracking.delivery_time | integer |
Delivery date and time |
|
destination_country_iso3
|
data.tracking.destination_country_iso3 | string |
Destination country code in ISO 3 format |
|
courier_destination_country_iso3
|
data.tracking.courier_destination_country_iso3 | string |
Courier country code in ISO 3 format |
|
emails
|
data.tracking.emails | array of |
Email addresses |
|
expected_delivery
|
data.tracking.expected_delivery | string |
Expected delivery date and time |
|
ios
|
data.tracking.ios | array of |
iOS |
|
note
|
data.tracking.note | string |
Notes |
|
order_id
|
data.tracking.order_id | string |
Order ID |
|
order_id_path
|
data.tracking.order_id_path | string |
Order ID path |
|
origin_country_iso3
|
data.tracking.origin_country_iso3 | string |
Originating country code in ISO 3 format |
|
shipment_package_count
|
data.tracking.shipment_package_count | integer |
Number of packages in the shipment |
|
shipment_pickup_date
|
data.tracking.shipment_pickup_date | string |
Date and time of packages picked up |
|
shipment_delivery_date
|
data.tracking.shipment_delivery_date | string |
Date and time of packages delivered |
|
shipment_type
|
data.tracking.shipment_type | string |
Type of shipment |
|
shipment_weight
|
data.tracking.shipment_weight | integer |
Weight of shipment |
|
shipment_weight_unit
|
data.tracking.shipment_weight_unit | string |
Unit of shipment weight |
|
signed_by
|
data.tracking.signed_by | string |
Signed by |
|
smses
|
data.tracking.smses | array of |
SMS |
|
source
|
data.tracking.source | string |
Source |
|
tag
|
data.tracking.tag | string |
Tags |
|
subtag
|
data.tracking.subtag | string |
Sub tags |
|
subtag_message
|
data.tracking.subtag_message | string |
Sub tag messages |
|
title
|
data.tracking.title | string |
title |
|
tracked_count
|
data.tracking.tracked_count | integer |
Number of times tracked |
|
last_mile_tracking_supported
|
data.tracking.last_mile_tracking_supported | string |
Last mile tracking is supported |
|
language
|
data.tracking.language | string |
Language |
|
unique_token
|
data.tracking.unique_token | string |
Unique token |
|
checkpoints
|
data.tracking.checkpoints | array of object |
checkpoints |
|
slug
|
data.tracking.checkpoints.slug | string |
Courier Name |
|
city
|
data.tracking.checkpoints.city | string |
City |
|
created_at
|
data.tracking.checkpoints.created_at | string |
Created date and time |
|
location
|
data.tracking.checkpoints.location | string |
Location |
|
country_name
|
data.tracking.checkpoints.country_name | string |
Country name |
|
message
|
data.tracking.checkpoints.message | string |
Message |
|
country_iso3
|
data.tracking.checkpoints.country_iso3 | string |
Country code in ISO 3 format |
|
tag
|
data.tracking.checkpoints.tag | string |
Tags |
|
subtag
|
data.tracking.checkpoints.subtag | string |
Sub tags |
|
subtag_message
|
data.tracking.checkpoints.subtag_message | string |
Sub tag messages |
|
checkpoint_time
|
data.tracking.checkpoints.checkpoint_time | string |
Time reached checkpoint |
|
coordinates
|
data.tracking.checkpoints.coordinates | array of |
Coordinates |
|
state
|
data.tracking.checkpoints.state | string |
State |
|
zip
|
data.tracking.checkpoints.zip | string |
Zip code |
|
raw_tag
|
data.tracking.checkpoints.raw_tag | string |
Raw tags |
|
subscribed_smses
|
data.tracking.subscribed_smses | array of |
subscribed_smses |
|
subscribed_emails
|
data.tracking.subscribed_emails | array of |
subscribed_emails |
|
return_to_sender
|
data.tracking.return_to_sender | boolean |
return_to_sender |
|
tracking_account_number
|
data.tracking.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.tracking.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.tracking.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.tracking.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.tracking.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.tracking.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.tracking.tracking_state | string |
tracking_state |
|
order_promised_delivery_date
|
data.tracking.order_promised_delivery_date | string |
order_promised_delivery_date |
|
delivery_type
|
data.tracking.delivery_type | string |
delivery_type |
|
pickup_location
|
data.tracking.pickup_location | string |
pickup_location |
|
pickup_note
|
data.tracking.pickup_note | string |
pickup_note |
|
courier_tracking_link
|
data.tracking.courier_tracking_link | string |
courier_tracking_link |
|
courier_redirect_link
|
data.tracking.courier_redirect_link | string |
courier_redirect_link |
|
first_attempted_at
|
data.tracking.first_attempted_at | string |
first_attempted_at |
Get all couriers
Return a list of all couriers.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
total
|
data.total | integer |
total |
|
couriers
|
data.couriers | array of object |
Couriers information |
|
slug
|
data.couriers.slug | string |
Courier Name |
|
name
|
data.couriers.name | string |
Name |
|
phone
|
data.couriers.phone | string |
Phone number |
|
other_name
|
data.couriers.other_name | string |
Alternative name |
|
web_url
|
data.couriers.web_url | string |
URL of the website |
|
required_fields
|
data.couriers.required_fields | array of |
Required fields |
|
optional_fields
|
data.couriers.optional_fields | array of |
Optional fields |
Get last checkpoint
Return the tracking information of the last checkpoint of a single tracking.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Courier slug
|
slug | True | string |
Courier slug |
|
Tracking number
|
tracking_number | True | string |
Enter the tracking number |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
id
|
data.id | string |
ID |
|
tracking_number
|
data.tracking_number | string |
Tracking number |
|
slug
|
data.slug | string |
Courier Name |
|
tag
|
data.tag | string |
Tags |
|
subtag
|
data.subtag | string |
Sub tags |
|
subtag_message
|
data.subtag_message | string |
Sub tag messages |
|
slug
|
data.checkpoint.slug | string |
Courier Name |
|
created_at
|
data.checkpoint.created_at | string |
Created date and time |
|
checkpoint_time
|
data.checkpoint.checkpoint_time | string |
Time reached checkpoint |
|
city
|
data.checkpoint.city | string |
City |
|
coordinates
|
data.checkpoint.coordinates | array of |
Coordinates |
|
country_iso3
|
data.checkpoint.country_iso3 | string |
Country code in ISO 3 format |
|
country_name
|
data.checkpoint.country_name | string |
Country name |
|
message
|
data.checkpoint.message | string |
Message |
|
state
|
data.checkpoint.state | string |
State |
|
tag
|
data.checkpoint.tag | string |
Tags |
|
subtag
|
data.checkpoint.subtag | string |
Sub tags |
|
subtag_message
|
data.checkpoint.subtag_message | string |
Sub tag messages |
|
zip
|
data.checkpoint.zip | string |
Zip code |
|
raw_tag
|
data.checkpoint.raw_tag | string |
Raw tags |
Get tracking notification
Get contact information for the users to notify when the tracking changes. Please note that only customer receivers will be returned. Any email, sms or webhook that belongs to the Store will not be returned.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Courier slug
|
slug | True | string |
Courier slug |
|
Tracking number
|
tracking_number | True | string |
Enter the tracking number |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
emails
|
data.notification.emails | array of |
Email addresses |
|
smses
|
data.notification.smses | array of string |
SMS |
Get trackings
Get tracking results of multiple trackings.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
page
|
data.page | integer |
page |
|
limit
|
data.limit | integer |
limit |
|
count
|
data.count | integer |
count |
|
keyword
|
data.keyword | string |
keyword |
|
slug
|
data.slug | string |
Courier Name |
|
origin
|
data.origin | array of |
origin |
|
destination
|
data.destination | array of |
destination |
|
tag
|
data.tag | string |
Tags |
|
fields
|
data.fields | string |
fields |
|
created_at_min
|
data.created_at_min | string |
created_at_min |
|
created_at_max
|
data.created_at_max | string |
created_at_max |
|
last_updated_at
|
data.last_updated_at | string |
Last updated date and time |
|
return_to_sender
|
data.return_to_sender | array of |
return_to_sender |
|
courier_destination_country_iso3
|
data.courier_destination_country_iso3 | array of |
Courier country code in ISO 3 format |
|
trackings
|
data.trackings | array of object |
trackings |
|
id
|
data.trackings.id | string |
ID |
|
created_at
|
data.trackings.created_at | string |
Created date and time |
|
updated_at
|
data.trackings.updated_at | string |
Updated date and time |
|
last_updated_at
|
data.trackings.last_updated_at | string |
Last updated date and time |
|
tracking_number
|
data.trackings.tracking_number | string |
Tracking number |
|
slug
|
data.trackings.slug | string |
Courier Name |
|
active
|
data.trackings.active | boolean |
Active or inactive tracking |
|
android
|
data.trackings.android | array of |
Android |
|
custom_fields
|
data.trackings.custom_fields | string |
Custom fields |
|
customer_name
|
data.trackings.customer_name | string |
Customer Name |
|
delivery_time
|
data.trackings.delivery_time | integer |
Delivery date and time |
|
destination_country_iso3
|
data.trackings.destination_country_iso3 | string |
Destination country code in ISO 3 format |
|
courier_destination_country_iso3
|
data.trackings.courier_destination_country_iso3 | string |
Courier country code in ISO 3 format |
|
emails
|
data.trackings.emails | array of string |
Email addresses |
|
expected_delivery
|
data.trackings.expected_delivery | string |
Expected delivery date and time |
|
ios
|
data.trackings.ios | array of |
iOS |
|
note
|
data.trackings.note | string |
Notes |
|
order_id
|
data.trackings.order_id | string |
Order ID |
|
order_id_path
|
data.trackings.order_id_path | string |
Order ID path |
|
origin_country_iso3
|
data.trackings.origin_country_iso3 | string |
Originating country code in ISO 3 format |
|
shipment_package_count
|
data.trackings.shipment_package_count | integer |
Number of packages in the shipment |
|
shipment_pickup_date
|
data.trackings.shipment_pickup_date | string |
Date and time of packages picked up |
|
shipment_delivery_date
|
data.trackings.shipment_delivery_date | string |
Date and time of packages delivered |
|
shipment_type
|
data.trackings.shipment_type | string |
Type of shipment |
|
shipment_weight
|
data.trackings.shipment_weight | string |
Weight of shipment |
|
shipment_weight_unit
|
data.trackings.shipment_weight_unit | string |
Unit of shipment weight |
|
signed_by
|
data.trackings.signed_by | string |
Signed by |
|
smses
|
data.trackings.smses | array of string |
SMS |
|
source
|
data.trackings.source | string |
Source |
|
tag
|
data.trackings.tag | string |
Tags |
|
subtag
|
data.trackings.subtag | string |
Sub tags |
|
subtag_message
|
data.trackings.subtag_message | string |
Sub tag messages |
|
title
|
data.trackings.title | string |
title |
|
tracked_count
|
data.trackings.tracked_count | integer |
Number of times tracked |
|
last_mile_tracking_supported
|
data.trackings.last_mile_tracking_supported | string |
Last mile tracking is supported |
|
language
|
data.trackings.language | string |
Language |
|
unique_token
|
data.trackings.unique_token | string |
Unique token |
|
checkpoints
|
data.trackings.checkpoints | array of object |
checkpoints |
|
slug
|
data.trackings.checkpoints.slug | string |
Courier Name |
|
city
|
data.trackings.checkpoints.city | string |
City |
|
created_at
|
data.trackings.checkpoints.created_at | string |
Created date and time |
|
location
|
data.trackings.checkpoints.location | string |
Location |
|
country_name
|
data.trackings.checkpoints.country_name | string |
Country name |
|
message
|
data.trackings.checkpoints.message | string |
Message |
|
country_iso3
|
data.trackings.checkpoints.country_iso3 | string |
Country code in ISO 3 format |
|
tag
|
data.trackings.checkpoints.tag | string |
Tags |
|
subtag
|
data.trackings.checkpoints.subtag | string |
Sub tags |
|
subtag_message
|
data.trackings.checkpoints.subtag_message | string |
Sub tag messages |
|
checkpoint_time
|
data.trackings.checkpoints.checkpoint_time | string |
Time reached checkpoint |
|
coordinates
|
data.trackings.checkpoints.coordinates | array of |
Coordinates |
|
state
|
data.trackings.checkpoints.state | string |
State |
|
zip
|
data.trackings.checkpoints.zip | string |
Zip code |
|
raw_tag
|
data.trackings.checkpoints.raw_tag | string |
Raw tags |
|
subscribed_smses
|
data.trackings.subscribed_smses | array of string |
subscribed_smses |
|
subscribed_emails
|
data.trackings.subscribed_emails | array of string |
subscribed_emails |
|
return_to_sender
|
data.trackings.return_to_sender | boolean |
return_to_sender |
|
tracking_account_number
|
data.trackings.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.trackings.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.trackings.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.trackings.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.trackings.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.trackings.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.trackings.tracking_state | string |
tracking_state |
|
order_promised_delivery_date
|
data.trackings.order_promised_delivery_date | string |
order_promised_delivery_date |
|
delivery_type
|
data.trackings.delivery_type | string |
delivery_type |
|
pickup_location
|
data.trackings.pickup_location | string |
pickup_location |
|
pickup_note
|
data.trackings.pickup_note | string |
pickup_note |
|
courier_tracking_link
|
data.trackings.courier_tracking_link | string |
courier_tracking_link |
|
courier_redirect_link
|
data.trackings.courier_redirect_link | string |
courier_redirect_link |
|
first_attempted_at
|
data.trackings.first_attempted_at | string |
first_attempted_at |
Get user activated couriers
Return a list of couriers activated at your AfterShip account.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
total
|
data.total | integer |
total |
|
couriers
|
data.couriers | array of object |
Couriers information |
|
slug
|
data.couriers.slug | string |
Courier Name |
|
name
|
data.couriers.name | string |
Name |
|
phone
|
data.couriers.phone | string |
Phone number |
|
other_name
|
data.couriers.other_name | string |
Alternative name |
|
web_url
|
data.couriers.web_url | string |
URL of the website |
|
required_fields
|
data.couriers.required_fields | array of string |
Required fields |
|
optional_fields
|
data.couriers.optional_fields | array of string |
Optional fields |
|
default_language
|
data.couriers.default_language | string |
Default language |
|
support_languages
|
data.couriers.support_languages | array of string |
Supported languages |
|
service_from_country_iso3
|
data.couriers.service_from_country_iso3 | array of string |
Country code of the service in ISO3 format |
Mark tracking as completed
Mark a tracking as completed. The tracking won't auto update until retrack it.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Courier slug
|
slug | True | string |
Courier slug |
|
Tracking number
|
tracking_number | True | string |
Enter the tracking number |
|
reason
|
reason | string |
reason |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
message
|
meta.message | string |
Message |
|
type
|
meta.type | string |
type |
Remove a notification
Remove notification receivers from a tracking number.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Courier slug
|
slug | True | string |
Courier slug |
|
Tracking number
|
tracking_number | True | string |
Enter the tracking number |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
emails
|
data.notification.emails | array of |
Email addresses |
|
smses
|
data.notification.smses | array of string |
SMS |
Retrack an expired tracking
Retrack an expired tracking. Max 3 times per tracking.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Courier slug
|
slug | True | string |
Courier slug |
|
Tracking number
|
tracking_number | True | string |
Enter the tracking number |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
message
|
meta.message | string |
Message |
|
type
|
meta.type | string |
type |
|
id
|
data.tracking.id | string |
ID |
|
tracking_number
|
data.tracking.tracking_number | string |
Tracking number |
|
slug
|
data.tracking.slug | string |
Courier Name |
|
tracking_account_number
|
data.tracking.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.tracking.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.tracking.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.tracking.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.tracking.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.tracking.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.tracking.tracking_state | string |
tracking_state |
|
active
|
data.tracking.active | boolean |
Active or inactive tracking |
Update a tracking
Update a tracking.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Courier slug
|
slug | True | string |
Courier slug |
|
Tracking number
|
tracking_number | True | string |
Enter the tracking number |
|
title
|
title | string |
title |
|
|
note
|
note | string |
Notes |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
meta.code | integer |
code |
|
id
|
data.tracking.id | string |
ID |
|
created_at
|
data.tracking.created_at | string |
Created date and time |
|
updated_at
|
data.tracking.updated_at | string |
Updated date and time |
|
last_updated_at
|
data.tracking.last_updated_at | string |
Last updated date and time |
|
tracking_number
|
data.tracking.tracking_number | string |
Tracking number |
|
slug
|
data.tracking.slug | string |
Courier Name |
|
active
|
data.tracking.active | boolean |
Active or inactive tracking |
|
android
|
data.tracking.android | array of |
Android |
|
custom_fields
|
data.tracking.custom_fields | string |
Custom fields |
|
customer_name
|
data.tracking.customer_name | string |
Customer Name |
|
delivery_time
|
data.tracking.delivery_time | integer |
Delivery date and time |
|
destination_country_iso3
|
data.tracking.destination_country_iso3 | string |
Destination country code in ISO 3 format |
|
courier_destination_country_iso3
|
data.tracking.courier_destination_country_iso3 | string |
Courier country code in ISO 3 format |
|
emails
|
data.tracking.emails | array of |
Email addresses |
|
expected_delivery
|
data.tracking.expected_delivery | string |
Expected delivery date and time |
|
ios
|
data.tracking.ios | array of |
iOS |
|
note
|
data.tracking.note | string |
Notes |
|
order_id
|
data.tracking.order_id | string |
Order ID |
|
order_id_path
|
data.tracking.order_id_path | string |
Order ID path |
|
origin_country_iso3
|
data.tracking.origin_country_iso3 | string |
Originating country code in ISO 3 format |
|
shipment_package_count
|
data.tracking.shipment_package_count | integer |
Number of packages in the shipment |
|
shipment_pickup_date
|
data.tracking.shipment_pickup_date | string |
Date and time of packages picked up |
|
shipment_delivery_date
|
data.tracking.shipment_delivery_date | string |
Date and time of packages delivered |
|
shipment_type
|
data.tracking.shipment_type | string |
Type of shipment |
|
shipment_weight
|
data.tracking.shipment_weight | integer |
Weight of shipment |
|
shipment_weight_unit
|
data.tracking.shipment_weight_unit | string |
Unit of shipment weight |
|
signed_by
|
data.tracking.signed_by | string |
Signed by |
|
smses
|
data.tracking.smses | array of |
SMS |
|
source
|
data.tracking.source | string |
Source |
|
tag
|
data.tracking.tag | string |
Tags |
|
subtag
|
data.tracking.subtag | string |
Sub tags |
|
subtag_message
|
data.tracking.subtag_message | string |
Sub tag messages |
|
title
|
data.tracking.title | string |
title |
|
tracked_count
|
data.tracking.tracked_count | integer |
Number of times tracked |
|
last_mile_tracking_supported
|
data.tracking.last_mile_tracking_supported | string |
Last mile tracking is supported |
|
language
|
data.tracking.language | string |
Language |
|
unique_token
|
data.tracking.unique_token | string |
Unique token |
|
checkpoints
|
data.tracking.checkpoints | array of object |
checkpoints |
|
slug
|
data.tracking.checkpoints.slug | string |
Courier Name |
|
city
|
data.tracking.checkpoints.city | string |
City |
|
created_at
|
data.tracking.checkpoints.created_at | string |
Created date and time |
|
location
|
data.tracking.checkpoints.location | string |
Location |
|
country_name
|
data.tracking.checkpoints.country_name | string |
Country name |
|
message
|
data.tracking.checkpoints.message | string |
Message |
|
country_iso3
|
data.tracking.checkpoints.country_iso3 | string |
Country code in ISO 3 format |
|
tag
|
data.tracking.checkpoints.tag | string |
Tags |
|
subtag
|
data.tracking.checkpoints.subtag | string |
Sub tags |
|
subtag_message
|
data.tracking.checkpoints.subtag_message | string |
Sub tag messages |
|
checkpoint_time
|
data.tracking.checkpoints.checkpoint_time | string |
Time reached checkpoint |
|
coordinates
|
data.tracking.checkpoints.coordinates | array of |
Coordinates |
|
state
|
data.tracking.checkpoints.state | string |
State |
|
zip
|
data.tracking.checkpoints.zip | string |
Zip code |
|
raw_tag
|
data.tracking.checkpoints.raw_tag | string |
Raw tags |
|
subscribed_smses
|
data.tracking.subscribed_smses | array of |
subscribed_smses |
|
subscribed_emails
|
data.tracking.subscribed_emails | array of |
subscribed_emails |
|
return_to_sender
|
data.tracking.return_to_sender | boolean |
return_to_sender |
|
tracking_account_number
|
data.tracking.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.tracking.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.tracking.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.tracking.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.tracking.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.tracking.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.tracking.tracking_state | string |
tracking_state |
|
order_promised_delivery_date
|
data.tracking.order_promised_delivery_date | string |
order_promised_delivery_date |
|
delivery_type
|
data.tracking.delivery_type | string |
delivery_type |
|
pickup_location
|
data.tracking.pickup_location | string |
pickup_location |
|
pickup_note
|
data.tracking.pickup_note | string |
pickup_note |
|
courier_tracking_link
|
data.tracking.courier_tracking_link | string |
courier_tracking_link |
|
courier_redirect_link
|
data.tracking.courier_redirect_link | string |
courier_redirect_link |
|
first_attempted_at
|
data.tracking.first_attempted_at | string |
first_attempted_at |