Connect your systems to Ultineo
The API of each product, a guide for each task, the integrations and the tools, and the reference: what is written for those who build.
Choose where you start
- E-commerce API
A JSON over HTTPS API for the shop you run with Ultineo E-commerce. A migration script, an ERP sync or a supplier feed sends records in batches, and reads any single record back to check what was saved.
- Ultineo Reasoning API
Run your reasoning from your software.
- Ultineo SaaS project API
An option of an Ultineo SaaS project, not a part of every application. Its availability and its price appear in the offer of the project, and it exposes the operations agreed for that project.
A first call, and its answer
The sample of the first guide, as the reference of the E-commerce API publishes it.
Request
curl "https://api.ultineo.com/v1/category/import?name=Smartphones" \
-H "Authorization: Bearer sk-project-YOUR_KEY" The key travels in the Authorization header, after the word Bearer.
Answer
{
"code": 200,
"title": "OK",
"response": {
"object": "category",
"id": "cate_4be1a07f93c2d58e6a10",
"name": "Smartphones",
...
"status": "activated",
...
"created_at": 1789143990,
"updated_at": 1789143990
}
} The envelope holds code, title and response, and here response holds the category.
APIs
The API of each product, and what each part of it covers.
- E-commerce API
Create API access and exchange your shop data
- Catalogue, orders and vouchers
What a program sends and reads back for each catalogue, sales history and voucher resource.
- Parcels, addresses and carriers
The Ultineo Logistics API: follow parcels, keep an address book in step and read the carrier catalogue.
- Ultineo Reasoning API
Run your reasoning from your software.
- Ultineo SaaS project API
Review an API scope for an eligible project and distinguish planned routes from the endpoints already built.
Guides
One task per guide, from a first call to a daily connection.
- Make your first API call
The address, the health check, the key in the header and how to read the answer of a first call.
- Manage keys and access
Who creates a key, what it may reach, when it expires and how to rename, disable or delete it.
- Import in batches
The contract every import shares: batches, the dry run, replays without duplicates and the report.
- Handle errors and limits
What each status of the API asks of your client, and what you can safely send again.
- Connect an ERP or a supplier feed
A typical connection from another system: the keys to map, a first dry run, the sync and its checks.
- Move an existing shop
Bring your catalogue, your sales history and your domain to a new shop, and check each step.
- AI inside your software
A reasoning step added to a screen of your own software, launched through the API and read back.
Integrations and tools
What connects without code: services, files, domain names and software projects.
- Integrations
The services a shop connects, the state of each connection, and external connections of a software project.
- Product feeds
Product feeds for shopping services
- File imports and exports
Catalogue spreadsheets with a report for every line, and the other file exchanges of a shop.
- Domain names
Connect a domain you own to a shop or to a software project: ownership proof, DNS records, checks.
- Software projects
The project API option, external connections, environments and versions of a custom software project.
Resources
The reference, the conventions, security, service status, product updates and help.
- E-commerce API reference
Every article of the E-commerce API, in the help center.
- API conventions
The rules every route shares: JSON over HTTPS, one envelope, identifiers, dates, amounts and lists.
- Security
How keys, encrypted connections and team access protect what your integration reaches.
- Service status
The current state of our services
- Product updates
What changed in the products
- Developer help
Where a developer or an integrator finds an answer, what to check first and what to send us.
Open your shop, then connect it
A key is created inside an open shop. Accounts are opened after a review: send your application, and our team replies by e-mail.
Questions from developers
An administrator of the project of your shop creates it in the workspace, on the "API Access" tab. Its full value is shown once, so copy it when it is created. You need an open shop first, and accounts are opened after a review.
Yes, for imports. Send the batch with dry_run set to true: you get the full report of what would be created, updated, left unchanged or refused, and nothing is written. Check the dry_run field of the response before you trust a report.
The catalogue, the sales history and vouchers; parcels, addresses and carriers are the API of Ultineo Logistics. The article "Your first API call" lists every resource with its scopes. Do not assume that every screen of the workspace has an equivalent endpoint.
A failed call uses the same envelope as a successful one: read the HTTP status code, then the message in response. In an import, each item is checked on its own: an item that fails a check is reported as refused with what to correct, and the other items of the batch carry on.
Yes. Each resource has its own batch limit, given in its reference article, and a request body has a maximum size. When too many requests arrive in a short time, the call is refused and the Retry-After header gives the number of seconds to wait. Sending the same batch again never creates a duplicate.
No. The API provides building blocks, not an automatically installed connector. Your technical team or your service provider builds and tests the exchange against the documented endpoints.
A project API is an option of an Ultineo SaaS project. Its availability and its price appear in the offer of the project, and an application can operate without it. Its reference belongs to the project for which it is activated.
In the E-commerce help center, in the section on the E-commerce API. It is public, written in English and in French, and you need no account to read it.