Skip to main content

Location object

AttributesDescription

id
string

Unique location ID, assigned by the Voucherify API.

Example: loc_NoMGXmHO9OUs7iz9mGWpamma

object
string

The type of the object represented by JSON. This object stores information about a location.

Available values: location

name
string

Location name.

shape
object

Defines the shape and boundaries of the location.

One of:
  1. Circle
  2. Polygon

created_at
string

Timestamp representing the date and time when the location was created. The value is shown in the ISO 8601 format.

Example: 2022-02-14T15:12:06.817Z

updated_at
string, null

Timestamp representing the date and time when the location was updated. The value is shown in the ISO 8601 format.

Example: 2022-03-14T15:12:06.817Z

Circle

AttributesDescription

type
string

The type of shape being defined is a circle.

Available values: circle

format
string

The location is defined in terms of a distance object.

Available values: distance

distance
object

Defines the parameters for the circle.

Distance

AttributesDescription

center
string

Center of the circle identified by GPS coordinates in decimal degrees.

Example: geo:40.79372699823857,-74.15092132694554

radius
string

Defines the radius of the circle.

Polygon

AttributesDescription

type
string

The type of shape being defined is a polygon.

Available values: polygon

format
string

The location is defined in terms of a geojson object.

Available values: geojson

geojson

One of:
  1. Geojson Polygon
  2. Geojson Multi Polygon

Geojson Polygon

AttributesDescription

type
string

Type of geojson coordinates, i.e. Polygon.

Available values: Polygon

coordinates

See: PolygonCoordinates

Geojson Multi Polygon

AttributesDescription

type
string

Type of geojson coordinates, i.e. MultiPolygon.

Available values: MultiPolygon

coordinates
array

Array of PolygonCoordinates

PolygonCoordinates

⌘I