.. AUTO-GENERATED FILE. DO NOT EDIT.

store-customer-settings-get-many
================================

Source
------

- Repository: ``jef-systems/jef-store-backend``
- Source Run ID: ``25333167796``
- Source SHA: ``69cb846339fa14db005aec45414a4a94ec2a821e``
- Module: ``store``
- Documentation Scope: ``get``
- Lambda: ``jef-store-get-18``

Endpoint
--------

- API Name: ``jef-store``
- Action Name: ``get``
- Method: ``GET``
- Scope Label: ``GET``
- Resource Path: ``/store-customer-settings-get-many``
- Complete Endpoint: ``https://rw53l0a90m.execute-api.ap-southeast-1.amazonaws.com/prod/store-customer-settings-get-many``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-store-get-18``
- curl payload mode: ``query_string``

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

.. code-block:: text

   Function: jef-store-get-18
   API Name: jef-store
   Action: get
   Method: GET
   Resource Path: /store-customer-settings-get-many
   
   Table:
   - table: jef-store-customer-settings
   - operation: get-many
   
   Payload Schema:
   - gsi_1_pk: entity_number
   
   Payload Example:
   - gsi_1_pk: 1001
   
   Response Schema:
   - exists: boolean
   - message: string
   - items: [{"customer_settings_id":"string","entity_number":"string","employee_number":"string","customer_number":"string","customer_name":"string","phone":"string","email":"string","delivery_mode":"string","payment_method":"string","receipt_mode":"string","branch_pickup_name":"string","full_address":"string","delivery_instructions":"string","internal_note":"string","call_before_delivery":"boolean","allow_partial_fulfillment":"boolean","save_as_default_customer":"boolean","is_active":"boolean","is_deleted":"boolean","deleted_at":"string","created_at":"string","updated_at":"string","idempotency_key":"string","schema_version":"number","version":"number"}]

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

.. code-block:: json

   {
     "gsi_1_pk": "entity_number"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "items": "[{\"customer_settings_id\":\"string\",\"entity_number\":\"string\",\"employee_number\":\"string\",\"customer_number\":\"string\",\"customer_name\":\"string\",\"phone\":\"string\",\"email\":\"string\",\"delivery_mode\":\"string\",\"payment_method\":\"string\",\"receipt_mode\":\"string\",\"branch_pickup_name\":\"string\",\"full_address\":\"string\",\"delivery_instructions\":\"string\",\"internal_note\":\"string\",\"call_before_delivery\":\"boolean\",\"allow_partial_fulfillment\":\"boolean\",\"save_as_default_customer\":\"boolean\",\"is_active\":\"boolean\",\"is_deleted\":\"boolean\",\"deleted_at\":\"string\",\"created_at\":\"string\",\"updated_at\":\"string\",\"idempotency_key\":\"string\",\"schema_version\":\"number\",\"version\":\"number\"}]"
   }

CMD curl
--------

.. code-block:: text

   curl "https://rw53l0a90m.execute-api.ap-southeast-1.amazonaws.com/prod/store-customer-settings-get-many?gsi_1_pk=1001"

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

.. code-block:: text

   curl.exe "https://rw53l0a90m.execute-api.ap-southeast-1.amazonaws.com/prod/store-customer-settings-get-many?gsi_1_pk=1001"