Create Tracker
create_trackerCreates 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| settings | No | ||
| courierCode | No | 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. | |
| courierName | No | Courier name (informational). | |
| orderNumber | No | Associated order number. | |
| trackingUrl | No | Courier tracking URL. | |
| shippingDate | No | Date the package was shipped (YYYY-MM-DD or ISO 8601). | |
| trackingNumber | Yes | Tracking number to monitor. | |
| clientTrackerId | No | Your unique identifier for this tracker, for lookup via searchBy=clientTrackerId. | |
| originCountryCode | No | Origin country code (ISO alpha-2, e.g. US). | |
| shipmentReference | No | Internal reference for the shipment. | |
| destinationPostCode | No | Destination postal/ZIP code. | |
| destinationCountryCode | No | Destination country code (ISO alpha-2). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tracker | Yes | The tracker. |