.. AUTO-GENERATED FILE. DO NOT EDIT.

store-orders-get-one
====================

Source
------

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

Endpoint
--------

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

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

.. code-block:: text

   Function: jef-store-get-29
   API Name: jef-store
   Action: get
   Method: GET
   Resource Path: /store-orders-get-one
   
   Table:
   - table: jef-store-orders
   - operation: get-one
   
   Payload Schema:
   - pk: order_number
   
   Payload Example:
   - pk: ORD-1001-0001
   
   Response Schema:
   - exists: boolean
   - message: string
   - item: {"entity_number":"string","order_number":"string","source":"string","created_at":"string","paid_at":"string","status":"string","payment_status":"string","payment_method":"string","payment_reference":"string","receipt_mode":"string","receipt_printed_at":"string","customer_number":"string","customer_name":"string","customer_phone":"string","customer_email":"string","delivery_mode":"string","full_address":"string","branch_pickup_name":"string","delivery_instructions":"string","internal_note":"string","call_before_delivery":"boolean","subtotal":"number","shipping_fee":"number","discount":"number","grand_total":"number","amount_paid":"number","total_quantity":"number","is_deleted":"boolean","deleted_at":"string","updated_at":"string","idempotency_key":"string","schema_version":"number","version":"number"}

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

.. code-block:: json

   {
     "pk": "order_number"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "item": "{\"entity_number\":\"string\",\"order_number\":\"string\",\"source\":\"string\",\"created_at\":\"string\",\"paid_at\":\"string\",\"status\":\"string\",\"payment_status\":\"string\",\"payment_method\":\"string\",\"payment_reference\":\"string\",\"receipt_mode\":\"string\",\"receipt_printed_at\":\"string\",\"customer_number\":\"string\",\"customer_name\":\"string\",\"customer_phone\":\"string\",\"customer_email\":\"string\",\"delivery_mode\":\"string\",\"full_address\":\"string\",\"branch_pickup_name\":\"string\",\"delivery_instructions\":\"string\",\"internal_note\":\"string\",\"call_before_delivery\":\"boolean\",\"subtotal\":\"number\",\"shipping_fee\":\"number\",\"discount\":\"number\",\"grand_total\":\"number\",\"amount_paid\":\"number\",\"total_quantity\":\"number\",\"is_deleted\":\"boolean\",\"deleted_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-orders-get-one?pk=ORD-1001-0001"

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

.. code-block:: text

   curl.exe "https://rw53l0a90m.execute-api.ap-southeast-1.amazonaws.com/prod/store-orders-get-one?pk=ORD-1001-0001"