.. AUTO-GENERATED FILE. DO NOT EDIT.

caferimo-products-post-one
==========================

Source
------

- Repository: ``jef-systems/jef-caferimo-backend``
- Source Run ID: ``24962842310``
- Source SHA: ``c73d8c4fa33c496a8e9d39267e4868ddfa8978a5``
- Module: ``caferimo``
- Documentation Scope: ``async``
- Lambda: ``jef-caferimo-post-3``

Endpoint
--------

- API Name: ``jef-caferimo``
- Action Name: ``post``
- Method: ``POST``
- Scope Label: ``Async``
- Resource Path: ``/caferimo-products-post-one``
- Complete Endpoint: ``https://iim2eohqsl.execute-api.ap-southeast-1.amazonaws.com/prod/caferimo-products-post-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-caferimo-post-3``
- curl payload mode: ``json_body``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-caferimo-post-3
   Module: jef-caferimo
   Action: post
   Method: POST
   Invocation Mode: ASYNC
   Resource Path: /caferimo-products-post-one
   
   API Gateway Response:
   - status_code: 202
   - message: Request accepted for asynchronous processing.
   
   Table:
   - table: jef-caferimo-products
   
   Payload Example:
   - entity_number: 1001
   - product_number: 0002
   - product_name: Chocolate Frappe
   - recipe_number: 0002
   - recipe_name: Chocolate Frappe Recipe
   - category: BEVERAGE
   - family: frappe
   - base_price: 150
   - size_mode: drink
   - uses_milk: True
   - has_add_ons: True
   - default_size_label: Medium
   - default_milk_name: Whole Milk
   - size_options[0].label: Medium
   - size_options[0].upcharge: 0
   - size_options[0].is_default: True
   - size_options[0].is_active: True
   - size_options[1].label: Large
   - size_options[1].upcharge: 20
   - size_options[1].is_default: False
   - size_options[1].is_active: True
   - milk_options[0].name: Whole Milk
   - milk_options[0].price: 0
   - milk_options[0].is_default: True
   - milk_options[0].is_active: True
   - milk_options[1].name: Oat Milk
   - milk_options[1].price: 30
   - milk_options[1].is_default: False
   - milk_options[1].is_active: True
   - add_on_options[0].id: addon-whipped-cream
   - add_on_options[0].name: Whipped Cream
   - add_on_options[0].price: 25
   - add_on_options[0].is_active: True
   - add_on_options[1].id: addon-chocolate-drizzle
   - add_on_options[1].name: Chocolate Drizzle
   - add_on_options[1].price: 15
   - add_on_options[1].is_active: True
   - source_type: recipe_autogenerated
   - source_recipe_version: 1
   - last_generated_at: 2026-04-25T12:00:00Z
   - display_order: 2
   - is_active: True
   - is_deleted: False
   - created_at: 2026-04-25T12:00:00Z
   - updated_at: 2026-04-25T12:00:00Z
   - version: 1
   
   Payload Schema:
   - entity_number: string
   - product_number: string
   - product_name: string
   - recipe_number: string
   - recipe_name: string
   - category: string
   - family: string
   - base_price: number
   - size_mode: string
   - uses_milk: boolean
   - has_add_ons: boolean
   - default_size_label: string
   - default_milk_name: string
   - size_options[0].label: string
   - size_options[0].upcharge: number
   - size_options[0].is_default: boolean
   - size_options[0].is_active: boolean
   - milk_options[0].name: string
   - milk_options[0].price: number
   - milk_options[0].is_default: boolean
   - milk_options[0].is_active: boolean
   - add_on_options[0].id: string
   - add_on_options[0].name: string
   - add_on_options[0].price: number
   - add_on_options[0].is_active: boolean
   - source_type: string
   - source_recipe_version: number
   - last_generated_at: string
   - display_order: number
   - is_active: boolean
   - is_deleted: boolean
   - created_at: string
   - updated_at: string
   - version: number
   
   Response Schema:
   - is_accepted: boolean
   - message: string

Request Payload
---------------

.. code-block:: json

   {
     "entity_number": "1001",
     "product_number": "0002",
     "product_name": "Chocolate Frappe",
     "recipe_number": "0002",
     "recipe_name": "Chocolate Frappe Recipe",
     "category": "BEVERAGE",
     "family": "frappe",
     "base_price": "150",
     "size_mode": "drink",
     "uses_milk": "True",
     "has_add_ons": "True",
     "default_size_label": "Medium",
     "default_milk_name": "Whole Milk",
     "size_options[0].label": "Medium",
     "size_options[0].upcharge": "0",
     "size_options[0].is_default": "True",
     "size_options[0].is_active": "True",
     "size_options[1].label": "Large",
     "size_options[1].upcharge": "20",
     "size_options[1].is_default": "False",
     "size_options[1].is_active": "True",
     "milk_options[0].name": "Whole Milk",
     "milk_options[0].price": "0",
     "milk_options[0].is_default": "True",
     "milk_options[0].is_active": "True",
     "milk_options[1].name": "Oat Milk",
     "milk_options[1].price": "30",
     "milk_options[1].is_default": "False",
     "milk_options[1].is_active": "True",
     "add_on_options[0].id": "addon-whipped-cream",
     "add_on_options[0].name": "Whipped Cream",
     "add_on_options[0].price": "25",
     "add_on_options[0].is_active": "True",
     "add_on_options[1].id": "addon-chocolate-drizzle",
     "add_on_options[1].name": "Chocolate Drizzle",
     "add_on_options[1].price": "15",
     "add_on_options[1].is_active": "True",
     "source_type": "recipe_autogenerated",
     "source_recipe_version": "1",
     "last_generated_at": "2026-04-25T12:00:00Z",
     "display_order": "2",
     "is_active": "True",
     "is_deleted": "False",
     "created_at": "2026-04-25T12:00:00Z",
     "updated_at": "2026-04-25T12:00:00Z",
     "version": "1"
   }

Response
--------

.. code-block:: json

   {
     "is_accepted": "boolean",
     "message": "string"
   }

CMD curl
--------

.. code-block:: text

   curl -X POST "https://iim2eohqsl.execute-api.ap-southeast-1.amazonaws.com/prod/caferimo-products-post-one" -H "Content-Type: application/json" --data-raw "{\"entity_number\": \"1001\", \"product_number\": \"0002\", \"product_name\": \"Chocolate Frappe\", \"recipe_number\": \"0002\", \"recipe_name\": \"Chocolate Frappe Recipe\", \"category\": \"BEVERAGE\", \"family\": \"frappe\", \"base_price\": 150, \"size_mode\": \"drink\", \"uses_milk\": true, \"has_add_ons\": true, \"default_size_label\": \"Medium\", \"default_milk_name\": \"Whole Milk\", \"size_options\": [{\"label\": \"Medium\", \"upcharge\": 0, \"is_default\": true, \"is_active\": true}, {\"label\": \"Large\", \"upcharge\": 20, \"is_default\": false, \"is_active\": true}], \"milk_options\": [{\"name\": \"Whole Milk\", \"price\": 0, \"is_default\": true, \"is_active\": true}, {\"name\": \"Oat Milk\", \"price\": 30, \"is_default\": false, \"is_active\": true}], \"add_on_options\": [{\"id\": \"addon-whipped-cream\", \"name\": \"Whipped Cream\", \"price\": 25, \"is_active\": true}, {\"id\": \"addon-chocolate-drizzle\", \"name\": \"Chocolate Drizzle\", \"price\": 15, \"is_active\": true}], \"source_type\": \"recipe_autogenerated\", \"source_recipe_version\": 1, \"last_generated_at\": \"2026-04-25T12:00:00Z\", \"display_order\": 2, \"is_active\": true, \"is_deleted\": false, \"created_at\": \"2026-04-25T12:00:00Z\", \"updated_at\": \"2026-04-25T12:00:00Z\", \"version\": 1}"

PowerShell curl
---------------

.. code-block:: text

   curl.exe -X POST "https://iim2eohqsl.execute-api.ap-southeast-1.amazonaws.com/prod/caferimo-products-post-one" -H "Content-Type: application/json" --data-raw '{"entity_number": "1001", "product_number": "0002", "product_name": "Chocolate Frappe", "recipe_number": "0002", "recipe_name": "Chocolate Frappe Recipe", "category": "BEVERAGE", "family": "frappe", "base_price": 150, "size_mode": "drink", "uses_milk": true, "has_add_ons": true, "default_size_label": "Medium", "default_milk_name": "Whole Milk", "size_options": [{"label": "Medium", "upcharge": 0, "is_default": true, "is_active": true}, {"label": "Large", "upcharge": 20, "is_default": false, "is_active": true}], "milk_options": [{"name": "Whole Milk", "price": 0, "is_default": true, "is_active": true}, {"name": "Oat Milk", "price": 30, "is_default": false, "is_active": true}], "add_on_options": [{"id": "addon-whipped-cream", "name": "Whipped Cream", "price": 25, "is_active": true}, {"id": "addon-chocolate-drizzle", "name": "Chocolate Drizzle", "price": 15, "is_active": true}], "source_type": "recipe_autogenerated", "source_recipe_version": 1, "last_generated_at": "2026-04-25T12:00:00Z", "display_order": 2, "is_active": true, "is_deleted": false, "created_at": "2026-04-25T12:00:00Z", "updated_at": "2026-04-25T12:00:00Z", "version": 1}'