Tracking response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aftership/main/json-schema/aftership-tracking-response-v1-schema.json",
  "title": "Tracking response",
  "description": "Tracking response for returning single tracking",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/aftership-tracking-api-openapi.yml#/components/schemas/Tracking_response.v1",
  "type": "object",
  "required": [
    "meta",
    "data"
  ],
  "properties": {
    "meta": {
      "$ref": "#/$defs/Meta.v1"
    },
    "data": {
      "$ref": "#/$defs/Tracking"
    }
  },
  "$defs": {
    "Checkpoint": {
      "x-stoplight": {
        "id": "ag7g0fudz5euk"
      },
      "title": "Checkpoint",
      "type": "object",
      "description": "Object describes checkpoint information.\n\n<div style=\"visibility:hidden; height: 0\">[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)</div>",
      "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.",
          "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)",
          "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",
          "x-stoplight": {
            "id": "9awzp75k9febs"
          }
        },
        "location": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "description": "Location info provided by carrier",
          "x-stoplight": {
            "id": "u93y11ihmeov8"
          }
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "description": "City info provided by carrier",
          "x-stoplight": {
            "id": "fabvm8mmikdej"
          }
        },
        "state": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "description": "State info provided by carrier",
          "x-stoplight": {
            "id": "1v0inuoj4e74y"
          }
        },
        "postal_code": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "description": "Postal code info provided by carrier",
          "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.",
          "x-stoplight": {
            "id": "zum7wa9pis108"
          },
          "properties": {
            "latitude": {
              "type": "number",
              "x-stoplight": {
                "id": "g76n61cbre4zl"
              },
              "description": "Represents the latitude.",
              "readOnly": true
            },
            "longitude": {
              "type": "number",
              "x-stoplight": {
                "id": "snidkwtd2epur"
              },
              "description": "Represents the longitude.",
              "readOnly": true
            }
          }
        },
        "country_region": {
          "type": [
            "string",
            "null"
          ],
          "description": "Country/Region ISO Alpha-3 (three letters) of the checkpoint",
          "x-stoplight": {
            "id": "j5fqociyv0ljk"
          }
        },
        "country_region_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Country/Region name of the checkpoint, may also contain other location info.",
          "x-stoplight": {
            "id": "gsg0p1qckju58"
          }
        },
        "message": {
          "type": "string",
          "minLength": 1,
          "description": "Checkpoint message",
          "x-stoplight": {
            "id": "cznxhuyp14g5q"
          }
        },
        "tag": {
          "$ref": "#/$defs/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))",
          "x-stoplight": {
            "id": "7w23827daymn0"
          }
        },
        "subtag_message": {
          "type": "string",
          "minLength": 1,
          "description": "Normalized checkpoint message. ([See subtag message definition](../../docs/enum/delivery_sub_statuses.md))",
          "x-stoplight": {
            "id": "gtmk5cuw7wtwb"
          }
        },
        "raw_tag": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "description": "Checkpoint raw status provided by courier",
          "x-stoplight": {
            "id": "9hl14tav56q2k"
          }
        },
        "events": {
          "type": "array",
          "x-stoplight": {
            "id": "yaarhzzr9lwlb"
          },
          "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) <span style=background-color:#ff6b2b;color:white;padding:2px>(Beta Feature)</span>\n- The events' value for the same checkpoint message is subject to change as we consistently strive to enhance the performance of this feature.",
          "items": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "x-stoplight": {
                  "id": "ga8y1l7lzhe0n"
                },
                "description": "Represents the event code."
              },
              "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. "
                  }
                }
              }
            }
          }
        },
        "source": {
          "x-stoplight": {
            "id": "2tkhtf7zk4pwk"
          },
          "description": "The source of the checkpoint, which can either be from the carrier or when the user marks the tracking as completed.",
          "enum": [
            "carrier",
            "user"
          ]
        },
        "hash": {
          "type": "string",
          "x-stoplight": {
            "id": "bu7ulg24vi728"
          },
          "description": "Unique hash identifier for each checkpoint event, could be used for deduplication.",
          "readOnly": true
        }
      }
    },
    "Meta.v1": {
      "title": "meta",
      "type": "object",
      "description": "Meta data",
      "required": [
        "code"
      ],
      "properties": {
        "code": {
          "type": "integer",
          "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"
        }
      }
    },
    "Tag.v1": {
      "x-stoplight": {
        "id": "zcw4ttoz76bsj"
      },
      "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))<div style=\"visibility:hidden; height: 0\">[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)</div>"
    },
    "Tracking": {
      "description": "Object describes the tracking information.\n\n<div style=\"visibility:hidden; height: 0\">[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/edd_revise_reasons.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)</div>",
      "x-stoplight": {
        "id": "85e38d6ce6521"
      },
      "type": "object",
      "title": "Tracking",
      "x-tags": [
        "Resource"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "A  system-generated tracking ID by default, which can be customized by the user when creating a tracking.\n",
          "x-stoplight": {
            "id": "cxja2lu8zfupm"
          },
          "pattern": "[0-9a-zA-Z-_]{1,128}"
        },
        "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."
        },
        "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.",
          "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.",
          "x-stoplight": {
            "id": "mdtq9vt7cln4z"
          }
        },
        "tracking_number": {
          "type": "string",
          "minLength": 1,
          "description": "Tracking number.",
          "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).",
          "x-stoplight": {
            "id": "5k6b1k0td71d2"
          }
        },
        "active": {
          "type": "boolean",
          "description": "Whether or not AfterShip will continue tracking the shipment. Value is false when no further updates for a few days since last update.",
          "x-stoplight": {
            "id": "zlxzpdlsudlup"
          }
        },
        "custom_fields": {
          "type": [
            "object",
            "null"
          ],
          "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.",
          "x-stoplight": {
            "id": "hc8c5xstqkevs"
          },
          "additionalProperties": {
            "type": "string",
            "x-stoplight": {
              "id": "ivboi1s75tc09"
            }
          }
        },
        "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.",
          "x-stoplight": {
            "id": "3edc9tvm5xice"
          }
        },
        "origin_country_region": {
          "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.",
          "x-stoplight": {
            "id": "lg4bgkpqich9d"
          }
        },
        "origin_state": {
          "type": [
            "string",
            "null"
          ],
          "description": "The state of the sender’s address.",
          "x-stoplight": {
            "id": "gfszuw9f9bsb1"
          }
        },
        "origin_city": {
          "type": [
            "string",
            "null"
          ],
          "description": "The city of the sender’s address.",
          "x-stoplight": {
            "id": "47c70cejlgh6k"
          }
        },
        "origin_postal_code": {
          "type": [
            "string",
            "null"
          ],
          "description": "The postal code of the sender’s address.",
          "x-stoplight": {
            "id": "tifkzldeihitn"
          }
        },
        "origin_raw_location": {
          "type": [
            "string",
            "null"
          ],
          "description": "The sender address that the shipment is shipping from.",
          "x-stoplight": {
            "id": "aaptwiqo10vwv"
          }
        },
        "destination_country_region": {
          "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.",
          "x-stoplight": {
            "id": "w36bba5uszpu5"
          }
        },
        "destination_state": {
          "type": [
            "string",
            "null"
          ],
          "description": "The state of the recipient’s address.",
          "x-stoplight": {
            "id": "pgb8c9dqxvpxm"
          }
        },
        "destination_city": {
          "type": [
            "string",
            "null"
          ],
          "description": "The city of the recipient’s address.",
          "x-stoplight": {
            "id": "1vq30jhzrh2jq"
          }
        },
        "destination_postal_code": {
          "type": [
            "string",
            "null"
          ],
          "description": "The postal code of the recipient’s address.",
          "x-stoplight": {
            "id": "erlb4rvw3in9k"
          }
        },
        "destination_raw_location": {
          "type": [
            "string",
            "null"
          ],
          "description": "The shipping address that the shipment is shipping to.",
          "x-stoplight": {
            "id": "w50z2discs59u"
          }
        },
        "courier_destination_country_region": {
          "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.",
          "x-stoplight": {
            "id": "lqezfz5kkst9u"
          }
        },
        "courier_estimated_delivery_date": {
          "description": "The field contains the estimated delivery date provided by the carrier.",
          "x-stoplight": {
            "id": "kg1to2qu44j2a"
          },
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "estimated_delivery_date": {
              "type": [
                "string",
                "null"
              ],
              "x-stoplight": {
                "id": "mpmyano2sxclg"
              },
              "description": "The estimated arrival date of the shipment. It reflects the shipment recipient’s timezone and the format may vary based on how the carrier provides it:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ"
            },
            "estimated_delivery_date_min": {
              "type": [
                "string",
                "null"
              ],
              "x-stoplight": {
                "id": "9r41arlc85sjm"
              },
              "description": "The earliest estimated delivery date of the shipment. It reflects the shipment recipient’s timezone and the format may vary based on how the carrier provides it:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ"
            },
            "estimated_delivery_date_max": {
              "type": [
                "string",
                "null"
              ],
              "x-stoplight": {
                "id": "qy1qm46vuapor"
              },
              "description": "The Latest estimated delivery date of the shipment. It reflects the shipment recipient’s timezone and the format may vary based on how the carrier provides it:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ"
            }
          }
        },
        "note": {
          "type": [
            "string",
            "null"
          ],
          "description": "Text field for the note.",
          "x-stoplight": {
            "id": "p6jf151eq3tph"
          }
        },
        "order_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "A globally-unique identifier for the order.",
          "x-stoplight": {
            "id": "8dmmcvb0udi7g"
          }
        },
        "order_id_path": {
          "type": [
            "string",
            "null"
          ],
          "description": "The URL for the order in your system or store.",
          "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.",
          "x-stoplight": {
            "id": "idtthxq18dkxq"
          }
        },
        "shipment_package_count": {
          "type": [
            "number",
            "null"
          ],
          "description": "Number of packages under the tracking.",
          "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",
          "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",
          "x-stoplight": {
            "id": "pq7hqb96dq6gz"
          }
        },
        "shipment_type": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "description": "The carrier service type for the shipment.",
          "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."
            },
            "value": {
              "type": "number",
              "x-stoplight": {
                "id": "m2r4qiavxyf6c"
              },
              "description": "The total amount of shipment weight."
            }
          }
        },
        "shipment_dimensions": {
          "type": [
            "object",
            "null"
          ],
          "x-stoplight": {
            "id": "4si68jb6q1h2j"
          },
          "description": "Physical dimensions of the package (length, width and height).",
          "readOnly": true,
          "properties": {
            "unit": {
              "type": "string",
              "x-stoplight": {
                "id": "40nwrbtlde4wf"
              },
              "description": "The unit in which the dimension values are expressed. Allowed values: cm, in"
            },
            "length": {
              "type": "number",
              "x-stoplight": {
                "id": "533abytqbg9ap"
              },
              "description": "The length of the shipment package."
            },
            "width": {
              "type": "number",
              "x-stoplight": {
                "id": "fw6ajmp7diqj5"
              },
              "description": "The width of the shipment package."
            },
            "height": {
              "type": "number",
              "x-stoplight": {
                "id": "u68r7q0tdn13y"
              },
              "description": "The height of the shipment package."
            }
          }
        },
        "signed_by": {
          "type": [
            "string",
            "null"
          ],
          "description": "Signed by information for delivered shipment.",
          "x-stoplight": {
            "id": "ou55pbuyi9c8s"
          }
        },
        "source": {
          "type": "string",
          "minLength": 1,
          "description": "Source of how this tracking is added.",
          "x-stoplight": {
            "id": "gqhhejuq7enqw"
          }
        },
        "tag": {
          "$ref": "#/$defs/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))",
          "x-stoplight": {
            "id": "ues79yoiwdb9c"
          }
        },
        "subtag_message": {
          "type": "string",
          "minLength": 1,
          "description": "Normalized tracking message. ([See subtag definition](../../docs/enum/delivery_sub_statuses.md))",
          "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).",
          "x-stoplight": {
            "id": "7hrsb1c469748"
          }
        },
        "tracked_count": {
          "type": "number",
          "description": "Number of attempts AfterShip tracks at courier's system.",
          "x-stoplight": {
            "id": "kiavnm2cxtem7"
          }
        },
        "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"
          ],
          "x-stoplight": {
            "id": "101i7f37z5gae"
          }
        },
        "unique_token": {
          "type": "string",
          "minLength": 1,
          "deprecated": true,
          "description": "Deprecated",
          "x-stoplight": {
            "id": "pfwgk0hm16h0o"
          }
        },
        "checkpoints": {
          "type": "array",
          "description": "Array of checkpoint object describes the checkpoint information.",
          "x-stoplight": {
            "id": "fls5bqyjffakv"
          },
          "items": {
            "$ref": "#/$defs/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`.",
          "x-stoplight": {
            "id": "dc058629cok6i"
          }
        },
        "order_promised_delivery_date": {
          "type": [
            "object",
            "null"
          ],
          "description": "The promised delivery date of the order in shipment recipient’s timezone.",
          "x-stoplight": {
            "id": "mcalgi7v11ckk"
          },
          "properties": {
            "promised_delivery_date": {
              "type": [
                "string",
                "null"
              ],
              "x-stoplight": {
                "id": "8znaiva1jye3g"
              },
              "description": "The promised delivery date of the order. \nIt uses the formats:\n- YYYY-MM-DD\n- YYYY-MM-DDTHH:mm:ss\n- YYYY-MM-DDTHH:mm:ssZ"
            },
            "promised_delivery_date_min": {
              "type": [
                "string",
                "null"
              ],
              "x-stoplight": {
                "id": "zrgm5kz68crqs"
              },
              "descript

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aftership/refs/heads/main/json-schema/aftership-tracking-response-v1-schema.json