- Category
- API
- Direction
- Read and write
- Version
- REST v2, OpenAPI specification
- Keys
- Up to 10 per organization, rights of your choice
- Languages
- Labels in French, English, Spanish and German
- Authentication
- API key in the Authorization header
- Plans
- Enterprise plan
- Publisher
- Upsellr
01What the API does
Upsellr, from your own tools.
- 01
Create your products in batches
Send up to 100 products per call. Upsellr recognizes them by EAN, SKU, or manufacturer reference and brand: a known product is not duplicated, it gets a new version when a value changes.
- 02
Read your master data
Fields, value lists, categories and templates: what structures your catalog can be read through the API, with labels in your language.
- 03
Upload your supplier files
Drop your spreadsheets and PDFs into the Upsellr file library: up to 10 MiB in one upload, beyond that in several parts.
- 04
Start enrichment and generation
Start a run on a selection, a search or the whole catalog, up to 50,000 products: Lily enriches the master data, Max writes your channels’ pages, or one of your workflows runs.
- 05
Read the generated content
Each product returns its master data, its imported values and its generated content, sorted by channel and language.
- 06
Follow your runs
A run can be followed through the API, or by webhook: completed, failed or stopped, your tool is notified.
02Getting started
Your first request in a few minutes.
- 01
Open the organization settings
API and webhooks section, reserved to owners and admins.
- 02
Create a key
Choose its rights: read-only, read and write, or full access. Add an expiry date and allowed IP addresses if you wish.
- 03
Plug it into your tool
It goes in the Authorization header of every call.
- 04
Call the API from your server
It is not called from a browser: your keys stay server-side.
- 05
Follow your runs
Through the API, or with a webhook that notifies you at the end of each run.
03Resources
What the API can read and write.
| Resource | Read | Write |
|---|---|---|
| Products | Yes | Yes |
| EAN, SKU and manufacturer reference | Yes | Yes |
| Master data values | Yes | Yes |
| Generated content, by channel and language | Yes | No |
| Master data fields and lists | Yes | No |
| Source files | Yes | YesUp to 10 MiB, or in several parts |
| Enrichment and generation runs | Yes | Yes |
| Price |
Compatibility and requirements
- The Enterprise plan
- An owner or admin role to create keys
- A server to call the API, never a browser
- The Authorization: Bearer header on every call
- Tip: one key per tool, with only the rights it needs
You stay in control
Keys under control.
- Rights per key: read-only, read and write, or full access
- An expiry date and allowed IP addresses, if you wish
- Call limits per organization, signalled when exceeded
- A request ID in every response, for support
04Questions
Questions about the Upsellr API.
Is the API included in my plan?
It is reserved to the Enterprise plan. On other plans, the API and webhooks section is visible but locked.
Where is the documentation?
The API reference is generated from its OpenAPI specification, with examples in curl, JavaScript, Python and Ruby.
What are the call limits?
Per organization: 200 reads and 60 writes per minute, and 20 per minute for heavy operations, such as creating products, uploading files and starting runs. Beyond that, the API answers 429 with the delay to wait.
Can I update or delete a product through the API?
Not yet. You create products, and sending an existing product again gives it a new version when a value changes. Updates and deletions are made in Upsellr.
How do I avoid duplicates?
Upsellr recognizes each product by its EAN, its SKU, or its manufacturer reference and brand: sending the same product again does not duplicate it.
Can I start enrichment from my tool?
Yes. Start enrichment, generation, both, or one of your workflows, on a selection, a search or the whole catalog, up to 50,000 products per run.
How do I know a run is finished?
Query the run through the API, or receive a webhook when it completes, fails or is stopped.
Is there an SDK?
Not for now: the API is a standard REST API, and the reference gives ready-to-copy examples.
Your next product
deserves more than copy and paste.
Give your AI team its first products to work on.
Marcus
Amazon