# /energystar/upcs/search

`POST /api/energystar/upcs/search`

Price: 5 credits

Resolve retail barcodes against the ENERGY STAR register, in either direction: give a UPC to find the certified model it belongs to, or give an ENERGY STAR product id to list every barcode registered for that model. Each row carries the product id, the barcode, the brand, model name and number, the programme category and sub-type, and whether the model meets the Most Efficient criteria.

## How to use it

This is the bridge from a retail barcode to the certification record: resolve the UPC here, then pass the `pd_id` to energystar/products for the measured performance figures, which this endpoint does not carry. The relation is one model to many barcodes — a single product id can have hundreds, one per pack size, colour or regional SKU — so a pd_id lookup returns a list and `count` matters. Barcode coverage is partial: many certified models have no barcode registered at all, so a 412 here means the barcode is not in the register rather than that the model is uncertified.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `upc` (string, nullable) — Barcode to resolve to the certified model it belongs to (examples: "84691815884", "8690842762512"; minLength: 1)
- `pd_id` (string, nullable) — ENERGY STAR product id whose registered barcodes to list (examples: "4015867", "1906850"; minLength: 1)
- `count` (integer, required) — Max number of results to return (min: 1; max: 5000)

## Response

### 200 — Successful Response

- `@type` (string) (default: "EnergystarUpc")
- `id` (string, required)
- `pd_id` (string, required)
- `upc` (string, required)
- `brand` (string, nullable)
- `model_name` (string, nullable)
- `model_number` (string, nullable)
- `energy_star_model_identifier` (string, nullable)
- `product_type` (string, nullable)
- `product_program_category` (string, nullable)
- `is_most_efficient` (boolean, nullable)

## Errors

### 422 — Validation Error

Neither upc nor pd_id was given.

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

Neither that barcode nor that product id has a registered barcode row.

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.