API referenceProducts
Search products for a picker
Needs a token with the read:products scope (or write:products). Authentication
Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.
GET
Active (not archived) items ranked for picking a line: SKU or GTIN equal, name prefix, name contains, then description matches; items in the given currency first. An empty q lists the most recently updated. Not paged: returns at most limit items.
bearerAuthheader
AuthorizationBearer <token>A personal API token, hvt_…, with scopes such as read:* or write:invoices
q?stringSearch term over name, SKU, GTIN and description.
limit?integerMaximum items.
Range
1 <= value <= 25Default
10currency?stringA three-letter ISO code, e.g. CHF; items in it rank first.
OK
application/json- response
data*array<>curl -X GET 'https://app.helvetly.com/api/v1/products/search'Example Response
{ "data": [ { "id": "string", "type": "product", "name": "string", "description": "string", "sku": "string", "gtin": "string", "unit": "string", "price_basis": "string", "unit_price": "1234.50", "unit_price_net": "1234.50", "unit_price_gross": "1234.50", "currency": "string", "vat_category": "string", "vat_rate": "string", "is_archived": true, "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ]}