AfterShip

AfterShip integration (Productivity, Location). Imported from open-connector.

API key9 toolshttps://api.aftership.com/tracking/2026-01

POST

aftership_create_tracking

Create an AfterShip tracking record for a shipment.

/trackings

36 parameters

Param	Type	Required	Description
id	string	optional	A custom tracking ID. AfterShip generates one if omitted.
tracking_number	string	required	The carrier tracking number of the shipment.
slug	string	optional	The AfterShip courier slug, such as dhl, ups, or usps.
slug_group	string	optional	A courier slug group such as fedex-group.
shipment_tags	array	optional	Shipment tag strings attached to the tracking.
courier_connection_id	string	optional	The AfterShip courier connection ID.
last_mile	string	optional	The AfterShip courier slug, such as dhl, ups, or usps.
title	string	optional	A user-facing tracking title, such as an order number.
order_id	string	optional	A globally unique identifier for the order.
custom_fields	object	optional	Custom tracking fields sent to AfterShip as string key-value pairs.
order_id_path	string	optional	The URL for the order in your system or store.
language	string	optional	The recipient's ISO 639-1 language code for notifications.
order_promised_delivery_date	object	optional	The promised delivery date range in the shipment recipient's timezone.
pickup_location	string	optional	The shipment pickup location for the receiver.
delivery_type	string	optional	The shipment delivery type.
pickup_note	string	optional	The shipment pickup note for the receiver.
tracking_account_number	string	optional	The shipper's carrier account number.
tracking_key	string	optional	A carrier-specific tracking credential.
tracking_ship_date	string	optional	The shipment ship date.
origin_country_region	string	optional	The origin country or region as an ISO Alpha-3 code.
origin_state	string	optional	The origin state or province.
origin_city	string	optional	The origin city.
origin_postal_code	string	optional	The origin postal code.
origin_raw_location	string	optional	The origin address or raw location text.
destination_country_region	string	optional	The destination country or region as an ISO Alpha-3 code.
destination_state	string	optional	The destination state or province.
destination_city	string	optional	The destination city.
destination_postal_code	string	optional	The destination postal code.
destination_raw_location	string	optional	The destination address or raw location text.
note	string	optional	A note attached to the tracking.
order_date	string	optional	The order date.
order_number	string	optional	The order number.
shipment_type	string	optional	The shipment type.
location_id	string	optional	The AfterShip location ID.
shipping_method	string	optional	The shipping method name.
customers	array	optional	Customer contacts attached to the tracking.

GET

aftership_get_tracking

Retrieve one AfterShip tracking record by tracking ID.

/trackings/{id}

3 parameters

Param	Type	Required	Description
id	string	required	The AfterShip tracking ID.
fields	string	optional	A comma-separated list of response fields to include.
lang	string	optional	The language code used to translate checkpoint messages.

PUT

aftership_update_tracking

Update editable fields on an AfterShip tracking record.

/trackings/{id}

31 parameters

Param	Type	Required	Description
id	string	required	The AfterShip tracking ID.
slug	string	optional	The AfterShip courier slug, such as dhl, ups, or usps.
title	string	optional	A user-facing tracking title, such as an order number.
order_id	string	optional	A globally unique identifier for the order.
custom_fields	object	optional	Custom tracking fields sent to AfterShip as string key-value pairs.
order_id_path	string	optional	The URL for the order in your system or store.
language	string	optional	The recipient's ISO 639-1 language code for notifications.
order_promised_delivery_date	object	optional	The promised delivery date range in the shipment recipient's timezone.
pickup_location	string	optional	The shipment pickup location for the receiver.
delivery_type	string	optional	The shipment delivery type.
pickup_note	string	optional	The shipment pickup note for the receiver.
tracking_account_number	string	optional	The shipper's carrier account number.
tracking_key	string	optional	A carrier-specific tracking credential.
tracking_ship_date	string	optional	The shipment ship date.
origin_country_region	string	optional	The origin country or region as an ISO Alpha-3 code.
origin_state	string	optional	The origin state or province.
origin_city	string	optional	The origin city.
origin_postal_code	string	optional	The origin postal code.
origin_raw_location	string	optional	The origin address or raw location text.
destination_country_region	string	optional	The destination country or region as an ISO Alpha-3 code.
destination_state	string	optional	The destination state or province.
destination_city	string	optional	The destination city.
destination_postal_code	string	optional	The destination postal code.
destination_raw_location	string	optional	The destination address or raw location text.
note	string	optional	A note attached to the tracking.
order_date	string	optional	The order date.
order_number	string	optional	The order number.
shipment_type	string	optional	The shipment type.
location_id	string	optional	The AfterShip location ID.
shipping_method	string	optional	The shipping method name.
customers	array	optional	Customer contacts attached to the tracking.

DELETE

aftership_delete_tracking

Delete an AfterShip tracking record by tracking ID.

/trackings/{id}

1 parameter

Param	Type	Required	Description
id	string	required	The AfterShip tracking ID.

GET

aftership_list_trackings

List AfterShip trackings with cursor pagination and shipment filters.

/trackings

18 parameters

Param	Type	Required	Description
cursor	string	optional	The cursor value for the current page of results.
limit	integer	optional	The number of trackings to return on each page.
keyword	string	optional	Search tracking numbers, titles, order IDs, customers, and custom fields.
tracking_numbers	array	optional	Tracking numbers to filter by. AfterShip supports up to 50 values.
slug	array	optional	Courier slugs to filter by.
transit_time	integer	optional	Total delivery time in days.
origin	array	optional	Origin ISO Alpha-3 country or region codes.
destination	array	optional	Destination ISO Alpha-3 country or region codes.
tag	string	optional	The current shipment delivery status.
created_at_min	string	optional	Only include trackings created at or after this timestamp.
created_at_max	string	optional	Only include trackings created at or before this timestamp.
updated_at_min	string	optional	Only include trackings updated at or after this timestamp.
updated_at_max	string	optional	Only include trackings updated at or before this timestamp.
fields	string	optional	A comma-separated list of response fields to include.
return_to_sender	boolean	optional	Whether to filter return-to-sender shipments.
courier_destination_country_region	string	optional	The courier destination country or region to filter by.
shipment_tags	array	optional	Shipment tags to filter by.
order_id	string	optional	The order ID to filter by.

POST

aftership_retrack_tracking

Ask AfterShip to retrack an expired tracking record by ID.

/trackings/{id}/retrack

1 parameter

Param	Type	Required	Description
id	string	required	The AfterShip tracking ID.

POST

aftership_mark_tracking_completed

Mark an AfterShip tracking record as completed by ID.

/trackings/{id}/mark-as-completed

3 parameters

Param	Type	Required	Description
id	string	required	The AfterShip tracking ID.
reason	string	required	The reason for marking the tracking as completed.
event_datetime	string	optional	The completion event timestamp.

GET

aftership_list_couriers

List AfterShip couriers, optionally limited to active couriers or slugs.

/couriers

2 parameters

Param	Type	Required	Description
active	boolean	optional	Whether to return only couriers activated for the account.
slug	array	optional	Courier slugs to filter by.

POST

aftership_detect_couriers

Detect possible AfterShip couriers for a tracking number.

/couriers/detect

10 parameters

Param	Type	Required	Description
tracking_number	string	required	The carrier tracking number to inspect.
slug	array	optional	Courier slugs to limit auto-detection to.
destination_postal_code	string	optional	The destination postal code.
tracking_ship_date	string	optional	The shipping date in YYYYMMDD format.
tracking_account_number	string	optional	The shipper's carrier account number.
tracking_key	string	optional	A carrier-specific tracking credential.
destination_state	string	optional	The destination state or province.
slug_group	string	optional	A courier slug group such as fedex-group.
origin_country_region	string	optional	The origin country or region as an ISO Alpha-3 code.
destination_country_region	string	optional	The destination country or region as an ISO Alpha-3 code.