Lookup Products
GET/api/v2/products/lookup
Lightweight paginated product lookup that returns only core identifying fields (id, sku, name, barcode, type, unit_cost, price, image_url) — much faster than the full List Products endpoint when you only need to resolve products by SKU, name, barcode, or id.
products:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
When a search term is given, results are ranked exact-SKU match first, SKU prefix match second, then everything else; within each rank results are ordered by SKU. A fully-numeric term additionally matches the product id directly. Without a search term, all products are returned ordered by SKU.
Archived products are excluded unless include_archived=true. Pass sellable_only=true to exclude non-sellable products (e.g. internal consumables).
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.