Skip to main content
GET
/
v1
/
products
/
barcode
/
{barcode}
Get product by barcode
curl --request GET \
  --url http://localhost:3000/v1/products/barcode/{barcode}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "taxonomy_id": "<string>",
  "name": "<string>",
  "brand": "<string>",
  "image_url": "<string>",
  "size": "<string>",
  "barcode": "<string>",
  "sellable_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "selling_price": 123,
  "is_active": true,
  "is_rfc_item": true,
  "has_inventory_history": true,
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subcategory_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rfc_location": {
    "slot_id": "<string>",
    "location_code": "<string>",
    "aisle": 123,
    "bay": 123,
    "shelf": 123,
    "slot": 123
  },
  "on_hand": 123,
  "reserved": 123,
  "in_sweep": 123,
  "inventory_events": [
    {
      "id": "<string>",
      "type": "sweep",
      "reference": "<string>",
      "quantity": 123,
      "date": "<string>"
    }
  ],
  "availability": [
    {
      "id": "<string>",
      "source_type": "rfc",
      "name": "<string>",
      "unit_price": 123,
      "is_in_stock": true,
      "retailer_name": "<string>",
      "updated_at": "<string>",
      "stock_quantity": 123,
      "location_name": "<string>"
    }
  ]
}

Path Parameters

barcode
string
required

Product barcode

Minimum string length: 1

Response

Product details

id
string<uuid>
required
taxonomy_id
string | null
required
name
string
required
brand
string | null
required
image_url
string | null
required
size
string | null
required
barcode
string
required
sellable_product_id
string<uuid> | null
required
selling_price
number | null
required
is_active
boolean | null
required
is_rfc_item
boolean
required
has_inventory_history
boolean
required
category_id
string<uuid> | null
required
subcategory_id
string<uuid> | null
required
rfc_location
object
required
on_hand
number
required
reserved
number
required
in_sweep
number
required
inventory_events
object[]
required
availability
object[]
required