Admin Locations APIs are highly configurable and require object identification prior to use.
POST org/location
Create/Add New Location.
| Example |
curl --request POST \
--url https://hostname/org/location \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--data '{
"id": "8801",
"name": "Bhayandar Location",
"address1": "Address Line 1",
"address2": "Address Line 2",
"city": "City",
"state_province": "CA",
"postal_code": "123456",
"longitude": -119.4179324,
"latitude": 36.778261,
"pri_organization_id": 1,
"timezone": "America/Los_Angeles",
"email": null,
"smstxt": "",
"uuid": "",
"alias": null,
"region_id": 1,
"floor_plan_format_id": "71",
"fact_id": "",
"store_code": "BY023",
"status": "ACTIVE",
"time_open_monday": "09:00",
"time_open_tuesday": "09:00",
"time_open_wednesday": "09:00",
"time_open_thursday": "09:00",
"time_open_friday": "09:00",
"time_open_saturday": "09:00",
"time_open_sunday": "09:00",
"time_close_monday": "19:00",
"time_close_tuesday": "19:00",
"time_close_wednesday": "19:00",
"time_close_thursday": "19:00",
"time_close_friday": "19:00",
"time_close_saturday": "19:00",
"time_close_sunday": "19:00",
"rvp_id": null,
"dir_id": null,
"country_iso3": "USA",
"closed_mondays": "NO",
"closed_tuesdays": "NO",
"closed_wednesdays": "NO",
"closed_thursdays": "NO",
"closed_fridays": "NO",
"closed_saturdays": "NO",
"closed_sundays": "NO",
"h24_mondays": "NO",
"h24_tuesdays": "NO",
"h24_wednesdays": "NO",
"h24_thursdays": "NO",
"h24_fridays": "NO",
"h24_saturdays": "NO",
"h24_sundays": "NO",
"location_type": 1
}'
|
GET org/location/{id}
Get/Fetch Location Data.
| Example |
curl --request GET \
--url https://hostname/org/location/{id} \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--data '{
"id": "8801",
"name": "Location Name",
"address1": "Address Line 1",
"address2": "Address Line 2",
"city": "City",
"state_province": "CA",
"postal_code": "123456",
"longitude": "-119.4179324",
"latitude": "36.778261",
"pri_organization_id": "1",
"timezone": "America/Los_Angeles",
"email": null,
"smstxt": "",
"uuid": "",
"alias": null,
"region_id": "1",
"floor_plan_format_id": "71",
"fact_id": "",
"store_code": "BY023",
"status": "ACTIVE",
"time_open_monday": "09:00",
"time_open_tuesday": "09:00",
"time_open_wednesday": "09:00",
"time_open_thursday": "09:00",
"time_open_friday": "09:00",
"time_open_saturday": "09:00",
"time_open_sunday": "09:00",
"time_close_monday": "19:00",
"time_close_tuesday": "19:00",
"time_close_wednesday": "19:00",
"time_close_thursday": "19:00",
"time_close_friday": "19:00",
"time_close_saturday": "19:00",
"time_close_sunday": "19:00",
"rvp_id": null,
"dir_id": null,
"country_iso3": "USA",
"closed_mondays": "NO",
"closed_tuesdays": "NO",
"closed_wednesdays": "NO",
"closed_thursdays": "NO",
"closed_fridays": "NO",
"closed_saturdays": "NO",
"closed_sundays": "NO",
"h24_mondays": "NO",
"h24_tuesdays": "NO",
"h24_wednesdays": "NO",
"h24_thursdays": "NO",
"h24_fridays": "NO",
"h24_saturdays": "NO",
"h24_sundays": "NO",
"location_type": "1",
"emails": [],
"trafficCounters": [],
"nvrs": [],
"activeTaskListCount": 0,
"locationgroups": {
"assigned": true,
"lgsLinked": [
{
"location_group_id": "6021",
"name": "Location Group Name"
}
]
}
},
|
DELETE org/location/{id}
Get/Fetch Location Data.
| Example |
curl --request DELETE \
--url https://hostname/org/location/{id} \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--data '{
"id": "8801",
"name": "Location Name",
"address1": "Address Line 1",
"address2": "Address Line 2",
"city": "City",
"state_province": "CA",
"postal_code": "123456",
"longitude": "-119.4179324",
"latitude": "36.778261",
"pri_organization_id": "1",
"timezone": "America/Los_Angeles",
"email": null,
"smstxt": "",
"uuid": "",
"alias": null,
"region_id": "1",
"floor_plan_format_id": "71",
"fact_id": "",
"store_code": "BY023",
"status": "INACTIVE",
"time_open_monday": "09:00",
"time_open_tuesday": "09:00",
"time_open_wednesday": "09:00",
"time_open_thursday": "09:00",
"time_open_friday": "09:00",
"time_open_saturday": "09:00",
"time_open_sunday": "09:00",
"time_close_monday": "19:00",
"time_close_tuesday": "19:00",
"time_close_wednesday": "19:00",
"time_close_thursday": "19:00",
"time_close_friday": "19:00",
"time_close_saturday": "19:00",
"time_close_sunday": "19:00",
"rvp_id": null,
"dir_id": null,
"country_iso3": "USA",
"closed_mondays": "NO",
"closed_tuesdays": "NO",
"closed_wednesdays": "NO",
"closed_thursdays": "NO",
"closed_fridays": "NO",
"closed_saturdays": "NO",
"closed_sundays": "NO",
"h24_mondays": "NO",
"h24_tuesdays": "NO",
"h24_wednesdays": "NO",
"h24_thursdays": "NO",
"h24_fridays": "NO",
"h24_saturdays": "NO",
"h24_sundays": "NO",
"location_type": "1",
"emails": [],
"trafficCounters": [],
"nvrs": [],
"activeTaskListCount": 0,
"locationgroups": {
"assigned": true,
"lgsLinked": [
{
"location_group_id": "6021",
"name": "Location Group Name"
}
]
}
},
|