---
title: "Scan"
method: GET
path: "/api/inventory/scan"
tags: ["inventory"]
---

# Scan

`GET /api/inventory/scan`

## Request

- Base URL: `https://api.electricair.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.electricair.io/api/inventory/scan`
- Auth: none declared

What a scanned barcode is: a location sticker, a unit's serial, or a pricebook code.

## Query parameters

- `code` string, required

## Response `200`

OK

- ScanResultSchema
  - `kind` 'location' | 'unit' | 'product' | 'unknown', required
  - `code` string, required
  - `location` LocationRefSchema
    - `id` integer, required
    - `code` string, required
    - `name` string, required
    - `path` string, required
    - `kind` string, required
  - `unit` StockUnitSchema
    - `id` integer, required
    - `product_id` integer, required
    - `product_name` string, required
    - `serial_number` string, required
    - `status` string, required
    - `status_label` string, required
    - `location` LocationRefSchema
      - `id` integer, required
      - `code` string, required
      - `name` string, required
      - `path` string, required
      - `kind` string, required
    - `unit_cost` number, nullable
    - `cost_source` string
    - `received_on` string, date, nullable
    - `receipt_reference` string
    - `supplier` string
    - `job` UnitJobSchema
      - `id` integer, required
      - `number` string, required
      - `customer_name` string, required
    - `installed_at` string, date-time, nullable
    - `packed_at` string, date-time, nullable
    - `disposition_reference` string, required
    - `notes` string, required
  - `product` StockProductSchema
    - `id` integer, required
    - `name` string, required
    - `code` string, required
    - `cost` union
      - number
      - string

## Changes

> 22 revisions in range; 1 not diffed.

- **2026-10-31** `1b3bacde7088`: 2 info
  - added the optional property `product/anyOf[subschema #1: StockProductSchema]/cost` to the response with the `200` status
  - added the optional property `unit/anyOf[subschema #1: StockUnitSchema]/cost_source` to the response with the `200` status
- **2026-10-28** `558d42db3b2e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/electricair/apis/electric-air-autoquote-api/changes/api/inventory/scan/get.md)

---

[API](https://skmtc.dev/electricair/apis/electric-air-autoquote-api.md) - [All operations](https://skmtc.dev/electricair/apis/electric-air-autoquote-api/llms.txt) - [OpenAPI document](https://skmtc.dev/electricair/apis/electric-air-autoquote-api/revisions/a13d832a5676?raw)