get-entity-ingredients-by-jsin

Source

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

  • Module: caferimo

  • Documentation Scope: get

  • Lambda: jef-caferimo-get-5

Endpoint

  • API Name: jef-caferimo

  • Action Name: get

  • Method: GET

  • Scope Label: GET

  • Resource Path: /get-entity-ingredients-by-jsin

  • Complete Endpoint: https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-entity-ingredients-by-jsin

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

  • curl payload mode: query_string

API Gateway Description

Function: jef-caferimo-get-5
API Name: jef-caferimo
Action: get
Method: GET
Resource Path: /get-entity-ingredients-by-jsin

Payload:
- entity_number: string-4-digits-nonzerostart
- jsin: string

Response:
- exists: boolean
- message: string
- item: {"pk":"string-{entity_number}#{jsin}","gsi_1_pk":"string-{entity_number}#{active}","gsi_1_sk":"string-product_name","entity_number":"string-4-digits-nonzerostart","jsin":"string","barcode":"string","product_name":"string","product_unit":"string","active":"boolean","on_hand_quantity":"number-two-decimals","reorder_level":"number-two-decimals-optional","unit_cost":"number-decimal-optional","notes":"string-optional","updated_at":"string-iso8601"}

Request Payload

{
  "entity_number": "string-4-digits-nonzerostart",
  "jsin": "string"
}

Response

{
  "exists": "boolean",
  "message": "string",
  "item": "{\"pk\":\"string-{entity_number}#{jsin}\",\"gsi_1_pk\":\"string-{entity_number}#{active}\",\"gsi_1_sk\":\"string-product_name\",\"entity_number\":\"string-4-digits-nonzerostart\",\"jsin\":\"string\",\"barcode\":\"string\",\"product_name\":\"string\",\"product_unit\":\"string\",\"active\":\"boolean\",\"on_hand_quantity\":\"number-two-decimals\",\"reorder_level\":\"number-two-decimals-optional\",\"unit_cost\":\"number-decimal-optional\",\"notes\":\"string-optional\",\"updated_at\":\"string-iso8601\"}"
}

CMD curl

curl "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-entity-ingredients-by-jsin?entity_number=string-4-digits-nonzerostart&jsin=string"

PowerShell curl

curl.exe "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-entity-ingredients-by-jsin?entity_number=string-4-digits-nonzerostart&jsin=string"