YQueue DocsDevelopers

Schema

Delivery Area Configuration

Represents the delivery area permitted for an associated outlet.

  • Services

Overview

object · 3 properties · 0 required

Properties

maximum_delivery_area_in_metres

integer | null

The maximum permitted distance from the outlet's location that a delivery order will be permitted.

Minimum 1
Maximum 40075017
Nullable Yes

maximum_drive_time_in_minutes

integer | null

The maximum permitted (estimated) drive time from the outlet's location that a delivery order will be permitted.

Minimum 1
Maximum 45000
Nullable Yes

accepted_postal_codes

array

The postal codes that the outlet will accept a delivery order for.

Unique items Yes
Array items

Items

string
Example 238875
Pattern ^\d+\*?$
Min length 1
Max length 255

Used by

Raw YAML
Download source
title: Delivery Area Configuration
x-tags:
  - Services
type: object
description: Represents the delivery area permitted for an associated outlet.
properties:
  maximum_delivery_area_in_metres:
    type:
      - integer
      - 'null'
    minimum: 1
    maximum: 40075017
    description: The maximum permitted distance from the outlet's location that a delivery order will be permitted.
  maximum_drive_time_in_minutes:
    type:
      - integer
      - 'null'
    minimum: 1
    maximum: 45000
    description: The maximum permitted (estimated) drive time from the outlet's location that a delivery order will be permitted.
  accepted_postal_codes:
    type: array
    uniqueItems: true
    description: The postal codes that the outlet will accept a delivery order for.
    items:
      type: string
      minLength: 1
      maxLength: 255
      pattern: ^\d+\*?$
      example: '238875'

Search documentation

Search across this documentation site.