API Overview

Modified on: 2018-07-11 15:56:13 -0400


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: 

Sample Requests


DataStream (NEW!)

A bulk-load endpoint has been added to our API. Learn more about this here:

DataStream


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 threshhold 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

Locations

Endpoint
Verb
Parameters
Description
api/v2/locations
GET

Returns all locations.
api/v2/locations/{id}
GET

Returns the model with the given ID


Orders

Endpoint
Verb
Parameters
Description
api/v2/orders
GET
date
Returns all orders for the given date.
api/v2/orders/{id}
GET

Returns the model with the given ID
api/v2/orders
PUT
Order
 
tryAndMatch
Optional
 
importDependencies
Optional
Saves an order.
api/v2/orders/{id}
DELETE

Deletes the model with the given ID


OrderTemplates

Endpoint
Verb
Parameters
Description
api/v2/OrderTemplates
GET

Returns all order templates in a location but will not include template items. Query a specific template to get its details.
api/v2/OrderTemplates/{id}
GET

Returns the model with the given ID


ProductPricings

Endpoint
Verb
Parameters
Description
api/v2/ProductPricings
GET
orderViewType
 
startDate
Optional
 
endDate
Optional
 
targetDate
Optional

api/v2/ProductPricings/{id}
GET

Returns the model with the given ID


Products

Endpoint
Verb
Parameters
Description
api/v2/products
GET

Returns all products
api/v2/products/{id}
GET

Returns the model with the given ID


Shifts

Endpoint
Verb
Parameters
Description
api/v2/shifts
GET

Returns all shifts
api/v2/shifts/{id}
GET

Returns the model with the given ID


Wastes

Endpoint
Verb
Parameters
Description
api/v2/wastes
GET
date
 
Returns all waste records on the given date.
api/v2/wastes/{id}
GET

Returns the model with the given ID
api/v2/wastes
PUT
Waste
 
tryAndMatch
Optional
 
importDependencies
Optional
 
Saves a waste.
api/v2/wastes/{id}
DELETE

Deletes the model with the given ID



Did you find it helpful? Yes No

Can you please tell us how we can improve this article?