Location
The Location object is for creating a physical store location associated with a Company. Depending on your subscription, you can have one or more Locations associated with your Company.
GET/v3/location/:id
Find Location
Find a Location by id
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Location schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- Name
meta
- Type
- object Required
- Description
- the metadata about the most recent change to the row
- Name
metadata
- Type
- object
- Description
- metadata reserved for customers to control
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Name
address1
- Type
- string Required
- Description
- Name
address2
- Type
- string Required
- Description
- Name
city
- Type
- string Required
- Description
- Name
state
- Type
- string Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
country
- Type
- string Required
- Description
- Name
privacyPolicy
- Type
- string Required
- Description
- Name
termsAndConditions
- Type
- string Required
- Description
- Name
website
- Type
- string Required
- Description
- Name
timezone
- Type
- string Required
- Description
- Name
email
- Type
- string Required
- Description
- Name
contactName
- Type
- string Required
- Description
- Name
phone
- Type
- string Required
- Description
- Name
showNameOnDocuments
- Type
- boolean Required
- Description
- Name
showWebsiteOnDocuments
- Type
- boolean Required
- Description
- Name
showEmailOnDocuments
- Type
- boolean Required
- Description
- Name
certifications
- Type
- object
- Description
- Name
latitude
- Type
- number Required
- Description
- Name
longitude
- Type
- number Required
- Description
- Name
archived
- Type
- boolean Required
- Description
- Name
geolocationId
- Type
- string Required
- Description
- Name
showCompanyLogo
- Type
- boolean Required
- Description
- whether or not to use the company logo
- Name
locationSubscriptionId
- Type
- string Required
- Description
- Name
externalId
- Type
- string Required
- Description
- a location identifier that can be used by multi-location companies
Properties for meta
object
- Name
userId
- Type
- string
- Description
- the user id that made the most recent change
- Name
sessionId
- Type
- string
- Description
- the session id for the most recent change
- Name
version
- Type
- number
- Description
- a monotonically increasing number for the most recent change
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Request
GET
/v3/location/:idcurl https://api.shopmonkey.cloud/v3/location/ID \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"meta": {
"userId": "userId",
"sessionId": "sessionId",
"version": 1
},
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"address1": "address1",
"address2": null,
"city": "city",
"state": "state",
"postalCode": "postalCode",
"country": "country",
"website": null,
"timezone": "timezone",
"email": null,
"contactName": null,
"locationPhoneNumberId": null
}
}
POST/v3/location
Create New Location
Create a new location for a company
Body parameters
- Name
name
- Type
- string Required
- Description
- Name
address1
- Type
- string Required
- Description
- Name
address2
- Type
- string
- Description
- Name
city
- Type
- string Required
- Description
- Name
state
- Type
- string Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
country
- Type
- string Required
- Description
- Name
privacyPolicy
- Type
- string
- Description
- Name
termsAndConditions
- Type
- string
- Description
- Name
website
- Type
- string
- Description
- Name
timezone
- Type
- string
- Description
- Name
email
- Type
- string
- Description
- Name
contactName
- Type
- string
- Description
- Name
phone
- Type
- string
- Description
- Name
showNameOnDocuments
- Type
- boolean
- Description
- Name
showWebsiteOnDocuments
- Type
- boolean
- Description
- Name
showEmailOnDocuments
- Type
- boolean
- Description
- Name
certifications
- Type
- object
- Description
- Name
latitude
- Type
- number
- Description
- Name
longitude
- Type
- number
- Description
- Name
archived
- Type
- boolean
- Description
- Name
geolocationId
- Type
- string
- Description
- Name
showCompanyLogo
- Type
- boolean
- Description
- whether or not to use the company logo
- Name
locationSubscriptionId
- Type
- string
- Description
- Name
externalId
- Type
- string
- Description
- a location identifier that can be used by multi-location companies
- Name
companyId
- Type
- string Required
- Description
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Location schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Name
address1
- Type
- string Required
- Description
- Name
address2
- Type
- string Required
- Description
- Name
city
- Type
- string Required
- Description
- Name
state
- Type
- string Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
country
- Type
- string Required
- Description
- Name
privacyPolicy
- Type
- string Required
- Description
- Name
termsAndConditions
- Type
- string Required
- Description
- Name
website
- Type
- string Required
- Description
- Name
timezone
- Type
- string Required
- Description
- Name
email
- Type
- string Required
- Description
- Name
contactName
- Type
- string Required
- Description
- Name
phone
- Type
- string Required
- Description
- Name
showNameOnDocuments
- Type
- boolean Required
- Description
- Name
showWebsiteOnDocuments
- Type
- boolean Required
- Description
- Name
showEmailOnDocuments
- Type
- boolean Required
- Description
- Name
certifications
- Type
- object
- Description
- Name
latitude
- Type
- number Required
- Description
- Name
longitude
- Type
- number Required
- Description
- Name
archived
- Type
- boolean Required
- Description
- Name
showCompanyLogo
- Type
- boolean Required
- Description
- whether or not to use the company logo
- Name
locationSubscriptionId
- Type
- string Required
- Description
- Name
externalId
- Type
- string Required
- Description
- a location identifier that can be used by multi-location companies
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
POST
/v3/locationcurl https://api.shopmonkey.cloud/v3/location \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X POST -H 'Content-Type: application/json' \
--data '{ "name" : "value", "address1" : "value", "city" : "value", "state" : "value", "postalCode" : "value", "country" : "value", "companyId" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"address1": "address1",
"address2": null,
"city": "city",
"state": "state",
"postalCode": "postalCode",
"country": "country",
"privacyPolicy": null,
"termsAndConditions": null,
"website": null,
"timezone": "timezone",
"email": null,
"contactName": null,
"phone": null,
"showNameOnDocuments": true,
"showWebsiteOnDocuments": true,
"showEmailOnDocuments": true,
"latitude": 1,
"longitude": 1,
"archived": true,
"showCompanyLogo": true,
"locationSubscriptionId": null
}
}
PUT/v3/location/:id
Update Location
Update Location data.
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
Body parameters
- Name
name
- Type
- string
- Description
- Name
address1
- Type
- string
- Description
- Name
address2
- Type
- string
- Description
- Name
city
- Type
- string
- Description
- Name
state
- Type
- string
- Description
- Name
postalCode
- Type
- string
- Description
- Name
country
- Type
- string
- Description
- Name
privacyPolicy
- Type
- string
- Description
- Name
termsAndConditions
- Type
- string
- Description
- Name
website
- Type
- string
- Description
- Name
timezone
- Type
- string
- Description
- Name
email
- Type
- string
- Description
- Name
contactName
- Type
- string
- Description
- Name
phone
- Type
- string
- Description
- Name
showNameOnDocuments
- Type
- boolean
- Description
- Name
showWebsiteOnDocuments
- Type
- boolean
- Description
- Name
showEmailOnDocuments
- Type
- boolean
- Description
- Name
latitude
- Type
- number
- Description
- Name
longitude
- Type
- number
- Description
- Name
archived
- Type
- boolean
- Description
- Name
geolocationId
- Type
- string
- Description
- Name
showCompanyLogo
- Type
- boolean
- Description
- whether or not to use the company logo
- Name
locationSubscriptionId
- Type
- string
- Description
- Name
externalId
- Type
- string
- Description
- a location identifier that can be used by multi-location companies
- Name
certifications
- Type
- array
- Description
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
- Location schema
Properties for data
object
- Name
id
- Type
- string Required
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
name
- Type
- string Required
- Description
- Name
address1
- Type
- string Required
- Description
- Name
address2
- Type
- string Required
- Description
- Name
city
- Type
- string Required
- Description
- Name
state
- Type
- string Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
country
- Type
- string Required
- Description
- Name
privacyPolicy
- Type
- string Required
- Description
- Name
termsAndConditions
- Type
- string Required
- Description
- Name
website
- Type
- string Required
- Description
- Name
timezone
- Type
- string Required
- Description
- Name
email
- Type
- string Required
- Description
- Name
contactName
- Type
- string Required
- Description
- Name
phone
- Type
- string Required
- Description
- Name
showNameOnDocuments
- Type
- boolean Required
- Description
- Name
showWebsiteOnDocuments
- Type
- boolean Required
- Description
- Name
showEmailOnDocuments
- Type
- boolean Required
- Description
- Name
certifications
- Type
- object
- Description
- Name
latitude
- Type
- number Required
- Description
- Name
longitude
- Type
- number Required
- Description
- Name
archived
- Type
- boolean Required
- Description
- Name
geolocationId
- Type
- string Required
- Description
- Name
showCompanyLogo
- Type
- boolean Required
- Description
- whether or not to use the company logo
- Name
locationSubscriptionId
- Type
- string Required
- Description
- Name
externalId
- Type
- string Required
- Description
- a location identifier that can be used by multi-location companies
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
PUT
/v3/location/:idcurl https://api.shopmonkey.cloud/v3/location/ID \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"id": "id",
"createdDate": "createdDate",
"updatedDate": null,
"companyId": "companyId",
"name": "name",
"address1": "address1",
"address2": null,
"city": "city",
"state": "state",
"postalCode": "postalCode",
"country": "country",
"website": null,
"timezone": "timezone",
"email": null,
"contactName": null,
"phone": null,
"showNameOnDocuments": true,
"showWebsiteOnDocuments": true,
"showEmailOnDocuments": true,
"latitude": 1,
"longitude": 1
}
}
PUT/v3/location/:id/image
Assign Image
Assign an Image to Location
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
Body parameters
- Name
blobId
- Type
- string Required
- Description
- the id of the blob
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
Properties for data
object
- Name
blobId
- Type
- string Required
- Description
- the id of the blob
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
PUT
/v3/location/:id/imagecurl https://api.shopmonkey.cloud/v3/location/ID/image \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X PUT -H 'Content-Type: application/json' \
--data '{ "blobId" : "value" }'
Example Responseapplication/json
{
"success": true,
"data": {
"blobId": "blobId"
}
}
DELETE/v3/location/:id/image
Unassign Image
Unassign an Image from Location
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
- Name
data
- Type
- object Required
- Description
Properties for data
object
- Name
blobId
- Type
- string Required
- Description
- the id of the blob
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
5xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if not successful
- Name
success
- Type
- boolean Required
- Description
- if successful, will be true. if not successful, will be false and message will contain a human readable error message
Example Requestapplication/json
DELETE
/v3/location/:id/imagecurl https://api.shopmonkey.cloud/v3/location/ID/image \
-H "Authorization: Bearer ${SM_TOKEN}" \
-X DELETE -H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"success": true,
"data": {
"blobId": "blobId"
}
}
GET/v3/location/:id/image
Find Location Image
Find the image for a Location
URL parameters
- Name
id
- Type
- string Required
- Description
- the id of the location
200
Response
the content of the uploaded blob based on its contentType
Example Request
GET
/v3/location/:id/imagecurl https://api.shopmonkey.cloud/v3/location/ID/image \
-H "Authorization: Bearer ${SM_TOKEN}"