Skip to main content
POST
/
v1
/
receiving
/
scan
Scan barcode for receiving
curl --request POST \
  --url http://localhost:3000/v1/receiving/scan \
  --header 'Content-Type: application/json' \
  --data '
{
  "barcode": 12345678901,
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sweep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
import requests

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

payload = {
"barcode": 12345678901,
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sweep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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: 12345678901,
product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sweep_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};

fetch('http://localhost:3000/v1/receiving/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/receiving/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' => 12345678901,
'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sweep_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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/receiving/scan"

payload := strings.NewReader("{\n \"barcode\": 12345678901,\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sweep_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/receiving/scan")
.header("Content-Type", "application/json")
.body("{\n \"barcode\": 12345678901,\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sweep_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"barcode\": 12345678901,\n \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sweep_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "product_name": "<string>",
  "product_image": "<string>",
  "temperature_zone": "<string>",
  "assignments": [
    {
      "sweep_item_id": "<string>",
      "quantity": 123,
      "order_id": "<string>",
      "order_display_id": 123,
      "assignment": {
        "type": "<string>",
        "cart_id": "<string>",
        "cart_type": "<string>",
        "display_id": "<string>",
        "label": "<string>",
        "active_tote": {
          "id": "<string>",
          "display_id": "<string>"
        },
        "requires_tote": true,
        "bag_id": "<string>",
        "bag_code": "<string>",
        "needs_new_bag": true,
        "storage_zone": "<string>",
        "cart_number": "<string>"
      }
    }
  ],
  "sweep_item_id": "<string>",
  "quantity": 123,
  "picked_quantity": 123,
  "order_id": "<string>",
  "order_display_id": 123,
  "assignment": {
    "type": "<string>",
    "cart_id": "<string>",
    "cart_type": "<string>",
    "display_id": "<string>",
    "label": "<string>",
    "active_tote": {
      "id": "<string>",
      "display_id": "<string>"
    },
    "requires_tote": true,
    "bag_id": "<string>",
    "bag_code": "<string>",
    "needs_new_bag": true,
    "storage_zone": "<string>",
    "cart_number": "<string>"
  }
}
{
"error": "<string>"
}

Body

application/json
barcode
string

Barcode to scan (required if product_id not provided)

Minimum string length: 1
Example:

12345678901

product_id
string<uuid>

Scraped product ID to look up directly (required if barcode not provided)

sweep_id
string<uuid>

Optional sweep ID to filter by

Response

Scan result with assignment info

success
boolean
required
product_name
string
required
product_image
string | null
required
temperature_zone
string
required
assignments
object[]
required
sweep_item_id
string
required
quantity
number
required
picked_quantity
number | null
required
order_id
string | null
required
order_display_id
number | null
required
assignment
object
required