Create a tracking

post
/trackings

Create 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)
Content-Type
string
required

Content-Type

Allowed value:
application/json
Default:
application/json

Create tracking object

tracking
object
required
tracking_number
string
required

Tracking number of a shipment.Show all...

>= 1 characters
slug

comma seperated slug

title
string

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

>= 1 characters
order_id
string

A globally-unique identifier for the order.

>= 1 characters
order_id_path
string

The URL for the order in your system or store.

>= 1 characters
custom_fields
object

Custom fields that accept an object with string field.Show all...

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.

>= 1 characters
order_promised_delivery_date
string<date>

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

>= 1 characters
Match pattern:
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
delivery_type
string

Shipment delivery typeShow all...

>= 1 characters
Allowed values:
pickup_at_storedoor_to_doorpickup_at_courier
pickup_location
string

Shipment pickup location for receiver

>= 1 characters
pickup_note
string

Shipment pickup note for receiver

>= 1 characters
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.

emails
array[string]

Email address(es) to receive email notifications. Accept either array or comma separated as input. Supports up to 3 email addresses.

smses
array[string]

Phone number(s) to receive sms notifications. Enter + andarea code before phone number. Accept either array or comma separated as input. Supports up to 3 phone numbers.

customer_name
string

Customer name of the tracking.

origin_country_iso3
string

The ISO Alpha-3 code (3 letters) for the origin country/region. E.g. USA for the United States. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.

destination_country_iso3
string

The ISO Alpha-3 code (3 letters) for the destination country/region. E.g. USA for the United States. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.

note
string

Text field for the note

slug_group
string

Slug group is a group of slugs which belong to same courier. For example, when you inpit "fedex-group" as slug_group, AfterShip will detect the tracking with "fedex-uk", "fedex-fims", and other slugs which belong to "fedex". It cannot be used with slug at the same time. (See slug_groups definition)

Allowed values:
amazon-groupfedex-grouptoll-grouptaqbin-grouptnt-groupcj-grouphermes-groupdpd-groupgls-groupdhl-groupfastway-groupasendia-group
order_date
string

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

order_number
string

A unique, human-readable identifier for the order.

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.

shipment_tags
array[string]

Used to add tags to your shipments to help categorize and filter them easily.

<= 50 items
courier_connection_id
string

If you’ve connected multiple accounts for a single carrier on AfterShip, you can now use the courier_connection_id field to tell AfterShip which carrier account you’ve used to handle a shipment so we can track it. (Get your courier connection id)

next_couriers
array[object]

If a shipment has multiple carriers, you can use the next_couriers field to tell AfterShip who the second carrier is. This is useful if the first carrier does not send us this information.

<= 1 items
Auth
:
Parameters
:
Body
preparing...