.. AUTO-GENERATED FILE. DO NOT EDIT.

store-inventory-ledger-patch-one
================================

Source
------

- Repository: ``jef-systems/jef-store-backend``
- Source Run ID: ``25334823297``
- Source SHA: ``69cb846339fa14db005aec45414a4a94ec2a821e``
- Module: ``store``
- Documentation Scope: ``async``
- Lambda: ``jef-store-patch-35``

Endpoint
--------

- API Name: ``jef-store``
- Action Name: ``patch``
- Method: ``PATCH``
- Scope Label: ``Async``
- Resource Path: ``/store-inventory-ledger-patch-one``
- Complete Endpoint: ``https://rw53l0a90m.execute-api.ap-southeast-1.amazonaws.com/prod/store-inventory-ledger-patch-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-store-patch-35``
- curl payload mode: ``json_body``

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

.. code-block:: text

   Function: jef-store-patch-35
   Module: jef-store
   Action: patch
   Method: PATCH
   Invocation Mode: ASYNC
   Resource Path: /store-inventory-ledger-patch-one
   
   API Gateway Response:
   - status_code: 202
   - message: Request accepted for asynchronous processing.
   
   Table:
   - table: jef-store-inventory-ledger
   
   Payload Example:
   - pk: inventory-ledger-1001-0001
   - gsi_1_pk: PRO-1001-0001
   - gsi_1_sk: 2026-05-04T09:07:00+08:00
   - gsi_2_pk: 1001
   - gsi_2_sk: 2026-05-04T09:07:00+08:00
   - inventory_ledger_id: inventory-ledger-1001-0001
   - entity_number: 1001
   - product_number: PRO-1001-0001
   - sku: PH-COFFEE-10010001
   - movement_type: coffee-beans
   - source_type: coffee-beans
   - source_number: SOU-1001-0001
   - quantity_before: 10
   - quantity_delta: 10
   - quantity_after: 10
   - note: Barista grocery sample note for Benguet Arabica Beans 250g at Bacolod Main Barista Grocery.
   - created_at: 2026-05-04T09:07:00+08:00
   - updated_at: 2026-05-04T09:07:00+08:00
   - idempotency_key: 8d8767b2-2fb0-535f-b1f8-05700c540e5d
   - schema_version: 1001
   - version: 1001
   
   Payload Schema:
   - pk: string-{inventory_ledger_id}
   - gsi_1_pk: string-{product_number}
   - gsi_1_sk: string-{created_at}
   - gsi_2_pk: string-{entity_number}
   - gsi_2_sk: string-{created_at}
   - inventory_ledger_id: string
   - entity_number: string
   - product_number: string
   - sku: string
   - movement_type: string
   - source_type: string
   - source_number: string
   - quantity_before: number
   - quantity_delta: number
   - quantity_after: number
   - note: string
   - created_at: string
   - updated_at: string
   - idempotency_key: string
   - schema_version: number
   - version: number
   
   Response Schema:
   - is_accepted: boolean
   - message: string

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

.. code-block:: json

   {
     "pk": "inventory-ledger-1001-0001",
     "gsi_1_pk": "PRO-1001-0001",
     "gsi_1_sk": "2026-05-04T09:07:00+08:00",
     "gsi_2_pk": "1001",
     "gsi_2_sk": "2026-05-04T09:07:00+08:00",
     "inventory_ledger_id": "inventory-ledger-1001-0001",
     "entity_number": "1001",
     "product_number": "PRO-1001-0001",
     "sku": "PH-COFFEE-10010001",
     "movement_type": "coffee-beans",
     "source_type": "coffee-beans",
     "source_number": "SOU-1001-0001",
     "quantity_before": "10",
     "quantity_delta": "10",
     "quantity_after": "10",
     "note": "Barista grocery sample note for Benguet Arabica Beans 250g at Bacolod Main Barista Grocery.",
     "created_at": "2026-05-04T09:07:00+08:00",
     "updated_at": "2026-05-04T09:07:00+08:00",
     "idempotency_key": "8d8767b2-2fb0-535f-b1f8-05700c540e5d",
     "schema_version": "1001",
     "version": "1001"
   }

Response
--------

.. code-block:: json

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

CMD curl
--------

.. code-block:: text

   curl -X PATCH "https://rw53l0a90m.execute-api.ap-southeast-1.amazonaws.com/prod/store-inventory-ledger-patch-one" -H "Content-Type: application/json" --data-raw "{\"pk\": \"inventory-ledger-1001-0001\", \"gsi_1_pk\": \"PRO-1001-0001\", \"gsi_1_sk\": \"2026-05-04T09:07:00+08:00\", \"gsi_2_pk\": \"1001\", \"gsi_2_sk\": \"2026-05-04T09:07:00+08:00\", \"inventory_ledger_id\": \"inventory-ledger-1001-0001\", \"entity_number\": \"1001\", \"product_number\": \"PRO-1001-0001\", \"sku\": \"PH-COFFEE-10010001\", \"movement_type\": \"coffee-beans\", \"source_type\": \"coffee-beans\", \"source_number\": \"SOU-1001-0001\", \"quantity_before\": 10, \"quantity_delta\": 10, \"quantity_after\": 10, \"note\": \"Barista grocery sample note for Benguet Arabica Beans 250g at Bacolod Main Barista Grocery.\", \"created_at\": \"2026-05-04T09:07:00+08:00\", \"updated_at\": \"2026-05-04T09:07:00+08:00\", \"idempotency_key\": \"8d8767b2-2fb0-535f-b1f8-05700c540e5d\", \"schema_version\": 1001, \"version\": 1001}"

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

.. code-block:: text

   curl.exe -X PATCH "https://rw53l0a90m.execute-api.ap-southeast-1.amazonaws.com/prod/store-inventory-ledger-patch-one" -H "Content-Type: application/json" --data-raw '{"pk": "inventory-ledger-1001-0001", "gsi_1_pk": "PRO-1001-0001", "gsi_1_sk": "2026-05-04T09:07:00+08:00", "gsi_2_pk": "1001", "gsi_2_sk": "2026-05-04T09:07:00+08:00", "inventory_ledger_id": "inventory-ledger-1001-0001", "entity_number": "1001", "product_number": "PRO-1001-0001", "sku": "PH-COFFEE-10010001", "movement_type": "coffee-beans", "source_type": "coffee-beans", "source_number": "SOU-1001-0001", "quantity_before": 10, "quantity_delta": 10, "quantity_after": 10, "note": "Barista grocery sample note for Benguet Arabica Beans 250g at Bacolod Main Barista Grocery.", "created_at": "2026-05-04T09:07:00+08:00", "updated_at": "2026-05-04T09:07:00+08:00", "idempotency_key": "8d8767b2-2fb0-535f-b1f8-05700c540e5d", "schema_version": 1001, "version": 1001}'