Order

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developer.gett.com/schemas/order",
  "title": "Order",
  "description": "A Gett Business API ride order",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique order identifier"
    },
    "business_id": {
      "type": "string",
      "format": "uuid",
      "description": "Company UUID"
    },
    "product_id": {
      "type": "string",
      "description": "Ride product identifier"
    },
    "status": {
      "type": "string",
      "enum": [
        "Pending",
        "Reserved",
        "Routing",
        "Confirmed",
        "Waiting",
        "Driving",
        "Completed",
        "Cancelled",
        "Rejected",
        "CareReq",
        "ActiveOrder"
      ],
      "description": "Current order status in the lifecycle"
    },
    "passenger": {
      "$ref": "#/$defs/Passenger"
    },
    "pickup": {
      "$ref": "#/$defs/Location"
    },
    "dropoff": {
      "$ref": "#/$defs/Location"
    },
    "stops": {
      "type": "array",
      "description": "Intermediate stops for multi-stop rides",
      "items": {
        "$ref": "#/$defs/Location"
      }
    },
    "additional_dropoffs": {
      "type": "array",
      "description": "Additional dropoff locations for multi-dropoff rides",
      "items": {
        "$ref": "#/$defs/Location"
      }
    },
    "additional_passengers": {
      "type": "array",
      "description": "Additional passengers for multi-passenger rides",
      "items": {
        "$ref": "#/$defs/Passenger"
      }
    },
    "scheduled_at": {
      "type": "string",
      "format": "date-time",
      "description": "Scheduled pickup time for pre-booked rides"
    },
    "reference_code": {
      "type": "string",
      "description": "Business reference code for expense tracking"
    },
    "notes": {
      "type": "string",
      "description": "Special instructions for the driver"
    },
    "driver": {
      "type": "object",
      "description": "Assigned driver information",
      "properties": {
        "name": {
          "type": "string"
        },
        "phone_number": {
          "type": "string"
        },
        "vehicle": {
          "type": "object",
          "properties": {
            "make": { "type": "string" },
            "model": { "type": "string" },
            "color": { "type": "string" },
            "license_plate": { "type": "string" }
          }
        }
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": ["business_id", "product_id", "passenger", "pickup", "dropoff"],
  "$defs": {
    "Coordinates": {
      "type": "object",
      "required": ["lat", "lng"],
      "properties": {
        "lat": {
          "type": "number",
          "description": "Latitude"
        },
        "lng": {
          "type": "number",
          "description": "Longitude"
        }
      }
    },
    "Address": {
      "type": "object",
      "properties": {
        "line1": { "type": "string" },
        "line2": { "type": "string" },
        "city": { "type": "string" },
        "state": { "type": "string" },
        "postal_code": { "type": "string" },
        "country_code": {
          "type": "string",
          "description": "ISO 3166-1 alpha-2 country code"
        },
        "provider_name": {
          "type": "string",
          "description": "Address provider name (e.g., Google)"
        },
        "provider_id": {
          "type": "string",
          "description": "Provider-specific location ID for best accuracy"
        }
      }
    },
    "Location": {
      "type": "object",
      "properties": {
        "address": { "$ref": "#/$defs/Address" },
        "coordinates": { "$ref": "#/$defs/Coordinates" }
      }
    },
    "Passenger": {
      "type": "object",
      "required": ["name", "phone_number"],
      "properties": {
        "name": {
          "type": "string",
          "description": "Passenger full name"
        },
        "phone_number": {
          "type": "string",
          "description": "Passenger phone number in E.164 format"
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "Passenger email address"
        }
      }
    }
  }
}