Shop(Store)

Create shop

Creates a new store.

• POST
• /orgstruct/shops

Request body:

Attribute	Type	Description	Nullable
externalId	String	Shop external id	true
active	Boolean	Whether the shop is active	false
regionId	Integer	Id of the region in which the store is located	false
regionExternalId	String	External id of the region in which the store is located	true
addrRegOffice	String	Address of the region in which the store is located	true
sap	String	Unique store number	false
address	String	Store address	false
locality	String	Name of store	false
city	String	The city where the store is located	false
latitude	Double	Latitude of store	false
longitude	Double	Longitude of store	false
timeZoneId	String	Id of the time zone in which the store is located (format like America/Los_Angeles)	false
statusId	Integer	Status Id of the shop	true
email	String	Email of the shop	true
telegramChatId	String	TelegramChat Id of the shop	true

Response

Returns Store object

Examples

curl --request POST https://api.qvalon.com/v1/orgstruct/shops \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"locality":"Store 01","sap":"NVG01","active":true,"address":"5th Avenue, 100","city":"Portland","regionId":86,"latitude":45.51223,"longitude":-122.658722,"timeZoneId":"America/Los_Angeles"}'

200 OK

{

"id": 669,

"active": true,

"sap": "NVG01",

"locality": "Store 01",

"address": "5th Avenue, 100",

"city": "Portland",

"latitude": 45.51223,

"longitude": -122.658722,

"regionId": 86,

"clusterId": 86,

"timeZoneId": "America/Los_Angeles"

}

Update shop

Updates an existing store by id.

• PUT
• /orgstruct/shops/{id}

Request body:

Attribute	Type	Description	Nullable
externalId	String	Shop external id	true
active	Boolean	Whether the shop is active	false
regionId	Integer	Id of the region in which the store is located	false
regionExternalId	String	External id of the region in which the store is located	true
addrRegOffice	String	Address of the region in which the store is located	true
sap	String	Unique store number	false
address	String	Store address	false
locality	String	Name of store	false
city	String	The city where the store is located	false
latitude	Double	Latitude of store	false
longitude	Double	Longitude of store	false
timeZoneId	String	Id of the time zone in which the store is located (format like America/Los_Angeles)	false
statusId	Integer	Status Id of the shop	true
email	String	Email of the shop	true
telegramChatId	String	TelegramChat Id of the shop	true

Response

Returns Store object

Examples

curl --request PUT https://api.qvalon.com/v1/orgstruct/shops/669 \

--header 'Authorization: Bearer <your_token>' \

--header 'Content-Type: application/json' \

-d '{"active":true,"sap":"NVG01","locality":"Store 01","address":"5th Avenue, 100, Suite 2","city":"Portland","latitude":45.51223,"longitude":-122.658722,"regionId":86,"timeZoneId":"America/Los_Angeles"}'

200 OK

{

"active": true,

"sap": "NVG01",

"locality": "Store 01",

"address": "5th Avenue, 100, Suite 2",

"city": "Portland",

"latitude": 45.51223,

"longitude": -122.658722,

"regionId": 86,

"timeZoneId": "America/Los_Angeles"

}

List shops

Returns a list of Shop objects

Available fields to add in object see here

• GET
• /orgstruct/shops

Request parameters:

Request Parameter	Type	Description	Required
fields	List of String (comma-separated)	Additional shop fields to include in the response object, e.g. dir. Default: dir	false
active	Boolean	Return only active shops	false
ids	List of integers	Find shops by ids	false
region	List of integers	Find shops by region ids	false
division	List of integers	Find shops by division ids	false
sapLike	String	Find shops by SAP(store number) like	false
localityLike	String	Find shops by name like	false
cityLike	String	Find shops by city like	false
addressLike	String	Find shops by address like	false
searchString	String	Find shop by sap, name or division name or region name or city or address or manager of shop first or last name	false
status	Integer	Find shops by status	false
director	Boolean	Get shops where appointed are manager	false
allDay	Boolean	Get convenience (24-hour) shops	false

Examples

curl https://api.qvalon.com/v1/orgstruct/shops \

--header 'Authorization: Bearer <your_token>'

200 OK

[

{

"id": 669,

"active": true,

"sap": "NVG01",

"locality": "Store 01",

"address": "5th Avenue, 100, Suite 2",

"city": "Portland",

"latitude": 45.51223,

"longitude": -122.658722,

"regionId": 86,

"timeZoneId": "America/Los_Angeles"

}

]

Get shop by id

Returns a Shop object

Available fields to add in object see here

• GET
• /orgstruct/shops/{id}

Request parameters:

Request Parameter	Type	Description	Required
fields	List of String (comma-separated)	Additional shop fields to include in the response object, e.g. dir. Unlike List shops, none are included by default here — you must request them explicitly	false

Examples

curl https://api.qvalon.com/v1/orgstruct/shops/669 \

--header 'Authorization: Bearer <your_token>'

200 OK

{

"id": 669,

"active": true,

"sap": "NVG01",

"locality": "Store 01",

"address": "5th Avenue, 100, Suite 2",

"city": "Portland",

"latitude": 45.51223,

"longitude": -122.658722,

"regionId": 86,

"timeZoneId": "America/Los_Angeles"

}