Skip to main content
POST
/
v3
/
locations
/
batch.json
Batch Locations
curl --request POST \
  --url http://localhost/api/v3/locations/batch.json \
  --header 'Content-Type: application/json' \
  --data '
{
  "locations": [
    {
      "name": "<string>",
      "phone": "<string>",
      "id": 123,
      "external_id": "<string>",
      "type": "<string>",
      "description": "<string>",
      "timezone": "<string>",
      "email": "jsmith@example.com",
      "external_code": "<string>",
      "is_published": true,
      "is_permanently_closed": true,
      "address": {
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "address_line_3": "<string>",
        "company": "<string>",
        "is_default": true,
        "latitude": 123,
        "longitude": 123,
        "city": "<string>",
        "postcode": "<string>",
        "state": "<string>",
        "country": "<string>",
        "notes": "<string>",
        "iso": "<string>",
        "iso_state": "<string>"
      },
      "normal_hours": [
        {
          "day_of_week": "MON",
          "open_at": "<string>",
          "close_at": "<string>"
        }
      ],
      "special_hours": [
        {
          "name": "<string>",
          "start_at": "2023-12-25",
          "end_at": "2023-12-25",
          "is_repeating": true,
          "open_at": "<string>",
          "close_at": "<string>"
        }
      ],
      "tags": [
        "<string>"
      ],
      "icon": "<string>",
      "image_url": "<string>",
      "custom_fields": [
        {
          "namespace": "<string>",
          "handle": "<string>",
          "type": "string",
          "value": "<string>"
        }
      ]
    }
  ],
  "import_job_id": "<string>"
}
'
{
  "message": "<string>",
  "batch_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
locations
object[]
required
Required array length: 1 - 500 elements
import_job_id
string

Response

message
string
required
Allowed value: "Queued for processing."
batch_id
string
required