Barcodes API

The Barcodes API allows you to create, manage, and lookup barcodes and QR codes for your products and inventory items. This enables efficient tracking and quick identification using barcode scanners.

What is a Barcode?

A barcode in EquipDash is a unique identifier that can be assigned to:

• Products: Assign a barcode to identify a product type
• Inventory Items: Assign individual barcodes to track specific inventory items

Barcode Types

Type	Value	Description	Best For
QR Code	qr	2D matrix barcode	Most versatile, mobile scanning
Code 128	code128	High-density linear barcode	General purpose
Code 39	code39	Alphanumeric linear barcode	Legacy systems
EAN-13	ean13	13-digit product code	Retail products
EAN-8	ean8	8-digit compact code	Small items
UPC-A	upca	12-digit US/Canada code	Retail products

API Endpoints

Core Operations

Method	Endpoint	Description	Scope Required
GET	/v1/barcodes	List all barcodes	products:read
GET	/v1/barcodes/{id}	Get a single barcode	products:read
PATCH	/v1/barcodes/{id}	Update a barcode	products:write
DELETE	/v1/barcodes/{id}	Delete a barcode	products:write

Lookup & Validation

Method	Endpoint	Description	Scope Required
POST	/v1/barcodes/lookup	Lookup barcode by value	products:read
POST	/v1/barcodes/validate	Validate a barcode value	products:read
GET	/v1/barcodes/types	Get available barcode types	products:read

Create Barcodes

Method	Endpoint	Description	Scope Required
POST	/v1/barcodes/products	Create barcode for a product	products:write
POST	/v1/barcodes/inventory	Create barcode for inventory	products:write
POST	/v1/barcodes/products/auto-generate	Auto-generate for product	products:write
POST	/v1/barcodes/inventory/auto-generate	Auto-generate for inventory	products:write

Bulk Operations

Method	Endpoint	Description	Scope Required
POST	/v1/barcodes/generate-value	Generate a value (without creating)	products:read
POST	/v1/barcodes/bulk-delete	Delete multiple barcodes	products:write

Common Use Cases

Scanning a Barcode

When a barcode is scanned, lookup the product or inventory item:

curl -X POST "https://app.equipdash.com/api/v1/barcodes/lookup" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"barcode_value": "RENT-001-ABC123"}'

Creating a Barcode for a Product

curl -X POST "https://app.equipdash.com/api/v1/barcodes/products" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": 123,
    "barcode_value": "BIKE-MTN-001",
    "barcode_type": "code128"
  }'

Auto-generating Barcodes

Let the system generate a unique barcode value:

curl -X POST "https://app.equipdash.com/api/v1/barcodes/inventory/auto-generate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "inventory_id": 456,
    "barcode_type": "qr"
  }'

Barcode Value Format

Auto-generated barcode values follow this format:

{PREFIX}-{IDENTIFIER}-{UNIQUE_ID}

Where:

• PREFIX: Based on your supplier settings (default: "RENT")
• IDENTIFIER: Short form based on product/inventory
• UNIQUE_ID: Unique alphanumeric string

Example: RENT-001-A7B3C9

Related Resources

• Products - Products can have barcodes
• Inventory - Inventory items can have barcodes
• Workshop - Scan barcodes for workshop operations