Jera Supplyit's API is designed to facilitate programmatic interaction with the Supplyit platform, allowing our customers to adapt their existing processes and software to work cohesively with Supplyit.
Examples
Sample requests and responses are available here:
DataStream
A bulk-load endpoint has been added to our API. Learn more about this here:
Rate Limiting
To help prevent a high volume of API requests from degrading performance, the frequency of API calls is limited.
API Rate Threshold: 10 requests per second
Please note that the request threshold is subject to change without notice. Responses contain the header X-Jera-RemainingRequests which indicates the remaining requests per second. When this value is 0, please pause before continuing.
Models
Please see this knowledge base article for more information about how models and parameters are formatted in our API.
Endpoints
Notes: All end-points are prefaced with /api/v2 in this version of the API.
Locations
| Endpoint | Verb | Parameters | Description |
|---|---|---|---|
| /locations | GET | Returns all locations. | |
| /locations/{id} | GET | Returns the model with the given ID |
Invoices
| Endpoint | Verb | Parameters | Description |
|---|---|---|---|
| /invoices | GET | date | Returns all invoices for the given date. |
| /invoices | GET | start,end | Returns all invoices within the given date range. This range must be less than 31 days. |
| /invoices/{id} | GET | Returns the invoice with the given ID |
Orders
| Endpoint | Verb | Parameters | Description |
|---|---|---|---|
| /orders | GET | date | Returns all orders for the given date. |
| /orders/{id} | GET | Returns the order with the given ID | |
| /orders | PUT | Order tryAndMatch Optional importDependencies Optional | Saves an order. |
| /orders/{id} | DELETE | Deletes the order with the given ID |
OrderTemplates
| Endpoint | Verb | Parameters | Description |
|---|---|---|---|
| /orderTemplates | GET | Returns all order templates in a location but will not include template items. Query a specific template to get its details. | |
| /orderTemplates/{id} | GET | Returns the model with the given ID | |
| /orderTemplates | PUT | OrderTemplate tryAndMatch Optional importDependencies Optional | Saves an order template. |
ProductPricings
| Endpoint | Verb | Parameters | Description |
|---|---|---|---|
| /productPricings | GET | orderViewType startDate Optional endDate Optional targetDate Optional | |
| /productPricings/{id} | GET | Returns the model with the given ID |
Products
| Endpoint | Verb | Parameters | Description |
|---|---|---|---|
| /products | GET | Returns all products | |
| /products/{id} | GET | Returns the model with the given ID | |
| /products | PUT | Saves a product. |
ProductRecipes
| Endpoint | Verb | Parameters | Description |
|---|---|---|---|
| /productRecipes | GET | Returns all recipes (without details) | |
| /productRecipes/{id} | GET | id | Returns the model with the given ID |
| /productRecipes/ | productIDs | A comma delimited list of product IDs to return recipes (with details) associated with each product | |
| /productRecipes/{id} | DELETE | id | Deletes the recipe with the given ID |
| /productRecipes/ | PUT | ProductRecipe hardImport Optional importDependencies Optional | Puts a product recipe. When hardImport=true is specified, ingredients not included in the request will be removed from the recipe. |
Shifts
| Endpoint | Verb | Parameters | Description |
|---|---|---|---|
| /shifts | GET | Returns all shifts | |
| /shifts/{id} | GET | Returns the model with the given ID |
Wastes
| Endpoint | Verb | Parameters | Description |
|---|---|---|---|
| /wastes | GET | date | Returns all waste records on the given date. |
| /wastes/{id} | GET | Returns the model with the given ID | |
| /wastes | PUT | Waste tryAndMatch Optional importDependencies Optional | Saves a waste. |
| /wastes/{id} | DELETE | Deletes the model with the given ID |