Inventory - Increase On Hand

Increase the on-hand inventory quantity for an item at a specific warehouse.

PUT /inventory/increase_on_hand

Inventory - Increase On Hand

cURL

curl --request PUT \
  --url https://api.skulabs.com/inventory/increase_on_hand \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_id": "<string>",
  "item_id": "<string>",
  "amount": 123,
  "notes": "<string>",
  "no_invalidate": true,
  "lock_key": "<string>",
  "alert": 123
}
'

import requests

url = "https://api.skulabs.com/inventory/increase_on_hand"

payload = {
    "location_id": "<string>",
    "item_id": "<string>",
    "amount": 123,
    "notes": "<string>",
    "no_invalidate": True,
    "lock_key": "<string>",
    "alert": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    location_id: '<string>',
    item_id: '<string>',
    amount: 123,
    notes: '<string>',
    no_invalidate: true,
    lock_key: '<string>',
    alert: 123
  })
};

fetch('https://api.skulabs.com/inventory/increase_on_hand', 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.skulabs.com/inventory/increase_on_hand",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'location_id' => '<string>',
    'item_id' => '<string>',
    'amount' => 123,
    'notes' => '<string>',
    'no_invalidate' => true,
    'lock_key' => '<string>',
    'alert' => 123
  ]),
  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.skulabs.com/inventory/increase_on_hand"

	payload := strings.NewReader("{\n  \"location_id\": \"<string>\",\n  \"item_id\": \"<string>\",\n  \"amount\": 123,\n  \"notes\": \"<string>\",\n  \"no_invalidate\": true,\n  \"lock_key\": \"<string>\",\n  \"alert\": 123\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.skulabs.com/inventory/increase_on_hand")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"location_id\": \"<string>\",\n  \"item_id\": \"<string>\",\n  \"amount\": 123,\n  \"notes\": \"<string>\",\n  \"no_invalidate\": true,\n  \"lock_key\": \"<string>\",\n  \"alert\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skulabs.com/inventory/increase_on_hand")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"location_id\": \"<string>\",\n  \"item_id\": \"<string>\",\n  \"amount\": 123,\n  \"notes\": \"<string>\",\n  \"no_invalidate\": true,\n  \"lock_key\": \"<string>\",\n  \"alert\": 123\n}"

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

200

{
  "success": true
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

location_id · string · required

Location ID

item_id · string · required

Item ID

amount · number · required

Amount to increase by

notes · string

Notes for the change

no_invalidate · boolean

Skip cache invalidation

lock_key · string

Lock key for concurrent operations

alert · number

Set alert threshold

Response

200

application/json

On-hand increased

success · boolean · required

Whether the operation succeeded