Main Concepts
Under the hood
Unify is multi-tenant Software as a Service. Each tenant (internally called organization) is strongly isolated from the others by dedicated schema or database, (according to your plan), corresponding to a set of data for each data entity.
Concerned about operates independently, ensuring isolation and data privacy.
Data Input
Unify provides a REST API to integrate data programmaticaly
All APIs are server-side endpoints, which should be securely handled on your server rather than exposed in the browser. Handle sensitive information via server-side APIs, like bulk-creating datas.
Data model
Unify Data-Model are using predefined and consistent fields across all tenants. They provide essential attributes and functionalities available within the platform.
The main entities are :
| Entity | Description | Ressources |
|---|---|---|
| Items | Each variation of products managed in stock (must be specified at the most detailed level, IAN recommended) | Item API |
| Locations | Every location that may hold or handle stock | Locations API |
| Stocks | Product inventories by location | Stocks API |
| Orders | Represents a set of products purchased by customer | Orders API |
| Preparation Requests | Represents a set of products to be processed by the location | Preparation Request API |
Please refer to the Unify API documentation page for an exhaustive list of endpoints.
OpenAPI Specification
Unify API is documented using OpenAPI 3.0 specification, which provides a standard way to describe RESTful APIs.
This documentation is available in the Unify API documentation section, where you can find detailed information about each endpoint, including request and response formats, parameters, and examples.
You can also access the OpenAPI specification directly in JSON format, which can be used to generate client libraries or to import into API testing tools like Postman.
View the latest OpenAPI spec here
Updated 9 months ago