/caferimo-orders-patch-one¶

Summary¶

Source repository: jef-systems/jef-caferimo-backend
Source SHA: 8b581b1d13a85824a9fe99676c0acfe212acd4e2
Source run id: 26743367088
Lambda function: jef-caferimo-orders-patch-one
HTTP method: PATCH
API path: /caferimo-orders-patch-one
Endpoint URL: https://iim2eohqsl.execute-api.ap-southeast-1.amazonaws.com/prod/caferimo-orders-patch-one
Payload mode: json-body

Description¶

Function: jef-caferimo-orders-patch-one
Module: jef-caferimo
Action: patch-one
Method: PATCH
Invocation Mode: ASYNC
Resource Path: /caferimo-orders-patch-one
Table: jef-caferimo-orders
Primary Key: order_id

API Gateway Response¶

status\_code: 202
message: Request accepted for asynchronous processing.

Payload Example¶

order\_id: 2fc1288c-5bc3-4842-8d35-8d38a1fe04c5
store\_id: fea0d68f-e658-4352-8ed4-b05f89e665ca
entity\_number: 0001
order\_number: 0001
modified\_from\_transaction\_id: 4149c295-8bab-4cd9-95be-504663115382
modified\_from\_order\_number: 0001
business\_date: 2026-06-01
order\_date: 2026-06-01
order\_datetime: 2026-06-01T08:10:43Z
item\_count: 1
total\_quantity: 1
subtotal\_amount: 1
discount\_amount: 1
service\_charge\_amount: 1
tax\_amount: 1
total\_amount: 1
payment\_method: value-001
payment\_status: value-001
paid\_amount: 1
change\_amount: 1
payment\_reference\_number: 0001
purchase\_order\_number: 0001
purchase\_order\_status: value-001
branch\_name: Sample Caferimo Orders 001
store\_name: Sample Caferimo Orders 001
store\_legal\_name: Sample Caferimo Orders 001
store\_tagline: value-001
store\_address\_line\_1: value-001
store\_address\_line\_2: value-001
store\_contact\_number: 0001
store\_tin: value-001
terminal\_name: Sample Caferimo Orders 001
cashier\_employee\_number: 0001
cashier\_name: Sample Caferimo Orders 001
receipt\_version: value-001
recipe\_version: value-001
created: 2026-06-01T08:10:43Z
updated: 2026-06-01T08:10:43Z
sync\_status: value-001
idempotency\_key: value-001
order\_lifecycle\_status: value-001
void\_reason: value-001
voided\_at: 2026-06-01T08:10:43Z
superseded\_at: 2026-06-01T08:10:43Z
superseded\_by\_transaction\_id: 48e56bc4-da1c-4d3b-a747-5669cd6b7b83
superseded\_by\_order\_number: 0001
modified\_at: 2026-06-01T08:10:43Z
children.order\_items\[0\].order\_item\_id: 705c9c06-bbf8-40a3-81a7-3e3729f276e1
children.order\_items\[0\].order\_id: 2fc1288c-5bc3-4842-8d35-8d38a1fe04c5
children.order\_items\[0\].order\_number: 0001
children.order\_items\[0\].business\_date: 2026-06-01
children.order\_items\[0\].line\_number: 1
children.order\_items\[0\].product\_number: 0001
children.order\_items\[0\].product\_name: Sample Caferimo Order Items 001
children.order\_items\[0\].recipe\_number: 0001
children.order\_items\[0\].recipe\_name: Sample Caferimo Order Items 001
children.order\_items\[0\].category: value-001
children.order\_items\[0\].family: value-001
children.order\_items\[0\].quantity: 1
children.order\_items\[0\].size\_label: Medium
children.order\_items\[0\].milk\_name: Sample Caferimo Order Items 001
children.order\_items\[0\].add\_ons\_text: value-001
children.order\_items\[0\].vessel: cup
children.order\_items\[0\].note: value-001
children.order\_items\[0\].base\_price: 1
children.order\_items\[0\].size\_upcharge: 1
children.order\_items\[0\].milk\_upcharge: 1
children.order\_items\[0\].add\_ons\_total: 1
children.order\_items\[0\].unit\_price: 1
children.order\_items\[0\].line\_total: 1
children.order\_items\[0\].is\_voided: True
children.order\_items\[0\].created: 2026-06-01T08:10:43Z
children.order\_items\[0\].updated: 2026-06-01T08:10:43Z
children.order\_receipt\_lines\[0\].order\_receipt\_line\_id: 8ed28acd-dba2-4b0a-acf0-0bd2a25fbd27
children.order\_receipt\_lines\[0\].order\_id: 2fc1288c-5bc3-4842-8d35-8d38a1fe04c5
children.order\_receipt\_lines\[0\].receipt\_line\_id: ac218ade-784d-4335-b43c-8edebe60bb3b
children.order\_receipt\_lines\[0\].order\_number: 0001
children.order\_receipt\_lines\[0\].business\_date: 2026-06-01
children.order\_receipt\_lines\[0\].line\_number: 1
children.order\_receipt\_lines\[0\].line\_text: value-001
children.order\_receipt\_lines\[0\].receipt\_version: value-001
children.order\_receipt\_lines\[0\].created: 2026-06-01T08:10:43Z
children.order\_receipt\_lines\[0\].updated: 2026-06-01T08:10:43Z
children.order\_recipe\_lines\[0\].order\_recipe\_line\_id: a296b2d1-d575-41e4-b95c-17d94278c76d
children.order\_recipe\_lines\[0\].order\_id: 2fc1288c-5bc3-4842-8d35-8d38a1fe04c5
children.order\_recipe\_lines\[0\].entity\_number: 0001
children.order\_recipe\_lines\[0\].recipe\_line\_id: a722f7c7-8641-44d8-add1-d4ef0a8219a9
children.order\_recipe\_lines\[0\].order\_number: 0001
children.order\_recipe\_lines\[0\].business\_date: 2026-06-01
children.order\_recipe\_lines\[0\].order\_item\_id: 705c9c06-bbf8-40a3-81a7-3e3729f276e1
children.order\_recipe\_lines\[0\].item\_line\_number: 1
children.order\_recipe\_lines\[0\].recipe\_line\_number: 1
children.order\_recipe\_lines\[0\].line\_text: value-001
children.order\_recipe\_lines\[0\].recipe\_version: value-001
children.order\_recipe\_lines\[0\].created: 2026-06-01T08:10:43Z
children.order\_recipe\_lines\[0\].updated: 2026-06-01T08:10:43Z

Payload Schema¶

{
  "root.type": "M",
  "root.required": "True",
  "root.attributes.order_id.type": "S",
  "root.attributes.order_id.required": "True",
  "root.attributes.order_id.format": "uuidv4",
  "root.attributes.order_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.store_id.type": "S",
  "root.attributes.store_id.required": "False",
  "root.attributes.store_id.format": "uuidv4",
  "root.attributes.store_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.entity_number.type": "S",
  "root.attributes.entity_number.required": "False",
  "root.attributes.entity_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.order_number.type": "S",
  "root.attributes.order_number.required": "False",
  "root.attributes.order_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.modified_from_transaction_id.type": "S",
  "root.attributes.modified_from_transaction_id.required": "False",
  "root.attributes.modified_from_transaction_id.format": "uuidv4",
  "root.attributes.modified_from_transaction_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.modified_from_order_number.type": "S",
  "root.attributes.modified_from_order_number.required": "False",
  "root.attributes.modified_from_order_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.business_date.type": "S",
  "root.attributes.business_date.required": "False",
  "root.attributes.business_date.regex": "^\\d{4}-\\d{2}-\\d{2}$",
  "root.attributes.order_date.type": "S",
  "root.attributes.order_date.required": "False",
  "root.attributes.order_date.regex": "^\\d{4}-\\d{2}-\\d{2}$",
  "root.attributes.order_datetime.type": "S",
  "root.attributes.order_datetime.required": "False",
  "root.attributes.order_datetime.format": "iso8601",
  "root.attributes.order_datetime.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.item_count.type": "N",
  "root.attributes.item_count.required": "False",
  "root.attributes.item_count.regex": "^\\d+$",
  "root.attributes.total_quantity.type": "N",
  "root.attributes.total_quantity.required": "False",
  "root.attributes.total_quantity.regex": "^\\d+$",
  "root.attributes.subtotal_amount.type": "N",
  "root.attributes.subtotal_amount.required": "False",
  "root.attributes.subtotal_amount.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.discount_amount.type": "N",
  "root.attributes.discount_amount.required": "False",
  "root.attributes.discount_amount.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.service_charge_amount.type": "N",
  "root.attributes.service_charge_amount.required": "False",
  "root.attributes.service_charge_amount.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.tax_amount.type": "N",
  "root.attributes.tax_amount.required": "False",
  "root.attributes.tax_amount.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.total_amount.type": "N",
  "root.attributes.total_amount.required": "False",
  "root.attributes.total_amount.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.payment_method.type": "S",
  "root.attributes.payment_method.required": "False",
  "root.attributes.payment_method.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.payment_status.type": "S",
  "root.attributes.payment_status.required": "False",
  "root.attributes.payment_status.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.paid_amount.type": "N",
  "root.attributes.paid_amount.required": "False",
  "root.attributes.paid_amount.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.change_amount.type": "N",
  "root.attributes.change_amount.required": "False",
  "root.attributes.change_amount.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.payment_reference_number.type": "S",
  "root.attributes.payment_reference_number.required": "False",
  "root.attributes.payment_reference_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.purchase_order_number.type": "S",
  "root.attributes.purchase_order_number.required": "False",
  "root.attributes.purchase_order_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.purchase_order_status.type": "S",
  "root.attributes.purchase_order_status.required": "False",
  "root.attributes.purchase_order_status.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.branch_name.type": "S",
  "root.attributes.branch_name.required": "False",
  "root.attributes.branch_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.store_name.type": "S",
  "root.attributes.store_name.required": "False",
  "root.attributes.store_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.store_legal_name.type": "S",
  "root.attributes.store_legal_name.required": "False",
  "root.attributes.store_legal_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.store_tagline.type": "S",
  "root.attributes.store_tagline.required": "False",
  "root.attributes.store_tagline.regex": "^.{0,500}$",
  "root.attributes.store_address_line_1.type": "S",
  "root.attributes.store_address_line_1.required": "False",
  "root.attributes.store_address_line_1.regex": "^.{1,300}$",
  "root.attributes.store_address_line_2.type": "S",
  "root.attributes.store_address_line_2.required": "False",
  "root.attributes.store_address_line_2.regex": "^.{1,300}$",
  "root.attributes.store_contact_number.type": "S",
  "root.attributes.store_contact_number.required": "False",
  "root.attributes.store_contact_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.store_tin.type": "S",
  "root.attributes.store_tin.required": "False",
  "root.attributes.store_tin.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.terminal_name.type": "S",
  "root.attributes.terminal_name.required": "False",
  "root.attributes.terminal_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.cashier_employee_number.type": "S",
  "root.attributes.cashier_employee_number.required": "False",
  "root.attributes.cashier_employee_number.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.cashier_name.type": "S",
  "root.attributes.cashier_name.required": "False",
  "root.attributes.cashier_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.receipt_version.type": "S",
  "root.attributes.receipt_version.required": "False",
  "root.attributes.receipt_version.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.recipe_version.type": "S",
  "root.attributes.recipe_version.required": "False",
  "root.attributes.recipe_version.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.created.type": "S",
  "root.attributes.created.required": "False",
  "root.attributes.created.format": "iso8601",
  "root.attributes.created.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.updated.type": "S",
  "root.attributes.updated.required": "False",
  "root.attributes.updated.format": "iso8601",
  "root.attributes.updated.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.sync_status.type": "S",
  "root.attributes.sync_status.required": "False",
  "root.attributes.sync_status.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.idempotency_key.type": "S",
  "root.attributes.idempotency_key.required": "False",
  "root.attributes.idempotency_key.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.order_lifecycle_status.type": "S",
  "root.attributes.order_lifecycle_status.required": "False",
  "root.attributes.order_lifecycle_status.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.void_reason.type": "S",
  "root.attributes.void_reason.required": "False",
  "root.attributes.void_reason.regex": "^.{0,500}$",
  "root.attributes.voided_at.type": "S",
  "root.attributes.voided_at.required": "False",
  "root.attributes.voided_at.format": "iso8601",
  "root.attributes.voided_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.superseded_at.type": "S",
  "root.attributes.superseded_at.required": "False",
  "root.attributes.superseded_at.format": "iso8601",
  "root.attributes.superseded_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.superseded_by_transaction_id.type": "S",
  "root.attributes.superseded_by_transaction_id.required": "False",
  "root.attributes.superseded_by_transaction_id.format": "uuidv4",
  "root.attributes.superseded_by_transaction_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.superseded_by_order_number.type": "S",
  "root.attributes.superseded_by_order_number.required": "False",
  "root.attributes.superseded_by_order_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.modified_at.type": "S",
  "root.attributes.modified_at.required": "False",
  "root.attributes.modified_at.format": "iso8601",
  "root.attributes.modified_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.children.type": "M",
  "root.attributes.children.required": "False",
  "root.attributes.children.attributes.order_items.type": "L",
  "root.attributes.children.attributes.order_items.required": "False",
  "root.attributes.children.attributes.order_items.items.type": "M",
  "root.attributes.children.attributes.order_items.items.attributes.order_item_id.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.order_item_id.required": "True",
  "root.attributes.children.attributes.order_items.items.attributes.order_item_id.format": "uuidv4",
  "root.attributes.children.attributes.order_items.items.attributes.order_item_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.children.attributes.order_items.items.attributes.order_id.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.order_id.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.order_id.format": "uuidv4",
  "root.attributes.children.attributes.order_items.items.attributes.order_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.children.attributes.order_items.items.attributes.order_number.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.order_number.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.order_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.children.attributes.order_items.items.attributes.business_date.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.business_date.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.business_date.regex": "^\\d{4}-\\d{2}-\\d{2}$",
  "root.attributes.children.attributes.order_items.items.attributes.line_number.type": "N",
  "root.attributes.children.attributes.order_items.items.attributes.line_number.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.line_number.regex": "^\\d+$",
  "root.attributes.children.attributes.order_items.items.attributes.product_number.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.product_number.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.product_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.children.attributes.order_items.items.attributes.product_name.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.product_name.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.product_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.children.attributes.order_items.items.attributes.recipe_number.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.recipe_number.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.recipe_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.children.attributes.order_items.items.attributes.recipe_name.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.recipe_name.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.recipe_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.children.attributes.order_items.items.attributes.category.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.category.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.category.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.children.attributes.order_items.items.attributes.family.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.family.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.family.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.children.attributes.order_items.items.attributes.quantity.type": "N",
  "root.attributes.children.attributes.order_items.items.attributes.quantity.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.quantity.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.children.attributes.order_items.items.attributes.size_label.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.size_label.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.size_label.regex": "^(Medium|Large)$",
  "root.attributes.children.attributes.order_items.items.attributes.milk_name.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.milk_name.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.milk_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.children.attributes.order_items.items.attributes.add_ons_text.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.add_ons_text.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.add_ons_text.regex": "^.{0,500}$",
  "root.attributes.children.attributes.order_items.items.attributes.vessel.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.vessel.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.vessel.regex": "^(cup|glass|bottle)$",
  "root.attributes.children.attributes.order_items.items.attributes.note.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.note.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.note.regex": "^.{0,500}$",
  "root.attributes.children.attributes.order_items.items.attributes.base_price.type": "N",
  "root.attributes.children.attributes.order_items.items.attributes.base_price.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.base_price.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.children.attributes.order_items.items.attributes.size_upcharge.type": "N",
  "root.attributes.children.attributes.order_items.items.attributes.size_upcharge.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.size_upcharge.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.children.attributes.order_items.items.attributes.milk_upcharge.type": "N",
  "root.attributes.children.attributes.order_items.items.attributes.milk_upcharge.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.milk_upcharge.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.children.attributes.order_items.items.attributes.add_ons_total.type": "N",
  "root.attributes.children.attributes.order_items.items.attributes.add_ons_total.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.add_ons_total.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.children.attributes.order_items.items.attributes.unit_price.type": "N",
  "root.attributes.children.attributes.order_items.items.attributes.unit_price.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.unit_price.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.children.attributes.order_items.items.attributes.line_total.type": "N",
  "root.attributes.children.attributes.order_items.items.attributes.line_total.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.line_total.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.children.attributes.order_items.items.attributes.is_voided.type": "BOOL",
  "root.attributes.children.attributes.order_items.items.attributes.is_voided.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.is_voided.regex": "^(true|false)$",
  "root.attributes.children.attributes.order_items.items.attributes.created.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.created.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.created.format": "iso8601",
  "root.attributes.children.attributes.order_items.items.attributes.created.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.children.attributes.order_items.items.attributes.updated.type": "S",
  "root.attributes.children.attributes.order_items.items.attributes.updated.required": "False",
  "root.attributes.children.attributes.order_items.items.attributes.updated.format": "iso8601",
  "root.attributes.children.attributes.order_items.items.attributes.updated.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.children.attributes.order_receipt_lines.type": "L",
  "root.attributes.children.attributes.order_receipt_lines.required": "False",
  "root.attributes.children.attributes.order_receipt_lines.items.type": "M",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_receipt_line_id.type": "S",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_receipt_line_id.required": "True",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_receipt_line_id.format": "uuidv4",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_receipt_line_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_id.type": "S",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_id.required": "False",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_id.format": "uuidv4",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.receipt_line_id.type": "S",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.receipt_line_id.required": "False",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.receipt_line_id.format": "uuidv4",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.receipt_line_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_number.type": "S",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_number.required": "False",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.order_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.business_date.type": "S",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.business_date.required": "False",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.business_date.regex": "^\\d{4}-\\d{2}-\\d{2}$",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.line_number.type": "N",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.line_number.required": "False",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.line_number.regex": "^\\d+$",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.line_text.type": "S",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.line_text.required": "False",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.line_text.regex": "^.{0,500}$",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.receipt_version.type": "S",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.receipt_version.required": "False",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.receipt_version.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.created.type": "S",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.created.required": "False",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.created.format": "iso8601",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.created.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.updated.type": "S",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.updated.required": "False",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.updated.format": "iso8601",
  "root.attributes.children.attributes.order_receipt_lines.items.attributes.updated.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.children.attributes.order_recipe_lines.type": "L",
  "root.attributes.children.attributes.order_recipe_lines.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.type": "M",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_recipe_line_id.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_recipe_line_id.required": "True",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_recipe_line_id.format": "uuidv4",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_recipe_line_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_id.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_id.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_id.format": "uuidv4",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.entity_number.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.entity_number.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.entity_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.recipe_line_id.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.recipe_line_id.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.recipe_line_id.format": "uuidv4",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.recipe_line_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_number.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_number.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.business_date.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.business_date.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.business_date.regex": "^\\d{4}-\\d{2}-\\d{2}$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_item_id.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_item_id.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_item_id.format": "uuidv4",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.order_item_id.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.item_line_number.type": "N",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.item_line_number.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.item_line_number.regex": "^\\d+$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.recipe_line_number.type": "N",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.recipe_line_number.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.recipe_line_number.regex": "^\\d+$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.line_text.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.line_text.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.line_text.regex": "^.{0,500}$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.recipe_version.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.recipe_version.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.recipe_version.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.created.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.created.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.created.format": "iso8601",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.created.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.updated.type": "S",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.updated.required": "False",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.updated.format": "iso8601",
  "root.attributes.children.attributes.order_recipe_lines.items.attributes.updated.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$"
}

Response Schema¶

{
  "root.type": "M",
  "root.required": "True",
  "root.attributes.is_accepted.type": "BOOL",
  "root.attributes.is_accepted.required": "True",
  "root.attributes.message.type": "S",
  "root.attributes.message.required": "True",
  "root.attributes.request_id.type": "S",
  "root.attributes.request_id.required": "False"
}

Request Payload¶

{
  "order_id": "2fc1288c-5bc3-4842-8d35-8d38a1fe04c5",
  "store_id": "fea0d68f-e658-4352-8ed4-b05f89e665ca",
  "entity_number": "0001",
  "order_number": "0001",
  "modified_from_transaction_id": "4149c295-8bab-4cd9-95be-504663115382",
  "modified_from_order_number": "0001",
  "business_date": "2026-06-01",
  "order_date": "2026-06-01",
  "order_datetime": "2026-06-01T08:10:43Z",
  "item_count": "1",
  "total_quantity": "1",
  "subtotal_amount": "1",
  "discount_amount": "1",
  "service_charge_amount": "1",
  "tax_amount": "1",
  "total_amount": "1",
  "payment_method": "value-001",
  "payment_status": "value-001",
  "paid_amount": "1",
  "change_amount": "1",
  "payment_reference_number": "0001",
  "purchase_order_number": "0001",
  "purchase_order_status": "value-001",
  "branch_name": "Sample Caferimo Orders 001",
  "store_name": "Sample Caferimo Orders 001",
  "store_legal_name": "Sample Caferimo Orders 001",
  "store_tagline": "value-001",
  "store_address_line_1": "value-001",
  "store_address_line_2": "value-001",
  "store_contact_number": "0001",
  "store_tin": "value-001",
  "terminal_name": "Sample Caferimo Orders 001",
  "cashier_employee_number": "0001",
  "cashier_name": "Sample Caferimo Orders 001",
  "receipt_version": "value-001",
  "recipe_version": "value-001",
  "created": "2026-06-01T08:10:43Z",
  "updated": "2026-06-01T08:10:43Z",
  "sync_status": "value-001",
  "idempotency_key": "value-001",
  "order_lifecycle_status": "value-001",
  "void_reason": "value-001",
  "voided_at": "2026-06-01T08:10:43Z",
  "superseded_at": "2026-06-01T08:10:43Z",
  "superseded_by_transaction_id": "48e56bc4-da1c-4d3b-a747-5669cd6b7b83",
  "superseded_by_order_number": "0001",
  "modified_at": "2026-06-01T08:10:43Z",
  "children.order_items[0].order_item_id": "705c9c06-bbf8-40a3-81a7-3e3729f276e1",
  "children.order_items[0].order_id": "2fc1288c-5bc3-4842-8d35-8d38a1fe04c5",
  "children.order_items[0].order_number": "0001",
  "children.order_items[0].business_date": "2026-06-01",
  "children.order_items[0].line_number": "1",
  "children.order_items[0].product_number": "0001",
  "children.order_items[0].product_name": "Sample Caferimo Order Items 001",
  "children.order_items[0].recipe_number": "0001",
  "children.order_items[0].recipe_name": "Sample Caferimo Order Items 001",
  "children.order_items[0].category": "value-001",
  "children.order_items[0].family": "value-001",
  "children.order_items[0].quantity": "1",
  "children.order_items[0].size_label": "Medium",
  "children.order_items[0].milk_name": "Sample Caferimo Order Items 001",
  "children.order_items[0].add_ons_text": "value-001",
  "children.order_items[0].vessel": "cup",
  "children.order_items[0].note": "value-001",
  "children.order_items[0].base_price": "1",
  "children.order_items[0].size_upcharge": "1",
  "children.order_items[0].milk_upcharge": "1",
  "children.order_items[0].add_ons_total": "1",
  "children.order_items[0].unit_price": "1",
  "children.order_items[0].line_total": "1",
  "children.order_items[0].is_voided": "True",
  "children.order_items[0].created": "2026-06-01T08:10:43Z",
  "children.order_items[0].updated": "2026-06-01T08:10:43Z",
  "children.order_receipt_lines[0].order_receipt_line_id": "8ed28acd-dba2-4b0a-acf0-0bd2a25fbd27",
  "children.order_receipt_lines[0].order_id": "2fc1288c-5bc3-4842-8d35-8d38a1fe04c5",
  "children.order_receipt_lines[0].receipt_line_id": "ac218ade-784d-4335-b43c-8edebe60bb3b",
  "children.order_receipt_lines[0].order_number": "0001",
  "children.order_receipt_lines[0].business_date": "2026-06-01",
  "children.order_receipt_lines[0].line_number": "1",
  "children.order_receipt_lines[0].line_text": "value-001",
  "children.order_receipt_lines[0].receipt_version": "value-001",
  "children.order_receipt_lines[0].created": "2026-06-01T08:10:43Z",
  "children.order_receipt_lines[0].updated": "2026-06-01T08:10:43Z",
  "children.order_recipe_lines[0].order_recipe_line_id": "a296b2d1-d575-41e4-b95c-17d94278c76d",
  "children.order_recipe_lines[0].order_id": "2fc1288c-5bc3-4842-8d35-8d38a1fe04c5",
  "children.order_recipe_lines[0].entity_number": "0001",
  "children.order_recipe_lines[0].recipe_line_id": "a722f7c7-8641-44d8-add1-d4ef0a8219a9",
  "children.order_recipe_lines[0].order_number": "0001",
  "children.order_recipe_lines[0].business_date": "2026-06-01",
  "children.order_recipe_lines[0].order_item_id": "705c9c06-bbf8-40a3-81a7-3e3729f276e1",
  "children.order_recipe_lines[0].item_line_number": "1",
  "children.order_recipe_lines[0].recipe_line_number": "1",
  "children.order_recipe_lines[0].line_text": "value-001",
  "children.order_recipe_lines[0].recipe_version": "value-001",
  "children.order_recipe_lines[0].created": "2026-06-01T08:10:43Z",
  "children.order_recipe_lines[0].updated": "2026-06-01T08:10:43Z"
}

Response¶

{
  "root.type": "M",
  "root.required": "True",
  "root.attributes.is_accepted.type": "BOOL",
  "root.attributes.is_accepted.required": "True",
  "root.attributes.message.type": "S",
  "root.attributes.message.required": "True",
  "root.attributes.request_id.type": "S",
  "root.attributes.request_id.required": "False"
}

CMD curl¶

curl -X PATCH "https://iim2eohqsl.execute-api.ap-southeast-1.amazonaws.com/prod/caferimo-orders-patch-one" -H "Content-Type: application/json" --data-raw "{\"order_id\": \"2fc1288c-5bc3-4842-8d35-8d38a1fe04c5\", \"store_id\": \"fea0d68f-e658-4352-8ed4-b05f89e665ca\", \"entity_number\": \"0001\", \"order_number\": \"0001\", \"modified_from_transaction_id\": \"4149c295-8bab-4cd9-95be-504663115382\", \"modified_from_order_number\": \"0001\", \"business_date\": \"2026-06-01\", \"order_date\": \"2026-06-01\", \"order_datetime\": \"2026-06-01T08:10:43Z\", \"item_count\": 1, \"total_quantity\": 1, \"subtotal_amount\": 1, \"discount_amount\": 1, \"service_charge_amount\": 1, \"tax_amount\": 1, \"total_amount\": 1, \"payment_method\": \"value-001\", \"payment_status\": \"value-001\", \"paid_amount\": 1, \"change_amount\": 1, \"payment_reference_number\": \"0001\", \"purchase_order_number\": \"0001\", \"purchase_order_status\": \"value-001\", \"branch_name\": \"Sample Caferimo Orders 001\", \"store_name\": \"Sample Caferimo Orders 001\", \"store_legal_name\": \"Sample Caferimo Orders 001\", \"store_tagline\": \"value-001\", \"store_address_line_1\": \"value-001\", \"store_address_line_2\": \"value-001\", \"store_contact_number\": \"0001\", \"store_tin\": \"value-001\", \"terminal_name\": \"Sample Caferimo Orders 001\", \"cashier_employee_number\": \"0001\", \"cashier_name\": \"Sample Caferimo Orders 001\", \"receipt_version\": \"value-001\", \"recipe_version\": \"value-001\", \"created\": \"2026-06-01T08:10:43Z\", \"updated\": \"2026-06-01T08:10:43Z\", \"sync_status\": \"value-001\", \"idempotency_key\": \"value-001\", \"order_lifecycle_status\": \"value-001\", \"void_reason\": \"value-001\", \"voided_at\": \"2026-06-01T08:10:43Z\", \"superseded_at\": \"2026-06-01T08:10:43Z\", \"superseded_by_transaction_id\": \"48e56bc4-da1c-4d3b-a747-5669cd6b7b83\", \"superseded_by_order_number\": \"0001\", \"modified_at\": \"2026-06-01T08:10:43Z\", \"children\": {\"order_items\": [{\"order_item_id\": \"705c9c06-bbf8-40a3-81a7-3e3729f276e1\", \"order_id\": \"2fc1288c-5bc3-4842-8d35-8d38a1fe04c5\", \"order_number\": \"0001\", \"business_date\": \"2026-06-01\", \"line_number\": 1, \"product_number\": \"0001\", \"product_name\": \"Sample Caferimo Order Items 001\", \"recipe_number\": \"0001\", \"recipe_name\": \"Sample Caferimo Order Items 001\", \"category\": \"value-001\", \"family\": \"value-001\", \"quantity\": 1, \"size_label\": \"Medium\", \"milk_name\": \"Sample Caferimo Order Items 001\", \"add_ons_text\": \"value-001\", \"vessel\": \"cup\", \"note\": \"value-001\", \"base_price\": 1, \"size_upcharge\": 1, \"milk_upcharge\": 1, \"add_ons_total\": 1, \"unit_price\": 1, \"line_total\": 1, \"is_voided\": true, \"created\": \"2026-06-01T08:10:43Z\", \"updated\": \"2026-06-01T08:10:43Z\"}], \"order_receipt_lines\": [{\"order_receipt_line_id\": \"8ed28acd-dba2-4b0a-acf0-0bd2a25fbd27\", \"order_id\": \"2fc1288c-5bc3-4842-8d35-8d38a1fe04c5\", \"receipt_line_id\": \"ac218ade-784d-4335-b43c-8edebe60bb3b\", \"order_number\": \"0001\", \"business_date\": \"2026-06-01\", \"line_number\": 1, \"line_text\": \"value-001\", \"receipt_version\": \"value-001\", \"created\": \"2026-06-01T08:10:43Z\", \"updated\": \"2026-06-01T08:10:43Z\"}], \"order_recipe_lines\": [{\"order_recipe_line_id\": \"a296b2d1-d575-41e4-b95c-17d94278c76d\", \"order_id\": \"2fc1288c-5bc3-4842-8d35-8d38a1fe04c5\", \"entity_number\": \"0001\", \"recipe_line_id\": \"a722f7c7-8641-44d8-add1-d4ef0a8219a9\", \"order_number\": \"0001\", \"business_date\": \"2026-06-01\", \"order_item_id\": \"705c9c06-bbf8-40a3-81a7-3e3729f276e1\", \"item_line_number\": 1, \"recipe_line_number\": 1, \"line_text\": \"value-001\", \"recipe_version\": \"value-001\", \"created\": \"2026-06-01T08:10:43Z\", \"updated\": \"2026-06-01T08:10:43Z\"}]}}"

PowerShell curl¶

curl.exe -X PATCH "https://iim2eohqsl.execute-api.ap-southeast-1.amazonaws.com/prod/caferimo-orders-patch-one" -H "Content-Type: application/json" --data-raw '{"order_id": "2fc1288c-5bc3-4842-8d35-8d38a1fe04c5", "store_id": "fea0d68f-e658-4352-8ed4-b05f89e665ca", "entity_number": "0001", "order_number": "0001", "modified_from_transaction_id": "4149c295-8bab-4cd9-95be-504663115382", "modified_from_order_number": "0001", "business_date": "2026-06-01", "order_date": "2026-06-01", "order_datetime": "2026-06-01T08:10:43Z", "item_count": 1, "total_quantity": 1, "subtotal_amount": 1, "discount_amount": 1, "service_charge_amount": 1, "tax_amount": 1, "total_amount": 1, "payment_method": "value-001", "payment_status": "value-001", "paid_amount": 1, "change_amount": 1, "payment_reference_number": "0001", "purchase_order_number": "0001", "purchase_order_status": "value-001", "branch_name": "Sample Caferimo Orders 001", "store_name": "Sample Caferimo Orders 001", "store_legal_name": "Sample Caferimo Orders 001", "store_tagline": "value-001", "store_address_line_1": "value-001", "store_address_line_2": "value-001", "store_contact_number": "0001", "store_tin": "value-001", "terminal_name": "Sample Caferimo Orders 001", "cashier_employee_number": "0001", "cashier_name": "Sample Caferimo Orders 001", "receipt_version": "value-001", "recipe_version": "value-001", "created": "2026-06-01T08:10:43Z", "updated": "2026-06-01T08:10:43Z", "sync_status": "value-001", "idempotency_key": "value-001", "order_lifecycle_status": "value-001", "void_reason": "value-001", "voided_at": "2026-06-01T08:10:43Z", "superseded_at": "2026-06-01T08:10:43Z", "superseded_by_transaction_id": "48e56bc4-da1c-4d3b-a747-5669cd6b7b83", "superseded_by_order_number": "0001", "modified_at": "2026-06-01T08:10:43Z", "children": {"order_items": [{"order_item_id": "705c9c06-bbf8-40a3-81a7-3e3729f276e1", "order_id": "2fc1288c-5bc3-4842-8d35-8d38a1fe04c5", "order_number": "0001", "business_date": "2026-06-01", "line_number": 1, "product_number": "0001", "product_name": "Sample Caferimo Order Items 001", "recipe_number": "0001", "recipe_name": "Sample Caferimo Order Items 001", "category": "value-001", "family": "value-001", "quantity": 1, "size_label": "Medium", "milk_name": "Sample Caferimo Order Items 001", "add_ons_text": "value-001", "vessel": "cup", "note": "value-001", "base_price": 1, "size_upcharge": 1, "milk_upcharge": 1, "add_ons_total": 1, "unit_price": 1, "line_total": 1, "is_voided": true, "created": "2026-06-01T08:10:43Z", "updated": "2026-06-01T08:10:43Z"}], "order_receipt_lines": [{"order_receipt_line_id": "8ed28acd-dba2-4b0a-acf0-0bd2a25fbd27", "order_id": "2fc1288c-5bc3-4842-8d35-8d38a1fe04c5", "receipt_line_id": "ac218ade-784d-4335-b43c-8edebe60bb3b", "order_number": "0001", "business_date": "2026-06-01", "line_number": 1, "line_text": "value-001", "receipt_version": "value-001", "created": "2026-06-01T08:10:43Z", "updated": "2026-06-01T08:10:43Z"}], "order_recipe_lines": [{"order_recipe_line_id": "a296b2d1-d575-41e4-b95c-17d94278c76d", "order_id": "2fc1288c-5bc3-4842-8d35-8d38a1fe04c5", "entity_number": "0001", "recipe_line_id": "a722f7c7-8641-44d8-add1-d4ef0a8219a9", "order_number": "0001", "business_date": "2026-06-01", "order_item_id": "705c9c06-bbf8-40a3-81a7-3e3729f276e1", "item_line_number": 1, "recipe_line_number": 1, "line_text": "value-001", "recipe_version": "value-001", "created": "2026-06-01T08:10:43Z", "updated": "2026-06-01T08:10:43Z"}]}}'

/caferimo-orders-patch-one¶

Summary¶

Description¶

API Gateway Response¶

Payload Example¶

Payload Schema¶

Response Schema¶

Request Payload¶

Response¶

CMD curl¶

PowerShell curl¶

JEF Sphinx API Docs

Navigation

Related Topics