17TRACK · Schema

ChangeInfoRequest

Request body item for updating metadata on a tracked shipment.

ShippingPackage TrackingLogisticsCarriersDeliveryWebhooks

Properties

Name Type Description
number string Tracking number
tag string Custom tag or order reference for the tracking number
View JSON Schema on GitHub

JSON Schema

ChangeInfoRequest.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.17track.net/track/v1/schemas/ChangeInfoRequest",
  "title": "ChangeInfoRequest",
  "description": "Request body item for updating metadata on a tracked shipment.",
  "type": "object",
  "required": ["number"],
  "properties": {
    "number": {
      "type": "string",
      "minLength": 5,
      "maxLength": 50,
      "description": "Tracking number",
      "example": "1Z999AA10123456784"
    },
    "tag": {
      "type": "string",
      "description": "Custom tag or order reference for the tracking number",
      "example": "ORDER-12345"
    }
  },
  "additionalProperties": false
}