Location Object

Location object

AttributesDescription
id
string

Unique location ID, assigned by the Voucherify API.

Example:

loc_NoMGXmHO9OUs7iz9mGWpamma

object
string

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

name
string

Location name.

shape
object

Defines the shape and boundaries of the location.

One of: Circle, Polygon
created_at
string

Timestamp representing the date and time when the location was created in ISO 8601 format.

Example:

2022-02-14T15:12:06.817Z

updated_at
string

Timestamp representing the date and time when the location was updated in ISO 8601 format.

Example:

2022-03-14T15:12:06.817Z

Circle

AttributesDescription
type
string

The type of shape being defined is a circle.

format
string

The location is defined in terms of a distance object.

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.

format
string

The location is defined in terms of a geojson object.

distance
object

Defines the parameters for the polygon.

Geojson

AttributesDescription
type
string

Type of geojson coordinates, i.e. Polygon.

coordinates
array

Contains array of GeoJSON coordinate arrays.

Array of GeoJSON coordinate array.

GeoJSON coordinate array.

GeoJSON coordinate array.

Array of GeoJSON coordinate.

GeoJSON coordinate.

GeoJSON coordinate.