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,
  "sweep_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "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>"
  }
}

Body

application/json
barcode
string
required

Barcode to scan

Minimum string length: 1
Example:

12345678901

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