Skip to content

Search EAN from Barcode

GET
/v1/products/search-from-barcode
curl --request GET \
--url https://example.com/api/v1/products/search-from-barcode \
--header 'Authorization: <Authorization>'
data
string

Barcode to be searched

OK

Media type application/json
Array<object>
object
barcode
string
imageBase64
string
imageURL
string
item
object
description
string
<= 1000 characters
entityTypeId
string
locationId

LocationID is only needed when ParentID refers to another item and the new entity is stored somewhere other than that item’s location.

string
nullable
manufacturer
string
nullable <= 255 characters
modelNumber

Identifications — optional at create time; populated e.g. by the barcode product-search import flow (#1578).

string
nullable <= 255 characters
name
required
string
>= 1 characters <= 255 characters
parentId
string
nullable
quantity
number
tagIds

Edges

Array<string>
manufacturer
string
modelNumber

Identifications

string
notes

Extras

string
search_engine_name
string
Example generated
[
{
"barcode": "example",
"imageBase64": "example",
"imageURL": "example",
"item": {
"description": "example",
"entityTypeId": "example",
"locationId": "example",
"manufacturer": "example",
"modelNumber": "example",
"name": "example",
"parentId": "example",
"quantity": 1,
"tagIds": [
"example"
]
},
"manufacturer": "example",
"modelNumber": "example",
"notes": "example",
"search_engine_name": "example"
}
]