Get recipes by recipe IDs¶
Summary¶
Source repository:
jef-systems/jef-caferimo-backendSource SHA:
9a36b739b9d36644a4755661f84fd9219f6332cdSource run id:
29881756321Module:
CaferimoLambda function:
jef-caferimo-get-recipes-by-recipe-idsHTTP method:
POSTInvocation mode:
syncPackage mode:
no-packageAPI category:
Caferimo Complex Sync No Package POST APIsAPI path:
/caferimo/complex-sync-no-packages/jef-caferimo-get-recipes-by-recipe-idsEndpoint URL:
https://api.jefoffice.com/caferimo/complex-sync-no-packages/jef-caferimo-get-recipes-by-recipe-idsDocumentation scope:
lambda-complex-sync-no-packages
Synchronous Lambda Complex Rule¶
This API is documented as a synchronous Lambda complex no-package API. API Gateway waits for the Lambda result and returns the final Lambda response.
Description¶
Returns bounded complete recipe batches for printing.
Payload Example¶
{
"store_id": "11111111-1111-4111-8111-111111111111",
"recipe_ids": [
"22222222-2222-4222-8222-222222222222"
],
"require_active": true,
"include_capacity": false
}
Payload Schema¶
{
"root": {
"type": "M",
"required": true,
"additional_properties": false,
"attributes": {
"store_id": {
"type": "S",
"required": true,
"format": "uuid",
"regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"recipe_ids": {
"type": "L",
"required": false,
"min_items": 1,
"max_items": 25,
"items": {
"type": "S",
"required": true,
"format": "uuid"
}
},
"recipes": {
"type": "L",
"required": false,
"min_items": 1,
"max_items": 25,
"items": {
"type": "M",
"required": true,
"additional_properties": false,
"attributes": {
"recipe_id": {
"type": "S",
"required": true,
"format": "uuid"
},
"expected_version": {
"type": "N",
"integer": true,
"required": false,
"minimum": 1
},
"expected_content_hash": {
"type": "S",
"required": false,
"regex": "^[0-9a-f]{64}$"
}
}
}
},
"require_active": {
"type": "BOOL",
"required": false,
"default": true
},
"include_capacity": {
"type": "BOOL",
"required": false,
"default": false
}
}
}
}
Response Schema¶
{
"root": {
"type": "M",
"required": true,
"additional_properties": false,
"attributes": {
"contract_version": {
"type": "N",
"integer": true,
"required": true
},
"request_id": {
"type": "S",
"required": true
},
"is_accepted": {
"type": "BOOL",
"required": true
},
"is_found": {
"type": "BOOL",
"required": true
},
"can_continue": {
"type": "BOOL",
"required": true
},
"is_complete": {
"type": "BOOL",
"required": true
},
"is_truncated": {
"type": "BOOL",
"required": true
},
"message_type": {
"type": "S",
"required": true,
"enum": [
"success",
"info",
"warning",
"error"
]
},
"message": {
"type": "S",
"required": true
},
"next_action": {
"type": "S",
"required": true
},
"operation": {
"type": "S",
"required": true
},
"status_code": {
"type": "N",
"integer": true,
"required": true
},
"can_print": {
"type": "BOOL",
"required": true
},
"store_id": {
"type": "S",
"required": true
},
"recipe_count": {
"type": "N",
"integer": true,
"required": true
},
"recipes": {
"type": "L",
"required": true,
"items": {
"type": "M",
"required": true,
"additional_properties": false,
"attributes": {
"recipe_id": {
"type": "S",
"required": true,
"format": "uuid"
},
"recipe": {
"type": "M",
"required": true,
"additional_properties": false,
"attributes": {
"recipe_id": {
"type": "S",
"required": false,
"format": "uuid"
},
"store_id": {
"type": "S",
"required": false,
"format": "uuid"
},
"recipe_number": {
"type": "S",
"required": false
},
"recipe_name": {
"type": "S",
"required": false
},
"family": {
"type": "S",
"required": false
},
"size_mode": {
"type": "S",
"required": false
},
"uses_milk": {
"type": "BOOL",
"required": false
},
"vessel": {
"type": "S",
"required": false
},
"notes": {
"type": "S",
"required": false,
"nullable": true
},
"is_active": {
"type": "BOOL",
"required": false
},
"is_deleted": {
"type": "BOOL",
"required": false
},
"version": {
"type": "N",
"integer": true,
"required": false
},
"created": {
"type": "S",
"required": false,
"format": "date-time"
},
"updated": {
"type": "S",
"required": false,
"format": "date-time"
},
"content_hash": {
"type": "S",
"required": false
},
"deleted": {
"type": "S",
"required": false,
"format": "date-time"
}
}
},
"formula_lines": {
"type": "L",
"required": true,
"items": {
"type": "M",
"required": true,
"additional_properties": false,
"attributes": {
"line_id": {
"type": "S",
"required": true,
"format": "uuid"
},
"line_number": {
"type": "N",
"integer": true,
"required": true
},
"component_id": {
"type": "S",
"required": true,
"format": "uuid"
},
"component_version": {
"type": "N",
"integer": true,
"required": true
},
"component_number": {
"type": "S",
"required": true
},
"component_name": {
"type": "S",
"required": true
},
"component_label": {
"type": "S",
"required": true
},
"component_type": {
"type": "S",
"required": true
},
"size_label": {
"type": "S",
"required": true,
"nullable": true
},
"quantity": {
"type": "S",
"required": true
},
"unit": {
"type": "S",
"required": true
},
"sort_order": {
"type": "N",
"integer": true,
"required": true
}
}
}
},
"layers": {
"type": "L",
"required": true,
"items": {
"type": "M",
"required": true,
"additional_properties": false,
"attributes": {
"layer_id": {
"type": "S",
"required": true,
"format": "uuid"
},
"line_number": {
"type": "N",
"integer": true,
"required": true
},
"layer_text": {
"type": "S",
"required": true
},
"sort_order": {
"type": "N",
"integer": true,
"required": true
}
}
}
},
"process_steps": {
"type": "L",
"required": true,
"items": {
"type": "M",
"required": true,
"additional_properties": false,
"attributes": {
"step_id": {
"type": "S",
"required": true,
"format": "uuid"
},
"step_number": {
"type": "N",
"integer": true,
"required": true
},
"size_label": {
"type": "S",
"required": true,
"nullable": true
},
"step_text": {
"type": "S",
"required": true
},
"sort_order": {
"type": "N",
"integer": true,
"required": true
}
}
}
},
"counts": {
"type": "M",
"required": true,
"additional_properties": false,
"attributes": {
"formula_lines": {
"type": "N",
"integer": true,
"required": true
},
"layers": {
"type": "N",
"integer": true,
"required": true
},
"process_steps": {
"type": "N",
"integer": true,
"required": true
},
"total_child_records": {
"type": "N",
"integer": true,
"required": true
}
}
},
"content_hash": {
"type": "S",
"required": true
}
}
}
},
"failure_count": {
"type": "N",
"integer": true,
"required": true
},
"failures": {
"type": "L",
"required": true,
"items": {
"type": "M",
"required": true,
"additional_properties": false,
"attributes": {
"recipe_id": {
"type": "S",
"required": true,
"format": "uuid"
},
"failure_code": {
"type": "S",
"required": true
}
}
}
},
"legacy_component_enrichment": {
"type": "BOOL",
"required": true
},
"failure_code": {
"type": "S",
"required": false
},
"consumed_capacity": {
"type": "L",
"required": false,
"items": {
"type": "M",
"required": true,
"additional_properties": true,
"attributes": {}
}
}
}
}
}
Request Payload¶
{
"store_id": "11111111-1111-4111-8111-111111111111",
"recipe_ids": [
"22222222-2222-4222-8222-222222222222"
],
"require_active": true,
"include_capacity": false
}
CMD curl¶
curl.exe -X POST "https://api.jefoffice.com/caferimo/complex-sync-no-packages/jef-caferimo-get-recipes-by-recipe-ids" -H "Content-Type: application/json" --data-raw '{}'
PowerShell curl¶
curl.exe -X POST "https://api.jefoffice.com/caferimo/complex-sync-no-packages/jef-caferimo-get-recipes-by-recipe-ids" -H "Content-Type: application/json" --data-raw '{}'