GET /v1/ecommerce/products/find

GET

ecommerce

products

find

Buscar un producto por SKU, código de barras o texto

curl --request GET \
  --url https://api.keebai.com/v1/ecommerce/products/find \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.keebai.com/v1/ecommerce/products/find', 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://api.keebai.com/v1/ecommerce/products/find",
  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://api.keebai.com/v1/ecommerce/products/find"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.keebai.com/v1/ecommerce/products/find")

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

{
  "match": "exact",
  "items": [
    {
      "product_id": "<string>",
      "variant_id": "<string>",
      "name": "<string>",
      "variant_name": "<string>",
      "sku": "<string>",
      "barcode": "<string>",
      "price": 123,
      "stock_total": 123
    }
  ]
}

Resolves what a cashier scans or types into the product and variant it belongs to. An exact SKU or barcode returns those matches; anything else runs a text search over the catalog. This is the lookup to run before adjusting stock or creating a sale, since both take a product_id and, on products with variants, a variant_id.

Endpoint

GET https://api.keebai.com/v1/ecommerce/products/find

Required scope

ecommerce:products:read

Headers

Header	Required	Value
`Authorization`	Yes	`Bearer kbai_pk_<token>`

Query parameters

Field	Type	Required	Description
`query`	`string`	Yes	SKU, barcode, or free text.
`limit`	`integer`	No	Maximum number of items, `1`–`50`. Defaults to 10.

Example request

curl -G https://api.keebai.com/v1/ecommerce/products/find \
  -H "Authorization: Bearer kbai_pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  --data-urlencode "query=7801234567890"

const params = new URLSearchParams({ query: "7801234567890" });

const response = await fetch(
  `https://api.keebai.com/v1/ecommerce/products/find?${params}`,
  { headers: { Authorization: `Bearer ${process.env.KEEBAI_API_TOKEN}` } },
);
const { match, items } = await response.json();

import os, requests

resp = requests.get(
    "https://api.keebai.com/v1/ecommerce/products/find",
    headers={"Authorization": f"Bearer {os.environ['KEEBAI_API_TOKEN']}"},
    params={"query": "7801234567890"},
    timeout=10,
)
resp.raise_for_status()
result = resp.json()

Response

200 OK

{
  "match": "exact",
  "items": [
    {
      "product_id": "65d3e4f5a6b7c8d9e0f1a2b3",
      "variant_id": "65d3e4f5a6b7c8d9e0f1a2c1",
      "name": "Zapatilla Runner Pro",
      "variant_name": "42 / Negro",
      "sku": "RUN-PRO-42-NEG",
      "barcode": "7801234567890",
      "price": 59990,
      "stock_total": 12
    }
  ]
}

Field	Type	Description
`match`	`string`	`exact` when `query` matched a SKU or barcode exactly; `search` when the result comes from a text search.
`items[].product_id`	`string`	`ObjectId` of the product.
`items[].variant_id`	`string`	`ObjectId` of the variant, when the match is a variant.
`items[].name`	`string`	Product name.
`items[].variant_name`	`string`	Variant name, when the match is a variant.
`items[].sku`	`string`	SKU.
`items[].barcode`	`string \| null`	Barcode of the variant. `null` on a product-level item, since barcodes live on variants.
`items[].price`	`number`	Price.
`items[].stock_total`	`number`	Master stock. See `GET /v1/ecommerce/products/{id}/stock` for the split by branch.

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the ecommerce:products:read scope.

502 Bad Gateway

ECOMMERCE_UPSTREAM_ERROR — the ecommerce service could not answer.

Operational notes

SKU and barcode match loosely. Case and spaces are ignored, so run-pro-42-neg finds RUN-PRO-42-NEG.
Branch on match. With exact you can act on the item directly. With search, the items are candidates: show them to a person, or pick one only when there is a single clear result.

Authorizations

Authorization

string

header

required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Query Parameters

query

string

required

Texto a buscar. Si coincide exacto con el SKU o el código de barras de un producto o variante, se devuelven solo esas coincidencias

Example:

"7801234567890"

limit

number

default:10

Required range: 1 <= x <= 50

Response

200 - application/json

match

enum<string>

required

Available options:

exact,

search

items

object[]

required

Show child attributes

Buscar un producto por SKU, código de barras o texto

curl --request GET \
  --url https://api.keebai.com/v1/ecommerce/products/find \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.keebai.com/v1/ecommerce/products/find', 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://api.keebai.com/v1/ecommerce/products/find",
  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://api.keebai.com/v1/ecommerce/products/find"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.keebai.com/v1/ecommerce/products/find")

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

{
  "match": "exact",
  "items": [
    {
      "product_id": "<string>",
      "variant_id": "<string>",
      "name": "<string>",
      "variant_name": "<string>",
      "sku": "<string>",
      "barcode": "<string>",
      "price": 123,
      "stock_total": 123
    }
  ]
}

Get started

Products

Inventory

Carts

Sales

Electronic invoicing

GET /v1/ecommerce/products/find

Endpoint

Required scope

Headers

Query parameters

Example request

Response

200 OK

401 Unauthorized

403 Forbidden

502 Bad Gateway

Operational notes

Authorizations

Query Parameters

Response

​Endpoint

​Required scope

​Headers

​Query parameters

​Example request

​Response

​200 OK

​401 Unauthorized

​403 Forbidden

​502 Bad Gateway

​Operational notes

Authorizations

Query Parameters

Response

Endpoint

Required scope

Headers

Query parameters

Example request

Response

200 OK

401 Unauthorized

403 Forbidden

502 Bad Gateway

Operational notes