Locations

Retrieve all locations

get

Retrieve all locations for a company

Authorizations
Query parameters
per_pageintegerOptional

limit of records per page

Example: 10
pageintegerOptional

page number

Example: 2
citystringOptional

This field is used to filter by city model. (LIKE)

Example: Athens
statestringOptional

This field is used to filter by state model. (LIKE)

Example: Georgia
countrystringOptional

This field is used to filter by country model. (LIKE)

Example: United States
categorystringOptional

This field is used to filter by category model. (LIKE)

Example: office
typestringOptional

This field is used to filter by type model. (LIKE)

Example: Warehouse
sort_bystringOptional

This parameter is used to sort the records by a specific field (city,state,country,place_id,category,has_commute,ownership,type,has_solar,created_at)

Example: type
sort_dirstringOptional

Order type(asc or desc)

Example: asc
Responses
200

Successful operation

application/json
get
/locations

Store a location

post

Store a location for a company

Authorizations
Body

Creates locations request body data

quantityanyOptional

Quantity for the Location

Example: 100
skuanyOptional

SKU for the Location

Example: 35015
sourceanyOptional

Source for the Location

Example: factory
line1anyRequired

Line 1 for the Location

Example: 175 Atlantic St
line2anyOptional

Line 2 for the Location

Example: 175 Atlantic St
cityanyOptional

City for the Location

Example: Georgia
stateanyOptional

State for the Location

Example: Georgia
postal_codeanyOptional

Postal Code for the Location

Example: 77024-1503
countryanyOptional

Country for the Location

Example: United States
categoryanyOptional

Category for the Location

Example: Office
nicknameanyRequired

Nickname for the Location

Example: Office A/C
sqftanyOptional

The square foot for the Location

Example: 20
has_commuteanyOptional

Has commute for the Location

Example: true
ownershipanyOptional

Ownership for the Location

Example: Owned
typeanyRequired

Type for the Location

Example: Warehouse
populationanyOptional

Population for the Location

Example: 10
has_solaranyOptional

Has solar for the Location

Example: true
Responses
200

Successful operation

application/json
post
/locations

Retrieve a location

get

Retrieve a location for a company

Authorizations
Path parameters
locationstringRequired

Id of the location

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469
Responses
200

Successful operation

application/json
get
/locations/{id}

Update a location

put

Update a location for a company

Authorizations
Path parameters
idstringRequired

Id of the location

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469
Body

Update Location request body data

quantityanyOptional

Quantity for the Location

Example: 100
skuanyOptional

SKU for the Location

Example: 35015
sourceanyOptional

Source for the Location

Example: factory
line1anyRequired

Line 1 for the Location

Example: 175 Atlantic St
line2anyOptional

Line 2 for the Location

Example: 175 Atlantic St
cityanyOptional

City for the Location

Example: Georgia
stateanyOptional

State for the Location

Example: Georgia
postal_codeanyOptional

Postal Code for the Location

Example: 77024-1503
countryanyOptional

Country for the Location

Example: United States
categoryanyOptional

Category for the Location

Example: Office
nicknameanyRequired

Nickname for the Location

Example: Office A/C
sqftanyOptional

The square foot for the Location

Example: 20
has_commuteanyOptional

Has commute for the Location

Example: true
ownershipanyOptional

Ownership for the Location

Example: Owned
typeanyRequired

Type for the Location

Example: Warehouse
populationanyOptional

Population for the Location

Example: 10
has_solaranyOptional

Has solar for the Location

Example: true
Responses
200

Successful operation

application/json
put
/locations/{id}

Delete a location

delete

Delete a location for a company

Authorizations
Path parameters
idstringRequired

Id of the location

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469
Responses
200

Successful operation

application/json
delete
/locations/{id}