AfterShip Tracking API

Shipment tracking across 1,400+ carriers: create and query trackings, detect couriers, manage courier connections, and predict estimated delivery dates.

Operations 7

GET /trackings Get trackings #
POST /trackings Create a tracking #
GET /trackings/{id} Get a tracking by ID #
PUT /trackings/{id} Update a tracking by ID #
DELETE /trackings/{id} Delete a tracking by ID #
POST /trackings/{id}/retrack Retrack an expired tracking by ID #
POST /trackings/{id}/mark-as-completed Mark tracking as completed by ID #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/aftership-tracking-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aftership-tracking-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Overview Tracking API
  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%252F2026-07&deref=optimizedBundle)

    <div style="visibility:hidden; height: 0">[url](../../docs/quickstart/authentication.md)</div>'
  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/2026-07
  description: API Endpoint
security:
- as-api-key: []
tags:
- name: Tracking
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:
                      pagination:
                        total: 2
                        next_cursor: WzE3MTk5OTIwMzIzNTMsImE0NWQ5NDg5ODU4NzQzMjA5YjBjYjRlZjE3ZTBjNGVhIl0=
                        has_next_page: true
                      trackings:
                      - id: 0b02015fc7fd4f3c8d5490cece4d124d
                        legacy_id: my2uktymyz72xld1f7l3h01z
                        created_at: '2023-01-18T08:47:10+00:00'
                        updated_at: '2023-01-18T17:47:10+00:00'
                        tracking_number: '61293150000079650811'
                        slug: fedex
                        active: false
                        custom_fields:
                          store_name: my-store
                        transit_time: 9
                        origin_country_region: 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_region: 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_region: USA
                        courier_estimated_delivery_date:
                          estimated_delivery_date: '2022-01-03T12:11:11+01:00'
                          estimated_delivery_date_min: '2022-01-02T12:11:10+01:00'
                          estimated_delivery_date_max: '2022-01-03T12: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
                        customers:
                        - role: sender
                          name: Steve Young
                          phone_number: '+8613800138000'
                          email: example@aftership.com
                          language: en
                          id: cust_12345
                        source: api
                        tag: Delivered
                        subtag: Delivered_002
                        subtag_message: Picked up by customer
                        title: '61293150000079650811'
                        tracked_count: 13
                        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
                          postal_code: '10011'
                          coordinate: null
                          country_region: USA
                          country_region_name: United States
                          message: Package delivered
                          tag: Delivered
                          subtag: Delivered_002
                          subtag_message: Picked up by customer
                          raw_tag: RO
                          events:
                          - code: delivered_to_neighbor
                            reason:
                              code: incorrect_missing_address
                          source: carrier
                          hash: a1b2c3d4e5f6789012345678901234567890abcd
                        subscribed_smses:
                        - string
                        subscribed_emails:
                        - string
                        return_to_sender: false
                        order_promised_delivery_date:
                          promised_delivery_date: '2026-01-01'
                          promised_delivery_date_max: null
                          promised_delivery_date_min: null
                        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
                          revise_reason: extreme_weather
                        shipment_tags:
                        - Returned
                        courier_connection_id: 8e1261bde336436abbc7cb3eee8cd707
                        last_mile:
                          slug: usps
                          tracking_number: '61293150000079650811'
                          source: system
                          courier_tracking_link: https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US
                          courier_redirect_link: https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US
                        first_mile:
                          slug: usps
                          tracking_number: '61293150000079650812'
                          courier_tracking_link: https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650812&cntry_code=US
                          courier_redirect_link: https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650812&cntry_code=US
                        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
                        aftership_tracking_url: https://track.happytrading.com/61293150000079650811
                        aftership_tracking_order_url: https://track.happytrading.com/order-status?order-number=1001&code=eyJlbWFpbCI6InRlc3RAZXhhbXBsZS5jb20ifQ==
                        shipment_dimensions:
                          unit: cm
                          length: 30
                          width: 20
                          height: 10
                        proof_of_delivery:
                        - type: image
                          url: https://example.com/pod-image.jpg
                        multi_piece_info:
                          type: master
                          pieces:
                          - tracking_id: bff5a3bac79b472991a204172473a635
                            tracking_number: '61293150000079650811'
                            type: master
                            trackable: true
                          - tracking_id: c79b472991a204172473a635bff5a3ba
                            tracking_number: '61293150000079650812'
                            type: child
                            trackable: true
                        shipment_direction: forward
                        return_shipment:
                          id: a204172473a635bff5a3bac79b472991
                          tracking_number: '61293150000079650813'
                          slug: usps
                        forward_shipment: null
      operationId: get-trackings
      description: 'Get tracking results of multiple trackings.


        <div style="visibility:hidden; height: 0">[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)

        </div>'
      parameters:
      - schema:
          type: string
          enum:
          - application/json
          example: application/json
          default: application/json
        in: header
        name: Content-Type
        description: 'Content-Type

          '
        required: true
      - schema:
          type: string
          minimum: 1
          example: WzE3MTk5OTIwMzIzNTMsImE0NWQ5NDg5ODU4NzQzMjA5YjBjYjRlZjE3ZTBjNGVhIl0=
        in: query
        name: cursor
        description: A string representing the cursor value for the current page of results.
      - 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`, `customers[x].name`, `custom_fields`, `customers[x].email`, `customers[x].phone_number`'
      - 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.


          - When the shipment is delivered: Transit time = Delivered date - Picked up date

          - When the shipment is not delivered: Transit time = Current date - Picked up date


          Value 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).(Defaults: 120 days ago, Example: The escaped value of 2013-03-15T16:41:56+08:00 is 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).(Defaults: now, Example: The escaped value of 2013-04-15T16:41:56+08:00 is 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: The escaped value of 2013-03-15T16:41:56+08:00 is 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: 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: The escaped value of 2013-04-15T16:41:56+08:00 is 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_region
        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: 0b02015fc7fd4f3c8d5490cece4d124d
                      legacy_id: my2uktymyz72xld1f7l3h01z
                      created_at: '2023-01-18T08:47:10+00:00'
                      updated_at: '2023-01-18T17:47:10+00:00'
                      tracking_number: '61293150000079650811'
                      slug: fedex
                      active: false
                      custom_fields:
                        store_name: my-store
                      transit_time: 9
                      origin_country_region: 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_region: 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_region: USA
                      courier_estimated_delivery_date:
                        estimated_delivery_date: '2022-01-03T12:11:11+01:00'
                        estimated_delivery_date_min: '2022-01-02T12:11:10+01:00'
                        estimated_delivery_date_max: '2022-01-03T12: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
                      customers:
                      - role: sender
                        name: Steve Young
                        phone_number: '+8613800138000'
                        email: example@aftership.com
                        language: en
                        id: cust_12345
                      source: api
                      tag: Delivered
                      subtag: Delivered_002
                      subtag_message: Picked up by customer
                      title: '61293150000079650811'
                      tracked_count: 13
                      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
                        postal_code: '10011'
                        coordinate: null
                        country_region: USA
                        country_region_name: United States
                        message: Package delivered
                        tag: Delivered
                        subtag: Delivered_002
                        subtag_message: Picked up by customer
                        raw_tag: RO
                        events:
                        - code: delivered_to_neighbor
                          reason:
                            code: incorrect_missing_address
                        source: carrier
                        hash: a1b2c3d4e5f6789012345678901234567890abcd
                      subscribed_smses:
                      - string
                      subscribed_emails:
                      - string
                      return_to_sender: false
                      order_promised_delivery_date:
                        promised_delivery_date: '2026-01-01'
                        promised_delivery_date_max: null
                        promised_delivery_date_min: null
                      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: null
                      shipment_tags:
                      - Returned
                      courier_connection_id: 8e1261bde336436abbc7cb3eee8cd707
                      last_mile:
                        slug: usps
                        tracking_number: '61293150000079650811'
                        source: system
                        courier_tracking_link: https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650811&cntry_code=US
                        courier_redirect_link: https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650811&cntry_code=US
                      first_mile:
                        slug: usps
                        tracking_number: '61293150000079650812'
                        courier_tracking_link: https://www.fedex.com/apps/fedextrack/?tracknumbers=61293150000079650812&cntry_code=US
                        courier_redirect_link: https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=61293150000079650812&cntry_code=US
                      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
                      aftership_tracking_url: https://track.happytrading.com/61293150000079650811
                      aftership_tracking_order_url: https://track.happytrading.com/order-status?order-number=1001&code=eyJlbWFpbCI6InRlc3RAZXhhbXBsZS5jb20ifQ==
                      shipment_dimensions:
                        unit: cm
                        length: 30
                        width: 20
                        height: 10
                      proof_of_delivery:
                      - type: image
                        url: https://example.com/pod-image.jpg
                      multi_piece_info:
                        type: master
                        pieces:
                        - tracking_id: bff5a3bac79b472991a204172473a635
                          tracking_number: '61293150000079650811'
                          type: master
                          trackable: true
                        - tracking_id: c79b472991a204172473a635bff5a3ba
                          tracking_number: '61293150000079650812'
                          type: child
                          trackable: true
                      shipment_direction: forward
                      return_shipment:
                        id: a204172473a635bff5a3bac79b472991
                        tracking_number: '61293150000079650813'
                        slug: usps
                      forward_shipment: null
      description: 'Create a tracking.


        <div style="visibility:hidden; height: 0">[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)</div>'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - tracking_number
              properties:
                id:
                  type: string
                  x-stoplight:
                    id: 7t9fy06v5ekg7
                  description: Tracking ID that is system-generated by default and can be customized by the user when creating a tracking.
                  example: bff5a3bac79b472991a204172473a635
                  pattern: '[0-9a-zA-Z-_]{1,128}'
                tracking_number:
                  type: string
                  minLength: 1
                  description: 'Tracking number of a shipment.


                    Duplicated tracking numbers, tracking numbers with invalid tracking number format will not be accepted.


                    We only accept tracking numbers with length from 4 to 100


                    We currently support the following characters in a tracking number:


                    - A - Z

                    - 0 - 9

                    - `-` (Hyphen)

                    - . (Period)

                    - _ (Underscore)

                    - / (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.
                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.


                    - Maximum charater limit for a key name: 30

                    - Max

# --- truncated at 32 KB (178 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aftership/refs/heads/main/openapi/aftership-tracking-api-openapi.yml