Files
dashback/docs/api/routes/pos/cimage.md
2026-10-24 05:13:13 +02:00

1022 B

GET /v1/cimage

Protected. Requires a valid session cookie (credentials: 'include').

POS category image delivery

Returns category image by hash (path query param) scaled to preview size (padded to 1:1 with adaptive aspect-ratio borders: thinner borders for vertical images, wider borders for horizontal images).

Query parameters

Param Required Type Description
path yes string SHA-256 hash of the category image
size no integer Max dimension (width & height)
w no integer Max width
h no integer Max height
format no string Optional target format (defaults to jpeg/png or client Accept preference)

Response 200

Resized image binary

Errors

Status Description
304 Image not modified
400 Missing required query parameter 'path'
404 Image not found

Generated from @openapi JSDoc. Do not edit by hand — run npm run docs:api.