> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Location Object

<div class="prose dark:prose-invert custom-html">
  <h2 id="location-object">Location object</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            id

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Unique location ID, assigned by the Voucherify API.</p>

          <p>
            <strong>Example:</strong>
            loc\_NoMGXmHO9OUs7iz9mGWpamma
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            object

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>
            The type of the object represented by JSON. This object stores information about a
            <code>location</code>.
          </p>

          <p>
            Available values:
            <code>location</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            name

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Location name.</p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            shape

            <br />

            <code>object</code>
          </p>
        </td>

        <td>
          <p>Defines the shape and boundaries of the location.</p>
          One of:

          <ol>
            <li>
              <a href="#circle">Circle</a>
            </li>

            <li>
              <a href="#polygon">Polygon</a>
            </li>
          </ol>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            created\_at

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>Timestamp representing the date and time when the location was created. The value is shown in the ISO 8601 format.</p>

          <p>
            <strong>Example:</strong>
            2022-02-14T15:12:06.817Z
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            updated\_at

            <br />

            <code>string</code>,
            <code>null</code>
          </p>
        </td>

        <td>
          <p>Timestamp representing the date and time when the location was updated. The value is shown in the ISO 8601 format.</p>

          <p>
            <strong>Example:</strong>
            2022-03-14T15:12:06.817Z
          </p>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="circle">Circle</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            type

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>
            The type of shape being defined is a
            <code>circle</code>.
          </p>

          <p>
            Available values:
            <code>circle</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            format

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>
            The location is defined in terms of a
            <code>distance</code>
            object.
          </p>

          <p>
            Available values:
            <code>distance</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            distance

            <br />

            <code>object</code>
          </p>
        </td>

        <td>
          <p>Defines the parameters for the circle.</p>
          <h3>Distance</h3>

          <table>
            <thead>
              <tr>
                <th>Attributes</th>
                <th>Description</th>
              </tr>
            </thead>

            <tbody>
              <tr>
                <td>
                  <p>
                    center

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Center of the circle identified by GPS coordinates in decimal degrees.</p>

                  <p>
                    <strong>Example:</strong>
                    geo:40.79372699823857,-74.15092132694554
                  </p>
                </td>
              </tr>

              <tr>
                <td>
                  <p>
                    radius

                    <br />

                    <code>string</code>
                  </p>
                </td>

                <td>
                  <p>Defines the radius of the circle.</p>
                </td>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="polygon">Polygon</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            type

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>
            The type of shape being defined is a
            <code>polygon</code>.
          </p>

          <p>
            Available values:
            <code>polygon</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            format

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>
            The location is defined in terms of a
            <code>geojson</code>
            object.
          </p>

          <p>
            Available values:
            <code>geojson</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>geojson</p>
        </td>

        <td>
          One of:

          <ol>
            <li>
              <a href="#geojson-polygon">Geojson Polygon</a>
            </li>

            <li>
              <a href="#geojson-multi-polygon">Geojson Multi Polygon</a>
            </li>
          </ol>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="geojson-polygon">Geojson Polygon</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            type

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>
            Type of geojson coordinates, i.e.
            <code>Polygon</code>.
          </p>

          <p>
            Available values:
            <code>Polygon</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>coordinates</p>
        </td>

        <td>
          See:
          <a href="#polygoncoordinates">PolygonCoordinates</a>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="geojson-multi-polygon">Geojson Multi Polygon</h2>

  <table>
    <thead>
      <tr>
        <th>Attributes</th>
        <th>Description</th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>
          <p>
            type

            <br />

            <code>string</code>
          </p>
        </td>

        <td>
          <p>
            Type of geojson coordinates, i.e.
            <code>MultiPolygon</code>.
          </p>

          <p>
            Available values:
            <code>MultiPolygon</code>
          </p>
        </td>
      </tr>

      <tr>
        <td>
          <p>
            coordinates

            <br />

            <code>array</code>
          </p>
        </td>

        <td>
          Array of
          <a href="#polygoncoordinates">PolygonCoordinates</a>
        </td>
      </tr>
    </tbody>
  </table>

  <h2 id="polygoncoordinates">PolygonCoordinates</h2>
</div>