POST
/
LocationServices
/
LocationManagement
/
CreateList
/
v1.10
/
json6.ws
cURL
curl --request POST \
  --url https://api.addressy.com/LocationServices/LocationManagement/CreateList/v1.10/json6.ws \
  --header 'Content-Type: application/json' \
  --data '{
  "Key": "<string>",
  "ListName": "<string>",
  "ListDescription": "<string>",
  "Locations": [
    {
      "Name": "<string>",
      "Description": "<string>",
      "Address": "<string>",
      "Country": "<string>",
      "Latitude": "<string>",
      "Longitude": "<string>",
      "MetaInfo": {},
      "UnstructuredMetaInfo": {},
      "OpeningHours": {
        "Monday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Tuesday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Wednesday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Thursday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Friday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Saturday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Sunday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        }
      }
    }
  ],
  "CreatedOn": "2023-11-07T05:31:56Z",
  "LastModifiedOn": "2023-11-07T05:31:56Z",
  "Geocoding": true
}'
{
  "ListId": "<string>",
  "ListName": "<string>",
  "ListDescription": "<string>",
  "LatestRelatedListId": "<string>",
  "IsErrorList": true,
  "Locations": [
    {
      "Id": "<string>",
      "Name": "<string>",
      "Description": "<string>",
      "Address": "<string>",
      "Country": "<string>",
      "Latitude": "<string>",
      "Longitude": "<string>",
      "MetaInfo": {},
      "UnstructuredMetaInfo": {},
      "OpeningHours": {
        "Monday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Tuesday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Wednesday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Thursday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Friday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Saturday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        },
        "Sunday": {
          "Open": "<string>",
          "Close": "<string>",
          "Information": "<string>"
        }
      }
    }
  ],
  "CreatedOn": "2023-11-07T05:31:56Z",
  "LastModifiedOn": "2023-11-07T05:31:56Z"
}
This endpoint requires the use of a Loqate Management key. Management keys are used to provide access to server-side functions in place of your standard API key, ensuring that were any of your keys to be scraped from a customer facing website, they could not be used to edit or delete your Location Lists. For information on how to create a Management key please see the Setting Up Store Finder Keys guide.
The Create List API allows you to create a list of locations, including their co-ordinates and their IDs. It can also store additional information such as a description of each location, opening times, and address, to provide more context. This API also supports the use of a “metaInfo” object which can be used to store any other relevant information such as contact details, accessibility information etc. When uploading a list, co-ordinates for each location are mandatory. If you do not have the co-ordinates of a location but have the address instead, we can geocode those for you. If the geocoding option is selected we will geocode every address in your request, any existing geocodes you send us will be overwritten. When Geocoding a list, if a geocode cannot be found for one of your locations then the request will fail. You will not be charged, and we will outline which address(es) had caused the issue. Please note that each address geocoded is chargeable based on your standard geocoding cost. Geocoding supports most international locations. For a full list of coverage please see https://support.loqate.com/coverage-full/.

Body

application/json

Response

200 - application/json

Success

The response is of type object.