Schema
Delivery Route
Represents the route between an outlet and a destination.
Overview
Properties
destination
reference
Required
The intended destination. The address `coordinates` must be supplied.
References Address.
estimated_travel_time_in_minutes
integer
Required
The time (in minutes) to travel between the outlet and the destination.
Minimum
1
estimated_travel_distance_in_meters
integer
Required
The distance (in meters) between the outlet and the destination.
Minimum
1
Used by
Raw YAML
Download source
title: Delivery Route
type: object
x-tags:
- Foundation
description: Represents the route between an outlet and a destination.
required:
- destination
- estimated_travel_time_in_minutes
- estimated_travel_distance_in_meters
properties:
destination:
$ref: ./Address.yaml
description: |-
The intended destination.
The address `coordinates` must be supplied.
estimated_travel_time_in_minutes:
type: integer
minimum: 1
description: The time (in minutes) to travel between the outlet and the destination.
estimated_travel_distance_in_meters:
type: integer
minimum: 1
description: The distance (in meters) between the outlet and the destination.