curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"code": "<string>",
"matches": [
{
"type": "product",
"id": 123,
"product_id": 123,
"sku": "<string>",
"name": "<string>",
"matched_by": "sku",
"units_per_scan": 123,
"lot_tracked": true,
"image_url": "<string>",
"location_id": 123,
"warehouse_id": 123,
"warehouse_name": "<string>",
"lot_id": 123,
"lot_number": "<string>",
"expiry_date": "2023-12-25",
"order_number": "<string>",
"status": "<unknown>",
"picking_status": null,
"picklist_id": 123,
"pallet_id": "<string>",
"run_id": 123,
"receiving_report_id": 123,
"reference": "<string>",
"sequence": 123,
"total": 123,
"contents": [
{
"product_id": 123,
"sku": "<string>",
"name": "<string>",
"quantity": 123
}
]
}
]
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}{
"message": "<string>",
"errors": {}
}Resolve a scanned barcode
Returns every record a scanned code could refer to, rather than the first match, so the client can choose based on what the operator is doing (a code that is both a SKU and a bin name is the destination when moving stock, and the product when looking it up).
Match types (up to 10 per type): active products by SKU, UPC, or alternate SKU (alternate SKUs report the unit-conversion factor as units_per_scan); bins by exact name (scoped to warehouse_id when given, since bin names are only unique per warehouse); lots by lot number; purchase orders by alternate order number or PO-{id}; transfer orders by order number or TO-{id}; return orders and sales orders by order number; picklists by PL-{id}; pallets by the pallet ID printed on a Pallet ID label run (looked up only when the code is an 18-digit SSCC, a 20-digit GS1-128 read with the leading 00 application identifier, or RR{receiving report id}-P{nn}). An empty matches array means nothing matched.
curl --request GET \
--url https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve \
--header 'Authorization: Bearer <token>'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/pickflow/scan/resolve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"code": "<string>",
"matches": [
{
"type": "product",
"id": 123,
"product_id": 123,
"sku": "<string>",
"name": "<string>",
"matched_by": "sku",
"units_per_scan": 123,
"lot_tracked": true,
"image_url": "<string>",
"location_id": 123,
"warehouse_id": 123,
"warehouse_name": "<string>",
"lot_id": 123,
"lot_number": "<string>",
"expiry_date": "2023-12-25",
"order_number": "<string>",
"status": "<unknown>",
"picking_status": null,
"picklist_id": 123,
"pallet_id": "<string>",
"run_id": 123,
"receiving_report_id": 123,
"reference": "<string>",
"sequence": 123,
"total": 123,
"contents": [
{
"product_id": 123,
"sku": "<string>",
"name": "<string>",
"quantity": 123
}
]
}
]
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}{
"message": "<string>",
"errors": {}
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Query Parameters
The scanned value.
255Extra product-code candidates to try for product matches only (e.g. the 12/13/14-digit forms of a GS1 GTIN). code is always included.
5255Scope bin matches to this warehouse.