---
title: "Tracking Updates"
method: POST
path: "/2024-09/shipments/tracking_updates"
tags: ["eFulfillment"]
---

# Tracking Updates

`POST /2024-09/shipments/tracking_updates`

## Request

- Base URL: `https://public-api.easyship.com`
- URL: `https://public-api.easyship.com/2024-09/shipments/tracking_updates`
- Auth: HTTP bearer

Update the shipment tracking number and create tracking events.

Required authorization scopes: `public.shipment:write`, `public.efulfillment:write`

> This endpoint is only available to eFulfillment clients with shipments fulfilled at one of Easyship's integrated warehouses.

> You will need to specify `tracking_number` for initial request for a shipment. Further updates of a shipment with the same `easyship_shipment_id` don't need to have the `tracking number` unless you change it.

For `events`, specify the `primary_status` field from the list:
* `InTransit`
* `OutForDelivery`
* `AttemptFail`
* `Delivered`
* `Exception`

#### Example request for an initial setup of a shipment

```json
{
  "easyship_shipment_id": "ESHK10017799",
  "tracking_number": "ABCD1234",
  "events": [
    {
      "primary_status": "InTransit"
    }
  ]
}
```

#### Example request for a shipment status update

This example has optional `event_time` and `event_time_zone`.

```json
{
  "easyship_shipment_id": "ESHK10017799",
  "events": [
    {
      "primary_status": "OutForDelivery",
      "event_time": "2020-04-29T03:38:00",
      "event_time_zone": "-04:00"
    }
  ]
}
```

#### Example request for a complete update

```json
{
  "easyship_shipment_id": "ESHK10017799",
  "events": [
    {
      "primary_status": "OutForDelivery",
      "location": "Brooklyn, NY",
      "city": "Brooklyn",
      "country_alpha2": "US",
      "state": "NY",
      "zip": "11201",
      "handler": "UPS",
      "message": "On UPS vehicle for delivery",
      "event_time": "2020-04-29T03:38:00",
      "event_time_zone": "-04:00"
    }
  ]
}
```

## Request body

- ShipmentTrackingUpdate
  - `easyship_shipment_id` EasyshipShipmentId, required (unresolved $ref)
  - `tracking_number` string, nullable: Tracking number
  - `events` object[]: Events
    - `primary_status` 'InTransit' | 'OutForDelivery' | 'AttemptFail' | 'Delivered' | 'Exception', required: Primary status
    - `location` string: Location
    - `city` City (unresolved $ref)
    - `country_alpha2` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW': Country Code in Alpha-2 format (ISO 3166-1)
    - `state` State (unresolved $ref)
    - `zip` PostalCode (unresolved $ref)
    - `handler` string: Handler
    - `message` string: Message
    - `event_time` string, date-time: Event time
    - `event_time_zone` string: Event time zone

## Response `201`

tracking successfully created and set to in transit

- Success: General success response
  - `success` object
    - `message` string
  - `meta` Meta
    - `request_id` string: An unique ID represent the request.

## Other responses

- `404`: shipment not found
- `422`: failed validations

## Changes

- **2026-11-03** `b47b54b748a7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/easyship/apis/easyship-public-api/changes/2024-09/shipments/tracking_updates/post.md)

---

[API](https://skmtc.dev/easyship/apis/easyship-public-api.md) - [All operations](https://skmtc.dev/easyship/apis/easyship-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/easyship/apis/easyship-public-api/revisions/b47b54b748a7?raw)