Skip to main content

API overview

The Validades API lets your organization's systems read and change Validades data: products, batches, categories, brands and stores. For example, you can:

  • create products and batches automatically from your ERP or inventory system;
  • fetch the batches that expire in the next few days to build your own reports or alerts;
  • keep another system in sync with Validades, receiving only what changed.

Everything done through the API shows up in the app and on the website, synced to every device of the organization, as if a member had entered it.

Who can use it​

The API is available to organizations with an active subscription. Personal accounts and workspaces have no access.

Access is enabled manually by our team:

  1. The owner or an admin of the organization requests access at validades.com → Team → API, accepting the API Terms of Use.
  2. Our team reviews the request, and you get an email when it is approved.
  3. Once the API is enabled, the owner or an admin creates API keys in the same panel.

The full walkthrough is in Getting started.

Base URL and version​

Base URLhttps://api.validades.com
Current versionv1 (every route starts with /v1)
OpenAPI specificationhttps://api.validades.com/v1/openapi.json
Response formatJSON (default) or XML
Request body formatJSON

The OpenAPI 3.1 specification describes every route, parameter and response. You can import it into Postman, Insomnia, Bruno or code generators.

Resources​

ResourceReadCreateUpdateDeletePage
Products✓✓✓✓Products
Batches✓✓✓✓Batches
Categories and brands✓✓✓✓Categories and brands
Stores✓✓✓✓Stores
Deletions✓Deletions
Your key✓Account (/v1/me)

How the API works, in short​

  • Authentication: every request carries the key in the Authorization: Bearer vld_live_... header. See Authentication.
  • Limits: 60 requests per minute per key, 120 per organization and 50,000 per month. See Limits and quota.
  • Cursor-paginated lists, with an updated_since filter to fetch only what changed. See Pagination and sync.
  • Errors always in the same format, with a stable code. See Errors.
  • Requests that are safe to retry with Idempotency-Key, and protection against overwriting changes with If-Match. See Concurrency and idempotency.
Use the key on your server only

The key gives access to your organization's data. Never put it in apps, websites, browser extensions or any code that runs on other people's devices. That is why the API does not accept calls made directly from a browser (there is no CORS).