Barcodes - API Documentation

Retrieve all

Endpoint

GET https://sqr.co/api/barcodes/

Example

curl --request GET \
--url 'https://sqr.co/api/barcodes/' \
--header 'Authorization: Bearer {api_key}' \

Parameters	Details	Description
page	Optional Integer	The page number that you want results from. Defaults to `1`.
results_per_page	Optional Integer	How many results you want per page. Allowed values are: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Defaults to `25`.

Response example

{ "data": [ { "id": 1, "type": "C32", "name": "Example name", "value": "123456", "barcode": "https://sqr.co/uploads/barcode/example.svg", "settings": { "foreground_color": "#000000", "width_scale": 2, "height": 50, }, "embedded_data": "123456", "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" }, ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://sqr.co/api/barcodes?&page=1", "last": "https://sqr.co/api/barcodes?&page=1", "next": null, "prev": null, "self": "https://sqr.co/api/barcodes?&page=1" } }

Retrieve one

Endpoint

GET https://sqr.co/api/barcodes/{barcode_id}

Example

curl --request GET \
--url 'https://sqr.co/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \

Response example

{ "data": { "id": 1, "type": "C32", "name": "Example name", "value": "123456", "barcode": "https://sqr.co/uploads/barcode/example.svg", "settings": { "foreground_color": "#000000", "width_scale": 2, "height": 50, }, "embedded_data": "123456", "last_datetime": "2021-10-31 09:47:25", "datetime": "2021-10-29 16:32:25" } }

Create

Endpoint

POST https://sqr.co/api/barcodes

Parameters	Details	Description
project_id	Optional Integer	-
name	Required String	-
type	Required String	Allowed values: `C32`, `C39`, `C39+`, `C39E`, `C39E+`, `C93`, `S25`, `S25+`, `I25`, `I25+`, `ITF14`, `C128`, `C128A`, `C128B`, `C128C`, `EAN2`, `EAN5`, `EAN8`, `EAN13`, `UPCA`, `UPCE`, `MSI`, `MSI+`, `POSTNET`, `PLANET`, `TELEPENALPHA`, `TELEPENNUMERIC`, `RMS4CC`, `KIX`, `IMB`, `CODABAR`, `CODE11`, `PHARMA`, `PHARMA2T`
is_bulk	Optional Boolean
value	Required String	-
foreground_color	Optional String	-
width_scale	Optional Integer	1-10
height	Optional Integer	30-1000

Parameters	Details	Description

Example

curl --request POST \
--url 'https://sqr.co/api/barcodes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \

Response example

{ "data": { "id": 1 } }

Update

Endpoint

POST https://sqr.co/api/barcodes/{barcode_id}

Parameters	Details	Description
project_id	Optional String	-
name	Optional String	-
type	Optional String	Allowed values: `C32`, `C39`, `C39+`, `C39E`, `C39E+`, `C93`, `S25`, `S25+`, `I25`, `I25+`, `ITF14`, `C128`, `C128A`, `C128B`, `C128C`, `EAN2`, `EAN5`, `EAN8`, `EAN13`, `UPCA`, `UPCE`, `MSI`, `MSI+`, `POSTNET`, `PLANET`, `TELEPENALPHA`, `TELEPENNUMERIC`, `RMS4CC`, `KIX`, `IMB`, `CODABAR`, `CODE11`, `PHARMA`, `PHARMA2T`
value	Required String	-
foreground_color	Optional String	-
width_scale	Optional Integer	1-10
height	Optional Integer	30-1000

Example

curl --request POST \
--url 'https://sqr.co/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \

Response example

{ "data": { "id": 1 } }

Delete

Endpoint

DELETE https://sqr.co/api/barcodes/{barcode_id}

Example

curl --request DELETE \
--url 'https://sqr.co/api/barcodes/{barcode_id}' \
--header 'Authorization: Bearer {api_key}' \