Add Location
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/locations \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"phone": "<string>",
"type": "<string>",
"handle": "<string>",
"description": "<string>",
"timezone": "<string>",
"email": "jsmith@example.com",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"icon": "<string>",
"image_url": "<string>",
"country_iso_3": "<string>",
"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>"
},
"tags": [
"<string>"
],
"normal_hours": [
{
"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>"
}
],
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<string>"
}
]
}
'{
"data": {
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
}Location
Add Location
A POST to the /locations endpoint allows your application to add a Location.
POST
/
v3
/
locations
Add Location
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/locations \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"phone": "<string>",
"type": "<string>",
"handle": "<string>",
"description": "<string>",
"timezone": "<string>",
"email": "jsmith@example.com",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"icon": "<string>",
"image_url": "<string>",
"country_iso_3": "<string>",
"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>"
},
"tags": [
"<string>"
],
"normal_hours": [
{
"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>"
}
],
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<string>"
}
]
}
'{
"data": {
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<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
Maximum string length:
255Required string length:
3Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Location
Show child attributes
Show child attributes
⌘I