Location
Location Object
| Field | Type | Description |
|---|---|---|
| id | snowflake | the location's id |
| organisation_id | snowflake | the role's organisation id |
| code | string | a short code for the location (2-6 characters) |
| name | string | the name of the location (2-30 characters) |
| description | string | a description of the location |
| type | location type | the location type |
| latitude | double | the latitude of the location |
| longitude | double | the longitude of the location |
| radius | integer | the radius of the location in metres |
| timezone | string | the time zone string of the location |
Location Types
| Name | Value | Description |
|---|---|---|
| none | 0x0000 | a location that is not owned by the organisation |
| manufacturing | 0x0001 | a manufacturing location |
| delivery | 0x0002 | a delivery location |
| maintenance | 0x0004 | a maintenance location |
| supplier | 0x0010 | a location at a supplier |
| customer | 0x0020 | a location at a customer |
List Locations
GET /organisations/{organisation.id}/locations
Returns an array of location objects for the organisation.
All filters for this method are optional.
Filters
| Field | Type | Description | Default |
|---|---|---|---|
| type | integer | bit field of location types to return, for example 0x0003 is all manufacturing and delivery locations | 0x0007 |
Create Location
POST /organisations/{organisation.id}/locations
Modify a location. Requires the manage_locations permission.
All parameters for this method are optional.
Parameters
| Field | Type | Description | Default |
|---|---|---|---|
| code | string | a short code for the location | NEW |
| name | string | the name of the location | New Location |
| description | string | a description of the location | This is a new location |
| type | location type | the location type | 0 |
| latitude | double | the latitude of the location | 0.00 |
| longitude | double | the longitude of the location | 0.00 |
| radius | integer | the radius of the location in metres | 0 |
| timezone | string | the time zone string of the location | UTC |
Modify Location
PATCH /organisations/{organisation.id}/locations/{location.id}
Modify a location. Requires the manage_locations permission.
All parameters for this method are optional.
Parameters
| Field | Type | Description |
|---|---|---|
| code | string | a short code for the location |
| name | string | the name of the location |
| description | string | a description of the location |
| type | location type | the location type |
| latitude | double | the latitude of the location |
| longitude | double | the longitude of the location |
| radius | integer | the radius of the location in metres |
| timezone | string | the time zone string of the location |
Delete Location
It is not possible to delete a location, however it can be marked as none.