Update a store department

curl --request PATCH \
  --url https://api.vori.com/v1/store-departments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deactivated_at": "2023-11-07T05:31:56Z",
  "exclude_from_sales_reporting": true,
  "name": "<string>",
  "parent_department_id": "<string>"
}
'

import requests

url = "https://api.vori.com/v1/store-departments/{id}"

payload = {
    "deactivated_at": "2023-11-07T05:31:56Z",
    "exclude_from_sales_reporting": True,
    "name": "<string>",
    "parent_department_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deactivated_at: '2023-11-07T05:31:56Z',
    exclude_from_sales_reporting: true,
    name: '<string>',
    parent_department_id: '<string>'
  })
};

fetch('https://api.vori.com/v1/store-departments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vori.com/v1/store-departments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'deactivated_at' => '2023-11-07T05:31:56Z',
    'exclude_from_sales_reporting' => true,
    'name' => '<string>',
    'parent_department_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vori.com/v1/store-departments/{id}"

	payload := strings.NewReader("{\n  \"deactivated_at\": \"2023-11-07T05:31:56Z\",\n  \"exclude_from_sales_reporting\": true,\n  \"name\": \"<string>\",\n  \"parent_department_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.vori.com/v1/store-departments/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deactivated_at\": \"2023-11-07T05:31:56Z\",\n  \"exclude_from_sales_reporting\": true,\n  \"name\": \"<string>\",\n  \"parent_department_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vori.com/v1/store-departments/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deactivated_at\": \"2023-11-07T05:31:56Z\",\n  \"exclude_from_sales_reporting\": true,\n  \"name\": \"<string>\",\n  \"parent_department_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "deactivated_at": "2023-11-07T05:31:56Z",
  "exclude_from_sales_reporting": true,
  "name": "<string>",
  "parent_department_id": "<string>"
}

{
  "error_code": "invalid_parent_department"
}

{
  "error_code": "insufficient_permissions",
  "error_details": {}
}

PATCH

store-departments

{id}

Update a store department

curl --request PATCH \
  --url https://api.vori.com/v1/store-departments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deactivated_at": "2023-11-07T05:31:56Z",
  "exclude_from_sales_reporting": true,
  "name": "<string>",
  "parent_department_id": "<string>"
}
'

import requests

url = "https://api.vori.com/v1/store-departments/{id}"

payload = {
    "deactivated_at": "2023-11-07T05:31:56Z",
    "exclude_from_sales_reporting": True,
    "name": "<string>",
    "parent_department_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deactivated_at: '2023-11-07T05:31:56Z',
    exclude_from_sales_reporting: true,
    name: '<string>',
    parent_department_id: '<string>'
  })
};

fetch('https://api.vori.com/v1/store-departments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vori.com/v1/store-departments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'deactivated_at' => '2023-11-07T05:31:56Z',
    'exclude_from_sales_reporting' => true,
    'name' => '<string>',
    'parent_department_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vori.com/v1/store-departments/{id}"

	payload := strings.NewReader("{\n  \"deactivated_at\": \"2023-11-07T05:31:56Z\",\n  \"exclude_from_sales_reporting\": true,\n  \"name\": \"<string>\",\n  \"parent_department_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.vori.com/v1/store-departments/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deactivated_at\": \"2023-11-07T05:31:56Z\",\n  \"exclude_from_sales_reporting\": true,\n  \"name\": \"<string>\",\n  \"parent_department_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vori.com/v1/store-departments/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deactivated_at\": \"2023-11-07T05:31:56Z\",\n  \"exclude_from_sales_reporting\": true,\n  \"name\": \"<string>\",\n  \"parent_department_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "deactivated_at": "2023-11-07T05:31:56Z",
  "exclude_from_sales_reporting": true,
  "name": "<string>",
  "parent_department_id": "<string>"
}

{
  "error_code": "invalid_parent_department"
}

{
  "error_code": "insufficient_permissions",
  "error_details": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Pattern: ^[0-9]+$

Body

application/json

deactivated_at

string<date-time> | null

When the department was deactivated. Null means active, so setting it reactivates the department.

exclude_from_sales_reporting

boolean

Whether sales from this department are omitted from sales reporting.

name

string

Human-readable department name.

parent_department_id

string | null

ID of the parent department, or null for a top-level department. A parent must itself be top-level: departments nest one level deep.

Pattern: ^[0-9]+$

Response

A grouping of products within a store, optionally nested under a parent department.

string

required

Unique identifier for the store department.

deactivated_at

string<date-time> | null

required

When the department was deactivated, or null when it is active.

exclude_from_sales_reporting

boolean

required

Whether sales from this department are omitted from sales reporting.

name

string

required

Human-readable department name.

parent_department_id

string | null

required

ID of the parent department, or null for a top-level department.