Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
In-Person Locations

Create an location at which one or more terminals will reside

Use this endpoint to setup a new location which will be used for housing one or more terminals. Note that once created a location's address & geo co-ordinates cannot be changed and instead a new location must be created

post/in-person/locations

Headers

Accountstring
Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this when you want to create an in person location under a linked account)

Request body

namestring required

Your name for the location. This can be used for display purposes.

metadataobject nullable

Your own custom key-value data for this object. These will be sent with any associated events on your webhooks. You can have a maximum of 10 pieces of metadata.

Keys must be between 1 and 30 characters in length.

Values must be between 1 and 250 characters in length.

Example request

{
  "name": "Main Office Front Desk",
  "address": {
    "lineOne": "123 Test Street",
    "lineTwo": "456 Test Lane",
    "city": "Manchester",
    "country": "GB",
    "postalCode": "M3 3AG",
    "region": "Greater Manchester"
  },
  "geoCoordinates": {
    "latitude": 51.1789,
    "longitude": 1.8262
  },
  "metadata": {
    "internalID": "1"
  }
}

Response

Resource successfully created

idstring

The unique Id of the location

namestring

Your name for the location. This can be used for display purposes.

metadataobject

Your own custom key-value data for this object. These will be sent with any associated events on your webhooks. You can have a maximum of 10 pieces of metadata.

Keys must be between 1 and 30 characters in length.

Values must be between 1 and 250 characters in length.

createdTimestampinteger

The epoch timestamp (seconds) when the object was created

lastUpdatedTimestampinteger

The epoch timestamp (seconds) when the object was last updated

Example response

{
  "id": "iploc_01FCTS1XMKH9FF43CAFA4CXT3P",
  "name": "Head Office front desk",
  "address": {
    "lineOne": "123 Test Street",
    "lineTwo": "456 Test Lane",
    "city": "Manchester",
    "country": "GB",
    "postalCode": "M3 3AG",
    "region": "Greater Manchester"
  },
  "geoCoordinates": {
    "latitude": 51.1789,
    "longitude": 1.8262
  },
  "metadata": {
    "internalID": "1"
  },
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}