get-ingredient-catalog-by-barcode

Source

  • Repository: jef-systems/jef-caferimo-backend

  • Module: caferimo

  • Documentation Scope: get

  • Lambda: jef-caferimo-get-3

Endpoint

  • API Name: jef-caferimo

  • Action Name: get

  • Method: GET

  • Scope Label: GET

  • Resource Path: /get-ingredient-catalog-by-barcode

  • Complete Endpoint: https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-ingredient-catalog-by-barcode

  • Lambda ARN: arn:aws:lambda:ap-southeast-1:246715082475:function:jef-caferimo-get-3

  • curl payload mode: query_string

API Gateway Description

Function: jef-caferimo-get-3
API Name: jef-caferimo
Action: get
Method: GET
Resource Path: /get-ingredient-catalog-by-barcode

Payload:
- barcode: string
- limit: number-whole-number-optional
- last_evaluated_key: string-optional

Response:
- exists: boolean
- message: string
- items: [{"pk":"string-jsin","gsi_1_pk":"string-barcode","jsin":"string","barcode":"string","product_name":"string","product_unit":"string"}]
- count: number-whole-number
- last_evaluated_key: string-optional

Request Payload

{
  "barcode": "string",
  "limit": "number-whole-number-optional",
  "last_evaluated_key": "string-optional"
}

Response

{
  "exists": "boolean",
  "message": "string",
  "items": "[{\"pk\":\"string-jsin\",\"gsi_1_pk\":\"string-barcode\",\"jsin\":\"string\",\"barcode\":\"string\",\"product_name\":\"string\",\"product_unit\":\"string\"}]",
  "count": "number-whole-number",
  "last_evaluated_key": "string-optional"
}

CMD curl

curl "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-ingredient-catalog-by-barcode?barcode=string&limit=number-whole-number-optional&last_evaluated_key=string-optional"

PowerShell curl

curl.exe "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-ingredient-catalog-by-barcode?barcode=string&limit=number-whole-number-optional&last_evaluated_key=string-optional"