{ "openapi": "3.1.0", "x-stoplight": { "id": "fcd9acb5f448a" }, "info": { "title": "API Overview", "version": "1.0", "description": "> OAS Schema can be downloaded [here](https://stoplight.io/api/v1/projects/automizely/docs-api-aftership-com/nodes/reference/api.json?branch=production%252F2024-07&deref=optimizedBundle)\n
[url](../../docs/quickstart/authentication.md)
", "contact": { "name": "AfterShip Support", "url": "https://www.aftership.com/contact-us", "email": "support@aftership.com" }, "termsOfService": "https://www.aftership.com/terms", "summary": "API Overview" }, "servers": [ { "url": "https://api.aftership.com/tracking/2024-07", "description": "API Endpoint" } ], "paths": { "/trackings": { "get": { "summary": "Get trackings", "responses": { "200": { "description": "Get trackings response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response_get_multiple.v1" }, "examples": { "get-trackings": { "value": { "meta": { "code": 200 }, "data": { "page": 1, "limit": 100, "count": 1, "keyword": "", "slug": "", "origin": [], "destination": [], "transit_time": [], "tag": "Delivered", "order_id": "", "fields": "", "created_at_min": "2023-12-11T06:29:50+00:00", "created_at_max": "2024-04-09T06:29:50+00:00", "last_updated_at": null, "return_to_sender": [], "courier_destination_country_iso3": [], "trackings": [ { "id": "0b02015fc7fd4f3c8d5490cece4d124d", "legacy_id": "my2uktymyz72xld1f7l3h01z", "created_at": "2023-01-18T08:47:10+00:00", "updated_at": "2023-01-18T17:47:10+00:00", "last_updated_at": "2023-01-18T17:47:10+00:00", "tracking_number": "61293150000079650811", "slug": "fedex", "active": false, "custom_fields": { "store_name": "my-store" }, "customer_name": "Steve Young", "transit_time": 9, "origin_country_iso3": "CHN", "origin_state": "Beijing", "origin_city": "Beijing", "origin_postal_code": "065001", "origin_raw_location": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China", "destination_country_iso3": "USA", "destination_state": "New York", "destination_city": "New York City", "destination_postal_code": "10001", "destination_raw_location": "13th Street, New York, NY, 10011, USA, United States", "courier_destination_country_iso3": "USA", "emails": [ "example@aftership.com" ], "expected_delivery": "2022-01-05T12:11:11+01:00", "note": "note", "order_id": "6845a095a27a4caeb27487806f058add", "order_id_path": "https://www.aftership.com/my-orders/6845a095a27a4caeb27487806f058add", "order_date": "2022-01-20T15:56:12+08:00", "shipment_package_count": 1, "shipment_pickup_date": "2022-01-21T15:00:00", "shipment_delivery_date": "2022-01-29T11:23:00", "shipment_type": "FedEx SmartPost", "shipment_weight": { "value": 0.7, "unit": "kg" }, "signed_by": "Steve Young", "smses": [ "+8613800138000" ], "source": "api", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "title": "61293150000079650811", "tracked_count": 13, "last_mile_tracking_supported": true, "language": "en", "checkpoints": [ { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T18:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinate": null, "country_iso3": "USA", "country_name": "United States", "message": "Package delivered", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "raw_tag": "RO", "events": { "code": "unable_to_deliver", "reason": { "code": "incorrect_missing_address" } } } ], "subscribed_smses": [ "string" ], "subscribed_emails": [ "string" ], "return_to_sender": false, "order_promised_delivery_date": "2022-01-01", "delivery_type": "pickup_at_store", "pickup_location": "13th Street, New York, NY 10011, USA, United States", "pickup_note": "No notes", "courier_tracking_link": "https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US", "first_attempted_at": "2022-01-01T17:00:00-05:00", "courier_redirect_link": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US", "tracking_account_number": null, "tracking_key": null, "tracking_ship_date": "20220101", "on_time_status": "on-time", "on_time_difference": 0, "order_tags": [ "Exception" ], "aftership_estimated_delivery_date": { "estimated_delivery_date": "2022-01-03", "confidence_code": 10001, "estimated_delivery_date_min": "2022-01-02", "estimated_delivery_date_max": "2022-01-04" }, "custom_estimated_delivery_date": { "type": "specific", "datetime": "2022-01-05", "datetime_min": null, "datetime_max": null }, "order_number": "162654659775", "first_estimated_delivery": { "type": "specific", "source": "Carrier EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "latest_estimated_delivery": { "type": "specific", "source": "AfterShip EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "shipment_tags": [ "Returned" ], "courier_connection_id": "8e1261bde336436abbc7cb3eee8cd707", "next_couriers": [ { "slug": "usps", "tracking_number": "61293150000079650811", "source": "system" } ], "tracking_origin_country": "CHN", "tracking_destination_country": "USA", "tracking_postal_code": "90213", "tracking_state": "CA", "carbon_emissions": { "unit": "kg", "value": 0.7 }, "location_id": "bda843ed811541fc852a8447371cf6f2", "shipping_method": "Local Delivery", "failed_delivery_attempts": 2, "signature_requirement": "signature_required", "delivery_location_type": null } ] } } } } } } } }, "operationId": "get-trackings", "description": "Get tracking results of multiple trackings.\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)\n[url](../../docs/quickstart/authentication.md)\n
", "parameters": [ { "schema": { "type": "string", "enum": [ "application/json" ], "example": "application/json", "default": "application/json" }, "in": "header", "name": "Content-Type", "description": "Content-Type\n", "required": true }, { "schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 }, "in": "query", "name": "page", "description": "The page to query. Maximum page number is bounded by total number of queried trackings which cannot exceed 160,000 trackings. (Default: 1)" }, { "schema": { "type": "integer", "minLength": 1, "maxLength": 200, "minimum": 1, "maximum": 200, "default": 100, "example": 100 }, "in": "query", "name": "limit", "description": "Number of trackings each page contain. (Default: 100, Max: 200)" }, { "schema": { "type": "string", "example": "RA123456789US" }, "in": "query", "name": "keyword", "description": "Search the content of the tracking record fields: `tracking_number`, `title`, `order_id`, `customer_name`, `custom_fields`, `emails`, `smses`" }, { "schema": { "type": "string", "example": "RA123456789US,LE123456789US" }, "in": "query", "name": "tracking_numbers", "description": "Tracking number of shipments. Use comma to separate multiple values (Example: RA123456789US,LE123456789US). Supports up to 50 tracking numbers." }, { "schema": { "type": "string", "pattern": "^[a-z0-9-]+$", "minLength": 1, "example": "usps" }, "in": "query", "name": "slug", "description": "Unique courier code Use comma for multiple values. (Example: dhl,ups,usps)" }, { "schema": { "type": "integer", "example": 1 }, "in": "query", "name": "transit_time", "description": "Total delivery time in days.\n\n- When the shipment is delivered: Transit time = Delivered date - Picked up date\n- When the shipment is not delivered: Transit time = Current date - Picked up date\n\nValue as `null` for the shipment without pickup date." }, { "schema": { "type": "string", "pattern": "^[A-Z,]+$", "example": "USA" }, "in": "query", "name": "origin", "description": "Origin country/region of trackings. Use ISO Alpha-3 (three letters). Use comma for multiple values. (Example: USA,HKG)" }, { "schema": { "type": "string", "pattern": "^[A-Z,]+$", "example": "USA" }, "in": "query", "name": "destination", "description": "Destination country/region of trackings. Use ISO Alpha-3 (three letters). Use comma for multiple values. (Example: USA,HKG)" }, { "schema": { "type": "string", "enum": [ "Pending", "InfoReceived", "InTransit", "OutForDelivery", "AttemptFail", "Delivered", "AvailableForPickup", "Exception", "Expired" ], "example": "InTransit", "pattern": "^[A-Za-z]+$" }, "in": "query", "name": "tag", "description": "Current status of tracking. Values include `Pending`, `InfoReceived`, `InTransit`, `OutForDelivery`, `AttemptFail`, `Delivered`, `AvailableForPickup`, `Exception`, `Expired` (See tag definition)" }, { "schema": { "type": "string", "example": "2013-03-15T16:41:56%2B08:00", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\+[0-9]{2}:[0-9]{2}$" }, "in": "query", "name": "created_at_min", "description": "Start date and time of trackings created. AfterShip only stores data of 120 days. Please make sure the value of the parameter is properly escaped in [URL encoding](https://en.wikipedia.org/wiki/Percent-encoding).\n(Defaults: 30 days ago, Example: 2013-03-15T16:41:56%2B08:00)" }, { "schema": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\+[0-9]{2}:[0-9]{2}$", "example": "2013-03-15T16:41:56%2B08:00" }, "in": "query", "name": "created_at_max", "description": "End date and time of trackings created. Please make sure the value of the parameter is properly escaped in [URL encoding](https://en.wikipedia.org/wiki/Percent-encoding).\n(Defaults: now, Example: 2013-04-15T16:41:56%2B08:00)" }, { "schema": { "type": "string", "example": "2013-03-15T16:41:56%2B08:00", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\+[0-9]{2}:[0-9]{2}$" }, "in": "query", "name": "updated_at_min", "description": "Start date and time of trackings updated. Please make sure the value of the parameter is properly escaped in [URL encoding](https://en.wikipedia.org/wiki/Percent-encoding).(Example: 2013-04-15T16:41:56%2B08:00)" }, { "schema": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\+[0-9]{2}:[0-9]{2}$", "example": "2013-03-15T16:41:56%2B08:00" }, "in": "query", "name": "updated_at_max", "description": "End date and time of trackings updated. Please make sure the value of the parameter is properly escaped in [URL encoding](https://en.wikipedia.org/wiki/Percent-encoding).(Example: 2013-04-15T16:41:56%2B08:00)" }, { "schema": { "type": "string", "example": "title", "pattern": "^[a-z0-9,]+$" }, "in": "query", "name": "fields", "description": "List of fields to include in the response. Use comma for multiple values. Available options: `title`, `order_id`, `tag`, `checkpoints`. Example: `title,order_id`" }, { "schema": { "type": "string", "pattern": "^[a-z,]+$", "example": "true" }, "in": "query", "name": "return_to_sender", "description": "Select return to sender, the value should be `true` or `false`, with optional comma separated." }, { "schema": { "type": "string", "pattern": "^[A-Z,]+$", "example": "USA" }, "in": "query", "name": "courier_destination_country_iso3", "description": "Destination country/region of trackings returned by courier. Use ISO Alpha-3 (three letters). Use comma for multiple values. (Example: USA,HKG)" }, { "schema": { "type": "string" }, "in": "query", "description": "Tags you added to your shipments to help categorize and filter them easily. Use a comma to separate multiple values (Example: a,b)", "name": "shipment_tags" }, { "schema": { "type": "string", "example": "6845a095a27a4caeb27487806f058add" }, "in": "query", "name": "order_id", "description": "A globally-unique identifier for the order. Use comma for multiple values.(Example: 6845a095a27a4caeb27487806f058add,4845a095a27a4caeb27487806f058abc)" } ], "x-stoplight": { "id": "jh865r66gc6hi" }, "tags": [ "Tracking" ] }, "post": { "summary": "Create a tracking", "operationId": "create-tracking", "responses": { "201": { "description": "Tracking object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" }, "examples": { "normal response": { "value": { "meta": { "code": 201 }, "data": { "id": "56442da79af64b5f894109b5cbaba64c", "legacy_id": "my2uktymyz72xld1f7l3h01z", "created_at": "2023-01-18T08:47:10+00:00", "updated_at": "2023-01-18T17:47:10+00:00", "last_updated_at": "2023-01-18T17:47:10+00:00", "tracking_number": "61293150000079650811", "slug": "fedex", "active": true, "custom_fields": { "store_name": "my-store" }, "customer_name": "Steve Young", "transit_time": 9, "origin_country_iso3": "CHN", "origin_state": "Beijing", "origin_city": "Beijing", "origin_postal_code": "065001", "origin_raw_location": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China", "destination_country_iso3": "USA", "destination_state": "New York", "destination_city": "New York City", "destination_postal_code": "10001", "destination_raw_location": "13th Street, New York, NY, 10011, USA, United States", "courier_destination_country_iso3": "USA", "emails": [ "example@aftership.com" ], "expected_delivery": "2022-01-05T12:11:11+01:00", "note": "note", "order_id": "6845a095a27a4caeb27487806f058add", "order_id_path": "https://www.aftership.com/my-orders/6845a095a27a4caeb27487806f058add", "order_date": "2022-01-20T15:56:12+08:00", "shipment_package_count": 1, "shipment_pickup_date": "2022-01-21T15:00:00", "shipment_delivery_date": "2022-01-29T11:23:00", "shipment_type": "FedEx SmartPost", "shipment_weight": null, "signed_by": "Steve Young", "smses": [ "+8613800138000" ], "source": "api", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "title": "61293150000079650811", "tracked_count": 13, "last_mile_tracking_supported": true, "language": "en", "unique_token": "Deprecated", "checkpoints": [], "subscribed_smses": [ "+8613800138000" ], "subscribed_emails": [ "example@aftership.com" ], "return_to_sender": false, "order_promised_delivery_date": "2022-01-01", "delivery_type": "pickup_at_store", "pickup_location": "13th Street, New York, NY 10011, USA, United States", "pickup_note": "No notes", "courier_tracking_link": "https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US", "first_attempted_at": "2022-01-01T17:00:00-05:00", "courier_redirect_link": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US", "tracking_account_number": null, "tracking_key": null, "tracking_ship_date": "20220101", "on_time_status": "on-time", "on_time_difference": 0, "order_tags": [ "Exception" ], "aftership_estimated_delivery_date": { "estimated_delivery_date": "2022-01-03", "confidence_code": 10001, "estimated_delivery_date_min": "2022-01-02", "estimated_delivery_date_max": "2022-01-04" }, "custom_estimated_delivery_date": { "type": "specific", "datetime": "2022-01-05", "datetime_min": null, "datetime_max": null }, "order_number": "162654659775", "first_estimated_delivery": { "type": "specific", "source": "Carrier EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "latest_estimated_delivery": { "type": "specific", "source": "AfterShip EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "shipment_tags": [ "Returned" ], "courier_connection_id": "8e1261bde336436abbc7cb3eee8cd707", "location_id": "bda843ed811541fc852a8447371cf6f2", "shipping_method": "Local Delivery", "carbon_emissions": { "value": 0.7, "unit": "kg" }, "next_couriers": [ { "slug": "usps", "tracking_number": "61293150000079650811", "source": "system" } ], "tracking_origin_country": "CHN", "tracking_destination_country": "USA", "tracking_postal_code": "90213", "tracking_state": "CA" } } } } } } } }, "description": "Create a tracking.\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)\n[url](../../docs/quickstart/authentication.md)
", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "tracking_number" ], "properties": { "tracking_number": { "type": "string", "minLength": 1, "description": "Tracking number of a shipment.\n\nDuplicated tracking numbers, tracking numbers with invalid tracking number format will not be accepted.\n\nWe only accept tracking numbers with length from 4 to 100\n\nWe currently support the following characters in a tracking number:\n\n- A - Z\n- 0 - 9\n- `-` (Hyphen)\n- . (Period)\n- _ (Underscore)\n- / (Slash)" }, "slug": { "type": "string", "description": "Unique courier code. Get courier codes [here](https://www.aftership.com/docs/tracking/others/supported-couriers)." }, "title": { "type": "string", "minLength": 1, "description": "By default this field shows the `tracking_number`, but you can customize it as you wish with any info (e.g. the order number)." }, "order_id": { "type": "string", "minLength": 1, "description": "A globally-unique identifier for the order." }, "order_id_path": { "type": "string", "minLength": 1, "description": "The URL for the order in your system or store." }, "custom_fields": { "type": "object", "description": "Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any [personal data](https://www.aftership.com/legal/dpa#:~:text=Personal%20Data%20means,that%20natural%20person) in custom fields.\n\n- Maximum charater limit for a key name: 30\n- Maximum count for a key-value pair in a custom field object: 25\n- Maximum value length: 512 charaters\n- Supported value type: String only (object and array are prohibted)", "additionalProperties": { "x-stoplight": { "id": "ojdlar98pvzkw" }, "type": "string" } }, "language": { "type": "string", "minLength": 1, "description": "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](https://help.aftership.com/hc/en-us/articles/360001623287-Supported-Language-Parameters) to specify the language." }, "order_promised_delivery_date": { "type": "string", "minLength": 1, "description": "The promised delivery date of the order. It uses the formats:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ", "format": "date" }, "delivery_type": { "type": "string", "minLength": 1, "description": "Shipment delivery type\n\n- pickup_at_store\n- pickup_at_courier\n- door_to_door", "enum": [ "pickup_at_store", "door_to_door", "pickup_at_courier" ] }, "pickup_location": { "type": "string", "minLength": 1, "description": "Shipment pickup location for receiver" }, "pickup_note": { "type": "string", "minLength": 1, "description": "Shipment pickup note for receiver" }, "tracking_account_number": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_key": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_ship_date": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "emails": { "type": "array", "description": "Email address(es) to receive email notifications. Accept either array. Supports up to 3 email addresses.", "items": { "type": "string" } }, "smses": { "type": "array", "description": "The phone number(s) to receive sms notifications. Enter `+` andarea `code before` phone number. Accept either array. Supports up to 3 phone numbers.", "items": { "type": "string" } }, "customer_name": { "type": "string", "description": "Customer name of the tracking." }, "origin_country_iso3": { "type": "string", "description": "The [ISO Alpha-3](https://support.aftership.com/en/article/iso3-country-code-rlpi07/) 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. Also the 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "CHN" }, "origin_state": { "type": "string", "description": "The state of the sender’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "Beijing" }, "origin_city": { "type": "string", "description": "The city of the sender’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "Beijing" }, "origin_postal_code": { "type": "string", "description": "The postal of the sender’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "065001" }, "origin_raw_location": { "type": "string", "description": "The sender address that the shipment is shipping from. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China" }, "destination_country_iso3": { "type": "string", "description": "The [ISO Alpha-3](https://support.aftership.com/en/article/iso3-country-code-rlpi07/) 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. Also the 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "USA" }, "destination_state": { "type": "string", "description": "The state of the recipient’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. Also the 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "New York" }, "destination_city": { "type": "string", "description": "The city of the recipient’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "New York City" }, "destination_postal_code": { "type": "string", "description": "The postal of the recipient’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. Also the 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "10001" }, "destination_raw_location": { "type": "string", "description": "The shipping address that the shipment is shipping to. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "13th Street, New York, NY, 10011, USA, United States" }, "note": { "type": "string", "description": "Text field for the note" }, "slug_group": { "$ref": "#/components/schemas/Slug_group.v1" }, "order_date": { "type": "string", "description": "Order date in YYYY-MM-DDTHH:mm:ssZ format. e.g. 2021-07-26T11:23:51-05:00" }, "order_number": { "type": "string", "description": "A unique, human-readable identifier for the order." }, "shipment_type": { "type": "string", "description": "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": { "type": "array", "description": "Used to add tags to your shipments to help categorize and filter them easily.", "maxItems": 50, "items": { "type": "string", "maxLength": 32 } }, "courier_connection_id": { "type": "string", "description": "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](https://admin.aftership.com/carrier-connection))" }, "next_couriers": { "type": "array", "description": "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. ", "maxItems": 1, "items": { "type": "object", "required": [ "slug", "tracking_number" ], "properties": { "slug": { "type": "string" }, "tracking_number": { "type": "string", "description": "Tracking number of a shipment.\n\nDuplicated tracking numbers, tracking numbers with invalid tracking number format will not be accepted.\n\nWe only accept tracking numbers with length from 4 to 100\n\nWe currently support the following characters in a tracking number:\n\n- A - Z\n- 0 - 9\n- `-` (Hyphen)\n- . (Period)\n- _ (Underscore)\n- / (Slash)" } } } }, "tracking_origin_country": { "type": "string", "description": "(Legacy) Replaced by `origin_country_iso3`. 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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_destination_country": { "type": "string", "description": "(Legacy) Replaced by `destination_country_iso3`. 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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_postal_code": { "type": "string", "description": "(Legacy) Replaced by `destination_postal_code`. 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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_state": { "type": "string", "description": "(Legacy) Replaced by `destination_state`. 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](../../docs/enum/additional_tracking_fields.md) for more details." }, "location_id": { "type": "string", "x-stoplight": { "id": "k01wm1whofqee" }, "description": "The location_id refers to the place where you fulfilled the items. \n - If you provide a location_id, the system will automatically use it as the tracking's origin address. However, passing both location_id and any origin address information simultaneously is not allowed.\n- Please make sure you add your locations [here](https://admin.aftership.com/settings/locations-and-rules) before passing the location_id and verify that the location's status is active. Learn more about adding locations [here](https://support.aftership.com/en/article/manage-ship-from-locations-via-aftership-tracking-okbhj4/?bust=1702871142396)." }, "shipping_method": { "type": "string", "x-stoplight": { "id": "jk4fjgpsi4agd" }, "description": "The shipping_method string refers to the chosen method for delivering the package. Merchants typically offer various shipping methods to consumers during the checkout process, such as, Local Delivery, Free Express Worldwide Shipping, etc" } } }, "examples": { "create-tracking": { "value": { "slug": "dhl", "tracking_number": "123456789", "title": "Title Name", "smses": [ "+18555072509", "+18555072501" ], "emails": [ "email@yourdomain.com", "another_email@yourdomain.com" ], "order_id": "ID 1234", "order_number": "1234", "order_id_path": "http://www.aftership.com/order_id=1234", "custom_fields": { "product_name": "iPhone Case", "product_price": "USD19.99" }, "language": "en", "order_promised_delivery_date": "2019-05-20", "delivery_type": "pickup_at_store", "pickup_location": "Flagship Store", "pickup_note": "Reach out to our staffs when you arrive our stores for shipment pickup", "origin_country_iso3": "CHN", "origin_state": "Beijing", "origin_city": "Beijing", "origin_postal_code": "065001", "origin_raw_location": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China", "destination_country_iso3": "USA", "destination_state": "New York", "destination_city": "New York City", "destination_postal_code": "10001", "destination_raw_location": "13th Street, New York, NY, 10011, USA, United States" } } } } }, "description": "Create tracking object" }, "parameters": [ { "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true } ], "x-stoplight": { "id": "sxafu5cay1usl" }, "tags": [ "Tracking" ] } }, "/trackings/{id}": { "get": { "summary": "Get a tracking by ID", "responses": { "200": { "description": "Tracking object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" }, "examples": { "get-tracking": { "value": { "meta": { "code": 200 }, "data": { "id": "56442da79af64b5f894109b5cbaba64c", "legacy_id": "my2uktymyz72xld1f7l3h01z", "created_at": "2023-01-18T08:47:10+00:00", "updated_at": "2023-01-18T17:47:10+00:00", "last_updated_at": "2023-01-18T17:47:10+00:00", "tracking_number": "61293150000079650811", "slug": "fedex", "active": false, "custom_fields": { "store_name": "my-store" }, "customer_name": "Steve Young", "transit_time": 9, "origin_country_iso3": "CHN", "origin_state": "Beijing", "origin_city": "Beijing", "origin_postal_code": "065001", "origin_raw_location": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China", "destination_country_iso3": "USA", "destination_state": "New York", "destination_city": "New York City", "destination_postal_code": "10001", "destination_raw_location": "13th Street, New York, NY, 10011, USA, United States", "courier_destination_country_iso3": "USA", "emails": [ "example@aftership.com" ], "expected_delivery": "2022-01-05T12:11:11+01:00", "note": "note", "order_id": "6845a095a27a4caeb27487806f058add", "order_id_path": "https://www.aftership.com/my-orders/6845a095a27a4caeb27487806f058add", "order_date": "2022-01-20T15:56:12+08:00", "shipment_package_count": 1, "shipment_pickup_date": "2022-01-21T15:00:00", "shipment_delivery_date": "2022-01-29T11:23:00", "shipment_type": "FedEx SmartPost", "shipment_weight": null, "signed_by": "Steve Young", "smses": [ "+8613800138000" ], "source": "api", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "title": "61293150000079650811", "tracked_count": 13, "last_mile_tracking_supported": true, "language": "en", "unique_token": "Deprecated", "checkpoints": [ { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T16:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Incorrect address - Retrying delivery", "tag": "Exception", "subtag": "Exception_001", "subtag_message": "Exception", "raw_tag": "EO", "events": [ { "code": "unable_to_deliver", "reason": { "code": "incorrect_missing_address" } } ] }, { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T18:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Package delivered", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "raw_tag": "RO", "events": [] } ], "subscribed_smses": [ "+8613800138000" ], "subscribed_emails": [ "example@aftership.com" ], "return_to_sender": false, "order_promised_delivery_date": "2022-01-01", "delivery_type": "pickup_at_store", "pickup_location": "13th Street, New York, NY 10011, USA, United States", "pickup_note": "No notes", "courier_tracking_link": "https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US", "first_attempted_at": "2022-01-01T17:00:00-05:00", "courier_redirect_link": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US", "tracking_account_number": null, "tracking_key": null, "tracking_ship_date": "20220101", "on_time_status": "on-time", "on_time_difference": 0, "order_tags": [ "Exception" ], "aftership_estimated_delivery_date": { "estimated_delivery_date": "2022-01-03", "confidence_code": 10001, "estimated_delivery_date_min": "2022-01-02", "estimated_delivery_date_max": "2022-01-04" }, "custom_estimated_delivery_date": { "type": "specific", "datetime": "2022-01-05", "datetime_min": null, "datetime_max": null }, "order_number": "162654659775", "first_estimated_delivery": { "type": "specific", "source": "Carrier EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "latest_estimated_delivery": { "type": "specific", "source": "AfterShip EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "shipment_tags": [ "Returned" ], "courier_connection_id": "8e1261bde336436abbc7cb3eee8cd707", "location_id": "bda843ed811541fc852a8447371cf6f2", "shipping_method": "Local Delivery", "carbon_emissions": { "value": 0.7, "unit": "kg" }, "next_couriers": [ { "slug": "usps", "tracking_number": "61293150000079650811", "source": "system" } ], "tracking_origin_country": "CHN", "tracking_destination_country": "USA", "tracking_postal_code": "90213", "tracking_state": "CA" } } } } } } } }, "operationId": "get-tracking-by-id", "description": "Get tracking results of a single tracking.\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "example": "title,order_id" }, "in": "query", "name": "fields", "description": "List of fields to include in the response. Use comma for multiple values. Fields to include: `tracking_postal_code`, `tracking_ship_date`, `tracking_account_number`, `tracking_key`, `tracking_origin_country`, `tracking_destination_country`, `tracking_state`, `title`, `order_id`, `tag`, `checkpoints`" }, { "schema": { "type": "string", "example": "en" }, "in": "query", "name": "lang", "description": "Translate checkpoint messages from the carrier’s provided language to the target language. Supported target languages include:
    - English (en)
    - French (fr)
    - French Canadian (fr-CA)
    - Arabic (ar)
    - Bulgarian (bg)
    - Catalan (ca)
    - Croatian (hr)
    - Czech (cs)
    - Danish (da)
    - Dutch (nl)
    - Estonian (et)
    - Filipino (tl)
    - Finnish (fi)
    - German (de)
    - Greek (el)
    - Hebrew (he)
    - Hindi (hi)
    - Hungarian (hu)
    - Indonesian (id)
    - Italian (it)
    - Japanese (ja)
    - Korean (ko)
    - Latvian (lv)
    - Lithuanian (lt)
    - Malay (ms)
    - Polish (pl)
    - Portuguese (pt)
    - Romanian (ro)
    - Russian (ru)
    - Serbian (sr)
    - Slovak (sk)
    - Slovenian (sl)
    - Spanish (es)
    - Swedish (sv)
    - Thai (th)
    - Turkish (tr)
    - Ukrainian (uk)
    - Vietnamese (vi)
    - Simplified Chinese (zh-Hans)
    - Traditional Chinese (zh-Hant)
    - Norwegian (nb)
" }, { "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true } ], "x-stoplight": { "id": "bcb1azgtk9n6r" }, "tags": [ "Tracking" ] }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "tracking ID" } ], "put": { "summary": "Update a tracking by ID", "operationId": "update-tracking-by-id", "responses": { "200": { "description": "Update a tracking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" }, "examples": { "update-tracking": { "value": { "meta": { "code": 200 }, "data": { "id": "56442da79af64b5f894109b5cbaba64c", "legacy_id": "my2uktymyz72xld1f7l3h01z", "created_at": "2023-01-18T08:47:10+00:00", "updated_at": "2023-01-18T17:47:10+00:00", "last_updated_at": "2023-01-18T17:47:10+00:00", "tracking_number": "61293150000079650811", "slug": "fedex", "active": false, "custom_fields": { "store_name": "my-store" }, "customer_name": "Steve Young", "transit_time": 9, "origin_country_iso3": "CHN", "origin_state": "Beijing", "origin_city": "Beijing", "origin_postal_code": "065001", "origin_raw_location": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China", "destination_country_iso3": "USA", "destination_state": "New York", "destination_city": "New York City", "destination_postal_code": "10001", "destination_raw_location": "13th Street, New York, NY, 10011, USA, United States", "courier_destination_country_iso3": "USA", "emails": [ "example@aftership.com" ], "expected_delivery": "2022-01-05T12:11:11+01:00", "note": "note", "order_id": "6845a095a27a4caeb27487806f058add", "order_id_path": "https://www.aftership.com/my-orders/6845a095a27a4caeb27487806f058add", "order_date": "2022-01-20T15:56:12+08:00", "shipment_package_count": 1, "shipment_pickup_date": "2022-01-21T15:00:00", "shipment_delivery_date": "2022-01-29T11:23:00", "shipment_type": "FedEx SmartPost", "shipment_weight": null, "signed_by": "Steve Young", "smses": [ "+8613800138000" ], "source": "api", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "title": "61293150000079650811", "tracked_count": 13, "last_mile_tracking_supported": true, "language": "en", "unique_token": "Deprecated", "checkpoints": [ { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T16:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Incorrect address - Retrying delivery", "tag": "Exception", "subtag": "Exception_001", "subtag_message": "Exception", "raw_tag": "EO", "events": [ { "code": "unable_to_deliver", "reason": { "code": "incorrect_missing_address" } } ] }, { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T18:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Package delivered", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "raw_tag": "RO", "events": [] } ], "subscribed_smses": [ "+8613800138000" ], "subscribed_emails": [ "example@aftership.com" ], "return_to_sender": false, "order_promised_delivery_date": "2022-01-01", "delivery_type": "pickup_at_store", "pickup_location": "13th Street, New York, NY 10011, USA, United States", "pickup_note": "No notes", "courier_tracking_link": "https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US", "first_attempted_at": "2022-01-01T17:00:00-05:00", "courier_redirect_link": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US", "tracking_account_number": null, "tracking_key": null, "tracking_ship_date": "20220101", "on_time_status": "on-time", "on_time_difference": 0, "order_tags": [ "Exception" ], "aftership_estimated_delivery_date": { "estimated_delivery_date": "2022-01-03", "confidence_code": 10001, "estimated_delivery_date_min": "2022-01-02", "estimated_delivery_date_max": "2022-01-04" }, "custom_estimated_delivery_date": { "type": "specific", "datetime": "2022-01-05", "datetime_min": null, "datetime_max": null }, "order_number": "162654659775", "first_estimated_delivery": { "type": "specific", "source": "Carrier EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "latest_estimated_delivery": { "type": "specific", "source": "AfterShip EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "shipment_tags": [ "Returned" ], "courier_connection_id": "8e1261bde336436abbc7cb3eee8cd707", "location_id": "bda843ed811541fc852a8447371cf6f2", "shipping_method": "Local Delivery", "carbon_emissions": { "value": 0.7, "unit": "kg" }, "next_couriers": [ { "slug": "usps", "tracking_number": "61293150000079650811", "source": "system" } ], "tracking_origin_country": "CHN", "tracking_destination_country": "USA", "tracking_postal_code": "90213", "tracking_state": "CA" } } } } } } } }, "description": "Update a tracking.\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "smses": { "type": "array", "description": "The phone number(s) to receive sms notifications. Input `[]` to clear the value of this field. Supports up to 3 phone numbers.", "items": { "type": "string" } }, "emails": { "type": "array", "description": "Email address(es) to receive email notifications. Input `[]` to clear the value of this field. Supports up to 3 email addresses.", "items": { "type": "string" } }, "title": { "type": "string", "description": "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": { "type": "string", "description": "Customer name of the tracking." }, "order_id": { "type": "string", "description": "A globally-unique identifier for the order." }, "order_id_path": { "type": "string", "description": "The URL for the order in your system or store." }, "custom_fields": { "type": "object", "description": "Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any [personal data](https://www.aftership.com/legal/dpa#:~:text=Personal%20Data%20means,that%20natural%20person) in custom fields.\n\n- Maximum charater limit for a key name: 30\n- Maximum count for a key-value pair in a custom field object: 25\n- Maximum value length: 512 charaters\n- Supported value type: String only (object and array are prohibted)", "additionalProperties": { "x-stoplight": { "id": "r6bo74xzj8vov" }, "type": "string" } }, "note": { "type": "string", "description": "Text field for the note.\nInput `\"\"` to clear the value of this field." }, "language": { "type": "string", "description": "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](https://help.aftership.com/hc/en-us/articles/360001623287-Supported-Language-Parameters) to specify the language." }, "order_promised_delivery_date": { "type": "string", "description": "The promised delivery date of the order. It uses the formats:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ" }, "delivery_type": { "type": "string", "description": "Shipment delivery type\n\n- `pickup_at_store`\n- `pickup_at_courier`\n- `door_to_door`", "enum": [ "pickup_at_store", "pickup_at_courier", "door_to_door" ] }, "pickup_location": { "type": "string", "description": "Shipment pickup location for receiver" }, "pickup_note": { "type": "string", "description": "Shipment pickup note for receiver" }, "slug": { "type": "string", "description": "Unique code of each courier. Provide a single courier.(https://admin.aftership.com/settings/couriers). Get a list of courier slug using [GET /couriers](./api.json/paths/~1couriers/get)" }, "tracking_account_number": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_key": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_ship_date": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "order_number": { "type": "string", "description": "A unique, human-readable identifier for the order." }, "order_date": { "type": "string", "description": "Order date in YYYY-MM-DDTHH:mm:ssZ format. e.g. 2021-07-26T11:23:51-05:00" }, "shipment_type": { "type": "string", "description": "The carrier service type for the shipment. If you provide info for this field, AfterShip will not update it with info from the carrier." }, "origin_country_iso3": { "type": "string", "description": "The [ISO Alpha-3](https://support.aftership.com/en/article/iso3-country-code-rlpi07/) 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. Also the 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "CHN" }, "origin_state": { "type": "string", "description": "The state of the sender’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "Beijing" }, "origin_city": { "type": "string", "description": "The city of the sender’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "Beijing" }, "origin_postal_code": { "type": "string", "description": "The postal of the sender’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "065001" }, "origin_raw_location": { "type": "string", "description": "The sender address that the shipment is shipping from. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China" }, "destination_country_iso3": { "type": "string", "description": "The [ISO Alpha-3](https://support.aftership.com/en/article/iso3-country-code-rlpi07/) 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. Also the 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "USA" }, "destination_state": { "type": "string", "description": "The state of the recipient’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. Also the 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "New York" }, "destination_city": { "type": "string", "description": "The city of the recipient’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "New York City" }, "destination_postal_code": { "type": "string", "description": "The postal of the recipient’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. Also the 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "10001" }, "destination_raw_location": { "type": "string", "description": "The shipping address that the shipment is shipping to. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.", "example": "13th Street, New York, NY, 10011, USA, United States" }, "tracking_origin_country": { "type": "string", "description": "(Legacy) Replaced by `origin_country_iso3`. 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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_destination_country": { "type": "string", "description": "(Legacy) Replaced by `destination_country_iso3`. 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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_postal_code": { "type": "string", "description": "(Legacy) Replaced by `destination_postal_code`. 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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_state": { "type": "string", "description": "(Legacy) Replaced by `destination_state`. 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](../../docs/enum/additional_tracking_fields.md) for more details." }, "location_id": { "type": "string", "x-stoplight": { "id": "0oextgvwqes8d" }, "description": "The location_id refers to the place where you fulfilled the items. \n - If you provide a location_id, the system will automatically use it as the tracking's origin address. However, passing both location_id and any origin address information simultaneously is not allowed.\n- Please make sure you add your locations [here](https://admin.aftership.com/settings/locations-and-rules) before passing the location_id and verify that the location's status is active. Learn more about adding locations [here](https://support.aftership.com/en/article/manage-ship-from-locations-via-aftership-tracking-okbhj4/?bust=1702871142396)." }, "shipping_method": { "type": "string", "x-stoplight": { "id": "jefb36kvnc0qp" }, "description": "The shipping_method string refers to the chosen method for delivering the package. Merchants typically offer various shipping methods to consumers during the checkout process, such as, Local Delivery, Free Express Worldwide Shipping, etc." } } }, "examples": { "update-tracking-request": { "value": { "title": "New Title", "note": "some notes" } } } } }, "description": "" }, "x-stoplight": { "id": "ambhbdx43wiq2" }, "tags": [ "Tracking" ] }, "delete": { "summary": "Delete a tracking by ID", "operationId": "delete-tracking-by-id", "responses": { "200": { "description": "Delete tracking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" }, "examples": { "delete tracking": { "value": { "meta": { "code": 200 }, "data": { "id": "56442da79af64b5f894109b5cbaba64c", "legacy_id": "my2uktymyz72xld1f7l3h01z", "created_at": "2023-01-18T08:47:10+00:00", "updated_at": "2023-01-18T17:47:10+00:00", "last_updated_at": "2023-01-18T17:47:10+00:00", "tracking_number": "61293150000079650811", "slug": "fedex", "active": false, "custom_fields": { "store_name": "my-store" }, "customer_name": "Steve Young", "transit_time": 9, "origin_country_iso3": "CHN", "origin_state": "Beijing", "origin_city": "Beijing", "origin_postal_code": "065001", "origin_raw_location": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China", "destination_country_iso3": "USA", "destination_state": "New York", "destination_city": "New York City", "destination_postal_code": "10001", "destination_raw_location": "13th Street, New York, NY, 10011, USA, United States", "courier_destination_country_iso3": "USA", "emails": [ "example@aftership.com" ], "expected_delivery": "2022-01-05T12:11:11+01:00", "note": "note", "order_id": "6845a095a27a4caeb27487806f058add", "order_id_path": "https://www.aftership.com/my-orders/6845a095a27a4caeb27487806f058add", "order_date": "2022-01-20T15:56:12+08:00", "shipment_package_count": 1, "shipment_pickup_date": "2022-01-21T15:00:00", "shipment_delivery_date": "2022-01-29T11:23:00", "shipment_type": "FedEx SmartPost", "shipment_weight": null, "signed_by": "Steve Young", "smses": [ "+8613800138000" ], "source": "api", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "title": "61293150000079650811", "tracked_count": 13, "last_mile_tracking_supported": true, "language": "en", "unique_token": "Deprecated", "checkpoints": [ { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T16:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Incorrect address - Retrying delivery", "tag": "Exception", "subtag": "Exception_001", "subtag_message": "Exception", "raw_tag": "EO", "events": [ { "code": "unable_to_deliver", "reason": { "code": "incorrect_missing_address" } } ] }, { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T18:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Package delivered", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "raw_tag": "RO", "events": [] } ], "subscribed_smses": [ "+8613800138000" ], "subscribed_emails": [ "example@aftership.com" ], "return_to_sender": false, "order_promised_delivery_date": "2022-01-01", "delivery_type": "pickup_at_store", "pickup_location": "13th Street, New York, NY 10011, USA, United States", "pickup_note": "No notes", "courier_tracking_link": "https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US", "first_attempted_at": "2022-01-01T17:00:00-05:00", "courier_redirect_link": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US", "tracking_account_number": null, "tracking_key": null, "tracking_ship_date": "20220101", "on_time_status": "on-time", "on_time_difference": 0, "order_tags": [ "Exception" ], "aftership_estimated_delivery_date": { "estimated_delivery_date": "2022-01-03", "confidence_code": 10001, "estimated_delivery_date_min": "2022-01-02", "estimated_delivery_date_max": "2022-01-04" }, "custom_estimated_delivery_date": { "type": "specific", "datetime": "2022-01-05", "datetime_min": null, "datetime_max": null }, "order_number": "162654659775", "first_estimated_delivery": { "type": "specific", "source": "Carrier EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "latest_estimated_delivery": { "type": "specific", "source": "AfterShip EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "shipment_tags": [ "Returned" ], "courier_connection_id": "8e1261bde336436abbc7cb3eee8cd707", "location_id": "bda843ed811541fc852a8447371cf6f2", "shipping_method": "Local Delivery", "carbon_emissions": { "value": 0.7, "unit": "kg" }, "next_couriers": [ { "slug": "usps", "tracking_number": "61293150000079650811", "source": "system" } ], "tracking_origin_country": "CHN", "tracking_destination_country": "USA", "tracking_postal_code": "90213", "tracking_state": "CA" } } } } } } } }, "description": "Delete a tracking.\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "enum": [ "application/json" ], "default": "application/json" }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true } ], "x-stoplight": { "id": "w9cq6brf94whb" }, "tags": [ "Tracking" ] } }, "/trackings/{id}/retrack": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "tracking id" } ], "post": { "summary": "Retrack an expired tracking by ID", "operationId": "retrack-tracking-by-id", "responses": { "200": { "description": "Partial tracking object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" } } }, "headers": {} } }, "description": "Retrack an expired tracking. Max 3 times per tracking.\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] }, "in": "header", "description": "Content-Type", "name": "Content-Type", "required": true } ], "x-stoplight": { "id": "7h0qwvzlv6fhg" }, "tags": [ "Tracking" ] } }, "/trackings/{id}/mark-as-completed": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "tracking id" } ], "post": { "summary": "Mark tracking as completed by ID", "operationId": "mark-tracking-completed-by-id", "responses": { "200": { "description": "Tracking object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" } } } } }, "description": "Mark a tracking as completed. The tracking won't auto update until retrack it.\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "DELIVERED", "LOST", "RETURNED_TO_SENDER" ], "description": "One of `DELIVERED`, `LOST` or `RETURNED_TO_SENDER`.\n\n- Mark the tracking as completed with `DELIVERED`. The tag of the tracking will be updated to `Delivered` and the subtag will be updated to `Delivered_001`.\n- Mark the tracking as completed with `LOST`. The tag of the tracking will be updated to `Exception` and the subtag will be updated to `Exception_013`.\n- Mark the tracking as completed with `RETURNED_TO_SENDER`. The tag of the tracking will be updated to `Exception` and the subtag will be updated to `Exception_011`." } }, "required": [ "reason" ] } } }, "description": "" }, "x-stoplight": { "id": "w8uwm9t73oshp" }, "tags": [ "Tracking" ] } }, "/trackings/{slug}/{tracking_number}": { "get": { "summary": "Get a tracking (Legacy)", "responses": { "200": { "description": "Tracking object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" }, "examples": { "get-tracking": { "value": { "meta": { "code": 200 }, "data": { "id": "56442da79af64b5f894109b5cbaba64c", "legacy_id": "my2uktymyz72xld1f7l3h01z", "created_at": "2023-01-18T08:47:10+00:00", "updated_at": "2023-01-18T17:47:10+00:00", "last_updated_at": "2023-01-18T17:47:10+00:00", "tracking_number": "61293150000079650811", "slug": "fedex", "active": false, "custom_fields": { "store_name": "my-store" }, "customer_name": "Steve Young", "transit_time": 9, "origin_country_iso3": "CHN", "origin_state": "Beijing", "origin_city": "Beijing", "origin_postal_code": "065001", "origin_raw_location": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China", "destination_country_iso3": "USA", "destination_state": "New York", "destination_city": "New York City", "destination_postal_code": "10001", "destination_raw_location": "13th Street, New York, NY, 10011, USA, United States", "courier_destination_country_iso3": "USA", "emails": [ "example@aftership.com" ], "expected_delivery": "2022-01-05T12:11:11+01:00", "note": "note", "order_id": "6845a095a27a4caeb27487806f058add", "order_id_path": "https://www.aftership.com/my-orders/6845a095a27a4caeb27487806f058add", "order_date": "2022-01-20T15:56:12+08:00", "shipment_package_count": 1, "shipment_pickup_date": "2022-01-21T15:00:00", "shipment_delivery_date": "2022-01-29T11:23:00", "shipment_type": "FedEx SmartPost", "shipment_weight": null, "signed_by": "Steve Young", "smses": [ "+8613800138000" ], "source": "api", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "title": "61293150000079650811", "tracked_count": 13, "last_mile_tracking_supported": true, "language": "en", "unique_token": "Deprecated", "checkpoints": [ { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T16:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Incorrect address - Retrying delivery", "tag": "Exception", "subtag": "Exception_001", "subtag_message": "Exception", "raw_tag": "EO", "events": [ { "code": "unable_to_deliver", "reason": { "code": "incorrect_missing_address" } } ] }, { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T18:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Package delivered", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "raw_tag": "RO", "events": [] } ], "subscribed_smses": [ "+8613800138000" ], "subscribed_emails": [ "example@aftership.com" ], "return_to_sender": false, "order_promised_delivery_date": "2022-01-01", "delivery_type": "pickup_at_store", "pickup_location": "13th Street, New York, NY 10011, USA, United States", "pickup_note": "No notes", "courier_tracking_link": "https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US", "first_attempted_at": "2022-01-01T17:00:00-05:00", "courier_redirect_link": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US", "tracking_account_number": null, "tracking_key": null, "tracking_ship_date": "20220101", "on_time_status": "on-time", "on_time_difference": 0, "order_tags": [ "Exception" ], "aftership_estimated_delivery_date": { "estimated_delivery_date": "2022-01-03", "confidence_code": 10001, "estimated_delivery_date_min": "2022-01-02", "estimated_delivery_date_max": "2022-01-04" }, "custom_estimated_delivery_date": { "type": "specific", "datetime": "2022-01-05", "datetime_min": null, "datetime_max": null }, "order_number": "162654659775", "first_estimated_delivery": { "type": "specific", "source": "Carrier EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "latest_estimated_delivery": { "type": "specific", "source": "AfterShip EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "shipment_tags": [ "Returned" ], "courier_connection_id": "8e1261bde336436abbc7cb3eee8cd707", "location_id": "bda843ed811541fc852a8447371cf6f2", "shipping_method": "Local Delivery", "carbon_emissions": { "value": 0.7, "unit": "kg" }, "next_couriers": [ { "slug": "usps", "tracking_number": "61293150000079650811", "source": "system" } ], "tracking_origin_country": "CHN", "tracking_destination_country": "USA", "tracking_postal_code": "90213", "tracking_state": "CA" } } } } } } } }, "operationId": "get-tracking-by-slug-tracking-number", "description": "Get tracking results of a single tracking.(This endpoint will be deprecated in version 2024-10)\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "example": "title,order_id" }, "in": "query", "name": "fields", "description": "List of fields to include in the response. Use comma for multiple values. Fields to include: `tracking_postal_code`, `tracking_ship_date`, `tracking_account_number`, `tracking_key`, `tracking_origin_country`, `tracking_destination_country`, `tracking_state`, `title`, `order_id`, `tag`, `checkpoints`" }, { "schema": { "type": "string", "example": "en" }, "in": "query", "name": "lang", "description": "Support Chinese to English translation for `china-ems` and `china-post` only" }, { "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_account_number", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_origin_country", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_destination_country", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_key", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_postal_code", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_ship_date", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_state", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." } ], "x-stoplight": { "id": "7z8q9reewow06" }, "tags": [ "Tracking" ] }, "parameters": [ { "schema": { "type": "string" }, "name": "slug", "in": "path", "required": true, "description": "Tracking slug" }, { "schema": { "type": "string" }, "name": "tracking_number", "in": "path", "required": true, "description": "Tracking number" } ], "put": { "summary": "Update a tracking (Legacy)", "operationId": "update-tracking-by-slug-tracking-number", "responses": { "200": { "description": "Update a tracking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" }, "examples": { "update-tracking": { "value": { "meta": { "code": 200 }, "data": { "id": "56442da79af64b5f894109b5cbaba64c", "legacy_id": "my2uktymyz72xld1f7l3h01z", "created_at": "2023-01-18T08:47:10+00:00", "updated_at": "2023-01-18T17:47:10+00:00", "last_updated_at": "2023-01-18T17:47:10+00:00", "tracking_number": "61293150000079650811", "slug": "fedex", "active": false, "custom_fields": { "store_name": "my-store" }, "customer_name": "Steve Young", "transit_time": 9, "origin_country_iso3": "CHN", "origin_state": "Beijing", "origin_city": "Beijing", "origin_postal_code": "065001", "origin_raw_location": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China", "destination_country_iso3": "USA", "destination_state": "New York", "destination_city": "New York City", "destination_postal_code": "10001", "destination_raw_location": "13th Street, New York, NY, 10011, USA, United States", "courier_destination_country_iso3": "USA", "emails": [ "example@aftership.com" ], "expected_delivery": "2022-01-05T12:11:11+01:00", "note": "note", "order_id": "6845a095a27a4caeb27487806f058add", "order_id_path": "https://www.aftership.com/my-orders/6845a095a27a4caeb27487806f058add", "order_date": "2022-01-20T15:56:12+08:00", "shipment_package_count": 1, "shipment_pickup_date": "2022-01-21T15:00:00", "shipment_delivery_date": "2022-01-29T11:23:00", "shipment_type": "FedEx SmartPost", "shipment_weight": null, "signed_by": "Steve Young", "smses": [ "+8613800138000" ], "source": "api", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "title": "61293150000079650811", "tracked_count": 13, "last_mile_tracking_supported": true, "language": "en", "unique_token": "Deprecated", "checkpoints": [ { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T16:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Incorrect address - Retrying delivery", "tag": "Exception", "subtag": "Exception_001", "subtag_message": "Exception", "raw_tag": "EO", "events": [ { "code": "unable_to_deliver", "reason": { "code": "incorrect_missing_address" } } ] }, { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T18:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Package delivered", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "raw_tag": "RO", "events": [] } ], "subscribed_smses": [ "+8613800138000" ], "subscribed_emails": [ "example@aftership.com" ], "return_to_sender": false, "order_promised_delivery_date": "2022-01-01", "delivery_type": "pickup_at_store", "pickup_location": "13th Street, New York, NY 10011, USA, United States", "pickup_note": "No notes", "courier_tracking_link": "https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US", "first_attempted_at": "2022-01-01T17:00:00-05:00", "courier_redirect_link": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US", "tracking_account_number": null, "tracking_key": null, "tracking_ship_date": "20220101", "on_time_status": "on-time", "on_time_difference": 0, "order_tags": [ "Exception" ], "aftership_estimated_delivery_date": { "estimated_delivery_date": "2022-01-03", "confidence_code": 10001, "estimated_delivery_date_min": "2022-01-02", "estimated_delivery_date_max": "2022-01-04" }, "custom_estimated_delivery_date": { "type": "specific", "datetime": "2022-01-05", "datetime_min": null, "datetime_max": null }, "order_number": "162654659775", "first_estimated_delivery": { "type": "specific", "source": "Carrier EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "latest_estimated_delivery": { "type": "specific", "source": "AfterShip EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "shipment_tags": [ "Returned" ], "courier_connection_id": "8e1261bde336436abbc7cb3eee8cd707", "location_id": "bda843ed811541fc852a8447371cf6f2", "shipping_method": "Local Delivery", "carbon_emissions": { "value": 0.7, "unit": "kg" }, "next_couriers": [ { "slug": "usps", "tracking_number": "61293150000079650811", "source": "system" } ], "tracking_origin_country": "CHN", "tracking_destination_country": "USA", "tracking_postal_code": "90213", "tracking_state": "CA" } } } } } } } }, "description": "Update a tracking.(This endpoint will be deprecated in version 2024-10)\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_account_number", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_origin_country", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_destination_country", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_key", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_postal_code", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_ship_date", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_state", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "smses": { "type": "array", "description": "The phone number(s) to receive sms notifications. Supports up to 3 phone numbers.", "items": { "type": "string" } }, "emails": { "type": "array", "description": "Email address(es) to receive email notifications. Supports up to 3 email addresses.", "items": { "type": "string" } }, "title": { "type": "string", "description": "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": { "type": "string", "description": "Customer name of the tracking." }, "order_id": { "type": "string", "description": "A globally-unique identifier for the order." }, "order_id_path": { "type": "string", "description": "The URL for the order in your system or store." }, "custom_fields": { "type": "object", "description": "Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any [personal data](https://www.aftership.com/legal/dpa#:~:text=Personal%20Data%20means,that%20natural%20person) in custom fields.\n\n- Maximum charater limit for a key name: 30\n- Maximum count for a key-value pair in a custom field object: 25\n- Maximum value length: 512 charaters\n- Supported value type: String only (object and array are prohibted)" }, "note": { "type": "string", "description": "Text field for the note" }, "language": { "type": "string", "description": "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](https://help.aftership.com/hc/en-us/articles/360001623287-Supported-Language-Parameters) to specify the language." }, "order_promised_delivery_date": { "type": "string", "description": "The promised delivery date of the order. It uses the formats:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ" }, "delivery_type": { "type": "string", "description": "Shipment delivery type\n\n- `pickup_at_store`\n- `pickup_at_courier`\n- `door_to_door`", "enum": [ "pickup_at_store", "pickup_at_courier", "door_to_door" ] }, "pickup_location": { "type": "string", "description": "Shipment pickup location for receiver" }, "pickup_note": { "type": "string", "description": "Shipment pickup note for receiver" }, "slug": { "type": "string", "description": "Unique code of each courier. Provide a single courier.(https://admin.aftership.com/settings/couriers). Get a list of courier slug using [GET /couriers](./api.json/paths/~1couriers/get)" }, "tracking_account_number": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_origin_country": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_destination_country": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_key": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_postal_code": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_ship_date": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "tracking_state": { "type": "string", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, "order_number": { "type": "string", "description": "A unique, human-readable identifier for the order." }, "order_date": { "type": "string", "description": "Order date in YYYY-MM-DDTHH:mm:ssZ format. e.g. 2021-07-26T11:23:51-05:00" }, "location_id": { "type": "string", "x-stoplight": { "id": "vynio82nbateg" }, "description": "The location_id refers to the place where you fulfilled the items. \n - If you provide a location_id, the system will automatically use it as the tracking's origin address. However, passing both location_id and any origin address information simultaneously is not allowed.\n- Please make sure you add your locations [here](https://admin.aftership.com/settings/locations-and-rules) before passing the location_id and verify that the location's status is active. Learn more about adding locations [here](https://support.aftership.com/en/article/manage-ship-from-locations-via-aftership-tracking-okbhj4/?bust=1702871142396). " }, "shipping_method": { "type": "string", "x-stoplight": { "id": "itj2avoe3yowo" }, "description": "The shipping_method string refers to the chosen method for delivering the package. Merchants typically offer various shipping methods to consumers during the checkout process, such as, Local Delivery, Free Express Worldwide Shipping, etc." } } }, "examples": { "update-tracking-request": { "value": { "title": "New Title", "note": "some notes" } } } } }, "description": "" }, "x-stoplight": { "id": "1so122bw6ljbs" }, "tags": [ "Tracking" ] }, "delete": { "summary": "Delete a tracking (Legacy)", "operationId": "delete-tracking-by-slug-tracking-number", "responses": { "200": { "description": "Delete tracking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" }, "examples": { "delete tracking": { "value": { "meta": { "code": 200 }, "data": { "id": "56442da79af64b5f894109b5cbaba64c", "legacy_id": "my2uktymyz72xld1f7l3h01z", "created_at": "2023-01-18T08:47:10+00:00", "updated_at": "2023-01-18T17:47:10+00:00", "last_updated_at": "2023-01-18T17:47:10+00:00", "tracking_number": "61293150000079650811", "slug": "fedex", "active": false, "custom_fields": { "store_name": "my-store" }, "customer_name": "Steve Young", "transit_time": 9, "origin_country_iso3": "CHN", "origin_state": "Beijing", "origin_city": "Beijing", "origin_postal_code": "065001", "origin_raw_location": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China", "destination_country_iso3": "USA", "destination_state": "New York", "destination_city": "New York City", "destination_postal_code": "10001", "destination_raw_location": "13th Street, New York, NY, 10011, USA, United States", "courier_destination_country_iso3": "USA", "emails": [ "example@aftership.com" ], "expected_delivery": "2022-01-05T12:11:11+01:00", "note": "note", "order_id": "6845a095a27a4caeb27487806f058add", "order_id_path": "https://www.aftership.com/my-orders/6845a095a27a4caeb27487806f058add", "order_date": "2022-01-20T15:56:12+08:00", "shipment_package_count": 1, "shipment_pickup_date": "2022-01-21T15:00:00", "shipment_delivery_date": "2022-01-29T11:23:00", "shipment_type": "FedEx SmartPost", "shipment_weight": null, "signed_by": "Steve Young", "smses": [ "+8613800138000" ], "source": "api", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "title": "61293150000079650811", "tracked_count": 13, "last_mile_tracking_supported": true, "language": "en", "unique_token": "Deprecated", "checkpoints": [ { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T16:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Incorrect address - Retrying delivery", "tag": "Exception", "subtag": "Exception_001", "subtag_message": "Exception", "raw_tag": "EO", "events": [ { "code": "unable_to_deliver", "reason": { "code": "incorrect_missing_address" } } ] }, { "created_at": "2023-01-18T08:47:10+00:00", "slug": "fedex", "checkpoint_time": "2022-01-01T18:47:10-05:00", "location": "13th Street, New York, NY 10011, USA, United States", "city": "New York", "state": "NY", "zip": "10011", "coordinates": null, "country_iso3": "USA", "country_name": "United States", "message": "Package delivered", "tag": "Delivered", "subtag": "Delivered_002", "subtag_message": "Picked up by customer", "raw_tag": "RO", "events": [] } ], "subscribed_smses": [ "+8613800138000" ], "subscribed_emails": [ "example@aftership.com" ], "return_to_sender": false, "order_promised_delivery_date": "2022-01-01", "delivery_type": "pickup_at_store", "pickup_location": "13th Street, New York, NY 10011, USA, United States", "pickup_note": "No notes", "courier_tracking_link": "https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US", "first_attempted_at": "2022-01-01T17:00:00-05:00", "courier_redirect_link": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US", "tracking_account_number": null, "tracking_key": null, "tracking_ship_date": "20220101", "on_time_status": "on-time", "on_time_difference": 0, "order_tags": [ "Exception" ], "aftership_estimated_delivery_date": { "estimated_delivery_date": "2022-01-03", "confidence_code": 10001, "estimated_delivery_date_min": "2022-01-02", "estimated_delivery_date_max": "2022-01-04" }, "custom_estimated_delivery_date": { "type": "specific", "datetime": "2022-01-05", "datetime_min": null, "datetime_max": null }, "order_number": "162654659775", "first_estimated_delivery": { "type": "specific", "source": "Carrier EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "latest_estimated_delivery": { "type": "specific", "source": "AfterShip EDD", "datetime": "2022-01-05T12:11:11+01:00", "datetime_min": null, "datetime_max": null }, "shipment_tags": [ "Returned" ], "courier_connection_id": "8e1261bde336436abbc7cb3eee8cd707", "location_id": "bda843ed811541fc852a8447371cf6f2", "shipping_method": "Local Delivery", "carbon_emissions": { "value": 0.7, "unit": "kg" }, "next_couriers": [ { "slug": "usps", "tracking_number": "61293150000079650811", "source": "system" } ], "tracking_origin_country": "CHN", "tracking_destination_country": "USA", "tracking_postal_code": "90213", "tracking_state": "CA", "delivery_location_type": null } } } } } } } }, "description": "Delete a tracking.(This endpoint will be deprecated in version 2024-10)\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "enum": [ "application/json" ], "default": "application/json" }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_account_number", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_origin_country", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_destination_country", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_key", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_postal_code", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_ship_date", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_state", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." } ], "x-stoplight": { "id": "5v1wrkn30mtz0" }, "tags": [ "Tracking" ] } }, "/trackings/{slug}/{tracking_number}/retrack": { "parameters": [ { "schema": { "type": "string" }, "name": "slug", "in": "path", "required": true, "description": "Tracking slug" }, { "schema": { "type": "string" }, "name": "tracking_number", "in": "path", "required": true, "description": "Tracking number" } ], "post": { "summary": "Retrack an expired tracking (Legacy)", "operationId": "retrack-tracking-by-slug-tracking-number", "responses": { "200": { "description": "Partial tracking object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" } } }, "headers": {} } }, "description": "Retrack an expired tracking. Max 3 times per tracking.(This endpoint will be deprecated in version 2024-10)\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] }, "in": "header", "description": "Content-Type", "name": "Content-Type", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_account_number", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_origin_country", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_destination_country", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_key", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_postal_code", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_ship_date", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_state", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." } ], "x-stoplight": { "id": "qzy1qprw8r3tg" }, "tags": [ "Tracking" ] } }, "/trackings/{slug}/{tracking_number}/mark-as-completed": { "parameters": [ { "schema": { "type": "string" }, "name": "slug", "in": "path", "required": true, "description": "Tracking slug" }, { "schema": { "type": "string" }, "name": "tracking_number", "in": "path", "required": true, "description": "Tracking number" } ], "post": { "summary": "Mark tracking as completed (Legacy)", "operationId": "mark-tracking-completed-by-slug-tracking-number", "responses": { "200": { "description": "Tracking object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tracking_response.v1" } } } } }, "description": "Mark a tracking as completed. The tracking won't auto update until retrack it.(This endpoint will be deprecated in version 2024-10)\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_account_number", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_origin_country", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_destination_country", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_key", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_postal_code", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_ship_date", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." }, { "schema": { "type": "string" }, "in": "query", "name": "tracking_state", "description": "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](../../docs/enum/additional_tracking_fields.md) for more details." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "DELIVERED", "LOST", "RETURNED_TO_SENDER" ], "description": "One of `DELIVERED`, `LOST` or `RETURNED_TO_SENDER`.\n\n- Mark the tracking as completed with `DELIVERED`. The tag of the tracking will be updated to `Delivered` and the subtag will be updated to `Delivered_001`.\n- Mark the tracking as completed with `LOST`. The tag of the tracking will be updated to `Exception` and the subtag will be updated to `Exception_013`.\n- Mark the tracking as completed with `RETURNED_TO_SENDER`. The tag of the tracking will be updated to `Exception` and the subtag will be updated to `Exception_011`." } }, "required": [ "reason" ] } } }, "description": "" }, "x-stoplight": { "id": "y3gf6xnrbhlop" }, "tags": [ "Tracking" ] } }, "/couriers": { "get": { "summary": "Get user activated couriers", "responses": { "200": { "description": "Couriers object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Courier_response.v1" }, "examples": { "get-user-couriers": { "value": { "meta": { "code": 200 }, "data": { "total": 1, "couriers": [ { "slug": "postnl-3s", "name": "PostNL International 3S", "phone": "+31 (0)900 0990", "other_name": "TNT Post parcel service United Kingdom", "web_url": "http://www.postnl.nl/voorthuis/", "required_fields": [ "tracking_destination_country" ], "optional_fields": [ "tracking_account_number" ], "default_language": "en", "support_languages": [ "en" ], "service_from_country_iso3": [ "NLD" ] } ] } } } } } } } }, "operationId": "get-user-couriers", "description": "Return a list of [couriers activated at your AfterShip account](https://admin.aftership.com/settings/couriers).\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "enum": [ "application/json" ], "example": "application/json", "default": "application/json" }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true } ], "tags": [ "Courier" ], "x-stoplight": { "id": "ukw8ouy82dp1k" } } }, "/couriers/detect": { "post": { "summary": "Detect courier", "operationId": "detect-courier", "responses": { "200": { "description": "Couriers object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Courier_response.v1" }, "examples": { "get couriers": { "value": { "meta": { "code": 200 }, "data": { "total": 1, "couriers": [ { "slug": "postnl-3s", "name": "PostNL International 3S", "phone": "+31 (0)900 0990", "other_name": "TNT Post parcel service United Kingdom", "web_url": "http://www.postnl.nl/voorthuis/", "required_fields": [ "tracking_destination_country" ], "optional_fields": [ "tracking_account_number" ], "default_language": "en", "support_languages": [ "en" ], "service_from_country_iso3": [ "NLD" ] } ] } } }, "cannot detect courier": { "value": { "meta": { "code": 200 }, "data": { "total": 0, "couriers": [] } } } } } } } }, "description": "Return a list of matched couriers based on tracking number format and [selected couriers](https://admin.aftership.com/settings/couriers) or a list of couriers.\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "example": "application/json", "enum": [ "application/json" ], "default": "application/json" }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "tracking_number" ], "properties": { "tracking_number": { "type": "string", "description": "Tracking number of a shipment.", "example": "RA123456879US" }, "slug": { "description": "If not specified, Aftership will automatically detect the courier based on the tracking number format and your [selected couriers](https://admin.aftership.com/settings/couriers). Use array to input a list of couriers for auto detect. Cannot be used with slug_group at the same time.", "type": "array", "items": { "x-stoplight": { "id": "bii35cnx55i15" }, "type": "string" } }, "tracking_postal_code": { "description": "The postal code of receiver's address. Required by some couriers. Refer to [this page](../../docs/enum/additional_tracking_fields.md) for more details", "type": "string" }, "tracking_ship_date": { "type": "string", "description": "Shipping date in `YYYYMMDD` format. Required by some couriers. Refer to [this page](../../docs/enum/additional_tracking_fields.md) for more details" }, "tracking_account_number": { "type": "string", "description": "Account number of the shipper for a specific courier. Required by some couriers. Refer to [this page](../../docs/enum/additional_tracking_fields.md) for more details" }, "tracking_key": { "type": "string", "description": "Key of the shipment for a specific courier. Required by some couriers. Refer to [this page](../../docs/enum/additional_tracking_fields.md) for more details" }, "tracking_origin_country": { "type": "string", "description": "Origin Country/Region of the shipment for a specific courier. Required by some couriers." }, "tracking_destination_country": { "type": "string", "description": "Destination Country/Region of the shipment for a specific courier. Required by some couriers. Refer to [this page](../../docs/enum/additional_tracking_fields.md) for more details" }, "tracking_state": { "type": "string", "description": "State of the destination shipping address of the \nshipment. Required by some couriers." }, "slug_group": { "$ref": "#/components/schemas/Slug_group.v1" }, "origin_country_iso3": { "type": "string", "description": "Enter [ISO Alpha-3](https://support.aftership.com/en/article/iso3-country-code-rlpi07/) (three letters) to specify the origin of the shipment (e.g. USA for United States)." }, "destination_country_iso3": { "type": "string", "description": "Enter [ISO Alpha-3](https://support.aftership.com/en/article/iso3-country-code-rlpi07/) (three letters) to specify the destination of the shipment (e.g. USA for United States)." } } }, "examples": { "with tracking number only": { "value": { "tracking_number": "906587618687" } }, "with tracking number and slug": { "value": { "tracking_number": "906587618686", "slug": "usps" } }, "with multiple slug": { "value": { "tracking_number": "906587618687", "slug": "usps,ups" } }, "with additional fields": { "value": { "tracking_number": "906587618687", "tracking_postal_code": "DA15BU", "tracking_ship_date": "20131231", "tracking_account_number": "1234567890", "slug": [ "dhl", "ups", "fedex" ] } } } } }, "description": "Detect courier request" }, "x-stoplight": { "id": "2qae9fa825r4t" }, "tags": [ "Courier" ] } }, "/couriers/all": { "get": { "summary": "Get all couriers", "responses": { "200": { "description": "Couriers object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Courier_response.v1" }, "examples": { "get-all-couriers": { "value": { "meta": { "code": 200 }, "data": { "total": 3, "couriers": [ { "slug": "india-post-int", "name": "India Post International", "phone": "+91 1800 11 2011", "other_name": "भारतीय डाक, Speed Post & eMO, EMS, IPS Web", "web_url": "http://www.indiapost.gov.in/", "required_fields": [], "optional_fields": [] }, { "slug": "italy-sda", "name": "Italy SDA", "phone": "+39 199 113366", "other_name": "SDA Express Courier", "web_url": "http://www.sda.it/", "required_fields": [], "optional_fields": [] }, { "slug": "bpost", "name": "Belgium Post", "phone": "+32 2 276 22 74", "other_name": "bpost, Belgian Post", "web_url": "http://www.bpost.be/", "required_fields": [], "optional_fields": [] } ] } } } } } } } }, "operationId": "get-all-couriers", "description": "Return a list of all couriers.\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "parameters": [ { "schema": { "type": "string", "enum": [ "application/json" ], "example": "application/json", "default": "application/json" }, "in": "header", "name": "Content-Type", "description": "Content-Type", "required": true } ], "x-stoplight": { "id": "0ag4gugsnsg5w" }, "tags": [ "Courier" ] } }, "/estimated-delivery-date/predict-batch": { "post": { "summary": "Batch prediction for the Estimated Delivery Date", "operationId": "predict-batch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta.v1" }, "data": { "type": "object", "required": [ "estimated_delivery_dates" ], "properties": { "estimated_delivery_dates": { "type": "array", "items": { "$ref": "#/components/schemas/Estimated_delivery_date_Response" } } } } }, "required": [ "meta", "data" ] }, "examples": { "200": { "value": { "meta": { "code": 200 }, "data": { "estimated_delivery_dates": [ { "id": "0b02015fc7fd4f3c8d5490cece4d124d", "slug": "fedex", "service_type_name": "FEDEX HOME DELIVERY", "origin_address": { "country": "USA", "state": "WA", "postal_code": "98108", "raw_location": "Seattle, Washington, 98108, USA, United States", "city": null }, "destination_address": { "country": "USA", "state": "CA", "postal_code": "92019", "raw_location": "El Cajon, California, 92019, USA, United States", "city": null }, "weight": { "unit": "kg", "value": 1 }, "package_count": 1, "pickup_time": "2021-07-01 15:00:00", "estimated_pickup": null, "estimated_delivery_date": "2021-07-04", "estimated_delivery_date_min": "2021-07-03", "estimated_delivery_date_max": "2021-07-04" }, { "id": "0b02015fc7fd4f3c8d5490cece4d124e", "slug": "fedex", "service_type_name": "FEDEX HOME DELIVERY", "origin_address": { "country": "USA", "state": "WA", "postal_code": "98108", "raw_location": "Seattle, Washington, 98108, USA, United States", "city": null }, "destination_address": { "country": "USA", "state": "CA", "postal_code": "92019", "raw_location": "El Cajon, California, 92019, USA, United States", "city": null }, "weight": null, "package_count": null, "pickup_time": null, "estimated_pickup": { "order_time": "2021-07-01 15:04:05", "order_cutoff_time": "20:00:00", "business_days": [ 1, 2, 3, 4, 5, 6, 7 ], "order_processing_time": { "unit": "day", "value": 0 }, "pickup_time": "2021-07-01 20:00:00" }, "estimated_delivery_date": "2021-07-03", "estimated_delivery_date_min": "2021-07-02", "estimated_delivery_date_max": "2021-07-04" } ] } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta.v1" }, "data": { "type": "object" } }, "required": [ "meta", "data" ] }, "examples": { "400": { "value": { "meta": { "code": 400, "message": "some message", "type": "BadRequest" }, "data": {} } } } } } } }, "description": "> The estimated delivery date is provided by AfterShip, based on its AI-predictive model. You can display the EDD on the product page, cart, and order checkout page. It indicates when a customer will receive the order.\n\nYou can use [AfterShip’s AI-powered predictive estimated delivery date API](https://www.aftership.com/features/delivery-date-prediction) to provide expected delivery dates to shoppers for online orders without tracking numbers. You can get the earliest date, the latest date, and the most-likely-arrival date through our AI-predictive EDD API. \n\nDisplay accurate estimated delivery dates on the product page, store cart, and order checkout page to encourage customers to check out faster and give them a better customer experience.\n\n[Contact sales](https://www.aftership.com/contact-sales) to activate this feature.\n\nSupported functionalities require:\n\n1. One `EstimatedDeliveryDate` object for one prediction result.\n2. Maximum 5 `EstimatedDeliveryDate` objects are allowed.\n3. API call will fail if any of the requests `EstimatedDeliveryDate` objects do not meet the specification requirement.\n\n
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/confidence_codes.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)[url](../../docs/quickstart/authentication.md)
", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "estimated_delivery_dates": { "type": "array", "maxItems": 5, "minItems": 1, "items": { "$ref": "#/components/schemas/Estimated_delivery_date_Request" } } }, "required": [ "estimated_delivery_dates" ] }, "examples": { "predict": { "value": { "estimated_delivery_dates": [ { "slug": "fedex", "service_type_name": "FEDEX HOME DELIVERY", "origin_address": { "country": "USA", "state": "WA", "city": "Seattle", "postal_code": "98108", "raw_location": "Seattle, Washington, 98108, USA, United States" }, "destination_address": { "country": "USA", "state": "CA", "postal_code": "92019", "raw_location": "El Cajon, California, 92019, USA, United States" }, "weight": { "unit": "kg", "value": 1 }, "package_count": 1, "pickup_time": "2021-07-01 15:00:00" }, { "slug": "fedex", "service_type_name": "FEDEX HOME DELIVERY", "origin_address": { "country": "USA", "state": "WA", "postal_code": "98108", "raw_location": "Seattle, Washington, 98108, USA, United States" }, "destination_address": { "country": "USA", "state": "California", "postal_code": "92019", "raw_location": "El Cajon, California, 92019, USA, United States" }, "weight": null, "package_count": null, "estimated_pickup": { "order_time": "2021-07-01 15:04:05", "order_cutoff_time": "20:00:00", "business_days": [ 1, 2, 3, 4, 5, 6, 7 ], "order_processing_time": { "unit": "day", "value": 0 } } } ] } } } } }, "description": "" }, "tags": [ "Estimated delivery date" ], "x-stoplight": { "id": "0dkrr2qt6lvwv" } }, "parameters": [] } }, "tags": [ { "name": "Trackings" }, { "name": "Couriers" }, { "name": "Last Checkpoints" }, { "name": "Notifications" }, { "name": "Estimated delivery date" } ], "components": { "securitySchemes": { "as-api-key": { "name": "as-api-key", "type": "apiKey", "in": "header", "description": "> Legacy API keys with `aftership-api-key` headers are not supported anymore start from `2023-10` version. For more information, check [authentication](../../docs/quickstart/authentication.md)." } }, "schemas": { "Additional_fields.v1": { "x-stoplight": { "id": "v0x73k8xspiqw" }, "type": "string", "title": "additional_fields", "description": "All available additional fields
[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.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)
", "enum": [ "tracking_account_number", "tracking_postal_code", "tracking_ship_date", "tracking_key", "tracking_origin_country", "tracking_destination_country", "tracking_state" ], "example": "tracking_account_number", "pattern": "^[a-z_0-9]+$" }, "Slug_group.v1": { "type": "string", "title": "slug_group", "description": "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](../../docs/enum/slug_groups.md))
[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.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)
", "enum": [ "amazon-group", "fedex-group", "toll-group", "taqbin-group", "tnt-group", "cj-group", "hermes-group", "dpd-group", "gls-group", "dhl-group", "fastway-group", "asendia-group" ] }, "Tag.v1": { "type": "string", "title": "tag", "enum": [ "Pending", "InfoReceived", "InTransit", "OutForDelivery", "AttemptFail", "Delivered", "AvailableForPickup", "Exception", "Expired" ], "description": "Current status of tracking. ([See tag definition](../../docs/enum/delivery_statuses.md))
[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.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)
", "example": "Delivered" }, "Checkpoint": { "x-stoplight": { "id": "ag7g0fudz5euk" }, "title": "Checkpoint", "type": "object", "description": "Object describes checkpoint information.\n\n
[url](../../docs/enum/events.md)[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.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)
", "x-tags": [ "Resource" ], "properties": { "created_at": { "type": "string", "minLength": 1, "description": "The date and time of the checkpoint event was added to AfterShip. It uses the format `YYYY-MM-DDTHH:mm:ssZ` for the timezone GMT +0.", "example": "2023-01-18T08:47:10+00:00", "x-stoplight": { "id": "zu8czui1spi5j" } }, "slug": { "type": "string", "minLength": 1, "description": "The unique code of courier for this checkpoint. Get courier slug [here](../../reference/api.json/paths/~1couriers/get)", "example": "fedex", "x-stoplight": { "id": "4owl79ms8d3u9" } }, "checkpoint_time": { "type": "string", "minLength": 1, "description": "The date and time of the checkpoint event, provided by the carrier. It uses the timezone of the checkpoint. The format may differ depending on how the carrier provides it:\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ", "example": "2022-01-01T18:47:10-05:00", "x-stoplight": { "id": "9awzp75k9febs" } }, "location": { "type": [ "string", "null" ], "minLength": 1, "description": "Location info provided by carrier", "example": "13th Street, New York, NY 10011, USA, United States", "x-stoplight": { "id": "u93y11ihmeov8" } }, "city": { "type": [ "string", "null" ], "minLength": 1, "description": "City info provided by carrier", "example": "New York", "x-stoplight": { "id": "fabvm8mmikdej" } }, "state": { "type": [ "string", "null" ], "minLength": 1, "description": "State info provided by carrier", "example": "NY", "x-stoplight": { "id": "1v0inuoj4e74y" } }, "zip": { "type": [ "string", "null" ], "minLength": 1, "description": "Postal code info provided by carrier", "example": "10011", "x-stoplight": { "id": "pf7bhy5eyojon" } }, "coordinate": { "type": [ "object", "null" ], "description": "The latitude and longitude coordinates indicate the precise location of the shipments that are currently in transit.", "example": null, "x-stoplight": { "id": "zum7wa9pis108" }, "properties": { "latitude": { "type": "number", "x-stoplight": { "id": "g76n61cbre4zl" }, "description": "Represents the latitude.", "example": "37.09024", "readOnly": true }, "longitude": { "type": "number", "x-stoplight": { "id": "snidkwtd2epur" }, "description": "Represents the longitude.", "example": "-95.712891", "readOnly": true } } }, "country_iso3": { "type": [ "string", "null" ], "description": "Country/Region ISO Alpha-3 (three letters) of the checkpoint", "example": "USA", "x-stoplight": { "id": "j5fqociyv0ljk" } }, "country_name": { "type": [ "string", "null" ], "description": "Country/Region name of the checkpoint, may also contain other location info.", "example": "United States", "x-stoplight": { "id": "gsg0p1qckju58" } }, "message": { "type": "string", "minLength": 1, "description": "Checkpoint message", "example": "Package delivered", "x-stoplight": { "id": "cznxhuyp14g5q" } }, "tag": { "$ref": "#/components/schemas/Tag.v1", "x-stoplight": { "id": "l0bsiywldok3r" } }, "subtag": { "type": "string", "minLength": 1, "description": "Current subtag of checkpoint. ([See subtag definition](../../docs/enum/delivery_sub_statuses.md))", "example": "Delivered_002", "x-stoplight": { "id": "7w23827daymn0" } }, "subtag_message": { "type": "string", "minLength": 1, "description": "Normalized checkpoint message. ([See subtag message definition](../../docs/enum/delivery_sub_statuses.md))", "example": "Picked up by customer", "x-stoplight": { "id": "gtmk5cuw7wtwb" } }, "raw_tag": { "type": [ "string", "null" ], "minLength": 1, "description": "Checkpoint raw status provided by courier", "example": "RO", "x-stoplight": { "id": "9hl14tav56q2k" } }, "events": { "type": "array", "x-stoplight": { "id": "yaarhzzr9lwlb" }, "items": { "type": "object", "properties": { "code": { "type": "string", "x-stoplight": { "id": "ga8y1l7lzhe0n" }, "description": "Represents the event code.", "example": "unable_to_deliver" }, "reason": { "type": [ "object", "null" ], "x-stoplight": { "id": "d19xczf0ux5qf" }, "description": "Describes the specific reason that led to the event.", "properties": { "code": { "type": "string", "x-stoplight": { "id": "cttlv8n2ojzes" }, "description": "The code of the reason. ", "example": "incorrect_missing_address" } } } } }, "description": "The array provides details about specific event(s) that occurred to a shipment, such as \"returned_to_sender\". You can find the full list of events and reasons [here](../../docs/enum/events.md#events) (Beta Feature)\n- The events' value for the same checkpoint message is subject to change as we consistently strive to enhance the performance of this feature." } } }, "Courier": { "x-stoplight": { "id": "dh84q02xjf082" }, "title": "Courier", "type": "object", "description": "Courier object\n\n
[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.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)
", "x-tags": [ "Resource" ], "properties": { "slug": { "type": "string", "description": "Unique code of courier. Get the slugs from [here](../../reference/api.json/paths/~1couriers/get).", "example": "postnl-3s", "pattern": "^[a-z0-9-]+$", "x-stoplight": { "id": "mzakwc7om47vb" } }, "name": { "type": "string", "description": "Name of courier", "example": "PostNL International 3S", "x-stoplight": { "id": "6mknhl154gjzu" } }, "phone": { "type": [ "string", "null" ], "description": "Contact phone number of courier", "example": "+31 (0)900 0990", "x-stoplight": { "id": "h48o2lon0t2fa" } }, "other_name": { "type": [ "string", "null" ], "description": "Other name of courier", "example": "TNT Post parcel service United Kingdom", "x-stoplight": { "id": "fbpgwz6ol8g3h" } }, "web_url": { "type": "string", "description": "Website link of courier", "format": "uri", "example": "http://www.postnl.nl/voorthuis/", "nullable": true, "x-stoplight": { "id": "baczpwcd13r99" } }, "required_fields": { "type": "array", "description": "The extra fields need for tracking, such as `tracking_account_number`, `tracking_postal_code`, `tracking_ship_date`, `tracking_key`, `tracking_destination_country`", "minItems": 0, "nullable": true, "x-stoplight": { "id": "5oa8tnsiixss8" }, "items": { "$ref": "#/components/schemas/Additional_fields.v1", "x-stoplight": { "id": "v0x73k8xspiqw" } } }, "optional_fields": { "type": "array", "description": "The extra fields which are optional for tracking. Basically it's the same as required_fields, but the difference is that only some of the tracking numbers require these fields.", "minItems": 0, "nullable": true, "x-stoplight": { "id": "mfv2fyoq3yvke" }, "items": { "$ref": "#/components/schemas/Additional_fields.v1", "x-stoplight": { "id": "bkwkfbsrhgwn5" } } }, "default_language": { "type": "string", "description": "Default language of tracking results", "minLength": 2, "maxLength": 2, "pattern": "^[a-z]{2}$", "example": "en", "nullable": true, "x-stoplight": { "id": "mdfm0cpgzgq0e" } }, "support_languages": { "type": "array", "description": "Other supported languages", "minItems": 1, "nullable": true, "x-stoplight": { "id": "w4rrvom5g6ggu" }, "items": { "type": "string", "minLength": 2, "maxLength": 2, "pattern": "^[a-z]{2}$", "example": "en", "x-stoplight": { "id": "1bneo988dbmbm" } } }, "service_from_country_iso3": { "type": "array", "description": "Country/Region code (ISO Alpha-3) where the courier provides service", "minItems": 1, "nullable": true, "x-stoplight": { "id": "zlnhlze1c88mg" }, "items": { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[A-Z]{3}$", "example": "NLD", "x-stoplight": { "id": "642xkrivaraks" } } } } }, "Estimated_delivery_date_Request": { "x-stoplight": { "id": "buezc13rd1k96" }, "type": "object", "x-examples": { "example-1": { "slug": "fedex", "service_type_name": "FEDEX HOME DELIVERY", "origin_address": { "country": "USA", "state": "WA", "postal_code": "98108", "raw_location": "Seattle, Washington, 98108, USA, United States" }, "destination_address": { "country": "USA", "state": "CA", "postal_code": "92019", "raw_location": "El Cajon, California, 92019, USA, United States" }, "weight": null, "package_count": null, "estimated_pickup": { "order_time": "2021-07-01 15:04:05", "order_cutoff_time": "20:00:00", "business_days": [ 1, 2, 3, 4, 5, 6, 7 ], "order_processing_time": { "unit": "day", "value": 0 } }, "estimated_delivery_date": "2021-07-07", "estimated_delivery_date_min": "2021-07-03", "estimated_delivery_date_max": "2021-07-10" } }, "title": "EstimatedDeliveryDate", "required": [ "slug", "origin_address", "destination_address" ], "properties": { "slug": { "type": "string", "description": "AfterShip's unique code of courier. Please refer to https://track.aftership.com/couriers/download.", "minLength": 1, "example": "fedex", "x-stoplight": { "id": "2fkha2qr7unu4" } }, "service_type_name": { "type": [ "string", "null" ], "minLength": 1, "example": "FEDEX HOME DELIVERY", "x-stoplight": { "id": "xf5a54x0eznad" }, "description": "AfterShip’s unique code represents carrier’s shipping and delivery options. Refer to [Download Link](https://assets.aftership.com/downloads/service_type_list.csv)." }, "origin_address": { "type": "object", "description": "The location from where the package is picked up by the carrier to be delivered to the final destination.", "x-stoplight": { "id": "3l69kjt8h52rv" }, "required": [ "country" ], "properties": { "country": { "type": "string", "description": "The country/region of the origin location from where the package is picked up by the carrier to be delivered to the final destination. Use 3 letters of ISO 3166-1 country/region code.", "minLength": 1, "example": "USA", "x-stoplight": { "id": "e8i3q8cgrao1i" } }, "state": { "type": [ "string", "null" ], "description": "State, province, or the equivalent location of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without state. \nEither `origin_address.state` or `origin_address.postal_code` is required.", "minLength": 1, "example": "WA", "maxLength": 256, "x-stoplight": { "id": "x45tzbvglk1kb" } }, "city": { "type": [ "string", "null" ], "description": "City of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without City.", "minLength": 1, "example": "Seattle", "maxLength": 256, "x-stoplight": { "id": "w2dh3z5iuz66d" } }, "postal_code": { "type": [ "string", "null" ], "description": "Postal code of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without postal code. \nEither `origin_address.state` or `origin_address.postal_code` is required.", "minLength": 1, "example": "98108", "maxLength": 256, "x-stoplight": { "id": "fnr91dv4wzr7x" } }, "raw_location": { "type": [ "string", "null" ], "description": "Raw location of the origin address. A raw address will help AI to identify the accurate location of the origin address.", "minLength": 1, "example": "Seattle, Washington, 98108, USA, United States", "maxLength": 512, "x-stoplight": { "id": "4rdm7ly5rzeix" } } } }, "destination_address": { "type": "object", "description": "The final destination of the customer where the delivery will be made.", "x-stoplight": { "id": "8becp8jxtn0kc" }, "required": [ "country" ], "properties": { "country": { "type": "string", "description": "The country/region of the destination location where the package will be delivered. Use 3 letters of ISO 3166-1 country code.", "minLength": 1, "x-stoplight": { "id": "0x042hr28q5rd" } }, "state": { "type": [ "string", "null" ], "description": "State, province, or the equivalent location of the destination address where the package will be delivered.\nEither `destination_address.state` or `destination_address.postal_code` is required.", "minLength": 1, "maxLength": 256, "x-stoplight": { "id": "6kfy7eftkvxvw" } }, "city": { "type": [ "string", "null" ], "description": "City of the destination address where the package will be delivered.", "minLength": 1, "maxLength": 256, "x-stoplight": { "id": "88zharfsrag0i" } }, "postal_code": { "type": [ "string", "null" ], "description": "Postal code of the destination address.\nEither `destination_address.state` or `destination_address.postal_code` is required.", "minLength": 1, "maxLength": 256, "x-stoplight": { "id": "soc4rhu323pph" } }, "raw_location": { "type": [ "string", "null" ], "description": "Raw location of the destination address. A raw address will help AI to identify the accurate location of the destination address.", "minLength": 1, "maxLength": 512, "x-stoplight": { "id": "5hxma28s9fb5p" } } } }, "weight": { "type": [ "object", "null" ], "description": "AfterShip uses this object to calculate the total weight of the order.", "x-stoplight": { "id": "r8zixon4yhr9t" }, "required": [ "unit", "value" ], "properties": { "unit": { "type": "string", "description": "The weight unit of the package. ", "example": "kg", "x-stoplight": { "id": "p70tijbxdtej6" } }, "value": { "type": "number", "description": "The weight of the shipment.", "example": 1, "x-stoplight": { "id": "33iyg3ulcnbzm" } } } }, "package_count": { "type": [ "integer", "null" ], "description": "The number of packages.", "example": 1, "x-stoplight": { "id": "gqk68aa256ryf" } }, "pickup_time": { "type": [ "string", "null" ], "example": "2021-07-01 06:42:30", "x-stoplight": { "id": "j6yfz7d6yc8n1" }, "description": "The local pickup time in the origin address time zone of the package.\n\nEither `pickup_time` or `estimated_pickup` is required." }, "estimated_pickup": { "type": [ "object", "null" ], "description": "The local pickup time of the package.\nEither `pickup_time` or `estimated_pickup` is required.", "x-stoplight": { "id": "prba2x0eapziz" }, "required": [ "order_time" ], "properties": { "order_time": { "type": "string", "description": "The local order time in the origin address time zone of the package.", "minLength": 1, "example": "2021-07-01 15:04:05", "x-stoplight": { "id": "aweebjla82xtj" } }, "order_cutoff_time": { "type": [ "string", "null" ], "minLength": 1, "example": "20:00:00", "x-stoplight": { "id": "abspbd3v6q79o" }, "description": "Order cut off time in the origin address time zone. The default value set by AfterShip is 18:00:00." }, "business_days": { "type": [ "array", "null" ], "description": "Operating days in a week. Number refers to the weekday.\nE.g., [1,2,3,4,5] means operating days are from Monday to Friday.\nAfterShip will set [1,2,3,4,5] as the default value.", "x-stoplight": { "id": "40m6r0vh76ydy" }, "items": { "type": "integer", "description": "Operating days in a week. Number refers to the weekday.\nE.g., [1,2,3,4,5] means operating days are from Monday to Friday.\nAfterShip will set [1,2,3,4,5] as the default value.", "example": 0, "x-stoplight": { "id": "synct2dgbd6ib" } } }, "order_processing_time": { "type": [ "object", "null" ], "x-stoplight": { "id": "56a65mpwjlyye" }, "properties": { "unit": { "type": "string", "minLength": 1, "example": "day", "description": "Processing time of an order, from being placed to being picked up. Only support day as value now.\nAfterShip will set day as the default value.", "x-stoplight": { "id": "raqv0b7k2ikz0" } }, "value": { "type": "number", "example": 0, "description": "Processing time of an order, from being placed to being picked up.\nAfterShip will set 0 as the default value.", "x-stoplight": { "id": "4rv3pdeeonpjb" } } } } } } } }, "Estimated_delivery_date_Response": { "x-stoplight": { "id": "40b6fc86060b5" }, "type": "object", "x-examples": { "example-1": { "slug": "fedex", "service_type_name": "FEDEX HOME DELIVERY", "origin_address": { "country": "USA", "state": "WA", "postal_code": "98108", "raw_location": "Seattle, Washington, 98108, USA, United States" }, "destination_address": { "country": "USA", "state": "CA", "postal_code": "92019", "raw_location": "El Cajon, California, 92019, USA, United States" }, "weight": null, "package_count": null, "estimated_pickup": { "order_time": "2021-07-01 15:04:05", "order_cutoff_time": "20:00:00", "business_days": [ 1, 2, 3, 4, 5, 6, 7 ], "order_processing_time": { "unit": "day", "value": 0 } }, "estimated_delivery_date": "2021-07-07", "estimated_delivery_date_min": "2021-07-03", "estimated_delivery_date_max": "2021-07-10" } }, "title": "EstimatedDeliveryDate", "required": [ "id", "slug", "origin_address", "destination_address" ], "properties": { "id": { "type": "string", "x-stoplight": { "id": "txwag8whxm10j" }, "description": "A string that acts as a unique identifier for the estimated delivery date value generated by AfterShip Predict API", "example": "56442da79af64b5f894109b5cbaba64c" }, "slug": { "type": "string", "description": "AfterShip's unique code of courier. Please refer to https://track.aftership.com/couriers/download.", "minLength": 1, "example": "fedex", "x-stoplight": { "id": "lbaa05enrsf0c" } }, "service_type_name": { "type": [ "string", "null" ], "description": "AfterShip’s unique code represents carrier’s shipping and delivery options. Refer to [Download Link](https://assets.aftership.com/downloads/service_type_list.csv).", "minLength": 1, "example": "FEDEX HOME DELIVERY", "x-stoplight": { "id": "7anehie9tjx2a" } }, "origin_address": { "type": "object", "description": "The location from where the package is picked up by the carrier to be delivered to the final destination.", "x-stoplight": { "id": "slojj1xwsknox" }, "required": [ "country" ], "properties": { "country": { "type": "string", "description": "The country/region of the origin location from where the package is picked up by the carrier to be delivered to the final destination. Use 3 letters of ISO 3166-1 country/region code.", "minLength": 1, "example": "USA", "x-stoplight": { "id": "2yxuigtg9pnun" } }, "state": { "type": [ "string", "null" ], "description": "State, province, or the equivalent location of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without state. \nEither `origin_address.state` or `origin_address.postal_code` is required.", "minLength": 1, "example": "WA", "maxLength": 256, "x-stoplight": { "id": "q0unlbi2ewtwx" } }, "city": { "type": [ "string", "null" ], "description": "City of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without City.", "minLength": 1, "example": "Seattle", "maxLength": 256, "x-stoplight": { "id": "49w0fp9in9ukm" } }, "postal_code": { "type": [ "string", "null" ], "description": "Postal code of the origin address. Use 3 letters of ISO 3166-1 country/region code for countries/regions without postal code. \nEither `origin_address.state` or `origin_address.postal_code` is required.", "minLength": 1, "example": "98108", "maxLength": 256, "x-stoplight": { "id": "nxn45r0gsdklr" } }, "raw_location": { "type": [ "string", "null" ], "description": "Raw location of the origin address. A raw address will help AI to identify the accurate location of the origin address.", "minLength": 1, "example": "Seattle, Washington, 98108, USA, United States", "maxLength": 512, "x-stoplight": { "id": "0z8k4qoirr090" } } } }, "destination_address": { "type": "object", "description": "The final destination of the customer where the delivery will be made.", "x-stoplight": { "id": "vjpub5i3oyvso" }, "required": [ "country" ], "properties": { "country": { "type": "string", "description": "The country/region of the destination location where the package will be delivered. Use 3 letters of ISO 3166-1 country code.", "minLength": 1, "x-stoplight": { "id": "ncnxcjyhfdtx0" } }, "state": { "type": [ "string", "null" ], "description": "State, province, or the equivalent location of the destination address where the package will be delivered.\nEither `destination_address.state` or `destination_address.postal_code` is required.", "minLength": 1, "maxLength": 256, "x-stoplight": { "id": "sevqes9hst531" } }, "city": { "type": [ "string", "null" ], "description": "City of the destination address where the package will be delivered.", "minLength": 1, "maxLength": 256, "x-stoplight": { "id": "vo0g195wsafjr" } }, "postal_code": { "type": [ "string", "null" ], "description": "Postal code of the destination address.\nEither `destination_address.state` or `destination_address.postal_code` is required.", "minLength": 1, "maxLength": 256, "x-stoplight": { "id": "ghkjgot2i0vvn" } }, "raw_location": { "type": [ "string", "null" ], "description": "Raw location of the destination address. A raw address will help AI to identify the accurate location of the destination address.", "minLength": 1, "maxLength": 512, "x-stoplight": { "id": "thmjibeacpde1" } } } }, "weight": { "type": [ "object", "null" ], "description": "AfterShip uses this object to calculate the total weight of the order.", "x-stoplight": { "id": "wtnoqqnwo0zuf" }, "required": [ "unit", "value" ], "properties": { "unit": { "type": "string", "description": "The weight unit of the package. ", "example": "kg", "x-stoplight": { "id": "2np5gtq194rjb" } }, "value": { "type": "number", "description": "The weight of the shipment.", "example": 1, "x-stoplight": { "id": "tsxccbksqmdh5" } } } }, "package_count": { "type": [ "integer", "null" ], "description": "The number of packages.", "example": 1, "x-stoplight": { "id": "d5mu2bz6vhl9d" } }, "pickup_time": { "type": [ "string", "null" ], "example": "2021-07-01 06:42:30", "description": "The local pickup time in the origin address time zone of the package.\n\nEither `pickup_time` or `estimated_pickup` is required.", "x-stoplight": { "id": "kudykb4y9b4nl" } }, "estimated_pickup": { "type": [ "object", "null" ], "description": "The local pickup time of the package.\nEither `pickup_time` or `estimated_pickup` is required.", "x-stoplight": { "id": "lvlrgi312chfh" }, "required": [ "order_time" ], "properties": { "order_time": { "type": "string", "description": "The local order time in the origin address time zone of the package.", "minLength": 1, "example": "2021-07-01 15:04:05", "x-stoplight": { "id": "mjepmn5afgrtl" } }, "order_cutoff_time": { "type": [ "string", "null" ], "description": "Order cut off time in the origin address time zone. The default value set by AfterShip is 18:00:00.", "minLength": 1, "example": "20:00:00", "x-stoplight": { "id": "y8dzxp6d1vxmb" } }, "business_days": { "type": [ "array", "null" ], "description": "Operating days in a week. Number refers to the weekday.\nE.g., [1,2,3,4,5] means operating days are from Monday to Friday.\nAfterShip will set [1,2,3,4,5] as the default value.", "x-stoplight": { "id": "t980et6dsz2vm" }, "items": { "type": "integer", "description": "Operating days in a week. Number refers to the weekday.\nE.g., [1,2,3,4,5] means operating days are from Monday to Friday.\nAfterShip will set [1,2,3,4,5] as the default value.", "example": 0, "x-stoplight": { "id": "ifan2t4e19a46" } } }, "order_processing_time": { "type": [ "object", "null" ], "x-stoplight": { "id": "4f4dybzr8r8j6" }, "properties": { "unit": { "type": "string", "minLength": 1, "example": "day", "description": "Processing time of an order, from being placed to being picked up. Only support day as value now.\nAfterShip will set day as the default value.", "x-stoplight": { "id": "j17iidd06s8h0" } }, "value": { "type": "number", "example": 0, "description": "Processing time of an order, from being placed to being picked up.\nAfterShip will set 0 as the default value.", "x-stoplight": { "id": "e44lr7kg9645f" } } } }, "pickup_time": { "type": [ "string", "null" ], "example": "2021-07-01 20:00:00", "description": "The local pickup time of the package. ", "x-stoplight": { "id": "yipnxu5x7rt9d" } } } }, "estimated_delivery_date": { "type": "string", "description": "The estimated arrival date of the shipment, provided by AfterShip.", "minLength": 1, "example": "2021-07-03", "x-stoplight": { "id": "qjas9kod90oba" } }, "confidence_code": { "type": "number", "x-stoplight": { "id": "sikywwuonop5i" }, "description": "Indicates the confidence level and associated reason for an AI EDD prediction request. For a comprehensive list of confidence codes, refer to [this document](../../docs/enum/confidence_codes.md#confidence-codes).", "example": 10001 }, "estimated_delivery_date_min": { "type": "string", "description": "The earliest estimated delivery date of the shipment, provided by AfterShip.", "minLength": 1, "example": "2021-07-02", "x-stoplight": { "id": "124tdtumjcnyy" } }, "estimated_delivery_date_max": { "type": "string", "description": "The latest estimated delivery date of the shipment, provided by AfterShip.", "minLength": 1, "example": "2021-07-04", "x-stoplight": { "id": "54toustiy68ro" } } } }, "Tracking": { "description": "Object describes the tracking information.
[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/delivery_sub_statuses.md)\n[url](../../docs/enum/confidence_codes.md)\n[url](../../docs/enum/events.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)
", "x-stoplight": { "id": "85e38d6ce6521" }, "type": "object", "title": "Tracking", "x-tags": [ "Resource" ], "examples": [], "properties": { "id": { "type": "string", "description": "Tracking ID.", "example": "bff5a3bac79b472991a204172473a635", "x-stoplight": { "id": "cxja2lu8zfupm" } }, "legacy_id": { "type": "string", "x-stoplight": { "id": "7r0ag0tqoaa1l" }, "description": "The length of the tracking ID has been increased from 24 characters to 32 characters. We will use the legacy_id field to store the original 24-character tracking ID to maintain compatibility with existing data. Therefore, all tracking endpoints will continue to work with the legacy_id field as before.", "example": "gngrj3vnc7toblxddgn5p02a" }, "created_at": { "type": "string", "minLength": 1, "description": "The date and time the shipment was imported or added to AfterShip. It uses the format `YYYY-MM-DDTHH:mm:ssZ` for the timezone GMT +0.", "example": "2023-01-18T08:47:10+00:00", "x-stoplight": { "id": "mdam4rz03101q" } }, "updated_at": { "type": "string", "minLength": 1, "description": "The date and time the shipment was updated. It uses the format `YYYY-MM-DDTHH:mm:ssZ` for the timezone GMT +0.", "example": "2023-01-18T17:47:10+00:00", "x-stoplight": { "id": "mdtq9vt7cln4z" } }, "last_updated_at": { "type": "string", "description": "(Legacy) The date and time the shipment was updated. It uses the format `YYYY-MM-DDTHH:mm:ssZ` for the timezone GMT +0.", "example": "2023-01-18T17:47:10+00:00", "x-stoplight": { "id": "tu0dge5wq37wr" } }, "tracking_number": { "type": "string", "minLength": 1, "description": "Tracking number.", "example": "61293150000079650811", "x-stoplight": { "id": "oqhmkeml2dqas" } }, "slug": { "type": "string", "minLength": 1, "description": "Unique courier code. When importing a shipment with no courier slug and the tracking number can’t be recognized, the courier will be marked as `unrecognized`. Get courier codes [here](https://www.aftership.com/docs/tracking/others/supported-couriers).", "example": "fedex", "x-stoplight": { "id": "5k6b1k0td71d2" } }, "active": { "type": "boolean", "description": "Whether or not AfterShip will continue tracking the shipments. Value is `false` when tag (status) is `Delivered`, `Expired`, or further updates for 30 days since last update.", "example": false, "x-stoplight": { "id": "zlxzpdlsudlup" } }, "custom_fields": { "type": "object", "nullable": true, "description": "Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any [personal data](https://www.aftership.com/legal/dpa#:~:text=Personal%20Data%20means,that%20natural%20person) in custom fields.", "example": { "store_name": "my-store" }, "x-stoplight": { "id": "hc8c5xstqkevs" }, "additionalProperties": { "type": "string", "x-stoplight": { "id": "ivboi1s75tc09" } } }, "customer_name": { "type": [ "string", "null" ], "description": "Customer name of the tracking.", "example": "Steve Young", "x-stoplight": { "id": "fttvf4oupa4rl" } }, "transit_time": { "type": [ "integer", "null" ], "description": "Total transit time in days.\n\n- For delivered shipments: Transit time (in days) = Delivered date - Pick-up date\n- For undelivered shipments: Transit time (in days) = Current date - Pick-up date\n\nValue as `null` for the shipment without pick-up date.", "example": 9, "x-stoplight": { "id": "3edc9tvm5xice" } }, "origin_country_iso3": { "type": [ "string", "null" ], "minLength": 1, "description": "The [ISO Alpha-3](https://support.aftership.com/en/article/iso3-country-code-rlpi07/) code (3 letters) for the origin country/region. E.g. USA for the United States.", "example": "CHN", "x-stoplight": { "id": "lg4bgkpqich9d" } }, "origin_state": { "type": [ "string", "null" ], "description": "The state of the sender’s address.", "example": "Beijing", "x-stoplight": { "id": "gfszuw9f9bsb1" } }, "origin_city": { "type": [ "string", "null" ], "description": "The city of the sender’s address.", "example": "Beijing", "x-stoplight": { "id": "47c70cejlgh6k" } }, "origin_postal_code": { "type": [ "string", "null" ], "description": "The postal code of the sender’s address.", "example": "065001", "x-stoplight": { "id": "tifkzldeihitn" } }, "origin_raw_location": { "type": [ "string", "null" ], "description": "The sender address that the shipment is shipping from.", "example": "Lihong Gardon 4A 2301, Chaoyang District, Beijing, BJ, 065001, CHN, China", "x-stoplight": { "id": "aaptwiqo10vwv" } }, "destination_country_iso3": { "type": [ "string", "null" ], "description": "The [ISO Alpha-3](https://support.aftership.com/en/article/iso3-country-code-rlpi07/) code (3 letters) for the destination country/region. E.g. USA for the United States.", "example": "USA", "x-stoplight": { "id": "w36bba5uszpu5" } }, "destination_state": { "type": [ "string", "null" ], "description": "The state of the recipient’s address.", "example": "New York", "x-stoplight": { "id": "pgb8c9dqxvpxm" } }, "destination_city": { "type": [ "string", "null" ], "description": "The city of the recipient’s address.", "example": "New York City", "x-stoplight": { "id": "1vq30jhzrh2jq" } }, "destination_postal_code": { "type": [ "string", "null" ], "description": "The postal code of the recipient’s address.", "example": "10001", "x-stoplight": { "id": "erlb4rvw3in9k" } }, "destination_raw_location": { "type": [ "string", "null" ], "description": "The shipping address that the shipment is shipping to.", "example": "13th Street, New York, NY, 10011, USA, United States", "x-stoplight": { "id": "w50z2discs59u" } }, "courier_destination_country_iso3": { "type": [ "string", "null" ], "description": "Destination country/region of the tracking detected from the courier. ISO Alpha-3 (three letters). Value will be `null` if the courier doesn't provide the destination country.", "example": "USA", "x-stoplight": { "id": "lqezfz5kkst9u" } }, "emails": { "type": "array", "description": "Email address(es) to receive email notifications.", "example": [ "example@aftership.com" ], "x-stoplight": { "id": "iu6k12rvurfjc" }, "items": { "type": "string", "x-stoplight": { "id": "4owuuj3sl6yxk" } } }, "expected_delivery": { "type": [ "string", "null" ], "minLength": 1, "description": "The estimated delivery date provided by the carrier. It uses the shipment recipient’s timezone and the format may differ depending on how the carrier provides it:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ", "example": "2022-01-05T12:11:11+01:00", "x-stoplight": { "id": "kg1to2qu44j2a" } }, "note": { "type": [ "string", "null" ], "description": "Text field for the note.", "example": "note", "x-stoplight": { "id": "p6jf151eq3tph" } }, "order_id": { "type": [ "string", "null" ], "description": "A globally-unique identifier for the order.", "example": "6845a095a27a4caeb27487806f058add", "x-stoplight": { "id": "8dmmcvb0udi7g" } }, "order_id_path": { "type": [ "string", "null" ], "description": "The URL for the order in your system or store.", "example": "https://www.aftership.com/my-orders/6845a095a27a4caeb27487806f058add", "x-stoplight": { "id": "z7ond9zx1dmhc" } }, "order_date": { "type": [ "string", "null" ], "description": "The date and time the order was created in your system or store. It uses the format: `YYYY-MM-DDTHH:mm:ssZ` based on whichever timezone you provide.", "example": "2022-01-20T15:56:12+08:00", "x-stoplight": { "id": "idtthxq18dkxq" } }, "shipment_package_count": { "type": [ "number", "null" ], "description": "Number of packages under the tracking.", "example": 1, "x-stoplight": { "id": "hdjjl0d9uouqx" } }, "shipment_pickup_date": { "type": [ "string", "null" ], "minLength": 1, "description": "The date and time the shipment was picked up by the carrier. It uses the timezone where the pickup occured. The format may differ depending on how the carrier provides it:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ", "example": "2022-01-21T15:00:00", "x-stoplight": { "id": "vin3rqt104uij" } }, "shipment_delivery_date": { "type": [ "string", "null" ], "minLength": 1, "description": "The date and time the shipment was delivered. It uses the shipment recipient’s timezone. The format may differ depending on how the carrier provides it:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ", "example": "2022-01-29T11:23:00", "x-stoplight": { "id": "pq7hqb96dq6gz" } }, "shipment_type": { "type": [ "string", "null" ], "minLength": 1, "description": "The carrier service type for the shipment.", "example": "FedEx SmartPost", "x-stoplight": { "id": "7aw6mydlwk3qk" } }, "shipment_weight": { "type": [ "object", "null" ], "description": "The shipment_weight field represents the total weight of the shipment. In scenarios where the carrier does not provide this information, you can provide the weight to AfterShip. We will prioritize the data provided by the carrier, if available. The shipment weight will be included in the Response and accessed through the GET API, Webhook, and CSV export. It will also be displayed on the AfterShip Tracking admin. Additionally, it plays a significant role in error-free shipment handling and carbon emission calculations, ensuring accurate and informed decision-making", "x-stoplight": { "id": "jyj21fo6q7oub" }, "properties": { "unit": { "type": "string", "x-stoplight": { "id": "6dz3wdq28kt0s" }, "description": "The unit in which the value field is expressed.", "example": "kg" }, "value": { "type": "number", "x-stoplight": { "id": "m2r4qiavxyf6c" }, "description": "The total amount of shipment weight.", "example": 1.3 } } }, "signed_by": { "type": [ "string", "null" ], "description": "Signed by information for delivered shipment.", "example": "Steve Young", "x-stoplight": { "id": "ou55pbuyi9c8s" } }, "smses": { "type": "array", "description": "The phone number(s) to receive sms notifications. Phone number should begin with `+` and `Area Code` before phone number.", "example": [ "+8613800138000" ], "x-stoplight": { "id": "fcicpb59pjhgz" }, "items": { "type": "string", "x-stoplight": { "id": "v7zarchvxp0ib" } } }, "source": { "type": "string", "minLength": 1, "description": "Source of how this tracking is added.", "example": "api", "x-stoplight": { "id": "gqhhejuq7enqw" } }, "tag": { "$ref": "#/components/schemas/Tag.v1", "x-stoplight": { "id": "zcw4ttoz76bsj" } }, "subtag": { "type": "string", "minLength": 1, "description": "Current subtag of tracking. ([See subtag definition](../../docs/enum/delivery_sub_statuses.md))", "example": "Delivered_002", "x-stoplight": { "id": "ues79yoiwdb9c" } }, "subtag_message": { "type": "string", "minLength": 1, "description": "Normalized tracking message. ([See subtag definition](../../docs/enum/delivery_sub_statuses.md))", "example": "Picked up by customer", "x-stoplight": { "id": "o7f0hujvn0vk1" } }, "title": { "type": "string", "minLength": 1, "description": "By default this field shows the `tracking_number`, but you can customize it as you wish with any info (e.g. the order number).", "example": "61293150000079650811", "x-stoplight": { "id": "7hrsb1c469748" } }, "tracked_count": { "type": "number", "description": "Number of attempts AfterShip tracks at courier's system.", "example": 13, "x-stoplight": { "id": "kiavnm2cxtem7" } }, "last_mile_tracking_supported": { "type": [ "boolean", "null" ], "description": "Indicates if the shipment is trackable till the final destination.\nThree possible values:\n- true\n- false\n- null", "example": true, "x-stoplight": { "id": "lqemaaywjjoj5" } }, "language": { "description": "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.", "type": [ "string", "null" ], "example": "en", "x-stoplight": { "id": "101i7f37z5gae" } }, "unique_token": { "type": "string", "minLength": 1, "deprecated": true, "description": "Deprecated", "example": "Deprecated", "x-stoplight": { "id": "pfwgk0hm16h0o" } }, "checkpoints": { "type": "array", "description": "Array of checkpoint object describes the checkpoint information.", "x-stoplight": { "id": "fls5bqyjffakv" }, "items": { "$ref": "#/components/schemas/Checkpoint", "x-stoplight": { "id": "ag7g0fudz5euk" } } }, "subscribed_smses": { "type": "array", "description": "Phone number(s) subscribed to receive sms notifications.", "x-stoplight": { "id": "9gakdu0fdg1cr" }, "items": { "type": "string", "x-stoplight": { "id": "xb7fnk65qo1ke" } } }, "subscribed_emails": { "type": "array", "description": "Email address(es) subscribed to receive email notifications.", "x-stoplight": { "id": "6byp7z9gjzl74" }, "items": { "type": "string", "x-stoplight": { "id": "nohm024901rw1" } } }, "return_to_sender": { "type": "boolean", "description": "Whether or not the shipment is returned to sender. Value is `true` when any of its checkpoints has subtag `Exception_010` (returning to sender) or `Exception_011` (returned to sender). Otherwise value is `false`.", "example": false, "x-stoplight": { "id": "dc058629cok6i" } }, "order_promised_delivery_date": { "type": [ "string", "null" ], "description": "The promised delivery date of the order. It uses the formats:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ", "example": "2022-01-01", "x-stoplight": { "id": "mcalgi7v11ckk" } }, "delivery_type": { "type": [ "string", "null" ], "description": "Shipment delivery type\n- pickup_at_store\n- pickup_at_courier\n- door_to_door", "example": "pickup_at_store", "x-stoplight": { "id": "34eh2pxqk7bpg" } }, "pickup_location": { "type": [ "string", "null" ], "description": "Shipment pickup location for receiver", "example": "13th Street, New York, NY 10011, USA, United States", "x-stoplight": { "id": "o8630dpp5s4t7" } }, "pickup_note": { "type": [ "string", "null" ], "description": "Shipment pickup note for receiver", "example": "No notes", "x-stoplight": { "id": "znsxb6xypmv2t" } }, "courier_tracking_link": { "type": [ "string", "null" ], "minLength": 1, "description": "Official tracking URL of the courier (if any). The language parameter of this link relies on the destination country/region and the language associated with the shipment, if the data regarding the destination country/region and language of the shipment is not available, AfterShip will set the language parameter of the link to \"US\" by default.", "example": "https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US", "x-stoplight": { "id": "n6roi7zoka82f" } }, "first_attempted_at": { "type": [ "string", "null" ], "minLength": 1, "description": "The date and time of the carrier’s first attempt to deliver the package to the recipient. It uses the shipment recipient’s timezone. The format may differ depending on how the carrier provides it:\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ", "example": "2022-01-01T17:00:00-05:00", "x-stoplight": { "id": "1nl6r2ptiz2ux" } }, "courier_redirect_link": { "type": [ "string", "null" ], "minLength": 1, "description": "Delivery instructions (delivery date or address) can be modified by visiting the link if supported by a carrier. The language parameter of this link relies on the destination country/region and the language associated with the shipment, if the data regarding the destination country/region and language of the shipment is not available, AfterShip will set the language parameter of the link to \"US\" by default.", "example": "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US", "x-stoplight": { "id": "l9wvmlbfpq9m5" } }, "tracking_account_number": { "type": [ "string", "null" ], "description": "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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": null, "x-stoplight": { "id": "a9bqpoefesxpz" } }, "tracking_key": { "type": [ "string", "null" ], "description": "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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": null, "x-stoplight": { "id": "cmjbmic75y8ow" } }, "tracking_ship_date": { "type": [ "string", "null" ], "description": "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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "20220101", "x-stoplight": { "id": "cf3kar40tbf5k" } }, "on_time_status": { "type": [ "string", "null" ], "description": "Whether the tracking is delivered on time or not.", "example": "on-time", "x-stoplight": { "id": "yyf8idqnwbv9s" } }, "on_time_difference": { "type": [ "number", "null" ], "description": "The difference days of the on time.", "example": 0, "x-stoplight": { "id": "i9kfgjee8guk0" } }, "order_tags": { "type": "array", "description": "The tags of the order.", "example": [ "Exception" ], "x-stoplight": { "id": "q9qbc7g33rrr1" }, "items": { "type": "string", "x-stoplight": { "id": "b3mmq7w881xjs" } } }, "aftership_estimated_delivery_date": { "type": [ "object", "null" ], "description": "The estimated delivery date of the shipment provided by AfterShip’s AI and shown to the recipients. It uses the format `YYYY-MM-DD` based on the shipment recipient’s timezone.", "x-stoplight": { "id": "aem0yqpi17b5u" }, "properties": { "estimated_delivery_date": { "type": "string", "description": "The estimated arrival date of the shipment.", "example": "2022-01-03", "x-stoplight": { "id": "mgqspjtuwt6ym" } }, "confidence_code": { "type": "number", "example": 10001, "x-stoplight": { "id": "vvl3hdd9lyvnk" }, "description": "Indicates the confidence level and associated reason for an AI EDD prediction request. For a comprehensive list of confidence codes, refer to [this document](../../docs/enum/confidence_codes.md#confidence-codes)." }, "estimated_delivery_date_min": { "type": "string", "description": "Earliest estimated delivery date of the shipment.", "example": "2022-01-02", "x-stoplight": { "id": "r7i1fnrmsh4n6" } }, "estimated_delivery_date_max": { "type": "string", "description": "Latest estimated delivery date of the shipment.", "example": "2022-01-04", "x-stoplight": { "id": "51nf99logjukp" } } } }, "custom_estimated_delivery_date": { "type": [ "object", "null" ], "description": "Estimated delivery time of the shipment based on your [custom EDD settings](https://admin.aftership.com/settings/promised-delivery-date). It uses the format `YYYY-MM-DD` based on the shipment recipient’s timezone.", "x-stoplight": { "id": "q9x8ooe0g2upf" }, "properties": { "type": { "type": "string", "enum": [ "range", "specific" ], "example": "specific", "description": "The format of the EDD. Either a single date or a date range.", "x-stoplight": { "id": "6n5pk0tkn40af" } }, "datetime": { "type": [ "string", "null" ], "description": "The specific EDD date.", "example": "2022-01-05", "x-stoplight": { "id": "kmc7zhvwvqp7c" } }, "datetime_min": { "type": [ "string", "null" ], "description": "For a date range EDD format, the date for the lower end of the range.", "example": null, "x-stoplight": { "id": "gq9jwjhf2x5f6" } }, "datetime_max": { "type": [ "string", "null" ], "description": "For a date range EDD format, the date for the upper end of the range.", "example": null, "x-stoplight": { "id": "mdgm5eo1pkf5h" } } } }, "order_number": { "type": [ "string", "null" ], "description": "A unique, human-readable identifier for the order.", "example": "162654659775", "x-stoplight": { "id": "7o48lnihq94l3" } }, "first_estimated_delivery": { "type": [ "object", "null" ], "description": "The shipment’s original estimated delivery date. It could be provided by the carrier, AfterShip AI, or based on your custom settings. The format of carrier EDDs may differ depending on how the carrier provides it:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ\n AfterShip AI and custom EDDs always use the format `YYYY-MM-DD`. All EDDs use the shipment recipient’s timezone.", "x-stoplight": { "id": "hh6ao95ap2hf3" }, "properties": { "type": { "type": "string", "enum": [ "range", "specific" ], "example": "specific", "description": "The format of the EDD. Either a single date or a date range.", "x-stoplight": { "id": "zi9cqxlbjdpmr" } }, "source": { "type": "string", "description": "The source of the EDD. Either the carrier, AfterShip AI, or based on your custom EDD settings.", "enum": [ "Carrier EDD", "AfterShip EDD", "Custom EDD", "Order EDD" ], "example": "Carrier EDD", "x-stoplight": { "id": "tytlfua2ewngl" } }, "datetime": { "type": [ "string", "null" ], "description": "The latest EDD time.", "example": "2022-01-05T12:11:11+01:00", "x-stoplight": { "id": "z0f7c7fy4lk9f" } }, "datetime_min": { "type": [ "string", "null" ], "description": "For a date range EDD format, the date and time for the lower end of the range.", "example": null, "x-stoplight": { "id": "y16dc2h9yw7yb" } }, "datetime_max": { "type": [ "string", "null" ], "description": "For a date range EDD format, the date and time for the upper end of the range.", "example": null, "x-stoplight": { "id": "ie29bqqkbdeml" } } } }, "latest_estimated_delivery": { "type": [ "object", "null" ], "description": "The most recently calculated estimated delivery date. It could be provided by the carrier, AfterShip AI, or based on your custom settings. The format of carrier EDDs may differ depending on how the carrier provides it:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ\n AfterShip AI and custom EDDs always use the format `YYYY-MM-DD`. All EDDs use the shipment recipient’s timezone.", "x-stoplight": { "id": "c8b1s1h74aa3l" }, "properties": { "type": { "type": "string", "enum": [ "range", "specific" ], "example": "specific", "description": "The format of the EDD. Either a single date or a date range.", "x-stoplight": { "id": "nsdx4v7ky9wm4" } }, "source": { "type": "string", "description": "The source of the EDD. Either the carrier, AfterShip AI, or based on your custom EDD settings.", "enum": [ "Carrier EDD", "AfterShip EDD", "Custom EDD", "Order EDD" ], "example": "AfterShip EDD", "x-stoplight": { "id": "43og381lh3igs" } }, "datetime": { "type": [ "string", "null" ], "description": "The latest EDD time.", "example": "2022-01-05T12:11:11+01:00", "x-stoplight": { "id": "0mtzl11ixh6bb" } }, "datetime_min": { "type": [ "string", "null" ], "description": "For a date range EDD format, the date and time for the lower end of the range.", "example": null, "x-stoplight": { "id": "b16ab78y852zq" } }, "datetime_max": { "type": [ "string", "null" ], "description": "For a date range EDD format, the date and time for the upper end of the range.", "example": null, "x-stoplight": { "id": "zyrjpftzihizd" } } } }, "shipment_tags": { "type": "array", "description": "Used to add tags to your shipments to help categorize and filter them easily.", "maxItems": 50, "example": [ "Returned" ], "x-stoplight": { "id": "n2hz9edtocz8x" }, "items": { "type": "string", "maxLength": 32, "x-stoplight": { "id": "klv3uvgsscjfn" } } }, "courier_connection_id": { "type": [ "string", "null" ], "description": "If you have multiple accounts connected for a single carrier on AfterShip, we have introduced the courier_connection_id field to allow you to specify the carrier account associated with each shipment. By providing this information, you enable us to accurately track and monitor your shipments based on the correct carrier account.([Get your courier connection id](https://admin.aftership.com/carrier-connection))
\nIn the event that you do not specify the courier_connection_id, we will handle your shipment using the connection that was created earliest among your connected accounts.", "minLength": 1, "example": "8e1261bde336436abbc7cb3eee8cd707", "x-stoplight": { "id": "8hpi8gf24thl8" } }, "next_couriers": { "type": "array", "description": "The next couriers get the second carrier information from user or AfterShip.", "x-stoplight": { "id": "fqc72e7awax6t" }, "items": { "type": "object", "x-stoplight": { "id": "vivltd2z0b0qt" }, "required": [ "slug", "tracking_number" ], "properties": { "slug": { "type": "string", "description": "Unique code of courier. Get courier [here](../../reference/api.json/paths/~1couriers/get)", "example": "usps", "x-stoplight": { "id": "b9hk8gge0l38o" } }, "tracking_number": { "type": "string", "description": "Tracking number.", "example": "61293150000079650811", "x-stoplight": { "id": "uvehz2wkjzfgq" } }, "source": { "type": "string", "description": "Source of next couriers.", "enum": [ "user", "system" ], "example": "system", "x-stoplight": { "id": "es57ckdjhxus3" } } } } }, "tracking_origin_country": { "type": [ "string", "null" ], "description": "(Legacy) Replaced by `origin_country_iso3`. 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "CHN", "x-stoplight": { "id": "7lug10mxnfz4f" } }, "tracking_destination_country": { "type": [ "string", "null" ], "description": "(Legacy) Replaced by `destination_country_iso3`. 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "USA", "x-stoplight": { "id": "ucf9v1hgpnomk" } }, "tracking_postal_code": { "type": [ "string", "null" ], "description": "(Legacy) Replaced by `destination_postal_code`. 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "90213", "x-stoplight": { "id": "2d5n9tpsor0zc" } }, "tracking_state": { "type": [ "string", "null" ], "description": "(Legacy) Replaced by `destination_state`. 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](../../docs/enum/additional_tracking_fields.md) for more details.", "example": "CA", "x-stoplight": { "id": "gtgwuyoxdbl7m" } }, "carbon_emissions": { "type": [ "object", "null" ], "x-stoplight": { "id": "v5uie75c3kray" }, "description": "The model contains the total amount of carbon emissions generated by the shipment. \n- AfterShip will provide this data only when it is available, and its availability is contingent upon the location and weight information that AfterShip can obtain.\n- The values will be accessible solely for shipments that have been successfully delivered. However, in the event of a shipping update after the delivery status has been achieved, the value may change.\n- It’s a paid service and only for Tracking Enterprise users, please contact your customer success manager if you want to know more.", "properties": { "unit": { "type": "string", "x-stoplight": { "id": "a28ex68lfv4of" }, "description": "The unit in which the value field is expressed. Allowed values: kg", "example": "kg", "readOnly": true }, "value": { "type": "number", "x-stoplight": { "id": "cpr55pp7pm3q8" }, "description": "The total amount of carbon emissions", "example": 0.7, "readOnly": true } } }, "location_id": { "type": [ "string", "null" ], "x-stoplight": { "id": "ydzbctpgbxw53" }, "example": "bda843ed811541fc852a8447371cf6f2", "description": "The location_id refers to the place where you fulfilled the items. \n - If you provide a location_id, the system will automatically use it as the tracking's origin address. However, passing both location_id and any origin address information simultaneously is not allowed.\n- Please make sure you add your locations [here](https://admin.aftership.com/settings/locations-and-rules) before passing the location_id and verify that the location's status is active. Learn more about adding locations [here](https://support.aftership.com/en/article/manage-ship-from-locations-via-aftership-tracking-okbhj4/?bust=1702871142396)." }, "shipping_method": { "type": [ "string", "null" ], "x-stoplight": { "id": "pkxdj6w6z0pey" }, "example": "Local Delivery", "description": "The shipping_method string refers to the chosen method for delivering the package. Merchants typically offer various shipping methods to consumers during the checkout process, such as, Local Delivery, Free Express Worldwide Shipping, etc." }, "failed_delivery_attempts": { "type": [ "integer", "null" ], "x-stoplight": { "id": "96wldsihcjrgz" }, "example": 2, "description": "By dynamically tracking failed delivery attempts during shipment, this field allows you to pinpoint carriers accountable for the most failures. Analyzing the root cause of these failures enables you to improve carriers' delivery standard operating procedures (SOP), leading to an overall enhancement in delivery service quality.", "readOnly": true }, "signature_requirement": { "x-stoplight": { "id": "38r19tj09ns5d" }, "example": "signature_required", "description": "The signature_requirement field serves the purpose of validating the service option type, specifically proof of delivery. By collecting the recipient's signature upon delivery, it ensures the package reaches the intended recipient and prevents disputes related to non-delivery or lost packages.
", "enum": [ "signature_required", "adult_signature_required", "indirect_signature_required", "no_signature_required", null ], "type": "string", "readOnly": true }, "delivery_location_type": { "type": [ "string", "null" ], "x-stoplight": { "id": "a5n0jegg7gg62" }, "example": "front door, porch, front desk", "description": "The delivery location type represents the secure area where the carrier leaves the package, such as a safe place, locker, mailbox, front porch, etc. This information helps ensure the shipment reaches the intended recipient efficiently, minimizing the risk of theft or damage." } } }, "Courier_response.v1": { "title": "Courier response", "type": "object", "description": "Model of all couriers endpoint response", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/Meta.v1" }, "data": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total count of courier objects" }, "couriers": { "description": "Array of [Courier](../../model/resource/courier.json) object.", "type": "array", "items": { "$ref": "#/components/schemas/Courier", "x-stoplight": { "id": "dh84q02xjf082" } } } } } } }, "Meta.v1": { "title": "meta", "type": "object", "description": "Meta data", "required": [ "code" ], "properties": { "code": { "type": "integer", "example": 200, "description": "meta code" }, "message": { "type": "string", "description": "error message, only exist if the response status is not 2xx" }, "type": { "type": "string", "enum": [ "BadRequest", "Unauthorized", "Forbidden", "NotFound", "TooManyRequests", "InternalError" ], "description": "error type, only exist if the response status is not 2xx" } } }, "Tracking_response.v1": { "title": "Tracking response", "type": "object", "description": "Tracking response for returning single tracking", "required": [ "meta", "data" ], "properties": { "meta": { "$ref": "#/components/schemas/Meta.v1" }, "data": { "$ref": "#/components/schemas/Tracking" } } }, "Tracking_response_get_multiple.v1": { "title": "Tracking response for get trackings", "type": "object", "description": "Tracking response for getting tracking", "required": [ "meta" ], "properties": { "meta": { "$ref": "#/components/schemas/Meta.v1" }, "data": { "type": "object", "properties": { "page": { "type": "integer", "description": "Page to show. (Default: 1)" }, "limit": { "type": "integer", "description": "Number of trackings each page contain. (Default: 100, Max: 200)" }, "count": { "type": "integer", "description": "Number of returned trackings" }, "keyword": { "type": "string", "description": "Search the content of the tracking record fields: `tracking_number`, `title`, `order_id`, `customer_name`, `custom_fields`, `order_id`, `emails`, `smses`" }, "slug": { "type": "string", "description": "Unique [courier code](../../reference/api.json/paths/~1couriers/get) Use comma for multiple values. (Example: `dhl`, `ups`, `usps`)" }, "origin": { "type": "array", "description": "Origin country/region of trackings. Use [ISO Alpha-3 (three letters)](https://support.aftership.com/en/article/iso3-country-code-rlpi07/). Use comma for multiple values. (Example: `USA`, `HKG`)", "items": { "type": "string" } }, "destination": { "type": "array", "description": "Destination country/region of trackings. Use [ISO Alpha-3 (three letters)](https://support.aftership.com/en/article/iso3-country-code-rlpi07/). Use comma for multiple values. (Example: `USA`, `HKG`)", "items": { "type": "string" } }, "tag": { "$ref": "#/components/schemas/Tag.v1" }, "created_at_min": { "type": "string", "description": "Start date and time of trackings created. AfterShip only stores data of 120 days." }, "created_at_max": { "type": "string", "description": "End date and time of trackings created." }, "last_updated_at": { "type": "string", "description": "Date and time the tracking was last updated" }, "return_to_sender": { "type": "array", "description": "Whether or not the shipment is returned to sender. Value is `true` when any of its checkpoints has subtag `Exception_010` (returning to sender) or `Exception_011` (returned to sender). Otherwise value is `false`", "items": { "type": "boolean" } }, "courier_destination_country_iso3": { "type": "array", "description": "Destination country/region of the tracking detected from the courier. ISO Alpha-3 (three letters). Value will be `null` if the courier doesn't provide the destination country.", "items": { "type": "string" } }, "trackings": { "description": "Array of [tracking object](../../model/resource/tracking.json)", "type": "array", "items": { "$ref": "#/components/schemas/Tracking", "x-stoplight": { "id": "tdehjrjz0yj1s" } } } } } } } } }, "security": [ { "as-api-key": [] }, { "aftership-api-key": [] } ] }