Skip to main content
POST
/
v1
/
inventory
/
scan
Scan inventory
curl --request POST \
  --url http://localhost:3000/v1/inventory/scan \
  --header 'Content-Type: application/json' \
  --data '
{
  "barcode": "<string>",
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quantity": 123,
  "action": "lookup"
}
'
import requests

url = "http://localhost:3000/v1/inventory/scan"

payload = {
"barcode": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 123,
"action": "lookup"
}
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({
barcode: '<string>',
location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 123,
action: 'lookup'
})
};

fetch('http://localhost:3000/v1/inventory/scan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/inventory/scan",
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([
'barcode' => '<string>',
'location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 123,
'action' => 'lookup'
]),
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 := "http://localhost:3000/v1/inventory/scan"

payload := strings.NewReader("{\n \"barcode\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"action\": \"lookup\"\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("http://localhost:3000/v1/inventory/scan")
.header("Content-Type", "application/json")
.body("{\n \"barcode\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"action\": \"lookup\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/inventory/scan")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"barcode\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 123,\n \"action\": \"lookup\"\n}"

response = http.request(request)
puts response.read_body
null
null
{
"error": "<string>",
"message": "<string>"
}
{
"error": "<string>",
"message": "<string>"
}

Body

application/json
barcode
string
required
Minimum string length: 1
location_id
string<uuid>
quantity
number
action
enum<string>
default:lookup
Available options:
lookup,
adjust,
count

Response

Scan result

The response is of type unknown.