Inventory - Upsert

Create or update an inventory record for an item at a specific warehouse.

PUT /inventory/upsert

Inventory - Upsert

cURL

curl --request PUT \
  --url https://api.skulabs.com/inventory/upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_name": "<string>",
  "item_id": "<string>",
  "on_hand": 123,
  "alert": 123,
  "notes": "<string>"
}
'

import requests

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

payload = {
    "location_name": "<string>",
    "item_id": "<string>",
    "on_hand": 123,
    "alert": 123,
    "notes": "<string>"
}
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_name: '<string>',
    item_id: '<string>',
    on_hand: 123,
    alert: 123,
    notes: '<string>'
  })
};

fetch('https://api.skulabs.com/inventory/upsert', 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/upsert",
  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_name' => '<string>',
    'item_id' => '<string>',
    'on_hand' => 123,
    'alert' => 123,
    'notes' => '<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.skulabs.com/inventory/upsert"

	payload := strings.NewReader("{\n  \"location_name\": \"<string>\",\n  \"item_id\": \"<string>\",\n  \"on_hand\": 123,\n  \"alert\": 123,\n  \"notes\": \"<string>\"\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/upsert")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"location_name\": \"<string>\",\n  \"item_id\": \"<string>\",\n  \"on_hand\": 123,\n  \"alert\": 123,\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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_name\": \"<string>\",\n  \"item_id\": \"<string>\",\n  \"on_hand\": 123,\n  \"alert\": 123,\n  \"notes\": \"<string>\"\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_name · string · required

Location name to upsert inventory at

item_id · string · required

Item ID

on_hand · number · required

On-hand quantity to set

alert · number

Low-stock alert threshold

notes · string

Notes for the inventory change

Response

200

application/json

Inventory upserted

success · boolean · required

Whether the operation succeeded