API Reference / LocationService
LocationService
CreateLocation
Request
| Field | Type | Validation | Description |
|---|---|---|---|
| brand_id | string | min_len: 1 | |
| street_address | string | min_len: 1 | |
| city | string | min_len: 1 | |
| state | string | min_len: 2 | |
| zip | string | min_len: 1 | |
| phone | string | min_len: 1 |
Response
| Field | Type | Description |
|---|---|---|
| location | Location |
ListLocationsForAccount
Request
| Field | Type | Validation | Description |
|---|---|---|---|
| account_id | string | min_len: 1 |
Response
| Field | Type | Description |
|---|---|---|
| locations | Location[] |
UpdateLocation
Request
| Field | Type | Validation | Description |
|---|---|---|---|
| account_id | string | min_len: 1 | |
| id | string | min_len: 1 | ULID of the resource |
| street_address | string | min_len: 1 | |
| city | string | min_len: 1 | |
| state | string | min_len: 2 | |
| zip | string | min_len: 1 | |
| phone | string | min_len: 1 |
Response
| Field | Type | Description |
|---|---|---|
| location | Location |
Messages
Location
| Field | Type | Description |
|---|---|---|
| id | string | ULID of the resource |
| brand_id | string | |
| street_address | string | |
| city | string | |
| state | string | |
| zip | string | |
| phone | string | |
| created_at | timestamp | |
| updated_at | timestamp |