Update a tracking by ID - AfterShip Tracking API

Update a tracking.

[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.v4.json)[url](../../model/resource/checkpoint.v4.json)[url](../../model/resource/courier.v4.json)[url](../../model/resource/notification.v4.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.v4.json/paths/~1trackings/get)[url](../../reference/api.v4.json/paths/~1trackings/post)[url](../../reference/api.v4.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.v4.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.v4.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.v4.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.v4.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.v4.json/paths/~1couriers/get)[url](../../reference/api.v4.json/paths/~1couriers~1detect/post)[url](../../reference/api.v4.json/paths/~1couriers~1all/get)[url](../../reference/api.v4.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.v4.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.v4.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.v4.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)

Request

Security: API Key (as-api-key)

Security: API Key (aftership-api-key)

Path Parameters

string

required

tracking ID

Headers

Content-Type

string

required

Content-Type

Allowed value:

application/json

Default:

application/json

Body

tracking

object

smses

array[string]

Phone number(s) to receive sms notifications. Input [] to clear the value of this field. Supports up to 3 phone numbers.

emails

array[string]

Email address(es) to receive email notifications. Input [] to clear the value of this field. Supports up to 3 email addresses.

title

string

By default this field shows the tracking_number, but you can customize it as you wish with any info (e.g. the order number).

customer_name

string

Customer name of the tracking.

order_id

string

A globally-unique identifier for the order.

order_id_path

string

The URL for the order in your system or store.

custom_fields

object

Custom fields that accept an object with string, boolean or number fields. Input null to clear the value of this field.

note

string

Text field for the note. Input "" to clear the value of this field.

language

string

The recipient’s language. If you set up AfterShip notifications in different languages, we use this to send the recipient tracking updates in their preferred language. Use an ISO 639-1 Language Code to specify the language.

order_promised_delivery_date

string

Promised delivery date of an order in YYYY-MM-DD format.

delivery_type

string

Shipment delivery typeShow all...

Allowed values:

pickup_at_storepickup_at_courierdoor_to_door

pickup_location

string

Shipment pickup location for receiver

pickup_note

string

Shipment pickup note for receiver

slug

string

Unique code of each courier. Provide a single courier.(https://admin.aftership.com/settings/couriers). Get a list of courier slug using GET /couriers

tracking_account_number

string

Additional field required by some carriers to retrieve the tracking info. The shipper’s carrier account number. Refer to our article on additional tracking fields for more details.

tracking_origin_country

string

Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on additional tracking fields for more details.

tracking_destination_country

string

Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on additional tracking fields for more details.

tracking_key

string

Additional field required by some carriers to retrieve the tracking info. A type of tracking credential required by some carriers. Refer to our article on additional tracking fields for more details.

tracking_postal_code

string

Additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on additional tracking fields for more details.

tracking_ship_date

string

Additional field required by some carriers to retrieve the tracking info. The date the shipment was sent, using the format YYYYMMDD. Refer to our article on additional tracking fields for more details.

tracking_state

string

Additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on additional tracking fields for more details.

order_number

string

A unique, human-readable identifier for the order.

order_date

string

Order date in YYYY-MM-DDTHH:mm:ssZ format. e.g. 2021-07-26T11:23:51Z

shipment_type

string

The carrier service type for the shipment. If you provide info for this field, AfterShip will not update it with info from the carrier.