Raw schema
{
"type": "object",
"properties": {
"stop_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The stop to update."
},
"address": {
"description": "New street address (re-geocoded).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"route_id": {
"description": "Move the stop to this route.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"city": {
"description": "City (only used when no address is passed).",
"type": "string",
"maxLength": 200
},
"state": {
"description": "State or region (only used when no address is passed).",
"type": "string",
"maxLength": 200
},
"zipcode": {
"description": "Postal code (only used when no address is passed).",
"type": "string",
"maxLength": 40
},
"contact_name": {
"description": "Contact (recipient) name.",
"type": "string",
"maxLength": 200
},
"phone": {
"description": "Contact phone number; non-digits are stripped by Upper.",
"type": "string",
"maxLength": 40
},
"phone_country_code": {
"description": "Phone dialing code, for example 1.",
"type": "string",
"pattern": "^\\d{1,4}$"
},
"email": {
"description": "Contact email.",
"type": "string",
"maxLength": 254
},
"note": {
"description": "Free-text note shown to the driver.",
"type": "string",
"maxLength": 2000
},
"company_name": {
"description": "Company name for the stop.",
"type": "string",
"maxLength": 200
},
"nick_name": {
"description": "Short label for the stop.",
"type": "string",
"maxLength": 100
},
"pin_color": {
"description": "Map pin colour, hex like #FF6600.",
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"start_time": {
"description": "Earliest service time (time window start), HH:MM or HH:MM:SS.",
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$"
},
"end_time": {
"description": "Latest service time (time window end), HH:MM or HH:MM:SS.",
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$"
},
"stop_duration": {
"description": "Service duration at the stop, in seconds.",
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"stop_type": {
"description": "Stop type, for example Delivery or Pickup.",
"type": "string",
"maxLength": 50
},
"stop_priority": {
"description": "Stop priority, for example Normal, High, Urgent.",
"type": "string",
"maxLength": 50
},
"parcel_count": {
"description": "Number of parcels at the stop.",
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"customer_system_id": {
"description": "Your own identifier for the stop (for cross-referencing).",
"type": "string",
"maxLength": 200
},
"custom_fields": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"description": "Custom field values keyed by slot (custom1 - custom5). Only fields enabled in the workspace (and in the plan) are stored."
},
"capacity_fields": {
"type": "object",
"properties": {
"capacity1": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"capacity2": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"capacity3": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"capacity4": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"capacity5": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"description": "Capacity values (integers) for load planning, keys capacity1 - capacity5."
}
},
"required": [
"stop_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}