Region

Create region#

Creates a new region.

POST
/orgstruct/regions

Request body:

Attribute	Type	Description	Nullable
externalId	String	Region external id	true
name	String	Region name	false
divisionId	Integer	Identifier of the division the region belongs to	false
active	Boolean	Whether the region is active	false
divisionExternalId	String	External id of the division the region belongs to, alternative to divisionId	true

Response

Returns Region object

Examples

curl --request POST https://api.qvalon.com/v1/orgstruct/regions \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json' \
-d '{"name":"Test region","divisionId":28,"active":true}'

200 OK

{
  "id": 66,
  "name": "Test region",
  "divisionId": 28,
  "shopsCount": 0,
  "active": true
}

Update region#

Updates an existing region by id.

PUT
/orgstruct/regions/{id}

Request body:

Attribute	Type	Description	Nullable
externalId	String	Region external id	true
name	String	Region name	false
divisionId	Integer	Identifier of the division the region belongs to	true
active	Boolean	Whether the region is active	false
divisionExternalId	String	External id of the division the region belongs to, alternative to divisionId	true

Response

Returns Region object

Examples

curl --request PUT https://api.qvalon.com/v1/orgstruct/regions/66 \
--header 'Authorization: Bearer <your_token>' \
--header 'Content-Type: application/json' \
-d '{"name":"Test region update","divisionId":28,"active":true}'

200 OK

{
  "id": 66,
  "name": "Test region update",
  "divisionId": 28,
  "active": true,
  "shopsCount": 0
}

List regions#

Returns a list of Region objects

Available fields to add in object see here

GET
/orgstruct/regions

Request parameters:

Request Parameter	Type	Description	Required
ids	List of integers	Filter regions by specified ids (comma-separated)	false
nameLike	String	Find regions by name	false
shopIds	List of integers	Find regions by shop ids	false
divisionIds	List of integers	Find regions by division ids	false
businessDirIds	List of integers	Find regions by business direction ids	false
active	Boolean	Get only active regions	false
fields	List of String (comma-separated)	Additional region fields to include in the response object. Available values: `dirs, division, shops`. Default: `dirs, division`	false
userId	Integer	Find regions by user Id	false
businessDirId	Integer	Find regions by businessDir Id	false
shopId	Integer	Find regions by shop Id	false
searchString	String	Find regions by name or division name or manager of regions first or last name	false
withDirs	Boolean	Deprecated, use `fields=dirs` instead. Get regions where appointed are manager	false

Examples

curl https://api.qvalon.com/v1/orgstruct/regions \
--header 'Authorization: Bearer <your_token>'

200 OK

[
  {
    "id": 66,
    "name": "Test region",
    "divisionId": 28,
    "active": true,
    "divisionName": "Division 1",
    "shopsCount": 8,
    "division": {
      "id": 28,
      "name": "Division 1",
      "active": true,
      "regionsCount": 6,
      "shopsCount": 51
    },
    "dirs": [
      {
        "id": 1697,
        "active": true,
        "login": "samplemail@example.com",
        "firstName": "Elena",
        "lastName": "Savina",
        "position": "Region manager",
        "level": "REGION",
        "businessDirId": 1001,
        "lang": "en_EN",
        "invited": false
      }
    ]
  }
]

Get region by id#

Returns a Region object. Unlike List regions, this endpoint doesn't accept a fields parameter — the relations (dirs, division, shops) are never included.

GET
/orgstruct/regions/{id}

Examples

curl https://api.qvalon.com/v1/orgstruct/regions/66 \
--header 'Authorization: Bearer <your_token>'

200 OK

{
  "id": 66,
  "name": "Test region",
  "divisionId": 28,
  "active": true,
  "shopsCount": 8
}