changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "$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"
+}
