/store-orders-patch-one¶
Summary¶
Source repository:
jef-systems/jef-store-backendSource SHA:
8268dc359b63dc3e4d3c8fbcf5f91c0628e40da2Source run id:
28375649454Lambda function:
jef-store-orders-patch-oneHTTP method:
PATCHAPI path:
/store-orders-patch-oneEndpoint URL:
https://dqo3268ty9.execute-api.ap-southeast-1.amazonaws.com/prod/store-orders-patch-onePayload mode:
json-body
Description¶
|
jef-store-orders-patch-one Logical ID: jef-store:jef-store-orders:patch-one Order Number: 003 |
|
jef-store |
|
patch-one |
|
PATCH |
|
SYNCHRONOUS |
|
/store-orders-patch-one Endpoint Name: jef-store-orders-patch-one |
|
jef-store-orders |
|
order_number |
API Gateway Response¶
|
Lambda proxy statusCode |
|
Lambda response reflects commit success or failure. |
Payload Example¶
|
8fd57c5f-ec32-4bf6-b0ea-bd13587aca1e |
|
95446c52-7558-4433-9bf4-9a37ae1f300f |
Payload Schema¶
{
"type": "object",
"additionalProperties": "False",
"payload_mode": "parent-plus-children-wrapper",
"allow_children_wrapper": "True",
"children_wrapper_field": "children",
"allow_batch": "False",
"table": "jef-store-orders",
"primary_key": "order_number",
"required[0]": "order_number",
"properties.order_number.field": "order_number",
"properties.order_number.type": "S",
"properties.order_number.required": "False",
"properties.order_number.source_required": "True",
"properties.order_number.server_generated": "True",
"properties.order_number.autogenerated": "False",
"properties.order_number.frontend_autocomputed": "False",
"properties.order_number.format": "uuidv4",
"properties.order_number.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}$",
"properties.entity_number.field": "entity_number",
"properties.entity_number.type": "S",
"properties.entity_number.required": "True",
"properties.entity_number.source_required": "True",
"properties.entity_number.server_generated": "True",
"properties.entity_number.autogenerated": "False",
"properties.entity_number.frontend_autocomputed": "False",
"properties.entity_number.format": "uuidv4",
"properties.entity_number.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}$",
"properties.source.field": "source",
"properties.source.type": "S",
"properties.source.required": "True",
"properties.source.source_required": "True",
"properties.source.server_generated": "False",
"properties.source.autogenerated": "False",
"properties.source.frontend_autocomputed": "False",
"properties.source.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.is_active.field": "is_active",
"properties.is_active.type": "BOOL",
"properties.is_active.required": "False",
"properties.is_active.source_required": "True",
"properties.is_active.server_generated": "True",
"properties.is_active.autogenerated": "False",
"properties.is_active.frontend_autocomputed": "False",
"properties.is_active.regex": "^(true|false)$",
"properties.paid_at.field": "paid_at",
"properties.paid_at.type": "S",
"properties.paid_at.required": "True",
"properties.paid_at.source_required": "True",
"properties.paid_at.server_generated": "True",
"properties.paid_at.autogenerated": "False",
"properties.paid_at.frontend_autocomputed": "False",
"properties.paid_at.format": "iso8601",
"properties.paid_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
"properties.status.field": "status",
"properties.status.type": "S",
"properties.status.required": "True",
"properties.status.source_required": "True",
"properties.status.server_generated": "False",
"properties.status.autogenerated": "False",
"properties.status.frontend_autocomputed": "False",
"properties.status.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.payment_status.field": "payment_status",
"properties.payment_status.type": "S",
"properties.payment_status.required": "True",
"properties.payment_status.source_required": "True",
"properties.payment_status.server_generated": "False",
"properties.payment_status.autogenerated": "False",
"properties.payment_status.frontend_autocomputed": "False",
"properties.payment_status.regex": "^[A-Za-z0-9_-]{1,64}$",
"properties.payment_method.field": "payment_method",
"properties.payment_method.type": "S",
"properties.payment_method.required": "True",
"properties.payment_method.source_required": "True",
"properties.payment_method.server_generated": "False",
"properties.payment_method.autogenerated": "False",
"properties.payment_method.frontend_autocomputed": "False",
"properties.payment_method.regex": "^[A-Za-z0-9_-]{1,64}$",
"properties.payment_reference.field": "payment_reference",
"properties.payment_reference.type": "S",
"properties.payment_reference.required": "True",
"properties.payment_reference.source_required": "True",
"properties.payment_reference.server_generated": "False",
"properties.payment_reference.autogenerated": "False",
"properties.payment_reference.frontend_autocomputed": "False",
"properties.payment_reference.regex": "^[A-Za-z0-9_-]{1,64}$",
"properties.receipt_mode.field": "receipt_mode",
"properties.receipt_mode.type": "S",
"properties.receipt_mode.required": "True",
"properties.receipt_mode.source_required": "True",
"properties.receipt_mode.server_generated": "False",
"properties.receipt_mode.autogenerated": "False",
"properties.receipt_mode.frontend_autocomputed": "False",
"properties.receipt_mode.regex": "^[A-Za-z0-9_-]{1,64}$",
"properties.receipt_printed_at.field": "receipt_printed_at",
"properties.receipt_printed_at.type": "S",
"properties.receipt_printed_at.required": "True",
"properties.receipt_printed_at.source_required": "True",
"properties.receipt_printed_at.server_generated": "True",
"properties.receipt_printed_at.autogenerated": "False",
"properties.receipt_printed_at.frontend_autocomputed": "False",
"properties.receipt_printed_at.format": "iso8601",
"properties.receipt_printed_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
"properties.customer_number.field": "customer_number",
"properties.customer_number.type": "S",
"properties.customer_number.required": "True",
"properties.customer_number.source_required": "True",
"properties.customer_number.server_generated": "True",
"properties.customer_number.autogenerated": "False",
"properties.customer_number.frontend_autocomputed": "False",
"properties.customer_number.format": "uuidv4",
"properties.customer_number.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}$",
"properties.customer_name.field": "customer_name",
"properties.customer_name.type": "S",
"properties.customer_name.required": "True",
"properties.customer_name.source_required": "True",
"properties.customer_name.server_generated": "False",
"properties.customer_name.autogenerated": "False",
"properties.customer_name.frontend_autocomputed": "False",
"properties.customer_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.customer_phone.field": "customer_phone",
"properties.customer_phone.type": "S",
"properties.customer_phone.required": "True",
"properties.customer_phone.source_required": "True",
"properties.customer_phone.server_generated": "False",
"properties.customer_phone.autogenerated": "False",
"properties.customer_phone.frontend_autocomputed": "False",
"properties.customer_phone.regex": "^[0-9+() .-]{0,30}$",
"properties.customer_email.field": "customer_email",
"properties.customer_email.type": "S",
"properties.customer_email.required": "True",
"properties.customer_email.source_required": "True",
"properties.customer_email.server_generated": "False",
"properties.customer_email.autogenerated": "False",
"properties.customer_email.frontend_autocomputed": "False",
"properties.customer_email.regex": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
"properties.delivery_mode.field": "delivery_mode",
"properties.delivery_mode.type": "S",
"properties.delivery_mode.required": "True",
"properties.delivery_mode.source_required": "True",
"properties.delivery_mode.server_generated": "False",
"properties.delivery_mode.autogenerated": "False",
"properties.delivery_mode.frontend_autocomputed": "False",
"properties.delivery_mode.regex": "^[A-Za-z0-9_-]{1,64}$",
"properties.full_address.field": "full_address",
"properties.full_address.type": "S",
"properties.full_address.required": "True",
"properties.full_address.source_required": "True",
"properties.full_address.server_generated": "False",
"properties.full_address.autogenerated": "False",
"properties.full_address.frontend_autocomputed": "False",
"properties.full_address.regex": "^.{0,500}$",
"properties.branch_pickup_name.field": "branch_pickup_name",
"properties.branch_pickup_name.type": "S",
"properties.branch_pickup_name.required": "True",
"properties.branch_pickup_name.source_required": "True",
"properties.branch_pickup_name.server_generated": "False",
"properties.branch_pickup_name.autogenerated": "False",
"properties.branch_pickup_name.frontend_autocomputed": "False",
"properties.branch_pickup_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.delivery_instructions.field": "delivery_instructions",
"properties.delivery_instructions.type": "S",
"properties.delivery_instructions.required": "True",
"properties.delivery_instructions.source_required": "True",
"properties.delivery_instructions.server_generated": "False",
"properties.delivery_instructions.autogenerated": "False",
"properties.delivery_instructions.frontend_autocomputed": "False",
"properties.delivery_instructions.regex": "^.{0,500}$",
"properties.internal_note.field": "internal_note",
"properties.internal_note.type": "S",
"properties.internal_note.required": "True",
"properties.internal_note.source_required": "True",
"properties.internal_note.server_generated": "False",
"properties.internal_note.autogenerated": "False",
"properties.internal_note.frontend_autocomputed": "False",
"properties.internal_note.regex": "^.{0,500}$",
"properties.call_before_delivery.field": "call_before_delivery",
"properties.call_before_delivery.type": "BOOL",
"properties.call_before_delivery.required": "True",
"properties.call_before_delivery.source_required": "True",
"properties.call_before_delivery.server_generated": "False",
"properties.call_before_delivery.autogenerated": "False",
"properties.call_before_delivery.frontend_autocomputed": "False",
"properties.call_before_delivery.regex": "^(true|false)$",
"properties.subtotal.field": "subtotal",
"properties.subtotal.type": "N",
"properties.subtotal.required": "True",
"properties.subtotal.source_required": "True",
"properties.subtotal.server_generated": "False",
"properties.subtotal.autogenerated": "False",
"properties.subtotal.frontend_autocomputed": "False",
"properties.subtotal.regex": "^-?\\d+(\\.\\d+)?$",
"properties.shipping_fee.field": "shipping_fee",
"properties.shipping_fee.type": "N",
"properties.shipping_fee.required": "True",
"properties.shipping_fee.source_required": "True",
"properties.shipping_fee.server_generated": "False",
"properties.shipping_fee.autogenerated": "False",
"properties.shipping_fee.frontend_autocomputed": "False",
"properties.shipping_fee.regex": "^-?\\d+(\\.\\d+)?$",
"properties.discount.field": "discount",
"properties.discount.type": "N",
"properties.discount.required": "True",
"properties.discount.source_required": "True",
"properties.discount.server_generated": "False",
"properties.discount.autogenerated": "False",
"properties.discount.frontend_autocomputed": "False",
"properties.discount.regex": "^-?\\d+(\\.\\d+)?$",
"properties.grand_total.field": "grand_total",
"properties.grand_total.type": "N",
"properties.grand_total.required": "True",
"properties.grand_total.source_required": "True",
"properties.grand_total.server_generated": "False",
"properties.grand_total.autogenerated": "False",
"properties.grand_total.frontend_autocomputed": "False",
"properties.grand_total.regex": "^-?\\d+(\\.\\d+)?$",
"properties.amount_paid.field": "amount_paid",
"properties.amount_paid.type": "N",
"properties.amount_paid.required": "True",
"properties.amount_paid.source_required": "True",
"properties.amount_paid.server_generated": "False",
"properties.amount_paid.autogenerated": "False",
"properties.amount_paid.frontend_autocomputed": "False",
"properties.amount_paid.regex": "^-?\\d+(\\.\\d+)?$",
"properties.total_quantity.field": "total_quantity",
"properties.total_quantity.type": "N",
"properties.total_quantity.required": "True",
"properties.total_quantity.source_required": "True",
"properties.total_quantity.server_generated": "False",
"properties.total_quantity.autogenerated": "False",
"properties.total_quantity.frontend_autocomputed": "False",
"properties.total_quantity.regex": "^\\d+$",
"properties.version.field": "version",
"properties.version.type": "N",
"properties.version.required": "True",
"properties.version.source_required": "True",
"properties.version.server_generated": "False",
"properties.version.autogenerated": "False",
"properties.version.frontend_autocomputed": "False",
"properties.version.regex": "^\\d+$",
"children[0].parent_table": "jef-store-orders",
"children[0].child_table": "jef-store-order-items",
"children[0].parent_key": "order_number",
"children[0].child_foreign_key": "order_number",
"children[0].child_index_name": "gsi_1",
"children[0].child_index_key": "gsi_1_pk",
"children[0].aliases[0]": "jef-store-order-items",
"children[0].aliases[1]": "order-items",
"children[0].aliases[2]": "store-order-items",
"children[0].aliases[3]": "jef_store_order_items",
"children[0].aliases[4]": "order_items",
"children[0].aliases[5]": "store_order_items",
"children[0].aliases[6]": "items",
"children[1].parent_table": "jef-store-orders",
"children[1].child_table": "jef-store-payments",
"children[1].parent_key": "order_number",
"children[1].child_foreign_key": "order_number",
"children[1].child_index_name": "gsi_1",
"children[1].child_index_key": "gsi_1_pk",
"children[1].aliases[0]": "jef-store-payments",
"children[1].aliases[1]": "payments",
"children[1].aliases[2]": "store-payments",
"children[1].aliases[3]": "jef_store_payments",
"children[1].aliases[4]": "store_payments",
"patch.semantic_patch_version": "patch-ignore-immutable-v2",
"patch.allowed_fields[0]": "order_number",
"patch.allowed_fields[1]": "entity_number",
"patch.allowed_fields[2]": "source",
"patch.allowed_fields[3]": "is_active",
"patch.allowed_fields[4]": "paid_at",
"patch.allowed_fields[5]": "status",
"patch.allowed_fields[6]": "payment_status",
"patch.allowed_fields[7]": "payment_method",
"patch.allowed_fields[8]": "payment_reference",
"patch.allowed_fields[9]": "receipt_mode",
"patch.allowed_fields[10]": "receipt_printed_at",
"patch.allowed_fields[11]": "customer_number",
"patch.allowed_fields[12]": "customer_name",
"patch.allowed_fields[13]": "customer_phone",
"patch.allowed_fields[14]": "customer_email",
"patch.allowed_fields[15]": "delivery_mode",
"patch.allowed_fields[16]": "full_address",
"patch.allowed_fields[17]": "branch_pickup_name",
"patch.allowed_fields[18]": "delivery_instructions",
"patch.allowed_fields[19]": "internal_note",
"patch.allowed_fields[20]": "call_before_delivery",
"patch.allowed_fields[21]": "subtotal",
"patch.allowed_fields[22]": "shipping_fee",
"patch.allowed_fields[23]": "discount",
"patch.allowed_fields[24]": "grand_total",
"patch.allowed_fields[25]": "amount_paid",
"patch.allowed_fields[26]": "total_quantity",
"patch.allowed_fields[27]": "version",
"patch.ignored_fields[0]": "created",
"patch.ignored_fields[1]": "created_at",
"patch.ignored_fields[2]": "deleted_at",
"patch.ignored_fields[3]": "idempotency_key",
"patch.ignored_fields[4]": "is_deleted",
"patch.ignored_fields[5]": "schema_version",
"patch.ignored_fields[6]": "updated",
"patch.ignored_fields[7]": "updated_at",
"patch.editable_attributes.order_number.field": "order_number",
"patch.editable_attributes.order_number.type": "S",
"patch.editable_attributes.order_number.required": "False",
"patch.editable_attributes.order_number.source_required": "True",
"patch.editable_attributes.order_number.server_generated": "True",
"patch.editable_attributes.order_number.autogenerated": "False",
"patch.editable_attributes.order_number.frontend_autocomputed": "False",
"patch.editable_attributes.order_number.format": "uuidv4",
"patch.editable_attributes.order_number.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}$",
"patch.editable_attributes.entity_number.field": "entity_number",
"patch.editable_attributes.entity_number.type": "S",
"patch.editable_attributes.entity_number.required": "True",
"patch.editable_attributes.entity_number.source_required": "True",
"patch.editable_attributes.entity_number.server_generated": "True",
"patch.editable_attributes.entity_number.autogenerated": "False",
"patch.editable_attributes.entity_number.frontend_autocomputed": "False",
"patch.editable_attributes.entity_number.format": "uuidv4",
"patch.editable_attributes.entity_number.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}$",
"patch.editable_attributes.source.field": "source",
"patch.editable_attributes.source.type": "S",
"patch.editable_attributes.source.required": "True",
"patch.editable_attributes.source.source_required": "True",
"patch.editable_attributes.source.server_generated": "False",
"patch.editable_attributes.source.autogenerated": "False",
"patch.editable_attributes.source.frontend_autocomputed": "False",
"patch.editable_attributes.source.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.is_active.field": "is_active",
"patch.editable_attributes.is_active.type": "BOOL",
"patch.editable_attributes.is_active.required": "False",
"patch.editable_attributes.is_active.source_required": "True",
"patch.editable_attributes.is_active.server_generated": "True",
"patch.editable_attributes.is_active.autogenerated": "False",
"patch.editable_attributes.is_active.frontend_autocomputed": "False",
"patch.editable_attributes.is_active.regex": "^(true|false)$",
"patch.editable_attributes.paid_at.field": "paid_at",
"patch.editable_attributes.paid_at.type": "S",
"patch.editable_attributes.paid_at.required": "True",
"patch.editable_attributes.paid_at.source_required": "True",
"patch.editable_attributes.paid_at.server_generated": "True",
"patch.editable_attributes.paid_at.autogenerated": "False",
"patch.editable_attributes.paid_at.frontend_autocomputed": "False",
"patch.editable_attributes.paid_at.format": "iso8601",
"patch.editable_attributes.paid_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
"patch.editable_attributes.status.field": "status",
"patch.editable_attributes.status.type": "S",
"patch.editable_attributes.status.required": "True",
"patch.editable_attributes.status.source_required": "True",
"patch.editable_attributes.status.server_generated": "False",
"patch.editable_attributes.status.autogenerated": "False",
"patch.editable_attributes.status.frontend_autocomputed": "False",
"patch.editable_attributes.status.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.payment_status.field": "payment_status",
"patch.editable_attributes.payment_status.type": "S",
"patch.editable_attributes.payment_status.required": "True",
"patch.editable_attributes.payment_status.source_required": "True",
"patch.editable_attributes.payment_status.server_generated": "False",
"patch.editable_attributes.payment_status.autogenerated": "False",
"patch.editable_attributes.payment_status.frontend_autocomputed": "False",
"patch.editable_attributes.payment_status.regex": "^[A-Za-z0-9_-]{1,64}$",
"patch.editable_attributes.payment_method.field": "payment_method",
"patch.editable_attributes.payment_method.type": "S",
"patch.editable_attributes.payment_method.required": "True",
"patch.editable_attributes.payment_method.source_required": "True",
"patch.editable_attributes.payment_method.server_generated": "False",
"patch.editable_attributes.payment_method.autogenerated": "False",
"patch.editable_attributes.payment_method.frontend_autocomputed": "False",
"patch.editable_attributes.payment_method.regex": "^[A-Za-z0-9_-]{1,64}$",
"patch.editable_attributes.payment_reference.field": "payment_reference",
"patch.editable_attributes.payment_reference.type": "S",
"patch.editable_attributes.payment_reference.required": "True",
"patch.editable_attributes.payment_reference.source_required": "True",
"patch.editable_attributes.payment_reference.server_generated": "False",
"patch.editable_attributes.payment_reference.autogenerated": "False",
"patch.editable_attributes.payment_reference.frontend_autocomputed": "False",
"patch.editable_attributes.payment_reference.regex": "^[A-Za-z0-9_-]{1,64}$",
"patch.editable_attributes.receipt_mode.field": "receipt_mode",
"patch.editable_attributes.receipt_mode.type": "S",
"patch.editable_attributes.receipt_mode.required": "True",
"patch.editable_attributes.receipt_mode.source_required": "True",
"patch.editable_attributes.receipt_mode.server_generated": "False",
"patch.editable_attributes.receipt_mode.autogenerated": "False",
"patch.editable_attributes.receipt_mode.frontend_autocomputed": "False",
"patch.editable_attributes.receipt_mode.regex": "^[A-Za-z0-9_-]{1,64}$",
"patch.editable_attributes.receipt_printed_at.field": "receipt_printed_at",
"patch.editable_attributes.receipt_printed_at.type": "S",
"patch.editable_attributes.receipt_printed_at.required": "True",
"patch.editable_attributes.receipt_printed_at.source_required": "True",
"patch.editable_attributes.receipt_printed_at.server_generated": "True",
"patch.editable_attributes.receipt_printed_at.autogenerated": "False",
"patch.editable_attributes.receipt_printed_at.frontend_autocomputed": "False",
"patch.editable_attributes.receipt_printed_at.format": "iso8601",
"patch.editable_attributes.receipt_printed_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
"patch.editable_attributes.customer_number.field": "customer_number",
"patch.editable_attributes.customer_number.type": "S",
"patch.editable_attributes.customer_number.required": "True",
"patch.editable_attributes.customer_number.source_required": "True",
"patch.editable_attributes.customer_number.server_generated": "True",
"patch.editable_attributes.customer_number.autogenerated": "False",
"patch.editable_attributes.customer_number.frontend_autocomputed": "False",
"patch.editable_attributes.customer_number.format": "uuidv4",
"patch.editable_attributes.customer_number.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}$",
"patch.editable_attributes.customer_name.field": "customer_name",
"patch.editable_attributes.customer_name.type": "S",
"patch.editable_attributes.customer_name.required": "True",
"patch.editable_attributes.customer_name.source_required": "True",
"patch.editable_attributes.customer_name.server_generated": "False",
"patch.editable_attributes.customer_name.autogenerated": "False",
"patch.editable_attributes.customer_name.frontend_autocomputed": "False",
"patch.editable_attributes.customer_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.customer_phone.field": "customer_phone",
"patch.editable_attributes.customer_phone.type": "S",
"patch.editable_attributes.customer_phone.required": "True",
"patch.editable_attributes.customer_phone.source_required": "True",
"patch.editable_attributes.customer_phone.server_generated": "False",
"patch.editable_attributes.customer_phone.autogenerated": "False",
"patch.editable_attributes.customer_phone.frontend_autocomputed": "False",
"patch.editable_attributes.customer_phone.regex": "^[0-9+() .-]{0,30}$",
"patch.editable_attributes.customer_email.field": "customer_email",
"patch.editable_attributes.customer_email.type": "S",
"patch.editable_attributes.customer_email.required": "True",
"patch.editable_attributes.customer_email.source_required": "True",
"patch.editable_attributes.customer_email.server_generated": "False",
"patch.editable_attributes.customer_email.autogenerated": "False",
"patch.editable_attributes.customer_email.frontend_autocomputed": "False",
"patch.editable_attributes.customer_email.regex": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
"patch.editable_attributes.delivery_mode.field": "delivery_mode",
"patch.editable_attributes.delivery_mode.type": "S",
"patch.editable_attributes.delivery_mode.required": "True",
"patch.editable_attributes.delivery_mode.source_required": "True",
"patch.editable_attributes.delivery_mode.server_generated": "False",
"patch.editable_attributes.delivery_mode.autogenerated": "False",
"patch.editable_attributes.delivery_mode.frontend_autocomputed": "False",
"patch.editable_attributes.delivery_mode.regex": "^[A-Za-z0-9_-]{1,64}$",
"patch.editable_attributes.full_address.field": "full_address",
"patch.editable_attributes.full_address.type": "S",
"patch.editable_attributes.full_address.required": "True",
"patch.editable_attributes.full_address.source_required": "True",
"patch.editable_attributes.full_address.server_generated": "False",
"patch.editable_attributes.full_address.autogenerated": "False",
"patch.editable_attributes.full_address.frontend_autocomputed": "False",
"patch.editable_attributes.full_address.regex": "^.{0,500}$",
"patch.editable_attributes.branch_pickup_name.field": "branch_pickup_name",
"patch.editable_attributes.branch_pickup_name.type": "S",
"patch.editable_attributes.branch_pickup_name.required": "True",
"patch.editable_attributes.branch_pickup_name.source_required": "True",
"patch.editable_attributes.branch_pickup_name.server_generated": "False",
"patch.editable_attributes.branch_pickup_name.autogenerated": "False",
"patch.editable_attributes.branch_pickup_name.frontend_autocomputed": "False",
"patch.editable_attributes.branch_pickup_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.delivery_instructions.field": "delivery_instructions",
"patch.editable_attributes.delivery_instructions.type": "S",
"patch.editable_attributes.delivery_instructions.required": "True",
"patch.editable_attributes.delivery_instructions.source_required": "True",
"patch.editable_attributes.delivery_instructions.server_generated": "False",
"patch.editable_attributes.delivery_instructions.autogenerated": "False",
"patch.editable_attributes.delivery_instructions.frontend_autocomputed": "False",
"patch.editable_attributes.delivery_instructions.regex": "^.{0,500}$",
"patch.editable_attributes.internal_note.field": "internal_note",
"patch.editable_attributes.internal_note.type": "S",
"patch.editable_attributes.internal_note.required": "True",
"patch.editable_attributes.internal_note.source_required": "True",
"patch.editable_attributes.internal_note.server_generated": "False",
"patch.editable_attributes.internal_note.autogenerated": "False",
"patch.editable_attributes.internal_note.frontend_autocomputed": "False",
"patch.editable_attributes.internal_note.regex": "^.{0,500}$",
"patch.editable_attributes.call_before_delivery.field": "call_before_delivery",
"patch.editable_attributes.call_before_delivery.type": "BOOL",
"patch.editable_attributes.call_before_delivery.required": "True",
"patch.editable_attributes.call_before_delivery.source_required": "True",
"patch.editable_attributes.call_before_delivery.server_generated": "False",
"patch.editable_attributes.call_before_delivery.autogenerated": "False",
"patch.editable_attributes.call_before_delivery.frontend_autocomputed": "False",
"patch.editable_attributes.call_before_delivery.regex": "^(true|false)$",
"patch.editable_attributes.subtotal.field": "subtotal",
"patch.editable_attributes.subtotal.type": "N",
"patch.editable_attributes.subtotal.required": "True",
"patch.editable_attributes.subtotal.source_required": "True",
"patch.editable_attributes.subtotal.server_generated": "False",
"patch.editable_attributes.subtotal.autogenerated": "False",
"patch.editable_attributes.subtotal.frontend_autocomputed": "False",
"patch.editable_attributes.subtotal.regex": "^-?\\d+(\\.\\d+)?$",
"patch.editable_attributes.shipping_fee.field": "shipping_fee",
"patch.editable_attributes.shipping_fee.type": "N",
"patch.editable_attributes.shipping_fee.required": "True",
"patch.editable_attributes.shipping_fee.source_required": "True",
"patch.editable_attributes.shipping_fee.server_generated": "False",
"patch.editable_attributes.shipping_fee.autogenerated": "False",
"patch.editable_attributes.shipping_fee.frontend_autocomputed": "False",
"patch.editable_attributes.shipping_fee.regex": "^-?\\d+(\\.\\d+)?$",
"patch.editable_attributes.discount.field": "discount",
"patch.editable_attributes.discount.type": "N",
"patch.editable_attributes.discount.required": "True",
"patch.editable_attributes.discount.source_required": "True",
"patch.editable_attributes.discount.server_generated": "False",
"patch.editable_attributes.discount.autogenerated": "False",
"patch.editable_attributes.discount.frontend_autocomputed": "False",
"patch.editable_attributes.discount.regex": "^-?\\d+(\\.\\d+)?$",
"patch.editable_attributes.grand_total.field": "grand_total",
"patch.editable_attributes.grand_total.type": "N",
"patch.editable_attributes.grand_total.required": "True",
"patch.editable_attributes.grand_total.source_required": "True",
"patch.editable_attributes.grand_total.server_generated": "False",
"patch.editable_attributes.grand_total.autogenerated": "False",
"patch.editable_attributes.grand_total.frontend_autocomputed": "False",
"patch.editable_attributes.grand_total.regex": "^-?\\d+(\\.\\d+)?$",
"patch.editable_attributes.amount_paid.field": "amount_paid",
"patch.editable_attributes.amount_paid.type": "N",
"patch.editable_attributes.amount_paid.required": "True",
"patch.editable_attributes.amount_paid.source_required": "True",
"patch.editable_attributes.amount_paid.server_generated": "False",
"patch.editable_attributes.amount_paid.autogenerated": "False",
"patch.editable_attributes.amount_paid.frontend_autocomputed": "False",
"patch.editable_attributes.amount_paid.regex": "^-?\\d+(\\.\\d+)?$",
"patch.editable_attributes.total_quantity.field": "total_quantity",
"patch.editable_attributes.total_quantity.type": "N",
"patch.editable_attributes.total_quantity.required": "True",
"patch.editable_attributes.total_quantity.source_required": "True",
"patch.editable_attributes.total_quantity.server_generated": "False",
"patch.editable_attributes.total_quantity.autogenerated": "False",
"patch.editable_attributes.total_quantity.frontend_autocomputed": "False",
"patch.editable_attributes.total_quantity.regex": "^\\d+$",
"patch.editable_attributes.version.field": "version",
"patch.editable_attributes.version.type": "N",
"patch.editable_attributes.version.required": "True",
"patch.editable_attributes.version.source_required": "True",
"patch.editable_attributes.version.server_generated": "False",
"patch.editable_attributes.version.autogenerated": "False",
"patch.editable_attributes.version.frontend_autocomputed": "False",
"patch.editable_attributes.version.regex": "^\\d+$",
"root.type": "object",
"root.attributes.order_number.field": "order_number",
"root.attributes.order_number.type": "S",
"root.attributes.order_number.required": "False",
"root.attributes.order_number.source_required": "True",
"root.attributes.order_number.server_generated": "True",
"root.attributes.order_number.autogenerated": "False",
"root.attributes.order_number.frontend_autocomputed": "False",
"root.attributes.order_number.format": "uuidv4",
"root.attributes.order_number.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.field": "entity_number",
"root.attributes.entity_number.type": "S",
"root.attributes.entity_number.required": "True",
"root.attributes.entity_number.source_required": "True",
"root.attributes.entity_number.server_generated": "True",
"root.attributes.entity_number.autogenerated": "False",
"root.attributes.entity_number.frontend_autocomputed": "False",
"root.attributes.entity_number.format": "uuidv4",
"root.attributes.entity_number.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.source.field": "source",
"root.attributes.source.type": "S",
"root.attributes.source.required": "True",
"root.attributes.source.source_required": "True",
"root.attributes.source.server_generated": "False",
"root.attributes.source.autogenerated": "False",
"root.attributes.source.frontend_autocomputed": "False",
"root.attributes.source.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.is_active.field": "is_active",
"root.attributes.is_active.type": "BOOL",
"root.attributes.is_active.required": "False",
"root.attributes.is_active.source_required": "True",
"root.attributes.is_active.server_generated": "True",
"root.attributes.is_active.autogenerated": "False",
"root.attributes.is_active.frontend_autocomputed": "False",
"root.attributes.is_active.regex": "^(true|false)$",
"root.attributes.paid_at.field": "paid_at",
"root.attributes.paid_at.type": "S",
"root.attributes.paid_at.required": "True",
"root.attributes.paid_at.source_required": "True",
"root.attributes.paid_at.server_generated": "True",
"root.attributes.paid_at.autogenerated": "False",
"root.attributes.paid_at.frontend_autocomputed": "False",
"root.attributes.paid_at.format": "iso8601",
"root.attributes.paid_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
"root.attributes.status.field": "status",
"root.attributes.status.type": "S",
"root.attributes.status.required": "True",
"root.attributes.status.source_required": "True",
"root.attributes.status.server_generated": "False",
"root.attributes.status.autogenerated": "False",
"root.attributes.status.frontend_autocomputed": "False",
"root.attributes.status.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.payment_status.field": "payment_status",
"root.attributes.payment_status.type": "S",
"root.attributes.payment_status.required": "True",
"root.attributes.payment_status.source_required": "True",
"root.attributes.payment_status.server_generated": "False",
"root.attributes.payment_status.autogenerated": "False",
"root.attributes.payment_status.frontend_autocomputed": "False",
"root.attributes.payment_status.regex": "^[A-Za-z0-9_-]{1,64}$",
"root.attributes.payment_method.field": "payment_method",
"root.attributes.payment_method.type": "S",
"root.attributes.payment_method.required": "True",
"root.attributes.payment_method.source_required": "True",
"root.attributes.payment_method.server_generated": "False",
"root.attributes.payment_method.autogenerated": "False",
"root.attributes.payment_method.frontend_autocomputed": "False",
"root.attributes.payment_method.regex": "^[A-Za-z0-9_-]{1,64}$",
"root.attributes.payment_reference.field": "payment_reference",
"root.attributes.payment_reference.type": "S",
"root.attributes.payment_reference.required": "True",
"root.attributes.payment_reference.source_required": "True",
"root.attributes.payment_reference.server_generated": "False",
"root.attributes.payment_reference.autogenerated": "False",
"root.attributes.payment_reference.frontend_autocomputed": "False",
"root.attributes.payment_reference.regex": "^[A-Za-z0-9_-]{1,64}$",
"root.attributes.receipt_mode.field": "receipt_mode",
"root.attributes.receipt_mode.type": "S",
"root.attributes.receipt_mode.required": "True",
"root.attributes.receipt_mode.source_required": "True",
"root.attributes.receipt_mode.server_generated": "False",
"root.attributes.receipt_mode.autogenerated": "False",
"root.attributes.receipt_mode.frontend_autocomputed": "False",
"root.attributes.receipt_mode.regex": "^[A-Za-z0-9_-]{1,64}$",
"root.attributes.receipt_printed_at.field": "receipt_printed_at",
"root.attributes.receipt_printed_at.type": "S",
"root.attributes.receipt_printed_at.required": "True",
"root.attributes.receipt_printed_at.source_required": "True",
"root.attributes.receipt_printed_at.server_generated": "True",
"root.attributes.receipt_printed_at.autogenerated": "False",
"root.attributes.receipt_printed_at.frontend_autocomputed": "False",
"root.attributes.receipt_printed_at.format": "iso8601",
"root.attributes.receipt_printed_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
"root.attributes.customer_number.field": "customer_number",
"root.attributes.customer_number.type": "S",
"root.attributes.customer_number.required": "True",
"root.attributes.customer_number.source_required": "True",
"root.attributes.customer_number.server_generated": "True",
"root.attributes.customer_number.autogenerated": "False",
"root.attributes.customer_number.frontend_autocomputed": "False",
"root.attributes.customer_number.format": "uuidv4",
"root.attributes.customer_number.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.customer_name.field": "customer_name",
"root.attributes.customer_name.type": "S",
"root.attributes.customer_name.required": "True",
"root.attributes.customer_name.source_required": "True",
"root.attributes.customer_name.server_generated": "False",
"root.attributes.customer_name.autogenerated": "False",
"root.attributes.customer_name.frontend_autocomputed": "False",
"root.attributes.customer_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.customer_phone.field": "customer_phone",
"root.attributes.customer_phone.type": "S",
"root.attributes.customer_phone.required": "True",
"root.attributes.customer_phone.source_required": "True",
"root.attributes.customer_phone.server_generated": "False",
"root.attributes.customer_phone.autogenerated": "False",
"root.attributes.customer_phone.frontend_autocomputed": "False",
"root.attributes.customer_phone.regex": "^[0-9+() .-]{0,30}$",
"root.attributes.customer_email.field": "customer_email",
"root.attributes.customer_email.type": "S",
"root.attributes.customer_email.required": "True",
"root.attributes.customer_email.source_required": "True",
"root.attributes.customer_email.server_generated": "False",
"root.attributes.customer_email.autogenerated": "False",
"root.attributes.customer_email.frontend_autocomputed": "False",
"root.attributes.customer_email.regex": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
"root.attributes.delivery_mode.field": "delivery_mode",
"root.attributes.delivery_mode.type": "S",
"root.attributes.delivery_mode.required": "True",
"root.attributes.delivery_mode.source_required": "True",
"root.attributes.delivery_mode.server_generated": "False",
"root.attributes.delivery_mode.autogenerated": "False",
"root.attributes.delivery_mode.frontend_autocomputed": "False",
"root.attributes.delivery_mode.regex": "^[A-Za-z0-9_-]{1,64}$",
"root.attributes.full_address.field": "full_address",
"root.attributes.full_address.type": "S",
"root.attributes.full_address.required": "True",
"root.attributes.full_address.source_required": "True",
"root.attributes.full_address.server_generated": "False",
"root.attributes.full_address.autogenerated": "False",
"root.attributes.full_address.frontend_autocomputed": "False",
"root.attributes.full_address.regex": "^.{0,500}$",
"root.attributes.branch_pickup_name.field": "branch_pickup_name",
"root.attributes.branch_pickup_name.type": "S",
"root.attributes.branch_pickup_name.required": "True",
"root.attributes.branch_pickup_name.source_required": "True",
"root.attributes.branch_pickup_name.server_generated": "False",
"root.attributes.branch_pickup_name.autogenerated": "False",
"root.attributes.branch_pickup_name.frontend_autocomputed": "False",
"root.attributes.branch_pickup_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.delivery_instructions.field": "delivery_instructions",
"root.attributes.delivery_instructions.type": "S",
"root.attributes.delivery_instructions.required": "True",
"root.attributes.delivery_instructions.source_required": "True",
"root.attributes.delivery_instructions.server_generated": "False",
"root.attributes.delivery_instructions.autogenerated": "False",
"root.attributes.delivery_instructions.frontend_autocomputed": "False",
"root.attributes.delivery_instructions.regex": "^.{0,500}$",
"root.attributes.internal_note.field": "internal_note",
"root.attributes.internal_note.type": "S",
"root.attributes.internal_note.required": "True",
"root.attributes.internal_note.source_required": "True",
"root.attributes.internal_note.server_generated": "False",
"root.attributes.internal_note.autogenerated": "False",
"root.attributes.internal_note.frontend_autocomputed": "False",
"root.attributes.internal_note.regex": "^.{0,500}$",
"root.attributes.call_before_delivery.field": "call_before_delivery",
"root.attributes.call_before_delivery.type": "BOOL",
"root.attributes.call_before_delivery.required": "True",
"root.attributes.call_before_delivery.source_required": "True",
"root.attributes.call_before_delivery.server_generated": "False",
"root.attributes.call_before_delivery.autogenerated": "False",
"root.attributes.call_before_delivery.frontend_autocomputed": "False",
"root.attributes.call_before_delivery.regex": "^(true|false)$",
"root.attributes.subtotal.field": "subtotal",
"root.attributes.subtotal.type": "N",
"root.attributes.subtotal.required": "True",
"root.attributes.subtotal.source_required": "True",
"root.attributes.subtotal.server_generated": "False",
"root.attributes.subtotal.autogenerated": "False",
"root.attributes.subtotal.frontend_autocomputed": "False",
"root.attributes.subtotal.regex": "^-?\\d+(\\.\\d+)?$",
"root.attributes.shipping_fee.field": "shipping_fee",
"root.attributes.shipping_fee.type": "N",
"root.attributes.shipping_fee.required": "True",
"root.attributes.shipping_fee.source_required": "True",
"root.attributes.shipping_fee.server_generated": "False",
"root.attributes.shipping_fee.autogenerated": "False",
"root.attributes.shipping_fee.frontend_autocomputed": "False",
"root.attributes.shipping_fee.regex": "^-?\\d+(\\.\\d+)?$",
"root.attributes.discount.field": "discount",
"root.attributes.discount.type": "N",
"root.attributes.discount.required": "True",
"root.attributes.discount.source_required": "True",
"root.attributes.discount.server_generated": "False",
"root.attributes.discount.autogenerated": "False",
"root.attributes.discount.frontend_autocomputed": "False",
"root.attributes.discount.regex": "^-?\\d+(\\.\\d+)?$",
"root.attributes.grand_total.field": "grand_total",
"root.attributes.grand_total.type": "N",
"root.attributes.grand_total.required": "True",
"root.attributes.grand_total.source_required": "True",
"root.attributes.grand_total.server_generated": "False",
"root.attributes.grand_total.autogenerated": "False",
"root.attributes.grand_total.frontend_autocomputed": "False",
"root.attributes.grand_total.regex": "^-?\\d+(\\.\\d+)?$",
"root.attributes.amount_paid.field": "amount_paid",
"root.attributes.amount_paid.type": "N",
"root.attributes.amount_paid.required": "True",
"root.attributes.amount_paid.source_required": "True",
"root.attributes.amount_paid.server_generated": "False",
"root.attributes.amount_paid.autogenerated": "False",
"root.attributes.amount_paid.frontend_autocomputed": "False",
"root.attributes.amount_paid.regex": "^-?\\d+(\\.\\d+)?$",
"root.attributes.total_quantity.field": "total_quantity",
"root.attributes.total_quantity.type": "N",
"root.attributes.total_quantity.required": "True",
"root.attributes.total_quantity.source_required": "True",
"root.attributes.total_quantity.server_generated": "False",
"root.attributes.total_quantity.autogenerated": "False",
"root.attributes.total_quantity.frontend_autocomputed": "False",
"root.attributes.total_quantity.regex": "^\\d+$",
"root.attributes.version.field": "version",
"root.attributes.version.type": "N",
"root.attributes.version.required": "True",
"root.attributes.version.source_required": "True",
"root.attributes.version.server_generated": "False",
"root.attributes.version.autogenerated": "False",
"root.attributes.version.frontend_autocomputed": "False",
"root.attributes.version.regex": "^\\d+$"
}
Response Schema¶
{
"type": "object",
"properties.ok.type": "boolean",
"properties.accepted.type": "boolean",
"properties.is_committed.type": "boolean",
"properties.request_id.type": "string",
"properties.message.type": "string",
"properties.table.type": "string",
"properties.operation.type": "string",
"properties.primary_key.type": "string",
"properties.primary_key_value.type": "string",
"properties.item_update_count.type": "number",
"properties.child_update_count.type": "number"
}
Request Payload¶
{
"order_number": "8fd57c5f-ec32-4bf6-b0ea-bd13587aca1e",
"entity_number": "95446c52-7558-4433-9bf4-9a37ae1f300f"
}
Response¶
{
"type": "object",
"properties.ok.type": "boolean",
"properties.accepted.type": "boolean",
"properties.is_committed.type": "boolean",
"properties.request_id.type": "string",
"properties.message.type": "string",
"properties.table.type": "string",
"properties.operation.type": "string",
"properties.primary_key.type": "string",
"properties.primary_key_value.type": "string",
"properties.item_update_count.type": "number",
"properties.child_update_count.type": "number"
}
CMD curl¶
curl -X PATCH "https://dqo3268ty9.execute-api.ap-southeast-1.amazonaws.com/prod/store-orders-patch-one" -H "Content-Type: application/json" --data-raw "{\"order_number\": \"8fd57c5f-ec32-4bf6-b0ea-bd13587aca1e\", \"entity_number\": \"95446c52-7558-4433-9bf4-9a37ae1f300f\"}"
PowerShell curl¶
curl.exe -X PATCH "https://dqo3268ty9.execute-api.ap-southeast-1.amazonaws.com/prod/store-orders-patch-one" -H "Content-Type: application/json" --data-raw '{"order_number": "8fd57c5f-ec32-4bf6-b0ea-bd13587aca1e", "entity_number": "95446c52-7558-4433-9bf4-9a37ae1f300f"}'