Update a tracking by ID

put
/trackings/{id}

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)
id
string
required

tracking ID

Content-Type
string
required

Content-Type

Allowed value:
application/json
Default:
application/json
tracking
object
smses
array[string]

Phone number(s) to receive sms notifications. Input [] to clear the value of this field.

emails
array[string]

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

title
string

Title of the tracking. You can customize the title for short notes. Input "" to clear the value of this field.

customer_name
string

Customer name of the tracking.

order_id
string

A globally-unique identifier for the order.

order_id_path
string

Text field for order path

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

Enter ISO 639-1 Language Code to specify the store, customer or order 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

Account number of the shipper for a specific courier. Required by some couriers. Refer to this page for more details

tracking_origin_country
string

Origin Country/Region of the shipment for a specific courier. Required by some couriers. Refer to this page for more details

tracking_destination_country
string

Destination Country/Region of the shipment for a specific courier. Required by some couriers. Refer to this page for more details

tracking_key
string

Key of the shipment for a specific courier. Required by some couriers. Refer to this page for more details

tracking_postal_code
string

The postal code of receiver's address. Required by some couriers. Refer to this page for more details

tracking_ship_date
string

Shipping date in YYYYMMDD format. Required by some couriers. Refer to this page for more details

tracking_state
string

Located state of the shipment for a specific courier. Required by some couriers. Refer to this page for more details

order_number
string

The unique numeric identifier for the order for use by shop owner and customer.(will come into action from est. 24 Feb)

order_date
string

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

shipment_type
string

The carrier’s shipment type. When you input this field, AfterShip will not get updates from the carrier.

Auth
:
Parameters
:
:
Body
preparing...