Server definition
- Hash
- sha256:8d889129e875797fd9a1dcf7e2b07aaac726a9af0b08307b692e609663b15a9d
- What it is
- What a remote MCP server returned when asked what it offers: 12 tools
The blob, as servednamed by its sha256
{
"instructions": "Ship24 shipment tracking. This connection carries no API key: tools can be listed but not called.\nTo use them, reconnect with the header \"Authorization: Bearer <Ship24 API key>\" (create a key at https://dashboard.ship24.com/integrations/api-keys).",
"tools": [
{
"description": "Creates up to 100 trackers in one request. Each tracker object accepts the same fields as create_tracker — see that tool for field details. Not fully idempotent: retrying a failed bulk request may partially create trackers. Returns counts of created, ignored (duplicate), and failed trackers plus per-item details.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"trackers": {
"description": "Array of tracker objects to create (minimum 1, maximum 100).",
"items": {
"properties": {
"clientTrackerId": {
"type": "string"
},
"courierCode": {
"description": "Courier codes for this tracker (max 3). Use get_couriers for valid codes. IMPORTANT: Check each courier's requiredFields array — any listed fields should be provided, otherwise the courier may not return any tracking data.",
"items": {
"type": "string"
},
"maxItems": 3,
"type": "array"
},
"courierName": {
"type": "string"
},
"destinationCountryCode": {
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"destinationPostCode": {
"type": "string"
},
"orderNumber": {
"type": "string"
},
"originCountryCode": {
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"settings": {
"properties": {
"restrictTrackingToCourierCode": {
"description": "When true, tracking is restricted to the specified courierCode(s) only.",
"type": "boolean"
}
},
"type": "object"
},
"shipmentReference": {
"type": "string"
},
"shippingDate": {
"type": "string"
},
"trackingNumber": {
"minLength": 1,
"type": "string"
},
"trackingUrl": {
"format": "uri",
"type": "string"
}
},
"required": [
"trackingNumber"
],
"type": "object"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
}
},
"required": [
"trackers"
],
"type": "object"
},
"name": "bulk_create_trackers",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"data": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"errors": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 error code."
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Error message."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Why this item failed. Null unless itemStatus is error."
},
"inputData": {
"description": "The submitted tracker payload, echoed back."
},
"itemStatus": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "created | existing | error."
},
"tracker": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"clientTrackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own tracker identifier, usable with searchBy=clientTrackerId."
},
"courierCode": {
"anyOf": [
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Courier code(s) pinned on this tracker."
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the tracker was created."
},
"isSubscribed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means the tracker is archived and no longer used for tracking."
},
"isTracked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means tracking stopped (delivered, inactive or unsubscribed); existing results remain."
},
"shipmentReference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own shipment reference, as supplied at creation."
},
"trackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 tracker identifier; pass this to get_tracking_results."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Tracking number this tracker follows."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "The created or existing tracker."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Per-item outcome, in submission order. Null when status is error."
},
"error": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 error code."
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Error message."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Request-level error. Null unless the whole request failed."
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "success (all created or already existing) | partial (successes and errors) | error (all failed, or a request-level error)."
},
"summary": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"totalCreated": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Number of trackers created."
},
"totalErrors": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Number of failed creations."
},
"totalExisting": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Number of inputs that matched an existing tracker."
},
"totalInputs": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Total number of trackers submitted."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Per-request counts. Null when status is error."
}
},
"type": "object"
}
},
{
"description": "Creates a new tracker for a tracking number. Use when the user explicitly wants ongoing monitoring or webhook updates; results arrive asynchronously — for immediate results use track or search_tracking. Idempotent: same parameters reuse the existing tracker; any field change creates a new one. Subscribes to webhook updates if configured. Returns the created tracker including its Ship24 trackerId.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"clientTrackerId": {
"description": "Your unique identifier for this tracker, for lookup via searchBy=clientTrackerId.",
"type": "string"
},
"courierCode": {
"description": "Courier codes for this tracker (max 3). Use get_couriers for valid codes. IMPORTANT: Check each courier's requiredFields array — any listed fields should be provided, otherwise the courier may not return any tracking data.",
"items": {
"type": "string"
},
"maxItems": 3,
"type": "array"
},
"courierName": {
"description": "Courier name (informational).",
"type": "string"
},
"destinationCountryCode": {
"description": "Destination country code (ISO alpha-2).",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"destinationPostCode": {
"description": "Destination postal/ZIP code.",
"type": "string"
},
"orderNumber": {
"description": "Associated order number.",
"type": "string"
},
"originCountryCode": {
"description": "Origin country code (ISO alpha-2, e.g. US).",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"settings": {
"properties": {
"restrictTrackingToCourierCode": {
"description": "When true, tracking is restricted to the specified courierCode(s) only.",
"type": "boolean"
}
},
"type": "object"
},
"shipmentReference": {
"description": "Internal reference for the shipment.",
"type": "string"
},
"shippingDate": {
"description": "Date the package was shipped (YYYY-MM-DD or ISO 8601).",
"type": "string"
},
"trackingNumber": {
"description": "Tracking number to monitor.",
"minLength": 1,
"type": "string"
},
"trackingUrl": {
"description": "Courier tracking URL.",
"format": "uri",
"type": "string"
}
},
"required": [
"trackingNumber"
],
"type": "object"
},
"name": "create_tracker",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"tracker": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"clientTrackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own tracker identifier, usable with searchBy=clientTrackerId."
},
"courierCode": {
"anyOf": [
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Courier code(s) pinned on this tracker."
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the tracker was created."
},
"isSubscribed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means the tracker is archived and no longer used for tracking."
},
"isTracked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means tracking stopped (delivered, inactive or unsubscribed); existing results remain."
},
"shipmentReference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own shipment reference, as supplied at creation."
},
"trackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 tracker identifier; pass this to get_tracking_results."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Tracking number this tracker follows."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "The tracker."
}
},
"required": [
"tracker"
],
"type": "object"
}
},
{
"description": "Retrieves the full webhook push history for a tracker. Returns metadata (trackingNumber, trackerId, clientTrackerId, webhookUrl, lastSuccessfulPushAt, lastFailedPushAt) and a list of all sent or failed pushes with status, pushTimestamp, requestBody, responseBody, responseHeaders, and responseStatusCode. Pending (unsent) webhooks are excluded. Results are sorted newest first. Rate-limited to 1 request/second per tracker.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"searchBy": {
"description": "How to interpret trackerId: default is Ship24 trackerId, use \"clientTrackerId\" for your own reference.",
"enum": [
"trackerId",
"clientTrackerId"
],
"type": "string"
},
"trackerId": {
"description": "Ship24 trackerId, or clientTrackerId when searchBy=\"clientTrackerId\".",
"minLength": 1,
"type": "string"
}
},
"required": [
"trackerId"
],
"type": "object"
},
"name": "download_webhook_history",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"metadata": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"clientTrackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own tracker identifier, if set."
},
"lastFailedPushAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Most recent failed delivery attempt."
},
"lastSuccessfulPushAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Most recent successful delivery."
},
"trackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 tracker identifier."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Tracking number of the shipment."
},
"webhookUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The webhook URL the pushes were delivered to."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Tracker and webhook endpoint context."
},
"webhooks": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"pushTimestamp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the delivery was attempted."
},
"requestBody": {
"description": "The payload Ship24 sent."
},
"responseBody": {
"description": "The body returned by the webhook endpoint."
},
"responseHeaders": {
"description": "The headers returned by the webhook endpoint."
},
"responseStatusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "HTTP status returned by the webhook endpoint."
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "success or failed."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Sent and failed pushes, newest first. Pending webhooks are excluded."
}
},
"required": [
"webhooks"
],
"type": "object"
}
},
{
"description": "Returns the list of all couriers supported by Ship24, including their unique courier codes, human-readable names, and any special tracking requirements. Use this tool to discover valid courierCode values before creating or updating trackers, or to help identify which courier handles a particular tracking number format. Note: this endpoint has a rate limit of 1 request/second; cache results when possible.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "get_couriers",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"couriers": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"countryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Main country the courier operates in (ISO alpha-2)."
},
"courierCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Value to pass as courierCode when creating or updating a tracker."
},
"courierName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Human-readable courier name."
},
"isDeprecated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "True when the courier code is deprecated."
},
"isPost": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "True when the courier is a national postal operator."
},
"requiredFields": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Extra tracker fields this courier needs for optimal results: destinationPostCode, destinationCountryCode, courierAccount."
},
"website": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The courier public website."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "All couriers supported by Ship24."
}
},
"required": [
"couriers"
],
"type": "object"
}
},
{
"description": "Retrieves a single tracker by trackerId (or clientTrackerId when searchBy is set). Returns tracker metadata only — use get_tracking_results for events and status.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"searchBy": {
"description": "How to interpret trackerId: default is Ship24 trackerId, use \"clientTrackerId\" for your own reference.",
"enum": [
"trackerId",
"clientTrackerId"
],
"type": "string"
},
"trackerId": {
"description": "Ship24 trackerId, or clientTrackerId when searchBy=\"clientTrackerId\".",
"minLength": 1,
"type": "string"
}
},
"required": [
"trackerId"
],
"type": "object"
},
"name": "get_tracker",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"tracker": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"clientTrackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own tracker identifier, usable with searchBy=clientTrackerId."
},
"courierCode": {
"anyOf": [
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Courier code(s) pinned on this tracker."
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the tracker was created."
},
"isSubscribed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means the tracker is archived and no longer used for tracking."
},
"isTracked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means tracking stopped (delivered, inactive or unsubscribed); existing results remain."
},
"shipmentReference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own shipment reference, as supplied at creation."
},
"trackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 tracker identifier; pass this to get_tracking_results."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Tracking number this tracker follows."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "The tracker."
}
},
"required": [
"tracker"
],
"type": "object"
}
},
{
"description": "Returns full tracking results for an existing tracker: metadata, shipment status, all events in order, and delivery statistics. Primary tool for \"where is my package?\" when you have a trackerId. statusMilestone values: pending | info_received | in_transit | out_for_delivery | failed_attempt | available_for_pickup | delivered | exception.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"searchBy": {
"description": "How to interpret trackerId: default is Ship24 trackerId, use \"clientTrackerId\" for your own reference.",
"enum": [
"trackerId",
"clientTrackerId"
],
"type": "string"
},
"trackerId": {
"description": "Ship24 trackerId, or clientTrackerId when searchBy=\"clientTrackerId\".",
"minLength": 1,
"type": "string"
}
},
"required": [
"trackerId"
],
"type": "object"
},
"name": "get_tracking_results",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"trackings": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"events": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"courierCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Courier code linked to this event; refers to the get_couriers list."
},
"datetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — use occurrenceDatetime."
},
"eventId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique identifier of this event in Ship24."
},
"eventTrackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The tracking number the event was actually found on."
},
"hasNoTime": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "DEPRECATED — true when the courier reported a date with no time."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Raw location text as reported by the courier."
},
"occurrenceDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the event occurred."
},
"order": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Tie-breaker when several events share the same occurrenceDatetime; lower comes first."
},
"sourceCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Internal code of the source this event came from. These codes may change at any time."
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Raw status text as reported by the courier."
},
"statusCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 status category for the event."
},
"statusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 normalised status code for the event."
},
"statusMilestone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Milestone at the time of the event: pending | info_received | in_transit | out_for_delivery | failed_attempt | available_for_pickup | delivered | exception."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The original tracking number used to create the tracker."
},
"utcOffset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — the offset is already carried by occurrenceDatetime."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Tracking events, most recent first."
},
"shipment": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"delivery": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"aiPredictiveDeliveryDate": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Earliest date of the window."
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Latest date of the window."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Ship24 AI-predicted window. Omitted entirely unless enabled on the account."
},
"courierEstimatedDeliveryDate": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Earliest date of the window."
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Latest date of the window."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Window promised by the courier."
},
"estimatedDeliveryDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Estimated delivery date, when the courier provides one."
},
"service": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the logistics service or product used."
},
"signedBy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — always null."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Delivery dates and service level."
},
"destinationCountryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Detected destination country (ISO alpha-2)."
},
"originCountryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Detected origin country (ISO alpha-2)."
},
"recipient": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient address."
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient city."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient name."
},
"postCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient postal code."
},
"subdivision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient state or province."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Recipient details. All fields are nulled unless the account may receive personal data."
},
"shipmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique identifier of the parcel in Ship24."
},
"statusCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 status category for the shipment."
},
"statusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 normalised status code for the shipment."
},
"statusMilestone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Current milestone; same value set as event.statusMilestone."
},
"trackingNumbers": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"tn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A tracking number linked to the shipment."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "All tracking numbers linked to the shipment."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "General shipment information and current status."
},
"statistics": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"timestamps": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"availableForPickupDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the available_for_pickup milestone."
},
"deliveredDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the delivered milestone."
},
"exceptionDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the exception milestone."
},
"failedAttemptDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the failed_attempt milestone."
},
"inTransitDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the in_transit milestone."
},
"infoReceivedDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the info_received milestone."
},
"outForDeliveryDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the out_for_delivery milestone."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "When each milestone was first reached; null for milestones never reached."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Milestone timestamps for the shipment lifecycle."
},
"tracker": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"clientTrackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own tracker identifier, usable with searchBy=clientTrackerId."
},
"courierCode": {
"anyOf": [
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Courier code(s) pinned on this tracker."
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the tracker was created."
},
"isSubscribed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means the tracker is archived and no longer used for tracking."
},
"isTracked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means tracking stopped (delivered, inactive or unsubscribed); existing results remain."
},
"shipmentReference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own shipment reference, as supplied at creation."
},
"trackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 tracker identifier; pass this to get_tracking_results."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Tracking number this tracker follows."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "The tracker this result comes from. Absent for search_tracking, which creates no tracker."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "One entry per matched tracker or shipment."
}
},
"required": [
"trackings"
],
"type": "object"
}
},
{
"description": "Returns a paginated list of all trackers. Supports offset (page/limit) or cursor-based pagination. Filter by subscription status with isSubscribed.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"description": "Results per page (max 500).",
"maximum": 500,
"minimum": 1,
"type": "integer"
},
"page": {
"description": "Page number (1-indexed).",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"sort": {
"anyOf": [
{
"const": 1,
"type": "number"
},
{
"const": -1,
"type": "number"
}
],
"description": "Sort order by createdAt. 1 = ascending (oldest first, default), -1 = descending (newest first)."
}
},
"type": "object"
},
"name": "list_trackers",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"trackers": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"clientTrackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own tracker identifier, usable with searchBy=clientTrackerId."
},
"courierCode": {
"anyOf": [
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Courier code(s) pinned on this tracker."
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the tracker was created."
},
"isSubscribed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means the tracker is archived and no longer used for tracking."
},
"isTracked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means tracking stopped (delivered, inactive or unsubscribed); existing results remain."
},
"shipmentReference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own shipment reference, as supplied at creation."
},
"trackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 tracker identifier; pass this to get_tracking_results."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Tracking number this tracker follows."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Trackers on the requested page."
}
},
"required": [
"trackers"
],
"type": "object"
}
},
{
"description": "Replays all webhook events for a tracker. Use when your endpoint missed or failed to process previous notifications. Terminates any in-flight webhook delivery for this tracker and invalidates its existing webhook payload records before regenerating and resending them — do not call repeatedly in quick succession. Rate-limited to 1 request/second per tracker.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"searchBy": {
"description": "How to interpret trackerId: default is Ship24 trackerId, use \"clientTrackerId\" for your own reference.",
"enum": [
"trackerId",
"clientTrackerId"
],
"type": "string"
},
"trackerId": {
"description": "Ship24 trackerId, or clientTrackerId when searchBy=\"clientTrackerId\".",
"minLength": 1,
"type": "string"
}
},
"required": [
"trackerId"
],
"type": "object"
},
"name": "resend_webhooks",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"summary": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"totalResent": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Number of webhook events queued for resending."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Outcome of the webhook replay."
}
},
"required": [
"summary"
],
"type": "object"
}
},
{
"description": "Default tool for one-off tracking lookups ('track X', 'where is my package'). Synchronous per-call plan endpoint: returns full results (status, events, statistics) immediately and creates NO tracker on the account. Billed per call. Requires an active per-call plan — if it fails with no_active_subscription, use the track tool instead.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"courierCode": {
"description": "Courier codes for this tracker (max 3). Use get_couriers for valid codes. IMPORTANT: Check each courier's requiredFields array — any listed fields should be provided, otherwise the courier may not return any tracking data.",
"items": {
"type": "string"
},
"maxItems": 3,
"type": "array"
},
"destinationCountryCode": {
"description": "Destination country code (ISO alpha-2).",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"destinationPostCode": {
"description": "Destination postal/ZIP code.",
"type": "string"
},
"originCountryCode": {
"description": "Origin country code (ISO alpha-2).",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"shippingDate": {
"description": "Date the package was shipped (YYYY-MM-DD or ISO 8601).",
"type": "string"
},
"trackingNumber": {
"description": "Tracking number to look up. 5-50 alphanumeric characters, hyphens, underscores, dots, or slashes.",
"maxLength": 50,
"minLength": 5,
"pattern": "^[a-zA-Z0-9\\-_/.]*$",
"type": "string"
}
},
"required": [
"trackingNumber"
],
"type": "object"
},
"name": "search_tracking",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"trackings": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"events": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"courierCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Courier code linked to this event; refers to the get_couriers list."
},
"datetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — use occurrenceDatetime."
},
"eventId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique identifier of this event in Ship24."
},
"eventTrackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The tracking number the event was actually found on."
},
"hasNoTime": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "DEPRECATED — true when the courier reported a date with no time."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Raw location text as reported by the courier."
},
"occurrenceDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the event occurred."
},
"order": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Tie-breaker when several events share the same occurrenceDatetime; lower comes first."
},
"sourceCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Internal code of the source this event came from. These codes may change at any time."
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Raw status text as reported by the courier."
},
"statusCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 status category for the event."
},
"statusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 normalised status code for the event."
},
"statusMilestone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Milestone at the time of the event: pending | info_received | in_transit | out_for_delivery | failed_attempt | available_for_pickup | delivered | exception."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The original tracking number used to create the tracker."
},
"utcOffset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — the offset is already carried by occurrenceDatetime."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Tracking events, most recent first."
},
"shipment": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"delivery": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"aiPredictiveDeliveryDate": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Earliest date of the window."
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Latest date of the window."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Ship24 AI-predicted window. Omitted entirely unless enabled on the account."
},
"courierEstimatedDeliveryDate": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Earliest date of the window."
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Latest date of the window."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Window promised by the courier."
},
"estimatedDeliveryDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Estimated delivery date, when the courier provides one."
},
"service": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the logistics service or product used."
},
"signedBy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — always null."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Delivery dates and service level."
},
"destinationCountryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Detected destination country (ISO alpha-2)."
},
"originCountryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Detected origin country (ISO alpha-2)."
},
"recipient": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient address."
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient city."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient name."
},
"postCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient postal code."
},
"subdivision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient state or province."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Recipient details. All fields are nulled unless the account may receive personal data."
},
"shipmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique identifier of the parcel in Ship24."
},
"statusCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 status category for the shipment."
},
"statusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 normalised status code for the shipment."
},
"statusMilestone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Current milestone; same value set as event.statusMilestone."
},
"trackingNumbers": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"tn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A tracking number linked to the shipment."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "All tracking numbers linked to the shipment."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "General shipment information and current status."
},
"statistics": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"timestamps": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"availableForPickupDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the available_for_pickup milestone."
},
"deliveredDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the delivered milestone."
},
"exceptionDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the exception milestone."
},
"failedAttemptDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the failed_attempt milestone."
},
"inTransitDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the in_transit milestone."
},
"infoReceivedDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the info_received milestone."
},
"outForDeliveryDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the out_for_delivery milestone."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "When each milestone was first reached; null for milestones never reached."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Milestone timestamps for the shipment lifecycle."
},
"tracker": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"clientTrackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own tracker identifier, usable with searchBy=clientTrackerId."
},
"courierCode": {
"anyOf": [
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Courier code(s) pinned on this tracker."
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the tracker was created."
},
"isSubscribed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means the tracker is archived and no longer used for tracking."
},
"isTracked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means tracking stopped (delivered, inactive or unsubscribed); existing results remain."
},
"shipmentReference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own shipment reference, as supplied at creation."
},
"trackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 tracker identifier; pass this to get_tracking_results."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Tracking number this tracker follows."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "The tracker this result comes from. Absent for search_tracking, which creates no tracker."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "One entry per matched tracker or shipment."
}
},
"required": [
"trackings"
],
"type": "object"
}
},
{
"description": "Returns existing tracking results for a raw tracking number across trackers already on the account, without needing a trackerId. Free read: never creates a tracker and never triggers a new crawl. Responds 404 tracker_not_found if no tracker exists for that number — in that case use search_tracking (per-call) or track (per-shipment). Use this first when a tracker may already exist.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"trackingNumber": {
"description": "The raw shipment tracking number to search for (e.g. 1Z999AA10123456784).",
"minLength": 1,
"type": "string"
}
},
"required": [
"trackingNumber"
],
"type": "object"
},
"name": "search_tracking_by_number",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"trackings": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"events": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"courierCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Courier code linked to this event; refers to the get_couriers list."
},
"datetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — use occurrenceDatetime."
},
"eventId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique identifier of this event in Ship24."
},
"eventTrackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The tracking number the event was actually found on."
},
"hasNoTime": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "DEPRECATED — true when the courier reported a date with no time."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Raw location text as reported by the courier."
},
"occurrenceDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the event occurred."
},
"order": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Tie-breaker when several events share the same occurrenceDatetime; lower comes first."
},
"sourceCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Internal code of the source this event came from. These codes may change at any time."
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Raw status text as reported by the courier."
},
"statusCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 status category for the event."
},
"statusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 normalised status code for the event."
},
"statusMilestone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Milestone at the time of the event: pending | info_received | in_transit | out_for_delivery | failed_attempt | available_for_pickup | delivered | exception."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The original tracking number used to create the tracker."
},
"utcOffset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — the offset is already carried by occurrenceDatetime."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Tracking events, most recent first."
},
"shipment": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"delivery": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"aiPredictiveDeliveryDate": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Earliest date of the window."
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Latest date of the window."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Ship24 AI-predicted window. Omitted entirely unless enabled on the account."
},
"courierEstimatedDeliveryDate": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Earliest date of the window."
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Latest date of the window."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Window promised by the courier."
},
"estimatedDeliveryDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Estimated delivery date, when the courier provides one."
},
"service": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the logistics service or product used."
},
"signedBy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — always null."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Delivery dates and service level."
},
"destinationCountryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Detected destination country (ISO alpha-2)."
},
"originCountryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Detected origin country (ISO alpha-2)."
},
"recipient": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient address."
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient city."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient name."
},
"postCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient postal code."
},
"subdivision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient state or province."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Recipient details. All fields are nulled unless the account may receive personal data."
},
"shipmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique identifier of the parcel in Ship24."
},
"statusCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 status category for the shipment."
},
"statusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 normalised status code for the shipment."
},
"statusMilestone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Current milestone; same value set as event.statusMilestone."
},
"trackingNumbers": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"tn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A tracking number linked to the shipment."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "All tracking numbers linked to the shipment."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "General shipment information and current status."
},
"statistics": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"timestamps": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"availableForPickupDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the available_for_pickup milestone."
},
"deliveredDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the delivered milestone."
},
"exceptionDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the exception milestone."
},
"failedAttemptDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the failed_attempt milestone."
},
"inTransitDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the in_transit milestone."
},
"infoReceivedDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the info_received milestone."
},
"outForDeliveryDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the out_for_delivery milestone."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "When each milestone was first reached; null for milestones never reached."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Milestone timestamps for the shipment lifecycle."
},
"tracker": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"clientTrackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own tracker identifier, usable with searchBy=clientTrackerId."
},
"courierCode": {
"anyOf": [
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Courier code(s) pinned on this tracker."
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the tracker was created."
},
"isSubscribed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means the tracker is archived and no longer used for tracking."
},
"isTracked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means tracking stopped (delivered, inactive or unsubscribed); existing results remain."
},
"shipmentReference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own shipment reference, as supplied at creation."
},
"trackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 tracker identifier; pass this to get_tracking_results."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Tracking number this tracker follows."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "The tracker this result comes from. Absent for search_tracking, which creates no tracker."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "One entry per matched tracker or shipment."
}
},
"required": [
"trackings"
],
"type": "object"
}
},
{
"description": "Creates a persistent tracker on the account AND returns full tracking results synchronously in one call (per-shipment plan). Idempotent: same payload reuses the existing tracker. Prefer search_tracking for one-off lookups when the per-call plan is available. If the returned shipment is still pending with no events, call get_tracking_results once with the returned trackerId before answering. Accepts the same fields as create_tracker — see that tool for field details.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"clientTrackerId": {
"type": "string"
},
"courierCode": {
"description": "Courier codes for this tracker (max 3). Use get_couriers for valid codes. IMPORTANT: Check each courier's requiredFields array — any listed fields should be provided, otherwise the courier may not return any tracking data.",
"items": {
"type": "string"
},
"maxItems": 3,
"type": "array"
},
"courierName": {
"type": "string"
},
"destinationCountryCode": {
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"destinationPostCode": {
"type": "string"
},
"orderNumber": {
"type": "string"
},
"originCountryCode": {
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"settings": {
"properties": {
"restrictTrackingToCourierCode": {
"description": "When true, tracking is restricted to the specified courierCode(s) only.",
"type": "boolean"
}
},
"type": "object"
},
"shipmentReference": {
"type": "string"
},
"shippingDate": {
"type": "string"
},
"trackingNumber": {
"minLength": 1,
"type": "string"
},
"trackingUrl": {
"format": "uri",
"type": "string"
}
},
"required": [
"trackingNumber"
],
"type": "object"
},
"name": "track",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"trackings": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"events": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"courierCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Courier code linked to this event; refers to the get_couriers list."
},
"datetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — use occurrenceDatetime."
},
"eventId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique identifier of this event in Ship24."
},
"eventTrackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The tracking number the event was actually found on."
},
"hasNoTime": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "DEPRECATED — true when the courier reported a date with no time."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Raw location text as reported by the courier."
},
"occurrenceDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the event occurred."
},
"order": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Tie-breaker when several events share the same occurrenceDatetime; lower comes first."
},
"sourceCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Internal code of the source this event came from. These codes may change at any time."
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Raw status text as reported by the courier."
},
"statusCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 status category for the event."
},
"statusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 normalised status code for the event."
},
"statusMilestone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Milestone at the time of the event: pending | info_received | in_transit | out_for_delivery | failed_attempt | available_for_pickup | delivered | exception."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The original tracking number used to create the tracker."
},
"utcOffset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — the offset is already carried by occurrenceDatetime."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Tracking events, most recent first."
},
"shipment": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"delivery": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"aiPredictiveDeliveryDate": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Earliest date of the window."
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Latest date of the window."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Ship24 AI-predicted window. Omitted entirely unless enabled on the account."
},
"courierEstimatedDeliveryDate": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Earliest date of the window."
},
"to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Latest date of the window."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Window promised by the courier."
},
"estimatedDeliveryDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Estimated delivery date, when the courier provides one."
},
"service": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Name of the logistics service or product used."
},
"signedBy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "DEPRECATED — always null."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Delivery dates and service level."
},
"destinationCountryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Detected destination country (ISO alpha-2)."
},
"originCountryCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Detected origin country (ISO alpha-2)."
},
"recipient": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient address."
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient city."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient name."
},
"postCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient postal code."
},
"subdivision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Recipient state or province."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Recipient details. All fields are nulled unless the account may receive personal data."
},
"shipmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique identifier of the parcel in Ship24."
},
"statusCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 status category for the shipment."
},
"statusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 normalised status code for the shipment."
},
"statusMilestone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Current milestone; same value set as event.statusMilestone."
},
"trackingNumbers": {
"anyOf": [
{
"items": {
"additionalProperties": {},
"properties": {
"tn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "A tracking number linked to the shipment."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "All tracking numbers linked to the shipment."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "General shipment information and current status."
},
"statistics": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"timestamps": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"availableForPickupDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the available_for_pickup milestone."
},
"deliveredDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the delivered milestone."
},
"exceptionDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the exception milestone."
},
"failedAttemptDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the failed_attempt milestone."
},
"inTransitDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the in_transit milestone."
},
"infoReceivedDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the info_received milestone."
},
"outForDeliveryDatetime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "First occurrence of the out_for_delivery milestone."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "When each milestone was first reached; null for milestones never reached."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Milestone timestamps for the shipment lifecycle."
},
"tracker": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"clientTrackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own tracker identifier, usable with searchBy=clientTrackerId."
},
"courierCode": {
"anyOf": [
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Courier code(s) pinned on this tracker."
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the tracker was created."
},
"isSubscribed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means the tracker is archived and no longer used for tracking."
},
"isTracked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means tracking stopped (delivered, inactive or unsubscribed); existing results remain."
},
"shipmentReference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own shipment reference, as supplied at creation."
},
"trackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 tracker identifier; pass this to get_tracking_results."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Tracking number this tracker follows."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "The tracker this result comes from. Absent for search_tracking, which creates no tracker."
}
},
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "One entry per matched tracker or shipment."
}
},
"required": [
"trackings"
],
"type": "object"
}
},
{
"description": "Partially updates a tracker (PATCH). Only provided fields are changed. Common uses: toggling isSubscribed, correcting destination details, or setting a clientTrackerId.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"courierCode": {
"description": "Courier codes for this tracker (max 3). Use get_couriers for valid codes. IMPORTANT: Check each courier's requiredFields array — any listed fields should be provided, otherwise the courier may not return any tracking data.",
"items": {
"type": "string"
},
"maxItems": 3,
"type": "array"
},
"destinationCountryCode": {
"description": "Destination country code (ISO alpha-2). Immutable once tracking data exists.",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"destinationPostCode": {
"type": "string"
},
"isSubscribed": {
"description": "true to subscribe to webhooks, false to unsubscribe.",
"type": "boolean"
},
"originCountryCode": {
"description": "Origin country code (ISO alpha-2). Immutable once tracking data exists.",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"searchBy": {
"description": "How to interpret trackerId: default is Ship24 trackerId, use \"clientTrackerId\" for your own reference.",
"enum": [
"trackerId",
"clientTrackerId"
],
"type": "string"
},
"settings": {
"properties": {
"restrictTrackingToCourierCode": {
"description": "When true, tracking is restricted to the specified courierCode(s) only.",
"type": "boolean"
}
},
"type": "object"
},
"shippingDate": {
"description": "Ship date (YYYY-MM-DD or ISO 8601). Immutable once tracking data exists.",
"type": "string"
},
"trackerId": {
"description": "The tracker to update (Ship24 trackerId or clientTrackerId).",
"minLength": 1,
"type": "string"
}
},
"required": [
"trackerId"
],
"type": "object"
},
"name": "update_tracker",
"outputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": {},
"properties": {
"tracker": {
"anyOf": [
{
"additionalProperties": {},
"properties": {
"clientTrackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own tracker identifier, usable with searchBy=clientTrackerId."
},
"courierCode": {
"anyOf": [
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Courier code(s) pinned on this tracker."
},
"createdAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "When the tracker was created."
},
"isSubscribed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means the tracker is archived and no longer used for tracking."
},
"isTracked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "False means tracking stopped (delivered, inactive or unsubscribed); existing results remain."
},
"shipmentReference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Your own shipment reference, as supplied at creation."
},
"trackerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Ship24 tracker identifier; pass this to get_tracking_results."
},
"trackingNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Tracking number this tracker follows."
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "The tracker."
}
},
"required": [
"tracker"
],
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:8d889129e875797fd9a1dcf7e2b07aaac726a9af0b08307b692e609663b15a9d | sha256sum