• Installs:
  • Today: 0
  • All Time: 3580
Developer:userstefan.skliarov

Aftership API Package

Track shipments of 400 couriers.

List of Endpoints
This is the list of endpoints this API includes. To add any of the endpoints to your app, please click on “Connect to endpoint” text.
See All
Discussions
See All
Readme

Aftership

Aftership Package

Aftership

How to get credentials:

  1. Go to Aftership
  2. Register or log in
  3. Go to Aftership API page to get your apiKey

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

Aftership.getActivatedCouriers

Return a list of couriers activated at your AfterShip account.

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership

Aftership.getAllCouriers

Return a list of all couriers.

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership

Aftership.detectCouriers

Return a list of matched couriers based on tracking number format and selected couriers or a list of couriers.

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingNumberStringTracking number of a shipment.
trackingPostalCodeStringThe postal code of receiver's address. Required by some couriers, such asdeutsch-post
trackingShippingDateDatePickerShipping date in YYYYMMDD format. Required by some couriers, such as deutsch-post
trackingAccountNumberStringAccount number of the shipper for a specific courier. Required by some couriers, such as dynamic-logistics
trackingKeyStringKey of the shipment for a specific courier. Required by some couriers, such as sic-teliway
trackingDestinationCountryStringDestination Country of the shipment for a specific courier. Required by some couriers, such as postnl-3s
slugListIf not specified, Aftership will automatically detect the courier based on the tracking number format and your selected couriers. Use array to input a list of couriers for auto detect.

Aftership.createTracking

Create a tracking

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingNumberStringTracking number of a shipment.
trackingPostalCodeStringThe postal code of receiver's address. Required by some couriers, such asdeutsch-post
trackingShippingDateDatePickerShipping date in YYYYMMDD format. Required by some couriers, such as deutsch-post
trackingAccountNumberStringAccount number of the shipper for a specific courier. Required by some couriers, such as dynamic-logistics
trackingKeyStringKey of the shipment for a specific courier. Required by some couriers, such as sic-teliway
trackingDestinationCountryStringDestination Country of the shipment for a specific courier. Required by some couriers, such as postnl-3s
slugListIf not specified, Aftership will automatically detect the courier based on the tracking number format and your selected couriers. Use array to input a list of couriers for auto detect.
androidListGoogle cloud message registration IDs to receive the push notifications.
iosListApple iOS device IDs to receive the push notifications.
emailsListEmail address(es) to receive email notifications.
smsesListPhone number(s) to receive sms notifications. Enter + and area code before phone number.
titleStringTitle of the tracking. Default value as tracking_number
customerNameStringCustomer name of the tracking.
destinationCountryIso3StringEnter ISO Alpha-3(three letters)to specify the destination of the shipment. If you use postal service to send international shipments, AfterShip will automatically get tracking results at destination courier as well (e.g. USPS for USA).
orderIdStringText field for order ID
orderIdPathStringText field for order path
customFieldsStringCustom fields that accept any text string
noteStringText field for the note

Aftership.getTrackingResults

Return a list of all couriers.

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
pageNumberPage to show. (Default: 1)
limitNumberNumber of trackings each page contain. (Default: 100, Max: 200)
keywordStringSearch the content of the tracking record fields
slugListUnique courier code Use array for multiple values
deliveryTimeNumberTotal delivery time in days. - Difference of 1st checkpoint time and delivered time for delivered shipments - Difference of 1st checkpoint time and current time for non-delivered shipments Value as 0 for pending shipments or delivered shipment with only one checkpoint.
originListOrigin country of trackings. Use ISO Alpha-3 (three letters). Use array for multiple values.
destinationListDestination country of trackings. Use ISO Alpha-3 (three letters). Use array for multiple values.
tagSelectCurrent status of tracking. Values include: Pending, InfoReceived, InTransit, OutForDelivery, AttemptFail, Delivered, Exception, Expired
createdAtMinDatePickerStart date and time of trackings created. AfterShip only stores data of 90 days.(Defaults: 30 days ago, Example: 2013-03-15T16:41:56+08:00)
createdAtMaxDatePickerEnd date and time of trackings created. AfterShip only stores data of 90 days.(Defaults: 30 days ago, Example: 2013-03-15T16:41:56+08:00)
fieldsListUnique courier code Use array for multiple values. Fields to include: title, order_id, tag, checkpoints, checkpoint_time, message, country_name
langStringDefault: '' / Example: 'en' Support Chinese to English translation for china-ems and china-post only

Aftership.getSingleTrackingResultById

Get tracking results of a single tracking by system id

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingIdStringID of the tracking in the system
fieldsListUnique courier code Use array for multiple values. Fields to include: tracking_postal_code,tracking_ship_date,tracking_account_number,tracking_key,tracking_destination_country,title,order_id,tag,checkpoints, checkpoint_time, message, country_name
langStringDefault: '' / Example: 'en' Support Chinese to English translation for china-ems and china-post only

Aftership.getSingleTrackingResultByTrackingNumber

Get tracking results of a single tracking by tracking number

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingNumberStringTracking number
slugStringTracking slug
fieldsListUnique courier code Use array for multiple values. Fields to include: tracking_postal_code,tracking_ship_date,tracking_account_number,tracking_key,tracking_destination_country,title,order_id,tag,checkpoints, checkpoint_time, message, country_name
langStringDefault: '' / Example: 'en' Support Chinese to English translation for china-ems and china-post only

Aftership.updateTrackingById

Update a tracking by system id

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingIdStringSystem tracking id
emailsListEmail address(es) to receive email notifications.
smsesListPhone number(s) to receive sms notifications. Enter + and area code before phone number.
titleStringTitle of the tracking. Default value as tracking_number
customerNameStringCustomer name of the tracking.
orderIdStringText field for order ID
orderIdPathStringText field for order path
customFieldsStringCustom fields that accept any text string
noteStringText field for the note

Aftership.updateTrackingByTrackingNumber

Update a tracking by tracking number

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingNumberStringTracking number
slugStringTracking slug
emailsListEmail address(es) to receive email notifications.
smsesListPhone number(s) to receive sms notifications. Enter + and area code before phone number.
titleStringTitle of the tracking. Default value as tracking_number
customerNameStringCustomer name of the tracking.
orderIdStringText field for order ID
orderIdPathStringText field for order path
customFieldsStringCustom fields that accept any text string
noteStringText field for the note

Aftership.retrackExpiredTrackingById

Retrack an expired tracking by system id. Max 3 times per tracking.

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingIdStringSystem tracking id

Aftership.retrackExpiredTrackingByTrackingNumber

Retrack an expired tracking by tracking number. Max 3 times per tracking.

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingNumberStringTracking number
slugStringTracking slug

Aftership.deleteTrackingById

Delete tracking by system id

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingIdStringSystem tracking id

Aftership.deleteTrackingByTrackingNumber

Delete tracking by tracking number.

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingNumberStringTracking number
slugStringTracking slug

Aftership.getLastCheckpointTrackingInfoById

Return the tracking information of the last checkpoint of a single tracking. by system id

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingIdStringID of the tracking in the system
fieldsListList of fields to include in the response. Fields to include: slug,created_at,checkpoint_time,city,coordinates,country_iso3, country_name,message,state,tag,zip
langStringDefault: '' / Example: 'en' Support Chinese to English translation for china-ems and china-post only

Aftership.getLastCheckpointTrackingInfoByTrackingNumber

Return the tracking information of the last checkpoint of a single tracking. by tracking number

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingNumberStringTracking number
slugStringTracking slug
fieldsListList of fields to include in the response. Use array for multiple values. Fields to include: Fields to include: slug,created_at,checkpoint_time,city,coordinates,country_iso3, country_name,message,state,tag,zip
langStringDefault: '' / Example: 'en' Support Chinese to English translation for china-ems and china-post only

Aftership.getUserContactInfoToNotifyByTrackingNumber

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.

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingNumberStringTracking number
slugStringTracking slug

Aftership.getUserContactInfoToNotifyById

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.

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingIdStringSystem tracking id

Aftership.addTrackingNumberNotificationById

Add a tracking notification by system id

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingIdStringSystem tracking id
emailsListEmail address(es) to receive email notifications.
smsesListPhone number(s) to receive sms notifications. Enter + and area code before phone number.

Aftership.addTrackingNumberNotificationByTrackingNumber

Add a tracking notification by tracking number

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingNumberStringTracking number
slugStringTracking slug
emailsListEmail address(es) to receive email notifications.
smsesListPhone number(s) to receive sms notifications. Enter + and area code before phone number.

Aftership.removeTrackingNumberNotificationById

Remove a tracking notification by system id

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingIdStringSystem tracking id
emailsListEmail address(es) to receive email notifications.
smsesListPhone number(s) to receive sms notifications. Enter + and area code before phone number.

Aftership.removeTrackingNumberNotificationByTrackingNumber

Remove a tracking notification by tracking number

FieldTypeDescription
apiKeycredentialsApi key you received from Aftership
trackingNumberStringTracking number
slugStringTracking slug
emailsListEmail address(es) to receive email notifications.
smsesListPhone number(s) to receive sms notifications. Enter + and area code before phone number.
x
circle
Aftership
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Why sign up to RapidAPI?

  • integrate
    Integrate APIs into your app
    Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
  • keys
    Save all API keys in one place
  • notifications
    Get notifications about API changes
  • stats
    Get stats and monitor API connections
__SING_UP_WITH_GITHUB__
__SING_UP_WITH_FACEBOOK__
__SING_UP_WITH_GOOGLE__
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view