Adjust Inventory
curl --request POST \
--url https://api.example.com/api/dashboard/inventory/adjust \
--header 'Content-Type: application/json' \
--data '
{
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_change": 123,
"reason": "<string>",
"note": "<string>"
}
'import requests
url = "https://api.example.com/api/dashboard/inventory/adjust"
payload = {
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_change": 123,
"reason": "<string>",
"note": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
variant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity_change: 123,
reason: '<string>',
note: '<string>'
})
};
fetch('https://api.example.com/api/dashboard/inventory/adjust', 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.example.com/api/dashboard/inventory/adjust",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'variant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity_change' => 123,
'reason' => '<string>',
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/dashboard/inventory/adjust"
payload := strings.NewReader("{\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_change\": 123,\n \"reason\": \"<string>\",\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.example.com/api/dashboard/inventory/adjust")
.header("Content-Type", "application/json")
.body("{\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_change\": 123,\n \"reason\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/dashboard/inventory/adjust")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_change\": 123,\n \"reason\": \"<string>\",\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_change": 123,
"previous_quantity": 123,
"new_quantity": 123,
"reason": "<string>",
"note": "<string>",
"adjusted_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"variant_sku": "<string>",
"product_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Dashboard
Adjust Inventory
Adjust inventory for a variant.
Reasons:
- received: New stock arrived
- sold: Item sold (usually automatic)
- damaged: Write-off damaged goods
- returned: Customer return
- correction: Manual count correction
POST
/
api
/
dashboard
/
inventory
/
adjust
Adjust Inventory
curl --request POST \
--url https://api.example.com/api/dashboard/inventory/adjust \
--header 'Content-Type: application/json' \
--data '
{
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_change": 123,
"reason": "<string>",
"note": "<string>"
}
'import requests
url = "https://api.example.com/api/dashboard/inventory/adjust"
payload = {
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_change": 123,
"reason": "<string>",
"note": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
variant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity_change: 123,
reason: '<string>',
note: '<string>'
})
};
fetch('https://api.example.com/api/dashboard/inventory/adjust', 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.example.com/api/dashboard/inventory/adjust",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'variant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity_change' => 123,
'reason' => '<string>',
'note' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/dashboard/inventory/adjust"
payload := strings.NewReader("{\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_change\": 123,\n \"reason\": \"<string>\",\n \"note\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.example.com/api/dashboard/inventory/adjust")
.header("Content-Type", "application/json")
.body("{\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_change\": 123,\n \"reason\": \"<string>\",\n \"note\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/dashboard/inventory/adjust")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"variant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity_change\": 123,\n \"reason\": \"<string>\",\n \"note\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity_change": 123,
"previous_quantity": 123,
"new_quantity": 123,
"reason": "<string>",
"note": "<string>",
"adjusted_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"variant_sku": "<string>",
"product_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Response
Successful Response
Schema for inventory adjustment in responses.