curl --request PUT \
--url http://localhost/api/v3/locations/{location} \
--header 'Content-Type: application/json' \
--data '
{
"type": "<string>",
"name": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "jsmith@example.com",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"timezone": "<string>",
"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": [
{
"day_of_week": "MON",
"open_at": "<string>",
"close_at": "<string>"
}
],
"special_hours": [
{
"name": "<string>",
"is_repeating": true,
"open_at": "<string>",
"close_at": "<string>",
"start_at": "2023-12-25",
"end_at": "2023-12-25"
}
],
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"type": "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>"
}
]
}
}A PUT to the /locations/{locationId} endpoint allows your application to edit a Location record.
curl --request PUT \
--url http://localhost/api/v3/locations/{location} \
--header 'Content-Type: application/json' \
--data '
{
"type": "<string>",
"name": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "jsmith@example.com",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"timezone": "<string>",
"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": [
{
"day_of_week": "MON",
"open_at": "<string>",
"close_at": "<string>"
}
],
"special_hours": [
{
"name": "<string>",
"is_repeating": true,
"open_at": "<string>",
"close_at": "<string>",
"start_at": "2023-12-25",
"end_at": "2023-12-25"
}
],
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"type": "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.
The location ID
3Show child attributes
1Show child attributes
Show child attributes
Show child attributes
Location
Show child attributes