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.
List s
Find all s
Query String parameters
- Name
ids
- Type
- one of: any, any
- Description
- Name
limit
- Type
- one of: any, any
- Description
- the limit on the number of records to return
- Name
orderby
- Type
- one of: any, any
- Description
- the order instructions for the result
- Name
params
- Type
- one of: any, any
- Description
- additional request specific params
- Name
skip
- Type
- one of: any, any
- Description
- the number of records to skip for a paginated result
- Name
where
- Type
- one of: any, any
- Description
- an object to use for filtering the results
- Name
include
- Type
- object
- Description
Properties for include
object
- Name
locationPhoneNumber
- Type
- boolean
- Description
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- array Required
- Description
- an array of items
- Name
meta
- Type
- object
- Description
- 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
Properties for meta
object
- Name
hasMore
- Type
- boolean Required
- Description
- if there are more records available
- Name
total
- Type
- number Required
- Description
- the total number of records
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
curl https://api.shopmonkey.cloud/v3/location \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"address1": "address1",
"city": "city",
"companyId": "companyId",
"country": "country",
"createdDate": "createdDate",
"externalId": null,
"id": "id",
"latitude": 1,
"longitude": 1,
"name": "name",
"postalCode": "postalCode",
"state": "state",
"timezone": "timezone",
"companyName": null,
"locationPhoneNumbers": [
{
"configurationCurrentState": "configurationCurrentState",
"error": null,
"status": "status",
"tcrUseCase": "tcrUseCase"
}
],
"finixIntegration": {
"error": null,
"identityId": null,
"merchantId": null
},
"stripeIntegration": {
"accountId": null,
"billingCustomerId": null,
"error": null
}
}
],
"success": true
}
Search entities
Search for Entries
Query String parameters
- Name
ids
- Type
- array
- Description
- Name
limit
- Type
- number
- Description
- the limit on the number of records to return
- Name
orderby
- Type
- string
- Description
- the order instructions for the result
- Name
params
- Type
- string
- Description
- additional request specific params
- Name
skip
- Type
- number
- Description
- the number of records to skip for a paginated result
- Name
where
- Type
- one of: any, any
- Description
- an object to use for filtering the results
- Name
include
- Type
- object
- Description
Properties for include
object
- Name
locationPhoneNumber
- Type
- boolean
- Description
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- array Required
- Description
- an array of items
- 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
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
curl https://api.shopmonkey.cloud/v3/location/search \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{}'
Example Responseapplication/json
{
"data": [
{
"address1": "address1",
"city": "city",
"companyId": "companyId",
"country": "country",
"createdDate": "createdDate",
"externalId": null,
"id": "id",
"latitude": 1,
"longitude": 1,
"name": "name",
"postalCode": "postalCode",
"state": "state",
"timezone": "timezone",
"companyName": null,
"locationPhoneNumbers": [
{
"configurationCurrentState": "configurationCurrentState",
"error": null,
"status": "status",
"tcrUseCase": "tcrUseCase"
}
],
"finixIntegration": {
"error": null,
"identityId": null,
"merchantId": null
},
"stripeIntegration": {
"accountId": null,
"billingCustomerId": null,
"error": null
}
}
],
"success": true
}
Find
Find one by id
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object to retrieve
Produces
The response content type: application/json
200
Response
- Name
data
- Type
- object Required
- Description
- 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
Properties for data
object
- Name
address1
- Type
- string Required
- Description
- Name
address2
- Type
- string Required
- Description
- Name
archived
- Type
- boolean Required
- Description
- Name
certifications
- Type
- object
- Description
- Name
city
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
contactName
- Type
- string Required
- Description
- Name
country
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
email
- Type
- string Required
- Description
- Name
externalId
- Type
- string Required
- Description
- a location identifier that can be used by multi-location companies
- Name
geolocationId
- Type
- string Required
- Description
- Name
id
- Type
- string Required
- Description
- Name
imported
- Type
- boolean Required
- Description
- Name
latitude
- Type
- number Required
- Description
- Name
locationSubscriptionId
- Type
- string Required
- Description
- Name
longitude
- Type
- number 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
name
- Type
- string Required
- Description
- Name
phone
- Type
- string Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
privacyPolicy
- Type
- string Required
- Description
- Name
showCompanyLogo
- Type
- boolean Required
- Description
- whether or not to use the company logo
- Name
showEmailOnDocuments
- Type
- boolean Required
- Description
- Name
showNameOnDocuments
- Type
- boolean Required
- Description
- Name
showWebsiteOnDocuments
- Type
- boolean Required
- Description
- Name
state
- Type
- string Required
- Description
- Name
termsAndConditions
- Type
- string Required
- Description
- Name
timezone
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
website
- Type
- string Required
- Description
- Name
accessLevel
- Type
- one of: 'FullAccess', 'ReadOnly' Required
- Description
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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
curl 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
}
}
Create New Location
Create a new location for a company
Body parameters
Consumes
The following content type is required: application/json
- Name
address1
- Type
- string Required
- Description
- Name
address2
- Type
- string
- Description
- Name
archived
- Type
- boolean
- Description
- Name
certifications
- Type
- object
- Description
- Name
city
- Type
- string Required
- Description
- Name
contactName
- Type
- string
- Description
- Name
country
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
email
- Type
- string
- Description
- Name
externalId
- Type
- string
- Description
- a location identifier that can be used by multi-location companies
- Name
geolocationId
- Type
- string
- Description
- Name
latitude
- Type
- number
- Description
- Name
locationSubscriptionId
- Type
- string
- Description
- Name
longitude
- Type
- number
- Description
- Name
name
- Type
- string Required
- Description
- Name
phone
- Type
- string
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
privacyPolicy
- Type
- string
- Description
- Name
showCompanyLogo
- Type
- boolean
- Description
- whether or not to use the company logo
- Name
showEmailOnDocuments
- Type
- boolean
- Description
- Name
showNameOnDocuments
- Type
- boolean
- Description
- Name
showWebsiteOnDocuments
- Type
- boolean
- Description
- Name
state
- Type
- string Required
- Description
- Name
termsAndConditions
- Type
- string
- Description
- Name
timezone
- Type
- string
- Description
- Name
website
- Type
- string
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
preferredLanguage
- Type
- one of: en, en_US, fr_CA, es_MX
- Description
Produces
The response content type: application/json
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
message
- Type
- string
- Description
- the error message if success = false
- 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
address1
- Type
- string Required
- Description
- Name
address2
- Type
- string Required
- Description
- Name
archived
- Type
- boolean Required
- Description
- Name
certifications
- Type
- object
- Description
- Name
city
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
contactName
- Type
- string Required
- Description
- Name
country
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
email
- Type
- string Required
- Description
- Name
externalId
- Type
- string Required
- Description
- a location identifier that can be used by multi-location companies
- Name
id
- Type
- string Required
- Description
- Name
imported
- Type
- boolean Required
- Description
- Name
latitude
- Type
- number Required
- Description
- Name
locationSubscriptionId
- Type
- string Required
- Description
- Name
longitude
- Type
- number Required
- Description
- Name
name
- Type
- string Required
- Description
- Name
phone
- Type
- string Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
privacyPolicy
- Type
- string Required
- Description
- Name
showCompanyLogo
- Type
- boolean Required
- Description
- whether or not to use the company logo
- Name
showEmailOnDocuments
- Type
- boolean Required
- Description
- Name
showNameOnDocuments
- Type
- boolean Required
- Description
- Name
showWebsiteOnDocuments
- Type
- boolean Required
- Description
- Name
state
- Type
- string Required
- Description
- Name
termsAndConditions
- Type
- string Required
- Description
- Name
timezone
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
website
- Type
- string Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
curl https://api.shopmonkey.cloud/v3/location \
-H "Authorization: Bearer ${SM_TOKEN}" \
-H 'Content-Type: application/json' \
--data '{ "address1" : "value", "city" : "value", "country" : "value", "name" : "value", "postalCode" : "value", "state" : "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
}
}
Update Location
Update Location data.
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
Body parameters
Consumes
The following content type is required: application/json
- Name
address1
- Type
- string
- Description
- Name
address2
- Type
- string
- Description
- Name
archived
- Type
- boolean
- Description
- Name
city
- Type
- string
- Description
- Name
contactName
- Type
- string
- Description
- Name
country
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW
- Description
- Name
email
- Type
- string
- Description
- Name
externalId
- Type
- string
- Description
- a location identifier that can be used by multi-location companies
- Name
geolocationId
- Type
- string
- Description
- Name
latitude
- Type
- number
- Description
- Name
locationSubscriptionId
- Type
- string
- Description
- Name
longitude
- Type
- number
- Description
- Name
name
- Type
- string
- Description
- Name
phone
- Type
- string
- Description
- Name
postalCode
- Type
- string
- Description
- Name
privacyPolicy
- Type
- string
- Description
- Name
showCompanyLogo
- Type
- boolean
- Description
- whether or not to use the company logo
- Name
showEmailOnDocuments
- Type
- boolean
- Description
- Name
showNameOnDocuments
- Type
- boolean
- Description
- Name
showWebsiteOnDocuments
- Type
- boolean
- Description
- Name
state
- Type
- string
- Description
- Name
termsAndConditions
- Type
- string
- Description
- Name
timezone
- Type
- string
- Description
- Name
website
- Type
- string
- Description
- Name
certifications
- Type
- array
- Description
Produces
The response content type: application/json
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
message
- Type
- string
- Description
- the error message if success = false
- 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
address1
- Type
- string Required
- Description
- Name
address2
- Type
- string Required
- Description
- Name
archived
- Type
- boolean Required
- Description
- Name
certifications
- Type
- object
- Description
- Name
city
- Type
- string Required
- Description
- Name
companyId
- Type
- string Required
- Description
- Name
contactName
- Type
- string Required
- Description
- Name
country
- Type
- one of: US, CA, MX, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, VG, BN, BG, BF, BI, CV, KH, CM, KY, CF, TD, CL, CN, HK, MO, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FM, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, PS, SD, SR, SJ, SE, CH, SY, TW, TJ, TH, MK, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, VI, UY, UZ, VU, VE, VN, WF, EH, YE, ZM, ZW Required
- Description
- Name
createdDate
- Type
- string Required
- Description
- Name
email
- Type
- string Required
- Description
- Name
externalId
- Type
- string Required
- Description
- a location identifier that can be used by multi-location companies
- Name
geolocationId
- Type
- string Required
- Description
- Name
id
- Type
- string Required
- Description
- Name
imported
- Type
- boolean Required
- Description
- Name
latitude
- Type
- number Required
- Description
- Name
locationSubscriptionId
- Type
- string Required
- Description
- Name
longitude
- Type
- number Required
- Description
- Name
name
- Type
- string Required
- Description
- Name
phone
- Type
- string Required
- Description
- Name
postalCode
- Type
- string Required
- Description
- Name
privacyPolicy
- Type
- string Required
- Description
- Name
showCompanyLogo
- Type
- boolean Required
- Description
- whether or not to use the company logo
- Name
showEmailOnDocuments
- Type
- boolean Required
- Description
- Name
showNameOnDocuments
- Type
- boolean Required
- Description
- Name
showWebsiteOnDocuments
- Type
- boolean Required
- Description
- Name
state
- Type
- string Required
- Description
- Name
termsAndConditions
- Type
- string Required
- Description
- Name
timezone
- Type
- string Required
- Description
- Name
updatedDate
- Type
- string Required
- Description
- Name
website
- Type
- string Required
- Description
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
curl 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
}
}
Assign Image
Assign an Image to Location
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
Body parameters
Consumes
The following content type is required: application/json
- Name
blobId
- Type
- string Required
- Description
- the id of the blob
Produces
The response content type: application/json
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
message
- Type
- string
- Description
- the error message if success = false
- 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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
curl 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"
}
}
Unassign Image
Unassign an Image from Location
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
Produces
The response content type: application/json
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
message
- Type
- string
- Description
- the error message if success = false
- 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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
curl 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"
}
}
MISSING summary
Get payment methods for a location
URL parameters
- Name
id
- Type
- string Required
- Description
- the id for the object
Produces
The response content type: application/json
200
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- array Required
- Description
- Name
documentation_url
- Type
- string
- Description
- An optional link to the documentation for the error
- Name
message
- Type
- string
- Description
- the error message if success = false
- Name
meta
- Type
- object
- Description
- 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
Properties for meta
object
- Name
hasMore
- Type
- boolean
- Description
- if there are more records available
- Name
lastRefreshedAt
- Type
- string
- Description
- the last refreshed at timestamp
- Name
sums
- Type
- object
- Description
- Name
total
- Type
- number
- Description
- the total number of records
4xx
Response
- Name
code
- Type
- string
- Description
- The error code
- Name
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
data
- Type
- object
- Description
- An optional object containing relevant error data
- 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
curl https://api.shopmonkey.cloud/v3/location/:id/payment_method \
-H "Authorization: Bearer ${SM_TOKEN}"
Example Responseapplication/json
{
"data": [
{
"id": "id",
"name": null,
"provider": null,
"scope": [
"scope"
],
"state": "state",
"type": "type"
}
],
"success": true
}
Find Location Image
Find the image for a Location
URL parameters
- Name
id
- Type
- string Required
- Description
- the id of the location
Query String parameters
- Name
inline
- Type
- boolean
- Description
- if true, the image will be returned inline
- Name
transform
- Type
- string
- Description
- an optional transformation to apply to the blob
200
Response
the content of the uploaded blob based on its contentType
Example Request
curl https://api.shopmonkey.cloud/v3/location/:id/image \
-H "Authorization: Bearer ${SM_TOKEN}"