List Barcodes
Retrieve a paginated list of all barcodes for your supplier account.
Endpointโ
GET /v1/barcodes
Required Scopeโ
products:read
Query Parametersโ
| Parameter | Type | Description |
|---|---|---|
search | string | Filter barcodes by value (partial match) |
entity_type | string | Filter by product or inventory |
barcode_type | string | Filter by barcode type (e.g., qr, code128) |
page | integer | Page number (default: 1) |
per_page | integer | Results per page (1-100, default: 25) |
sort | string | Sort field. Prefix with - for descending |
Sortable Fieldsโ
idbarcode_valuebarcode_typecreated_at(default, descending)
Request Exampleโ
curl "https://app.equipdash.com/api/v1/barcodes?entity_type=inventory&per_page=10" \
-H "Authorization: Bearer YOUR_API_KEY"
Responseโ
{
"data": [
{
"id": 1,
"barcode_value": "RENT-001-A7B3C9",
"barcode_type": "qr",
"barcode_type_label": "QR Code",
"is_auto_generated": true,
"entity_type": "inventory",
"entity_id": 456,
"entity": {
"type": "inventory",
"id": 456,
"identifier": "MTB-001",
"product_id": 123,
"product_name": "Mountain Bike",
"variation_id": null
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
],
"meta": {
"current_page": 1,
"per_page": 10,
"total": 45,
"total_pages": 5,
"request_id": "req_abc123",
"timestamp": "2024-01-15T12:00:00Z"
},
"links": {
"first": "https://app.equipdash.com/api/v1/barcodes?page=1",
"prev": null,
"next": "https://app.equipdash.com/api/v1/barcodes?page=2",
"last": "https://app.equipdash.com/api/v1/barcodes?page=5"
}
}
Response Fieldsโ
| Field | Type | Description |
|---|---|---|
id | integer | Unique barcode ID |
barcode_value | string | The barcode value/data |
barcode_type | string | Type code (e.g., qr, code128) |
barcode_type_label | string | Human-readable type name |
is_auto_generated | boolean | Whether auto-generated by system |
entity_type | string | product or inventory |
entity_id | integer | ID of the associated entity |
entity | object | Details about the associated product/inventory |
created_at | string | ISO 8601 creation timestamp |
updated_at | string | ISO 8601 last update timestamp |