Update location item
Request Information
Headers
| Name | Description | Type | Additional information |
|---|---|---|---|
| Authentication |
Authentication token |
string |
Required |
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| accountid |
Premium account id. Include it if you have the ability to create Premium (multi-user) accounts. |
globally unique identifier |
Optional |
Body Parameters
Location set item
ApiLocationSetItem| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Location set item Id |
integer |
None. |
| Address |
Location set item address |
string |
Max length: 250 |
| City |
Location set item city |
string |
Max length: 250 |
| Zip |
Location set item Zip |
string |
Max length: 250 |
| State |
Location set item state |
string |
Max length: 250 |
| Country |
Location set item country |
string |
Max length: 250 |
| Phone |
Location set item phone |
string |
Max length: 250 |
| Name |
Location set item name |
string |
Max length: 250 Required |
| Description |
Location set item description |
string |
Max length: 500 |
| Latitude |
Location set item latitude |
decimal number |
None. |
| Longitude |
Location set item longitude |
decimal number |
None. |
| StoreNumber |
Location set item store number |
string |
Max length: 50 Required |
Request Formats
application/json
Sample:
{
"Id": 1,
"Name": "Main location",
"Address": "555 Republic Dr.",
"City": "Plano",
"Zip": "75074",
"State": "TX",
"Country": "USA",
"Phone": "972 999 9999",
"Description": "Located just north of downtown",
"Latitude": "33.031252",
"Longitude": "-96.705198"
}
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiLocationSetItem |
None. |
|
| Success | boolean |
None. |
|
| Messages | Collection of ErrorMessage |
None. |
Response Formats
application/json
Sample:
{
"Id": 1,
"Name": "Main location",
"Address": "555 Republic Dr.",
"City": "Plano",
"Zip": "75074",
"State": "TX",
"Country": "USA",
"Phone": "972 999 9999",
"Description": "Located just north of downtown",
"Latitude": "33.031252",
"Longitude": "-96.705198"
}