Recipok API
Getting started:
In order to make a request you will need to include an authentication token in the request header. This token can be found in the integrations > developers tab section from your recipok account.
Base URL: https://api.recipok.com/api
Ingredients
GET /ingredients
Gets a list of existing resources.
Parameters
No parameters
Pagination
This endpoint supports pagination, Ex: api.recipok.com/api/final-path?page=1&limit=20
- page: page number
- limit: number of items per page
Response – Successful operation
{
"status": "success",
"code": 200,
"message": "Successful operation",
"data": {
"items": [
{
"id": "numeric",
"name": "string",
"priceUnit": "numeric, possible values 0=KG, 1=LT, 2=UD",
"price": "numeric",
"format": "numeric",
"sku": "string",
"pva": "numeric",
"brand": "string",
"measurementUnit": "numeric, possible values 0=gr, 1=ml, 2=pz",
"allergens": "array",
"displayName": "string",
"energeticValue": "numeric",
"fats": "numeric",
"saturatedFats": "numeric",
"monounsaturatedFats": "numeric",
"polyunsaturatedFats": "numeric",
"carbohydrates": "numeric",
"cholesterol": "numeric",
"transFats": "numeric",
"omegaFats": "numeric",
"sugars": "numeric",
"protein": "numeric",
"weight": "numeric",
"salt": "numeric",
"decrease": "numeric",
"link": "string",
"linkText": "string",
"advertise": "numeric",
"barcodeNumber": "string",
"calculatedPrice": "numeric",
"calculatedPriceFormat": "numeric",
"supplier": "string",
"family": "string"
}
],
"pagination": {
"currentPage": "numeric",
"totalPages": "numeric",
"totalItems": "numeric",
"itemsPerPage": "numeric"
}
}
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
GET /ingredients/{id}
Obtains a specific resource using an identifier.
Parameters
id: Resource identifier.
Response
{
"status": "success",
"code": 200,
"message": "Successful operation",
"data": {
"item": [
{
"id": "numeric",
"name": "string",
"priceUnit": "numeric, possible values 0=KG, 1=LT, 2=UD",
"price": "numeric",
"format": "numeric",
"sku": "string",
"pva": "numeric",
"brand": "string",
"measurementUnit": "numeric, possible values 0=gr, 1=ml, 2=pz",
"allergens": "array",
"displayName": "string",
"energeticValue": "numeric",
"fats": "numeric",
"saturatedFats": "numeric",
"monounsaturatedFats": "numeric",
"polyunsaturatedFats": "numeric",
"carbohydrates": "numeric",
"cholesterol": "numeric",
"transFats": "numeric",
"omegaFats": "numeric",
"sugars": "numeric",
"protein": "numeric",
"weight": "numeric",
"salt": "numeric",
"decrease": "numeric",
"link": "string",
"linkText": "string",
"advertise": "numeric",
"barcodeNumber": "string",
"calculatedPrice": "numeric",
"calculatedPriceFormat": "numeric",
"supplier": "string",
"family": "string"
}
]
}
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
POST /ingredients
Create a resource.
Parameters
No parameters
Request body
The new Ingredients resource
{
"name": "string",
"measurementUnit": "string",
"format": "numeric",
"price": "numeric"
}
Response
{
"status": "success",
"code": 201,
"message": "Successful operation",
"data": {
"item": {
"id": "numeric"
}
}
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
Raw Material Movevemts
GET /materials
Gets a list of existing resources.
Parameters
No parameters
Pagination
This endpoint supports pagination, Ex: api.recipok.com/api/final-path?page=1&limit=20
- page: page number
- limit: number of items per page
Response
{
"status": "success",
"code": 200,
"message": "Successful operation",
"data": {
"items": [
{
"supplierId": "numeric",
"date": "string",
"identification": "string",
"products": [
{
"id": "numeric",
"measurementUnit": "numeric",
"totalAmount": "numeric",
"price/ud": "numeric",
"numLot": "string"
}
]
}
],
"pagination": {
"currentPage": "numeric",
"totalPages": "numeric",
"totalItems": "numeric",
"itemsPerPage": "numeric"
}
}
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
GET /materials/{id}
Obtains a specific resource using an identifier.
Parameters
id: Resource identifier.
Response
{
"status": "success",
"code": 200,
"message": "Successful operation",
"data": {
"item": {
"supplierId": "numeric",
"date": "string",
"identification": "string",
"products": [
{
"id": "numeric",
"measurementUnit": "numeric",
"totalAmount": "numeric",
"price/ud": "numeric",
"numLot": "string"
}
]
}
}
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
POST /materials
Create a resource.
Parameters
No parameters
Request body
The new Ingredients resource
{
"supplierId": "numeric",
"createdAt": "string",
"identification": "string"
}
Response
{
"status": "success",
"code": 201,
"message": "Successful operation",
"data": {
"item": {
"id": "numeric"
}
}
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
Finished Product Movevemts
GET /finished-product-movements
Gets a list of existing resources.
Parameters
No parameters
Pagination
This endpoint supports pagination, Ex: api.recipok.com/api/final-path?page=1&limit=20
- page: page number
- limit: number of items per page
Response
{
"status": "success",
"code": 200,
"message": "Successful operation",
"data": {
"items": [
{
"id": "numeric",
"customer": "string",
"createdAt": "string",
"deliverDate": "string",
"documentNumber": "string",
"status": "numeric"
}
],
"pagination": {
"currentPage": "numeric",
"totalPages": "numeric",
"totalItems": "numeric",
"itemsPerPage": "numeric"
}
}
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
GET /finished-product-movements/{id}
Obtains a specific resource using an identifier.
Parameters
id: Resource identifier.
Response
{
"status": "success",
"code": 200,
"message": "Successful operation",
"data": {
"item": [
{
"customer": "string",
"createdAt": "string",
"deliverDate": "string",
"documentNumber": "string",
"total": "string",
"weight": "string",
"status": "numeric"
}
]
}
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
Finished Product Orders
GET /finished-product-orders
Gets a list of existing resources.
Parameters
No parameters
Response
{
"status": "success",
"code": 200,
"message": "Successful operation",
"data": {
"items": [
{
"id": "numeric",
"customerId": "numeric",
"customerName": "string",
"orderNumber": "string",
"prefix": "string",
"createdAt": "string",
"deliveredAt": "string",
"observations": "string",
"status": "numeric",
"statusText": "string",
"responsible": "string",
"products": [
{
"id": "numeric",
"recipeId": "numeric",
"recipeName": "string",
"recipeSku": "string",
"holded": "boolean",
"holdedId": "string"
}
]
}
]
}
"count": "numeric"
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
GET /finished-product-orders/{id}
Obtains a specific resource using an identifier.
Parameters
id: Resource identifier.
Response
{
"status": "success",
"code": 200,
"message": "Successful operation",
"data": {
"item": [
{
"id": "numeric",
"customerId": "numeric",
"customerName": "string",
"orderNumber": "string",
"prefix": "string",
"createdAt": "string",
"deliveredAt": "string",
"observations": "string",
"status": "numeric",
"statusText": "string",
"responsible": "string",
"products": [
{
"id": "numeric",
"recipeId": "numeric",
"recipeName": "string",
"recipeSku": "string",
"holded": "boolean",
"holdedId": "string"
}
]
}
]
}
"count": "numeric"
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
POST /finished-product-orders - under developing
Create a resource.
Parameters
No parameters
Request body
The new Ingredients resource
{
}
Response
{
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}
Recipes
GET /recipes
Gets a list of existing resources.
Parameters
No parameters
Pagination
This endpoint supports pagination, Ex: api.recipok.com/api/final-path?page=1&limit=20
- page: page number
- limit: number of items per page
Response
{
"status": "success",
"code": 200,
"message": "Successful operation",
"data": {
"items": [
{
"id": "numeric",
"name": "string",
"unit": "numeric, possible values: 0=Kilograms, 1=Units",
"ingredientCost": "string",
"indirectCost": "string",
"PersonalCost": "string",
"tags": "array",
"sku": "string",
"barcode": "string",
"expirationDays": "numeric",
"vat": "numeric",
"recommendedPVP": "string",
"pvp": "numeric",
"wholesalePrice": "numeric",
"rates": [
{
"name": "string",
"value": "string"
}
],
"allergens": "array, possible values: 0=LUPIN, 1=CELERY, 2=PEANUTS, 3=GLUTEN CEREALS, 4=CRUSTACEANS, 5=TREE NUTS, 6=EGGS, 7=DAIRY, 8=MOLLUSKS, 9=MUSTARD, 910=FISH, 11=SESAME SEEDS, 12=SOY, 13=SULFUR DIOXIDE AND SULFITES
"
}
],
"pagination": {
"currentPage": "numeric",
"totalPages": "numeric",
"totalItems": "numeric",
"itemsPerPage": "numeric"
}
}
}
Response – Not authenticated
{
"status": "error",
"code": 401,
"message": "Unauthorized. Authentication is required to access this resource."
}