# Orders

## GET /v1/om/orders

> List all orders.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"GetOrdersV2ApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/GetOrdersV2_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"GetOrdersV2_Data":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/OrderM"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserMap"}},"customers":{"type":"array","items":{"$ref":"#/components/schemas/UserMap"}},"tables":{"type":"array","items":{"$ref":"#/components/schemas/TableSummaryM"}},"areas":{"type":"array","items":{"$ref":"#/components/schemas/AreaSummaryM"}},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodMap"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductM"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryMap"}},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/DiscountMap"}},"nextId":{"type":"string"},"query":{"$ref":"#/components/schemas/ListQueryResult_18e58b0e"}},"required":["orders"]},"OrderM":{"type":"object","properties":{"branchUid":{"type":"string"},"businessDate":{"type":"string"},"numberOfGuests":{"type":"number"},"type":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]},"status":{"type":"string","enum":["canceled","closed","open"]},"closedAt":{"type":"string","nullable":true},"canceledAt":{"type":"string"},"readyForPickup":{"type":"boolean"},"readyForPickupAt":{"type":"string"},"callNumber":{"type":"number"},"callSource":{"type":"string"},"checkPrintCount":{"type":"number"},"invoicePrintCount":{"type":"number"},"noteToKitchen":{"type":"string","nullable":true},"internalNote":{"type":"string","nullable":true},"total":{"type":"number"},"gross":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"totalDiscount":{"type":"number"},"subtotalDiscount":{"type":"number"},"taxDiscount":{"type":"number"},"totalLineDiscounts":{"type":"number"},"balanceDue":{"type":"number"},"prepaidTaxable":{"type":"number"},"prepaidTax":{"type":"number"},"totalPrepaid":{"type":"number"},"appendLoyaltyBenefits":{"type":"boolean","nullable":true},"shipTo":{"$ref":"#/components/schemas/OrderM_ShipTo"},"displayId":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"channelOrderDisplayId":{"type":"string"},"prepareTime":{"type":"number"},"estimatedPickupAt":{"type":"string"},"estimatedDeliveryAt":{"type":"string"},"externalData":{"$ref":"#/components/schemas/Record_5494b96e"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"},"fuid":{"type":"string"},"branchId":{"type":"string"},"formattedShortNumber":{"type":"string"},"can":{"type":"array","items":{"type":"string","enum":["cancel","close","delete","edit","ready-for-pickup","void"]}},"paidAmount":{"type":"number"},"userUid":{"type":"string"},"customerUid":{"type":"string"},"tableUids":{"type":"array","items":{"type":"string"}},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/PaymentM"}},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceM"}},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/OrderM_AlertsItem"}},"channelUid":{"type":"string"},"externalId":{"type":"string"},"estimatedReadyAt":{"type":"string"},"sessionUid":{"type":"string"}},"required":["branchUid","businessDate","type","status","checkPrintCount","invoicePrintCount","total","gross","subtotal","tax","totalDiscount","subtotalDiscount","taxDiscount","totalLineDiscounts","balanceDue","prepaidTaxable","prepaidTax","totalPrepaid","id","uid","fuid","branchId","formattedShortNumber","can","paidAmount","userUid","customerUid","tableUids","lines","appliedDiscounts","payments","invoices","alerts"]},"OrderM_ShipTo":{"type":"object","properties":{"building":{"type":"string"},"street":{"type":"string"},"secondary":{"type":"string"},"district":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"uid":{"type":"string"}},"required":["building","street","postalCode","city","uid"]},"Record_5494b96e":{"type":"object","properties":{}},"OrderLineM":{"type":"object","properties":{"quantity":{"type":"number"},"note":{"type":"string"},"seats":{"type":"array","items":{"type":"number"}},"course":{"type":"number"},"status":{"type":"string","enum":["Comped","Draft","Fired","New","Ready","Rejected","Request","Sent","Served","Voided"]},"productType":{"type":"string","enum":["combo","prepared","raw","service","wallet-voucher"]},"sentAt":{"type":"string"},"sentPrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"firePrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"voidPrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"lastPrintTime":{"type":"string"},"firedAt":{"type":"string"},"voidedAt":{"type":"string","nullable":true},"voidReasonId":{"type":"string","nullable":true},"voidWaste":{"type":"boolean","nullable":true},"requestedAt":{"type":"string","nullable":true},"acceptedAt":{"type":"string","nullable":true},"rejectedAt":{"type":"string","nullable":true},"rejectReasonId":{"type":"string","nullable":true},"price":{"type":"number"},"amount":{"type":"number"},"tax":{"type":"number"},"subtotal":{"type":"number"},"taxRate":{"type":"number"},"subtotalDiscounts":{"type":"number"},"taxDiscounts":{"type":"number"},"totalDiscounts":{"type":"number"},"gross":{"type":"number"},"dueAmount":{"type":"number"},"orderDiscountsSubtotal":{"type":"number"},"orderDiscountsTax":{"type":"number"},"orderAppliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM_OrderAppliedDiscountsItem"}},"voucherUid":{"type":"string"},"invoiceId":{"type":"string"},"comboLineId":{"type":"string"},"comboOptionUid":{"type":"string"},"locked":{"type":"boolean","nullable":true},"lockedBy":{"type":"string"},"lockedAt":{"type":"string"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"},"productUid":{"type":"string"},"uomUid":{"type":"string"},"appliedModifiers":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM_AppliedModifiersItem"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"can":{"type":"array","items":{"type":"string","enum":["accept","comp","delete","discount","edit","fire","reject","request","send","void"]}},"subinventoryUid":{"type":"string"},"returns":{"type":"array","items":{"$ref":"#/components/schemas/ReturnLineM"}},"returnedQuantity":{"type":"number"}},"required":["quantity","seats","status","price","amount","tax","subtotal","taxRate","subtotalDiscounts","taxDiscounts","totalDiscounts","gross","dueAmount","orderDiscountsSubtotal","orderDiscountsTax","orderAppliedDiscounts","invoiceId","id","uid","productUid","appliedModifiers","appliedDiscounts","can","returns","returnedQuantity"]},"OrderLineM_OrderAppliedDiscountsItem":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"}},"required":["id","amount","subtotal","tax"]},"OrderLineM_AppliedModifiersItem":{"type":"object","properties":{"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/AppliedModifierOptionM"}}},"required":["id","options"]},"AppliedModifierOptionM":{"type":"object","properties":{"quantity":{"type":"number"},"amount":{"type":"number"},"price":{"type":"number"},"visible":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"modifierUid":{"type":"string"}},"required":["quantity","amount","visible","id","modifierUid"]},"AppliedDiscountM":{"type":"object","properties":{"type":{"type":"string","enum":["custom-fixed","custom-percent","fixed","percent","reprice","unknown"]},"value":{"type":"number"},"excludeTax":{"type":"boolean"},"source":{"type":"string","enum":["deliverect","discount","loyalty-level","loyalty-points","loyalty-program","loyalty-tag"]},"sourceId":{"type":"string"},"locales":{"$ref":"#/components/schemas/Record_5494b96e"},"amount":{"type":"number"},"subtotalAmount":{"type":"number"},"taxAmount":{"type":"number"},"reasonId":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"invoiceId":{"type":"string","nullable":true},"id":{"type":"string"}},"required":["type","value","excludeTax","amount","subtotalAmount","taxAmount","id"]},"ReturnLineM":{"type":"object","properties":{"quantity":{"type":"number"},"waste":{"type":"boolean"},"invoiceId":{"type":"string"},"reasonId":{"type":"string"},"price":{"type":"number"},"amount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"gross":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"}},"required":["quantity","waste","invoiceId","price","amount","subtotal","tax","gross","id","uid"]},"PaymentM":{"type":"object","properties":{"type":{"type":"string","enum":["receipt","refund"]},"status":{"type":"string","enum":["complete","pending","progress","reversed"]},"completedAt":{"type":"string"},"reversedAt":{"type":"string"},"custom":{"type":"boolean"},"amount":{"type":"number"},"sourcePaymentId":{"type":"string","nullable":true},"transactionRef":{"type":"string","nullable":true},"attrs":{"type":"object"},"invoiceId":{"type":"string"},"note":{"type":"string","nullable":true},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"can":{"type":"array","items":{"type":"string","enum":["confirm","delete","edit","pay","print","refund"]}},"methodUid":{"type":"string"}},"required":["type","status","custom","amount","invoiceId","id","can"]},"InvoiceM":{"type":"object","properties":{"type":{"type":"string","enum":["credit-note","debit-note","prepayment","standard"]},"status":{"type":"string","enum":["closed","open"]},"number":{"type":"number"},"source":{"type":"string"},"closedAt":{"type":"string"},"referenceInvoiceId":{"type":"string"},"applyExpiresAt":{"type":"string"},"checkPrintCount":{"type":"number"},"invoicePrintCount":{"type":"number"},"totalDiscount":{"type":"number"},"taxDiscount":{"type":"number"},"subtotalDiscount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"gross":{"type":"number"},"taxable":{"type":"number"},"total":{"type":"number"},"totalLineDiscounts":{"type":"number"},"prepaidTaxable":{"type":"number"},"prepaidTax":{"type":"number"},"totalPrepaid":{"type":"number"},"balanceDue":{"type":"number"},"id":{"type":"string"},"uid":{"type":"string"},"paidAmount":{"type":"number"},"appliedInvoices":{"type":"array","items":{"$ref":"#/components/schemas/AppliedInvoiceM"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"lines":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceM_LinesItem"}},"can":{"type":"array","items":{"type":"string","enum":["close","delete","pre-print","print","send","update"]}}},"required":["type","status","totalDiscount","taxDiscount","subtotalDiscount","subtotal","tax","gross","taxable","total","totalLineDiscounts","prepaidTaxable","prepaidTax","totalPrepaid","balanceDue","id","uid","paidAmount","appliedInvoices","appliedDiscounts","lines","can"]},"AppliedInvoiceM":{"type":"object","properties":{"code":{"type":"string"},"balance":{"type":"number"},"taxableBalance":{"type":"number"},"taxBalance":{"type":"number"},"sourceDate":{"type":"string"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"uid":{"type":"string"}},"required":["code","balance","taxableBalance","taxBalance","sourceDate","uid"]},"InvoiceM_LinesItem":{"type":"object","properties":{"id":{"type":"string"},"uid":{"type":"string"},"price":{"type":"number"},"amount":{"type":"number"},"dueAmount":{"type":"number"},"tax":{"type":"number"},"subtotal":{"type":"number"},"taxRate":{"type":"number"},"gross":{"type":"number"},"quantity":{"type":"number"},"productUid":{"type":"string"},"subtotalDiscounts":{"type":"number"},"taxDiscounts":{"type":"number"},"totalDiscounts":{"type":"number"},"referenceLineId":{"type":"string"},"status":{"type":"string","enum":["Comped","Draft","Fired","New","Ready","Rejected","Request","Sent","Served","Voided"]},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}}},"required":["id","uid","price","amount","dueAmount","tax","subtotal","taxRate","gross","quantity","productUid","subtotalDiscounts","taxDiscounts","totalDiscounts","status","appliedDiscounts"]},"OrderM_AlertsItem":{"type":"object","properties":{"type":{"type":"string","enum":["order-not-sent","pending-order-request"]}},"required":["type"]},"UserMap":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string","nullable":true},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountry":{"type":"string"},"phoneCountryCalling":{"type":"string"},"sequence":{"type":"number"},"number":{"type":"string"},"cityId":{"type":"string","nullable":true},"birthDate":{"type":"string","nullable":true},"gender":{"type":"object"},"passcode":{"type":"string","nullable":true},"unsubscribed":{"type":"boolean","nullable":true},"internalNote":{"type":"string","nullable":true},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"roleAssignments":{"type":"array","items":{"$ref":"#/components/schemas/RoleAssignmentMapSummary"}}},"required":["firstName","phone","phoneCountry","phoneCountryCalling","sequence","number","id","roleAssignments"]},"RoleAssignmentMapSummary":{"type":"object","properties":{"endDate":{"type":"string"},"id":{"type":"string"}},"required":["endDate","id"]},"TableSummaryM":{"type":"object","properties":{"name":{"type":"string"},"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"circle":{"type":"boolean","nullable":true},"minSeats":{"type":"number"},"maxSeats":{"type":"number"},"archived":{"type":"boolean"},"id":{"type":"string"},"areaId":{"type":"string"}},"required":["name","x","y","width","height","minSeats","maxSeats","id","areaId"]},"AreaSummaryM":{"type":"object","properties":{"locales":{"type":"object"},"backgroundImage":{"type":"string"},"id":{"type":"string"},"branchId":{"type":"string"}},"required":["locales","id","branchId"]},"PaymentMethodMap":{"type":"object","properties":{"locales":{"$ref":"#/components/schemas/__type_174bf132"},"visible":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"}},"required":["locales","visible","id"]},"__type_174bf132":{"type":"object","properties":{"ar":{"$ref":"#/components/schemas/__type_174bf132_Ar"},"en":{"$ref":"#/components/schemas/__type_174bf132_En"}},"required":["ar","en"]},"__type_174bf132_Ar":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"__type_174bf132_En":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"ProductM":{"type":"object","properties":{"image":{"type":"string"},"price":{"type":"number"},"locales":{"type":"object"},"calories":{"type":"number"},"sort":{"type":"number"},"allergies":{"type":"array","items":{"type":"string"}},"active":{"type":"boolean"},"posImageUrl":{"type":"string"},"type":{"type":"string","enum":["combo","prepared","raw","service","wallet-voucher"]},"sku":{"type":"string"},"inventory":{"type":"boolean"},"primaryUomUid":{"type":"string"},"voucherValidaty":{"type":"number"},"voucherPayLimit":{"type":"number"},"voucherSharingLimit":{"type":"number"},"voucherAccess":{"type":"string","enum":["anonymous","holder"]},"voucherDirectPay":{"type":"boolean"},"voucherTopup":{"type":"boolean"},"voucherAutoTopup":{"type":"boolean"},"voucherActivationEndDate":{"type":"string"},"id":{"type":"string"},"categoryId":{"type":"string"},"taxGroupUid":{"type":"string"},"bomUid":{"type":"string"},"listUids":{"type":"array","items":{"type":"string"}},"comboGroups":{"type":"array","items":{"$ref":"#/components/schemas/ComboGroupM"}},"modifiers":{"type":"array","items":{"$ref":"#/components/schemas/ModifierAssignmentM"}}},"required":["price","locales","id","categoryId","comboGroups","modifiers"]},"ComboGroupM":{"type":"object","properties":{"locales":{"type":"object"},"min":{"type":"number"},"max":{"type":"number"},"uid":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ComboOptionM"}}},"required":["locales","min","max","uid","options"]},"ComboOptionM":{"type":"object","properties":{"upcharge":{"type":"number"},"selected":{"type":"boolean"},"uid":{"type":"string"},"productUId":{"type":"string"}},"required":["uid","productUId"]},"ModifierAssignmentM":{"type":"object","properties":{"minSelection":{"type":"number"},"maxSelection":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ModifierOptionAssignmentM"}}},"required":["id","options"]},"ModifierOptionAssignmentM":{"type":"object","properties":{"defaultQuantity":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"}},"required":["id"]},"CategoryMap":{"type":"object","properties":{"image":{"type":"string"},"locales":{"type":"object"},"sort":{"type":"number","nullable":true},"id":{"type":"string"}},"required":["locales","id"]},"DiscountMap":{"type":"object","properties":{"locales":{"$ref":"#/components/schemas/__type_174bf132"},"type":{"type":"string","enum":["fixed","percent","reprice"]},"value":{"type":"number"},"qualifications":{"type":"array","items":{"type":"string","enum":["line","order"]}},"orderTypes":{"type":"array","items":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]}},"max":{"type":"number"},"isActive":{"type":"boolean"},"excludeTax":{"type":"boolean"},"reasonRequired":{"type":"boolean"},"commentRequired":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRuleM"}}},"required":["locales","type","value","qualifications","orderTypes","isActive","excludeTax","id","rules"]},"DiscountRuleM":{"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRuleM_ConditionsItem"}},"action":{"type":"string","enum":["exclude","include"]},"id":{"type":"string"}},"required":["conditions","action","id"]},"DiscountRuleM_ConditionsItem":{"type":"object","properties":{"key":{"type":"string","enum":["level","order-type","product-type"]},"operator":{"type":"string","enum":["contains","endsWith","equals","greater","greaterOrEquals","in","less","lessOrEquals","notEquals","startsWith"]},"value":{"type":"string"}},"required":["key","operator","value"]},"ListQueryResult_18e58b0e":{"type":"object","properties":{}},"GetOrdersV2ApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GetOrdersV2_Error"}},"required":["error"]},"GetOrdersV2_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/GetOrdersV2_ErrorCodes_enum"}]}},"required":["code"]},"GetOrdersV2_ErrorCodes_enum":{"type":"string","enum":["INVALID_FROM_ID","INVALID_PARAM_BUSINESS_DATE"]}}},"paths":{"/v1/om/orders":{"get":{"operationId":"Orders_list","parameters":[{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrdersV2ApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrdersV2ApiError"}}}}},"summary":"List all orders.","tags":["Orders"]}}}}
```

## POST /v1/om/orders

> Creates a new Order.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"CreateOrderApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/CreateOrder_Params"}},"required":["params"]},"CreateOrder_Params":{"type":"object","properties":{"branchId":{"type":"string"},"tableIds":{"type":"array","items":{"type":"string"}},"customerId":{"type":"string"},"userId":{"type":"string"},"numberOfGuests":{"type":"number"},"type":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]},"appendLoyaltyBenefits":{"type":"boolean"},"invoiceType":{"type":"string","enum":["prepayment","standard"]},"callNumber":{"type":"number"},"callSource":{"type":"string"},"deviceId":{"type":"string"},"applyExpiresAt":{"type":"string"},"externalId":{"type":"string"},"externalData":{"$ref":"#/components/schemas/__type_174bf132"},"shipTo":{"$ref":"#/components/schemas/CreateOrder_Params_ShipTo"},"displayId":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"channelUid":{"type":"string"},"channelOrderDisplayId":{"type":"string"},"noteToKitchen":{"type":"string","nullable":true},"internalNote":{"type":"string","nullable":true},"prepareTime":{"type":"number"},"estimatedPickupAt":{"type":"string"},"estimatedDeliveryAt":{"type":"string"}},"required":["branchId","type"]},"__type_174bf132":{"type":"object","properties":{"ar":{"$ref":"#/components/schemas/__type_174bf132_Ar"},"en":{"$ref":"#/components/schemas/__type_174bf132_En"}},"required":["ar","en"]},"__type_174bf132_Ar":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"__type_174bf132_En":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"CreateOrder_Params_ShipTo":{"type":"object","properties":{"building":{"type":"string"},"street":{"type":"string"},"secondary":{"type":"string"},"district":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"uid":{"type":"string"}},"required":["building","street","postalCode","city","uid"]},"CreateOrderApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/CreateOrder_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"CreateOrder_Data":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}},"paths":{"/v1/om/orders":{"post":{"operationId":"Orders_create","parameters":[{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderApiResponse"}}}}},"summary":"Creates a new Order.","tags":["Orders"]}}}}
```

## GET /v1/om/orders/{uid}

> Returns an order.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"GetOrderV2ApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/GetOrderV2_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"GetOrderV2_Data":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/GetOrderV2_Data_Order"},"user":{"$ref":"#/components/schemas/UserMap_1_89800dd9"},"customer":{"$ref":"#/components/schemas/UserMap_1_89800dd9"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/TableSummaryM"}},"areas":{"type":"array","items":{"$ref":"#/components/schemas/AreaSummaryM"}},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodMap"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductM"}},"modifiers":{"type":"array","items":{"$ref":"#/components/schemas/ModifierMap"}},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/DiscountMap"}}},"required":["order"]},"GetOrderV2_Data_Order":{"type":"object","properties":{"branchUid":{"type":"string"},"businessDate":{"type":"string"},"numberOfGuests":{"type":"number"},"type":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]},"status":{"type":"string","enum":["canceled","closed","open"]},"closedAt":{"type":"string","nullable":true},"canceledAt":{"type":"string"},"readyForPickup":{"type":"boolean"},"readyForPickupAt":{"type":"string"},"callNumber":{"type":"number"},"callSource":{"type":"string"},"checkPrintCount":{"type":"number"},"invoicePrintCount":{"type":"number"},"noteToKitchen":{"type":"string","nullable":true},"internalNote":{"type":"string","nullable":true},"total":{"type":"number"},"gross":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"totalDiscount":{"type":"number"},"subtotalDiscount":{"type":"number"},"taxDiscount":{"type":"number"},"totalLineDiscounts":{"type":"number"},"balanceDue":{"type":"number"},"prepaidTaxable":{"type":"number"},"prepaidTax":{"type":"number"},"totalPrepaid":{"type":"number"},"appendLoyaltyBenefits":{"type":"boolean","nullable":true},"shipTo":{"$ref":"#/components/schemas/GetOrderV2_Data_Order_ShipTo"},"displayId":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"channelOrderDisplayId":{"type":"string"},"prepareTime":{"type":"number"},"estimatedPickupAt":{"type":"string"},"estimatedDeliveryAt":{"type":"string"},"externalData":{"$ref":"#/components/schemas/Record_5494b96e"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"},"fuid":{"type":"string"},"branchId":{"type":"string"},"formattedShortNumber":{"type":"string"},"can":{"type":"array","items":{"type":"string","enum":["cancel","close","delete","edit","ready-for-pickup","void"]}},"paidAmount":{"type":"number"},"userUid":{"type":"string"},"customerUid":{"type":"string"},"tableUids":{"type":"array","items":{"type":"string"}},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/PaymentM"}},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceM"}},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/GetOrderV2_Data_Order_AlertsItem"}},"channelUid":{"type":"string"},"externalId":{"type":"string"},"estimatedReadyAt":{"type":"string"},"sessionUid":{"type":"string"}},"required":["branchUid","businessDate","type","status","checkPrintCount","invoicePrintCount","total","gross","subtotal","tax","totalDiscount","subtotalDiscount","taxDiscount","totalLineDiscounts","balanceDue","prepaidTaxable","prepaidTax","totalPrepaid","id","uid","fuid","branchId","formattedShortNumber","can","paidAmount","userUid","customerUid","tableUids","lines","appliedDiscounts","payments","invoices","alerts"]},"GetOrderV2_Data_Order_ShipTo":{"type":"object","properties":{"building":{"type":"string"},"street":{"type":"string"},"secondary":{"type":"string"},"district":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"uid":{"type":"string"}},"required":["building","street","postalCode","city","uid"]},"Record_5494b96e":{"type":"object","properties":{}},"OrderLineM":{"type":"object","properties":{"quantity":{"type":"number"},"note":{"type":"string"},"seats":{"type":"array","items":{"type":"number"}},"course":{"type":"number"},"status":{"type":"string","enum":["Comped","Draft","Fired","New","Ready","Rejected","Request","Sent","Served","Voided"]},"productType":{"type":"string","enum":["combo","prepared","raw","service","wallet-voucher"]},"sentAt":{"type":"string"},"sentPrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"firePrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"voidPrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"lastPrintTime":{"type":"string"},"firedAt":{"type":"string"},"voidedAt":{"type":"string","nullable":true},"voidReasonId":{"type":"string","nullable":true},"voidWaste":{"type":"boolean","nullable":true},"requestedAt":{"type":"string","nullable":true},"acceptedAt":{"type":"string","nullable":true},"rejectedAt":{"type":"string","nullable":true},"rejectReasonId":{"type":"string","nullable":true},"price":{"type":"number"},"amount":{"type":"number"},"tax":{"type":"number"},"subtotal":{"type":"number"},"taxRate":{"type":"number"},"subtotalDiscounts":{"type":"number"},"taxDiscounts":{"type":"number"},"totalDiscounts":{"type":"number"},"gross":{"type":"number"},"dueAmount":{"type":"number"},"orderDiscountsSubtotal":{"type":"number"},"orderDiscountsTax":{"type":"number"},"orderAppliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM_OrderAppliedDiscountsItem"}},"voucherUid":{"type":"string"},"invoiceId":{"type":"string"},"comboLineId":{"type":"string"},"comboOptionUid":{"type":"string"},"locked":{"type":"boolean","nullable":true},"lockedBy":{"type":"string"},"lockedAt":{"type":"string"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"},"productUid":{"type":"string"},"uomUid":{"type":"string"},"appliedModifiers":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM_AppliedModifiersItem"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"can":{"type":"array","items":{"type":"string","enum":["accept","comp","delete","discount","edit","fire","reject","request","send","void"]}},"subinventoryUid":{"type":"string"},"returns":{"type":"array","items":{"$ref":"#/components/schemas/ReturnLineM"}},"returnedQuantity":{"type":"number"}},"required":["quantity","seats","status","price","amount","tax","subtotal","taxRate","subtotalDiscounts","taxDiscounts","totalDiscounts","gross","dueAmount","orderDiscountsSubtotal","orderDiscountsTax","orderAppliedDiscounts","invoiceId","id","uid","productUid","appliedModifiers","appliedDiscounts","can","returns","returnedQuantity"]},"OrderLineM_OrderAppliedDiscountsItem":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"}},"required":["id","amount","subtotal","tax"]},"OrderLineM_AppliedModifiersItem":{"type":"object","properties":{"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/AppliedModifierOptionM"}}},"required":["id","options"]},"AppliedModifierOptionM":{"type":"object","properties":{"quantity":{"type":"number"},"amount":{"type":"number"},"price":{"type":"number"},"visible":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"modifierUid":{"type":"string"}},"required":["quantity","amount","visible","id","modifierUid"]},"AppliedDiscountM":{"type":"object","properties":{"type":{"type":"string","enum":["custom-fixed","custom-percent","fixed","percent","reprice","unknown"]},"value":{"type":"number"},"excludeTax":{"type":"boolean"},"source":{"type":"string","enum":["deliverect","discount","loyalty-level","loyalty-points","loyalty-program","loyalty-tag"]},"sourceId":{"type":"string"},"locales":{"$ref":"#/components/schemas/Record_5494b96e"},"amount":{"type":"number"},"subtotalAmount":{"type":"number"},"taxAmount":{"type":"number"},"reasonId":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"invoiceId":{"type":"string","nullable":true},"id":{"type":"string"}},"required":["type","value","excludeTax","amount","subtotalAmount","taxAmount","id"]},"ReturnLineM":{"type":"object","properties":{"quantity":{"type":"number"},"waste":{"type":"boolean"},"invoiceId":{"type":"string"},"reasonId":{"type":"string"},"price":{"type":"number"},"amount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"gross":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"}},"required":["quantity","waste","invoiceId","price","amount","subtotal","tax","gross","id","uid"]},"PaymentM":{"type":"object","properties":{"type":{"type":"string","enum":["receipt","refund"]},"status":{"type":"string","enum":["complete","pending","progress","reversed"]},"completedAt":{"type":"string"},"reversedAt":{"type":"string"},"custom":{"type":"boolean"},"amount":{"type":"number"},"sourcePaymentId":{"type":"string","nullable":true},"transactionRef":{"type":"string","nullable":true},"attrs":{"type":"object"},"invoiceId":{"type":"string"},"note":{"type":"string","nullable":true},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"can":{"type":"array","items":{"type":"string","enum":["confirm","delete","edit","pay","print","refund"]}},"methodUid":{"type":"string"}},"required":["type","status","custom","amount","invoiceId","id","can"]},"InvoiceM":{"type":"object","properties":{"type":{"type":"string","enum":["credit-note","debit-note","prepayment","standard"]},"status":{"type":"string","enum":["closed","open"]},"number":{"type":"number"},"source":{"type":"string"},"closedAt":{"type":"string"},"referenceInvoiceId":{"type":"string"},"applyExpiresAt":{"type":"string"},"checkPrintCount":{"type":"number"},"invoicePrintCount":{"type":"number"},"totalDiscount":{"type":"number"},"taxDiscount":{"type":"number"},"subtotalDiscount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"gross":{"type":"number"},"taxable":{"type":"number"},"total":{"type":"number"},"totalLineDiscounts":{"type":"number"},"prepaidTaxable":{"type":"number"},"prepaidTax":{"type":"number"},"totalPrepaid":{"type":"number"},"balanceDue":{"type":"number"},"id":{"type":"string"},"uid":{"type":"string"},"paidAmount":{"type":"number"},"appliedInvoices":{"type":"array","items":{"$ref":"#/components/schemas/AppliedInvoiceM"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"lines":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceM_LinesItem"}},"can":{"type":"array","items":{"type":"string","enum":["close","delete","pre-print","print","send","update"]}}},"required":["type","status","totalDiscount","taxDiscount","subtotalDiscount","subtotal","tax","gross","taxable","total","totalLineDiscounts","prepaidTaxable","prepaidTax","totalPrepaid","balanceDue","id","uid","paidAmount","appliedInvoices","appliedDiscounts","lines","can"]},"AppliedInvoiceM":{"type":"object","properties":{"code":{"type":"string"},"balance":{"type":"number"},"taxableBalance":{"type":"number"},"taxBalance":{"type":"number"},"sourceDate":{"type":"string"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"uid":{"type":"string"}},"required":["code","balance","taxableBalance","taxBalance","sourceDate","uid"]},"InvoiceM_LinesItem":{"type":"object","properties":{"id":{"type":"string"},"uid":{"type":"string"},"price":{"type":"number"},"amount":{"type":"number"},"dueAmount":{"type":"number"},"tax":{"type":"number"},"subtotal":{"type":"number"},"taxRate":{"type":"number"},"gross":{"type":"number"},"quantity":{"type":"number"},"productUid":{"type":"string"},"subtotalDiscounts":{"type":"number"},"taxDiscounts":{"type":"number"},"totalDiscounts":{"type":"number"},"referenceLineId":{"type":"string"},"status":{"type":"string","enum":["Comped","Draft","Fired","New","Ready","Rejected","Request","Sent","Served","Voided"]},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}}},"required":["id","uid","price","amount","dueAmount","tax","subtotal","taxRate","gross","quantity","productUid","subtotalDiscounts","taxDiscounts","totalDiscounts","status","appliedDiscounts"]},"GetOrderV2_Data_Order_AlertsItem":{"type":"object","properties":{"type":{"type":"string","enum":["order-not-sent","pending-order-request"]}},"required":["type"]},"UserMap_1_89800dd9":{"type":"object","properties":{}},"TableSummaryM":{"type":"object","properties":{"name":{"type":"string"},"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"circle":{"type":"boolean","nullable":true},"minSeats":{"type":"number"},"maxSeats":{"type":"number"},"archived":{"type":"boolean"},"id":{"type":"string"},"areaId":{"type":"string"}},"required":["name","x","y","width","height","minSeats","maxSeats","id","areaId"]},"AreaSummaryM":{"type":"object","properties":{"locales":{"type":"object"},"backgroundImage":{"type":"string"},"id":{"type":"string"},"branchId":{"type":"string"}},"required":["locales","id","branchId"]},"PaymentMethodMap":{"type":"object","properties":{"locales":{"$ref":"#/components/schemas/__type_174bf132"},"visible":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"}},"required":["locales","visible","id"]},"__type_174bf132":{"type":"object","properties":{"ar":{"$ref":"#/components/schemas/__type_174bf132_Ar"},"en":{"$ref":"#/components/schemas/__type_174bf132_En"}},"required":["ar","en"]},"__type_174bf132_Ar":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"__type_174bf132_En":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"ProductM":{"type":"object","properties":{"image":{"type":"string"},"price":{"type":"number"},"locales":{"type":"object"},"calories":{"type":"number"},"sort":{"type":"number"},"allergies":{"type":"array","items":{"type":"string"}},"active":{"type":"boolean"},"posImageUrl":{"type":"string"},"type":{"type":"string","enum":["combo","prepared","raw","service","wallet-voucher"]},"sku":{"type":"string"},"inventory":{"type":"boolean"},"primaryUomUid":{"type":"string"},"voucherValidaty":{"type":"number"},"voucherPayLimit":{"type":"number"},"voucherSharingLimit":{"type":"number"},"voucherAccess":{"type":"string","enum":["anonymous","holder"]},"voucherDirectPay":{"type":"boolean"},"voucherTopup":{"type":"boolean"},"voucherAutoTopup":{"type":"boolean"},"voucherActivationEndDate":{"type":"string"},"id":{"type":"string"},"categoryId":{"type":"string"},"taxGroupUid":{"type":"string"},"bomUid":{"type":"string"},"listUids":{"type":"array","items":{"type":"string"}},"comboGroups":{"type":"array","items":{"$ref":"#/components/schemas/ComboGroupM"}},"modifiers":{"type":"array","items":{"$ref":"#/components/schemas/ModifierAssignmentM"}}},"required":["price","locales","id","categoryId","comboGroups","modifiers"]},"ComboGroupM":{"type":"object","properties":{"locales":{"type":"object"},"min":{"type":"number"},"max":{"type":"number"},"uid":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ComboOptionM"}}},"required":["locales","min","max","uid","options"]},"ComboOptionM":{"type":"object","properties":{"upcharge":{"type":"number"},"selected":{"type":"boolean"},"uid":{"type":"string"},"productUId":{"type":"string"}},"required":["uid","productUId"]},"ModifierAssignmentM":{"type":"object","properties":{"minSelection":{"type":"number"},"maxSelection":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ModifierOptionAssignmentM"}}},"required":["id","options"]},"ModifierOptionAssignmentM":{"type":"object","properties":{"defaultQuantity":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"}},"required":["id"]},"ModifierMap":{"type":"object","properties":{"locales":{"type":"object"},"minSelection":{"type":"number"},"maxSelection":{"type":"number"},"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ModifierOptionMap"}}},"required":["locales","id"]},"ModifierOptionMap":{"type":"object","properties":{"id":{"type":"string"},"locales":{"type":"object"},"price":{"type":"number"},"isActive":{"type":"boolean"},"sortNumber":{"type":"number"},"multiple":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"uomAssignmentUid":{"type":"string"},"uomUid":{"type":"string"},"productUid":{"type":"string"}},"required":["id","locales","multiple"]},"DiscountMap":{"type":"object","properties":{"locales":{"$ref":"#/components/schemas/__type_174bf132"},"type":{"type":"string","enum":["fixed","percent","reprice"]},"value":{"type":"number"},"qualifications":{"type":"array","items":{"type":"string","enum":["line","order"]}},"orderTypes":{"type":"array","items":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]}},"max":{"type":"number"},"isActive":{"type":"boolean"},"excludeTax":{"type":"boolean"},"reasonRequired":{"type":"boolean"},"commentRequired":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRuleM"}}},"required":["locales","type","value","qualifications","orderTypes","isActive","excludeTax","id","rules"]},"DiscountRuleM":{"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRuleM_ConditionsItem"}},"action":{"type":"string","enum":["exclude","include"]},"id":{"type":"string"}},"required":["conditions","action","id"]},"DiscountRuleM_ConditionsItem":{"type":"object","properties":{"key":{"type":"string","enum":["level","order-type","product-type"]},"operator":{"type":"string","enum":["contains","endsWith","equals","greater","greaterOrEquals","in","less","lessOrEquals","notEquals","startsWith"]},"value":{"type":"string"}},"required":["key","operator","value"]},"GetOrderV2ApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GetOrderV2_Error"}},"required":["error"]},"GetOrderV2_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/GetOrderV2_ErrorCodes_enum"}]}},"required":["code"]},"GetOrderV2_ErrorCodes_enum":{"type":"string","enum":["INVALID_ORDER_ID","NotFound"]}}},"paths":{"/v1/om/orders/{uid}":{"get":{"operationId":"Orders_get","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderV2ApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderV2ApiError"}}}}},"summary":"Returns an order.","tags":["Orders"]}}}}
```

## PATCH /v1/om/orders/{uid}

> Updates an order.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"UpdateOrderApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/UpdateOrder_Params"}},"required":["params"]},"UpdateOrder_Params":{"type":"object","properties":{"tableIds":{"type":"array","items":{"type":"string"}},"customerId":{"type":"string","nullable":true},"userId":{"type":"string"},"numberOfGuests":{"type":"number"},"noteToKitchen":{"type":"string","nullable":true},"internalNote":{"type":"string","nullable":true},"type":{"type":"object"},"externalData":{"$ref":"#/components/schemas/__type_174bf132"},"readyForPickup":{"type":"boolean"},"prepareTime":{"type":"number"},"estimatedPickupAt":{"type":"string"},"estimatedDeliveryAt":{"type":"string"}}},"__type_174bf132":{"type":"object","properties":{"ar":{"$ref":"#/components/schemas/__type_174bf132_Ar"},"en":{"$ref":"#/components/schemas/__type_174bf132_En"}},"required":["ar","en"]},"__type_174bf132_Ar":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"__type_174bf132_En":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"UpdateOrderApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/UpdateOrder_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"UpdateOrder_Data":{"type":"object","properties":{"succeed":{"type":"boolean"}},"required":["succeed"]},"UpdateOrderApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/UpdateOrder_Error"}},"required":["error"]},"UpdateOrder_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/UpdateOrder_ErrorCodes_enum"}]}},"required":["code"]},"UpdateOrder_ErrorCodes_enum":{"type":"string","enum":["NoChanges","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED"]}}},"paths":{"/v1/om/orders/{uid}":{"patch":{"operationId":"Orders_001_update","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderApiError"}}}}},"summary":"Updates an order.","tags":["Orders"]}}}}
```

## PATCH /v1/om/orders/{uid}/close

> Finalizes and closes the specified order.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"CloseOrderApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/CloseOrder_Params"}},"required":["params"]},"CloseOrder_Params":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"CloseOrderApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/CloseOrder_Error"}},"required":["error"]},"CloseOrder_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/CloseOrder_ErrorCodes_enum"}]}},"required":["code"]},"CloseOrder_ErrorCodes_enum":{"type":"string","enum":["ALREADY_CLOSED","CONTAINS_REQUEST","INVOICE_NOT_CLOSED","LINES_NOT_SENT","NO_INVOICE","PAYMENT_NOT_COMPLETE"]}}},"paths":{"/v1/om/orders/{uid}/close":{"patch":{"operationId":"Orders_close","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseOrderApiRequest"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseOrderApiError"}}}}},"summary":"Finalizes and closes the specified order.","tags":["Orders"]}}}}
```

## PATCH /v1/om/orders/{uid}/cancel

> Cancels an order.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"CancelOrder":{"type":"object","properties":{"Params":{"$ref":"#/components/schemas/CancelOrder_Params"},"Data":{"$ref":"#/components/schemas/CancelOrder_Data"},"ErrorCodes":{"type":"string","enum":["ALREADY_CLOSED","ALREADY_PAID","CONTAIN_LINES"]}},"required":["Params","Data","ErrorCodes"]},"CancelOrder_Params":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"CancelOrder_Data":{"type":"object","properties":{"succeed":{"type":"boolean"}},"required":["succeed"]},"CancelOrderApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/CancelOrder_Error"}},"required":["error"]},"CancelOrder_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/CancelOrder_ErrorCodes_enum"}]}},"required":["code"]},"CancelOrder_ErrorCodes_enum":{"type":"string","enum":["ALREADY_CLOSED","ALREADY_PAID","CONTAIN_LINES"]}}},"paths":{"/v1/om/orders/{uid}/cancel":{"patch":{"operationId":"Orders_cancel","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOrder"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOrderApiError"}}}}},"summary":"Cancels an order.","tags":["Orders"]}}}}
```

## PATCH /v1/om/orders/{uid}/void

> Voids an order.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"VoidOrderApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/VoidOrder_Params"}},"required":["params"]},"VoidOrder_Params":{"type":"object","properties":{"waste":{"type":"boolean"},"reasonId":{"type":"string"}},"required":["waste","reasonId"]},"VoidOrderApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/VoidOrder_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"VoidOrder_Data":{"type":"object","properties":{"succeed":{"type":"boolean"}},"required":["succeed"]},"VoidOrderApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/VoidOrder_Error"}},"required":["error"]},"VoidOrder_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/VoidOrder_ErrorCodes_enum"}]}},"required":["code"]},"VoidOrder_ErrorCodes_enum":{"type":"string","enum":["ALREADY_CLOSED","ALREADY_PAID","INVALID_OPERATION"]}}},"paths":{"/v1/om/orders/{uid}/void":{"patch":{"operationId":"Orders_void","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidOrderApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidOrderApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidOrderApiError"}}}}},"summary":"Voids an order.","tags":["Orders"]}}}}
```

## GET /v1/om/orders/export

> Exports all orders with support for incremental fetching.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}}},"paths":{"/v1/om/orders/export":{"get":{"operationId":"Orders_export","parameters":[{"name":"updatedSince","required":false,"in":"query","schema":{"type":"string"}},{"name":"offset","required":false,"in":"query","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"summary":"Exports all orders with support for incremental fetching.","tags":["Orders"]}}}}
```

## PATCH /v1/om/orders/{uid}/discount

> Applies a discount at order level.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"ApplyDiscountApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/ApplyDiscount_Params"}},"required":["params"]},"ApplyDiscount_Params":{"type":"object","properties":{"discountId":{"type":"string"},"source":{"type":"string","enum":["deliverect","discount","loyalty-level","loyalty-points","loyalty-program","loyalty-tag"]},"reasonId":{"type":"string"},"comment":{"type":"string"}},"required":["discountId"]},"ApplyDiscountApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/ApplyDiscount_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"ApplyDiscount_Data":{"type":"object","properties":{}},"ApplyDiscountApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ApplyDiscount_Error"}},"required":["error"]},"ApplyDiscount_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/ApplyDiscount_ErrorCodes_enum"}]}},"required":["code"]},"ApplyDiscount_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","InvalidDeviceId","NO_PERMISSION","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED","REASON_REQUIRED"]}}},"paths":{"/v1/om/orders/{uid}/discount":{"patch":{"operationId":"Orders_discount","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyDiscountApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyDiscountApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyDiscountApiError"}}}}},"summary":"Applies a discount at order level.","tags":["Orders"]}}}}
```

## PATCH /v1/om/orders/{uid}/update-discount

> Updates applied discount at order level.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"UpdateAppliedDiscountApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/UpdateAppliedDiscount_Params"}},"required":["params"]},"UpdateAppliedDiscount_Params":{"type":"object","properties":{"discountId":{"type":"string"},"source":{"type":"string","enum":["deliverect","discount","loyalty-level","loyalty-points","loyalty-program","loyalty-tag"]},"reasonId":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true}},"required":["discountId"]},"UpdateAppliedDiscountApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/UpdateAppliedDiscount_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"UpdateAppliedDiscount_Data":{"type":"object","properties":{"succeed":{"type":"boolean"}},"required":["succeed"]},"UpdateAppliedDiscountApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/UpdateAppliedDiscount_Error"}},"required":["error"]},"UpdateAppliedDiscount_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/UpdateAppliedDiscount_ErrorCodes_enum"}]}},"required":["code"]},"UpdateAppliedDiscount_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","NO_PERMISSION","NoChanges","NotFound","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED","REASON_DISABLED","REASON_NOT_FOUND","REASON_REQUIRED"]}}},"paths":{"/v1/om/orders/{uid}/update-discount":{"patch":{"operationId":"Orders_updateDiscount","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppliedDiscountApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppliedDiscountApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppliedDiscountApiError"}}}}},"summary":"Updates applied discount at order level.","tags":["Orders"]}}}}
```

## PATCH /v1/om/orders/{uid}/cancel-discount

> Cancels a discount at order level.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"CancelDiscountApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/CancelDiscount_Params"}},"required":["params"]},"CancelDiscount_Params":{"type":"object","properties":{"discountId":{"type":"string"}},"required":["discountId"]},"CancelDiscountApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/CancelDiscount_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"CancelDiscount_Data":{"type":"object","properties":{}},"CancelDiscountApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/CancelDiscount_Error"}},"required":["error"]},"CancelDiscount_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/CancelDiscount_ErrorCodes_enum"}]}},"required":["code"]},"CancelDiscount_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","NO_PERMISSION","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED"]}}},"paths":{"/v1/om/orders/{uid}/cancel-discount":{"patch":{"operationId":"Orders_002_cancelDiscount","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelDiscountApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelDiscountApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelDiscountApiError"}}}}},"summary":"Cancels a discount at order level.","tags":["Orders"]}}}}
```

## PATCH /v1/om/orders/{uid}/custom-discount

> Applies a custom discount at order level.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"ApplyCustomDiscountApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/ApplyCustomDiscount_Params"}},"required":["params"]},"ApplyCustomDiscount_Params":{"type":"object","properties":{"type":{"type":"string","enum":["custom-fixed","custom-percent","unknown"]},"value":{"type":"number"},"excludeTax":{"type":"boolean"},"source":{"type":"string","enum":["deliverect","discount","loyalty-level","loyalty-points","loyalty-program","loyalty-tag"]},"sourceId":{"type":"string"},"locales":{"$ref":"#/components/schemas/__type_174bf132"},"subtotalAmount":{"type":"number"},"taxAmount":{"type":"number"}},"required":["type","value"]},"__type_174bf132":{"type":"object","properties":{"ar":{"$ref":"#/components/schemas/__type_174bf132_Ar"},"en":{"$ref":"#/components/schemas/__type_174bf132_En"}},"required":["ar","en"]},"__type_174bf132_Ar":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"__type_174bf132_En":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"ApplyCustomDiscountApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/ApplyCustomDiscount_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"ApplyCustomDiscount_Data":{"type":"object","properties":{}},"ApplyCustomDiscountApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ApplyCustomDiscount_Error"}},"required":["error"]},"ApplyCustomDiscount_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/ApplyCustomDiscount_ErrorCodes_enum"}]}},"required":["code"]},"ApplyCustomDiscount_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","InvalidDeviceId","NO_PERMISSION","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED"]}}},"paths":{"/v1/om/orders/{uid}/custom-discount":{"patch":{"operationId":"Orders_customDiscount","parameters":[{"name":"uid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyCustomDiscountApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyCustomDiscountApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyCustomDiscountApiError"}}}}},"summary":"Applies a custom discount at order level.","tags":["Orders"]}}}}
```

## GET /v1/om/orders/by-external/{externalId}

> Returns an order by external ID.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"GetOrderByExternalIdApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/GetOrderByExternalId_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"GetOrderByExternalId_Data":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/GetOrderByExternalId_Data_Order"},"user":{"$ref":"#/components/schemas/UserMap_1_89800dd9"},"customer":{"$ref":"#/components/schemas/UserMap_1_89800dd9"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/TableSummaryM"}},"areas":{"type":"array","items":{"$ref":"#/components/schemas/AreaSummaryM"}},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodMap"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductM"}},"modifiers":{"type":"array","items":{"$ref":"#/components/schemas/ModifierMap"}},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/DiscountMap"}}},"required":["order"]},"GetOrderByExternalId_Data_Order":{"type":"object","properties":{"branchUid":{"type":"string"},"businessDate":{"type":"string"},"numberOfGuests":{"type":"number"},"type":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]},"status":{"type":"string","enum":["canceled","closed","open"]},"closedAt":{"type":"string","nullable":true},"canceledAt":{"type":"string"},"readyForPickup":{"type":"boolean"},"readyForPickupAt":{"type":"string"},"callNumber":{"type":"number"},"callSource":{"type":"string"},"checkPrintCount":{"type":"number"},"invoicePrintCount":{"type":"number"},"noteToKitchen":{"type":"string","nullable":true},"internalNote":{"type":"string","nullable":true},"total":{"type":"number"},"gross":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"totalDiscount":{"type":"number"},"subtotalDiscount":{"type":"number"},"taxDiscount":{"type":"number"},"totalLineDiscounts":{"type":"number"},"balanceDue":{"type":"number"},"prepaidTaxable":{"type":"number"},"prepaidTax":{"type":"number"},"totalPrepaid":{"type":"number"},"appendLoyaltyBenefits":{"type":"boolean","nullable":true},"shipTo":{"$ref":"#/components/schemas/GetOrderByExternalId_Data_Order_ShipTo"},"displayId":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"channelOrderDisplayId":{"type":"string"},"prepareTime":{"type":"number"},"estimatedPickupAt":{"type":"string"},"estimatedDeliveryAt":{"type":"string"},"externalData":{"$ref":"#/components/schemas/Record_5494b96e"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"},"fuid":{"type":"string"},"branchId":{"type":"string"},"formattedShortNumber":{"type":"string"},"can":{"type":"array","items":{"type":"string","enum":["cancel","close","delete","edit","ready-for-pickup","void"]}},"paidAmount":{"type":"number"},"userUid":{"type":"string"},"customerUid":{"type":"string"},"tableUids":{"type":"array","items":{"type":"string"}},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/PaymentM"}},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceM"}},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/GetOrderByExternalId_Data_Order_AlertsItem"}},"channelUid":{"type":"string"},"externalId":{"type":"string"},"estimatedReadyAt":{"type":"string"},"sessionUid":{"type":"string"}},"required":["branchUid","businessDate","type","status","checkPrintCount","invoicePrintCount","total","gross","subtotal","tax","totalDiscount","subtotalDiscount","taxDiscount","totalLineDiscounts","balanceDue","prepaidTaxable","prepaidTax","totalPrepaid","id","uid","fuid","branchId","formattedShortNumber","can","paidAmount","userUid","customerUid","tableUids","lines","appliedDiscounts","payments","invoices","alerts"]},"GetOrderByExternalId_Data_Order_ShipTo":{"type":"object","properties":{"building":{"type":"string"},"street":{"type":"string"},"secondary":{"type":"string"},"district":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"uid":{"type":"string"}},"required":["building","street","postalCode","city","uid"]},"Record_5494b96e":{"type":"object","properties":{}},"OrderLineM":{"type":"object","properties":{"quantity":{"type":"number"},"note":{"type":"string"},"seats":{"type":"array","items":{"type":"number"}},"course":{"type":"number"},"status":{"type":"string","enum":["Comped","Draft","Fired","New","Ready","Rejected","Request","Sent","Served","Voided"]},"productType":{"type":"string","enum":["combo","prepared","raw","service","wallet-voucher"]},"sentAt":{"type":"string"},"sentPrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"firePrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"voidPrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"lastPrintTime":{"type":"string"},"firedAt":{"type":"string"},"voidedAt":{"type":"string","nullable":true},"voidReasonId":{"type":"string","nullable":true},"voidWaste":{"type":"boolean","nullable":true},"requestedAt":{"type":"string","nullable":true},"acceptedAt":{"type":"string","nullable":true},"rejectedAt":{"type":"string","nullable":true},"rejectReasonId":{"type":"string","nullable":true},"price":{"type":"number"},"amount":{"type":"number"},"tax":{"type":"number"},"subtotal":{"type":"number"},"taxRate":{"type":"number"},"subtotalDiscounts":{"type":"number"},"taxDiscounts":{"type":"number"},"totalDiscounts":{"type":"number"},"gross":{"type":"number"},"dueAmount":{"type":"number"},"orderDiscountsSubtotal":{"type":"number"},"orderDiscountsTax":{"type":"number"},"orderAppliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM_OrderAppliedDiscountsItem"}},"voucherUid":{"type":"string"},"invoiceId":{"type":"string"},"comboLineId":{"type":"string"},"comboOptionUid":{"type":"string"},"locked":{"type":"boolean","nullable":true},"lockedBy":{"type":"string"},"lockedAt":{"type":"string"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"},"productUid":{"type":"string"},"uomUid":{"type":"string"},"appliedModifiers":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM_AppliedModifiersItem"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"can":{"type":"array","items":{"type":"string","enum":["accept","comp","delete","discount","edit","fire","reject","request","send","void"]}},"subinventoryUid":{"type":"string"},"returns":{"type":"array","items":{"$ref":"#/components/schemas/ReturnLineM"}},"returnedQuantity":{"type":"number"}},"required":["quantity","seats","status","price","amount","tax","subtotal","taxRate","subtotalDiscounts","taxDiscounts","totalDiscounts","gross","dueAmount","orderDiscountsSubtotal","orderDiscountsTax","orderAppliedDiscounts","invoiceId","id","uid","productUid","appliedModifiers","appliedDiscounts","can","returns","returnedQuantity"]},"OrderLineM_OrderAppliedDiscountsItem":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"}},"required":["id","amount","subtotal","tax"]},"OrderLineM_AppliedModifiersItem":{"type":"object","properties":{"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/AppliedModifierOptionM"}}},"required":["id","options"]},"AppliedModifierOptionM":{"type":"object","properties":{"quantity":{"type":"number"},"amount":{"type":"number"},"price":{"type":"number"},"visible":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"modifierUid":{"type":"string"}},"required":["quantity","amount","visible","id","modifierUid"]},"AppliedDiscountM":{"type":"object","properties":{"type":{"type":"string","enum":["custom-fixed","custom-percent","fixed","percent","reprice","unknown"]},"value":{"type":"number"},"excludeTax":{"type":"boolean"},"source":{"type":"string","enum":["deliverect","discount","loyalty-level","loyalty-points","loyalty-program","loyalty-tag"]},"sourceId":{"type":"string"},"locales":{"$ref":"#/components/schemas/Record_5494b96e"},"amount":{"type":"number"},"subtotalAmount":{"type":"number"},"taxAmount":{"type":"number"},"reasonId":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"invoiceId":{"type":"string","nullable":true},"id":{"type":"string"}},"required":["type","value","excludeTax","amount","subtotalAmount","taxAmount","id"]},"ReturnLineM":{"type":"object","properties":{"quantity":{"type":"number"},"waste":{"type":"boolean"},"invoiceId":{"type":"string"},"reasonId":{"type":"string"},"price":{"type":"number"},"amount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"gross":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"}},"required":["quantity","waste","invoiceId","price","amount","subtotal","tax","gross","id","uid"]},"PaymentM":{"type":"object","properties":{"type":{"type":"string","enum":["receipt","refund"]},"status":{"type":"string","enum":["complete","pending","progress","reversed"]},"completedAt":{"type":"string"},"reversedAt":{"type":"string"},"custom":{"type":"boolean"},"amount":{"type":"number"},"sourcePaymentId":{"type":"string","nullable":true},"transactionRef":{"type":"string","nullable":true},"attrs":{"type":"object"},"invoiceId":{"type":"string"},"note":{"type":"string","nullable":true},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"can":{"type":"array","items":{"type":"string","enum":["confirm","delete","edit","pay","print","refund"]}},"methodUid":{"type":"string"}},"required":["type","status","custom","amount","invoiceId","id","can"]},"InvoiceM":{"type":"object","properties":{"type":{"type":"string","enum":["credit-note","debit-note","prepayment","standard"]},"status":{"type":"string","enum":["closed","open"]},"number":{"type":"number"},"source":{"type":"string"},"closedAt":{"type":"string"},"referenceInvoiceId":{"type":"string"},"applyExpiresAt":{"type":"string"},"checkPrintCount":{"type":"number"},"invoicePrintCount":{"type":"number"},"totalDiscount":{"type":"number"},"taxDiscount":{"type":"number"},"subtotalDiscount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"gross":{"type":"number"},"taxable":{"type":"number"},"total":{"type":"number"},"totalLineDiscounts":{"type":"number"},"prepaidTaxable":{"type":"number"},"prepaidTax":{"type":"number"},"totalPrepaid":{"type":"number"},"balanceDue":{"type":"number"},"id":{"type":"string"},"uid":{"type":"string"},"paidAmount":{"type":"number"},"appliedInvoices":{"type":"array","items":{"$ref":"#/components/schemas/AppliedInvoiceM"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"lines":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceM_LinesItem"}},"can":{"type":"array","items":{"type":"string","enum":["close","delete","pre-print","print","send","update"]}}},"required":["type","status","totalDiscount","taxDiscount","subtotalDiscount","subtotal","tax","gross","taxable","total","totalLineDiscounts","prepaidTaxable","prepaidTax","totalPrepaid","balanceDue","id","uid","paidAmount","appliedInvoices","appliedDiscounts","lines","can"]},"AppliedInvoiceM":{"type":"object","properties":{"code":{"type":"string"},"balance":{"type":"number"},"taxableBalance":{"type":"number"},"taxBalance":{"type":"number"},"sourceDate":{"type":"string"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"uid":{"type":"string"}},"required":["code","balance","taxableBalance","taxBalance","sourceDate","uid"]},"InvoiceM_LinesItem":{"type":"object","properties":{"id":{"type":"string"},"uid":{"type":"string"},"price":{"type":"number"},"amount":{"type":"number"},"dueAmount":{"type":"number"},"tax":{"type":"number"},"subtotal":{"type":"number"},"taxRate":{"type":"number"},"gross":{"type":"number"},"quantity":{"type":"number"},"productUid":{"type":"string"},"subtotalDiscounts":{"type":"number"},"taxDiscounts":{"type":"number"},"totalDiscounts":{"type":"number"},"referenceLineId":{"type":"string"},"status":{"type":"string","enum":["Comped","Draft","Fired","New","Ready","Rejected","Request","Sent","Served","Voided"]},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}}},"required":["id","uid","price","amount","dueAmount","tax","subtotal","taxRate","gross","quantity","productUid","subtotalDiscounts","taxDiscounts","totalDiscounts","status","appliedDiscounts"]},"GetOrderByExternalId_Data_Order_AlertsItem":{"type":"object","properties":{"type":{"type":"string","enum":["order-not-sent","pending-order-request"]}},"required":["type"]},"UserMap_1_89800dd9":{"type":"object","properties":{}},"TableSummaryM":{"type":"object","properties":{"name":{"type":"string"},"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"circle":{"type":"boolean","nullable":true},"minSeats":{"type":"number"},"maxSeats":{"type":"number"},"archived":{"type":"boolean"},"id":{"type":"string"},"areaId":{"type":"string"}},"required":["name","x","y","width","height","minSeats","maxSeats","id","areaId"]},"AreaSummaryM":{"type":"object","properties":{"locales":{"type":"object"},"backgroundImage":{"type":"string"},"id":{"type":"string"},"branchId":{"type":"string"}},"required":["locales","id","branchId"]},"PaymentMethodMap":{"type":"object","properties":{"locales":{"$ref":"#/components/schemas/__type_174bf132"},"visible":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"}},"required":["locales","visible","id"]},"__type_174bf132":{"type":"object","properties":{"ar":{"$ref":"#/components/schemas/__type_174bf132_Ar"},"en":{"$ref":"#/components/schemas/__type_174bf132_En"}},"required":["ar","en"]},"__type_174bf132_Ar":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"__type_174bf132_En":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"ProductM":{"type":"object","properties":{"image":{"type":"string"},"price":{"type":"number"},"locales":{"type":"object"},"calories":{"type":"number"},"sort":{"type":"number"},"allergies":{"type":"array","items":{"type":"string"}},"active":{"type":"boolean"},"posImageUrl":{"type":"string"},"type":{"type":"string","enum":["combo","prepared","raw","service","wallet-voucher"]},"sku":{"type":"string"},"inventory":{"type":"boolean"},"primaryUomUid":{"type":"string"},"voucherValidaty":{"type":"number"},"voucherPayLimit":{"type":"number"},"voucherSharingLimit":{"type":"number"},"voucherAccess":{"type":"string","enum":["anonymous","holder"]},"voucherDirectPay":{"type":"boolean"},"voucherTopup":{"type":"boolean"},"voucherAutoTopup":{"type":"boolean"},"voucherActivationEndDate":{"type":"string"},"id":{"type":"string"},"categoryId":{"type":"string"},"taxGroupUid":{"type":"string"},"bomUid":{"type":"string"},"listUids":{"type":"array","items":{"type":"string"}},"comboGroups":{"type":"array","items":{"$ref":"#/components/schemas/ComboGroupM"}},"modifiers":{"type":"array","items":{"$ref":"#/components/schemas/ModifierAssignmentM"}}},"required":["price","locales","id","categoryId","comboGroups","modifiers"]},"ComboGroupM":{"type":"object","properties":{"locales":{"type":"object"},"min":{"type":"number"},"max":{"type":"number"},"uid":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ComboOptionM"}}},"required":["locales","min","max","uid","options"]},"ComboOptionM":{"type":"object","properties":{"upcharge":{"type":"number"},"selected":{"type":"boolean"},"uid":{"type":"string"},"productUId":{"type":"string"}},"required":["uid","productUId"]},"ModifierAssignmentM":{"type":"object","properties":{"minSelection":{"type":"number"},"maxSelection":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ModifierOptionAssignmentM"}}},"required":["id","options"]},"ModifierOptionAssignmentM":{"type":"object","properties":{"defaultQuantity":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"}},"required":["id"]},"ModifierMap":{"type":"object","properties":{"locales":{"type":"object"},"minSelection":{"type":"number"},"maxSelection":{"type":"number"},"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ModifierOptionMap"}}},"required":["locales","id"]},"ModifierOptionMap":{"type":"object","properties":{"id":{"type":"string"},"locales":{"type":"object"},"price":{"type":"number"},"isActive":{"type":"boolean"},"sortNumber":{"type":"number"},"multiple":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"uomAssignmentUid":{"type":"string"},"uomUid":{"type":"string"},"productUid":{"type":"string"}},"required":["id","locales","multiple"]},"DiscountMap":{"type":"object","properties":{"locales":{"$ref":"#/components/schemas/__type_174bf132"},"type":{"type":"string","enum":["fixed","percent","reprice"]},"value":{"type":"number"},"qualifications":{"type":"array","items":{"type":"string","enum":["line","order"]}},"orderTypes":{"type":"array","items":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]}},"max":{"type":"number"},"isActive":{"type":"boolean"},"excludeTax":{"type":"boolean"},"reasonRequired":{"type":"boolean"},"commentRequired":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRuleM"}}},"required":["locales","type","value","qualifications","orderTypes","isActive","excludeTax","id","rules"]},"DiscountRuleM":{"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRuleM_ConditionsItem"}},"action":{"type":"string","enum":["exclude","include"]},"id":{"type":"string"}},"required":["conditions","action","id"]},"DiscountRuleM_ConditionsItem":{"type":"object","properties":{"key":{"type":"string","enum":["level","order-type","product-type"]},"operator":{"type":"string","enum":["contains","endsWith","equals","greater","greaterOrEquals","in","less","lessOrEquals","notEquals","startsWith"]},"value":{"type":"string"}},"required":["key","operator","value"]},"GetOrderByExternalIdApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GetOrderByExternalId_Error"}},"required":["error"]},"GetOrderByExternalId_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/GetOrderByExternalId_ErrorCodes_enum"}]}},"required":["code"]},"GetOrderByExternalId_ErrorCodes_enum":{"type":"string","enum":["INVALID_ORDER_ID","NotFound"]}}},"paths":{"/v1/om/orders/by-external/{externalId}":{"get":{"operationId":"Orders_getByExternalId","parameters":[{"name":"externalId","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderByExternalIdApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderByExternalIdApiError"}}}}},"summary":"Returns an order by external ID.","tags":["Orders"]}}}}
```

## GET /v1/om/orders/by-table/{tableUid}

> Returns the current open order for the specified table.

```json
{"openapi":"3.0.0","info":{"title":"Gormic Order Management & POS API","version":"1.0"},"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key","description":"API Key"}},"schemas":{"GetOrderByTableApiResponse":{"type":"object","properties":{"app":{"type":"string"},"service":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}},"instanceId":{"type":"string"},"requestId":{"type":"string"},"data":{"$ref":"#/components/schemas/GetOrderByTable_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"GetOrderByTable_Data":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/GetOrderByTable_Data_Order"},"user":{"$ref":"#/components/schemas/UserMap_1_89800dd9"},"customer":{"$ref":"#/components/schemas/UserMap_1_89800dd9"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/TableSummaryM"}},"areas":{"type":"array","items":{"$ref":"#/components/schemas/AreaSummaryM"}},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodMap"}},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductM"}},"modifiers":{"type":"array","items":{"$ref":"#/components/schemas/ModifierMap"}},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/DiscountMap"}}},"required":["order"]},"GetOrderByTable_Data_Order":{"type":"object","properties":{"branchUid":{"type":"string"},"businessDate":{"type":"string"},"numberOfGuests":{"type":"number"},"type":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]},"status":{"type":"string","enum":["canceled","closed","open"]},"closedAt":{"type":"string","nullable":true},"canceledAt":{"type":"string"},"readyForPickup":{"type":"boolean"},"readyForPickupAt":{"type":"string"},"callNumber":{"type":"number"},"callSource":{"type":"string"},"checkPrintCount":{"type":"number"},"invoicePrintCount":{"type":"number"},"noteToKitchen":{"type":"string","nullable":true},"internalNote":{"type":"string","nullable":true},"total":{"type":"number"},"gross":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"totalDiscount":{"type":"number"},"subtotalDiscount":{"type":"number"},"taxDiscount":{"type":"number"},"totalLineDiscounts":{"type":"number"},"balanceDue":{"type":"number"},"prepaidTaxable":{"type":"number"},"prepaidTax":{"type":"number"},"totalPrepaid":{"type":"number"},"appendLoyaltyBenefits":{"type":"boolean","nullable":true},"shipTo":{"$ref":"#/components/schemas/GetOrderByTable_Data_Order_ShipTo"},"displayId":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"channelOrderDisplayId":{"type":"string"},"prepareTime":{"type":"number"},"estimatedPickupAt":{"type":"string"},"estimatedDeliveryAt":{"type":"string"},"externalData":{"$ref":"#/components/schemas/Record_5494b96e"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"},"fuid":{"type":"string"},"branchId":{"type":"string"},"formattedShortNumber":{"type":"string"},"can":{"type":"array","items":{"type":"string","enum":["cancel","close","delete","edit","ready-for-pickup","void"]}},"paidAmount":{"type":"number"},"userUid":{"type":"string"},"customerUid":{"type":"string"},"tableUids":{"type":"array","items":{"type":"string"}},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/PaymentM"}},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceM"}},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/GetOrderByTable_Data_Order_AlertsItem"}},"channelUid":{"type":"string"},"externalId":{"type":"string"},"estimatedReadyAt":{"type":"string"},"sessionUid":{"type":"string"}},"required":["branchUid","businessDate","type","status","checkPrintCount","invoicePrintCount","total","gross","subtotal","tax","totalDiscount","subtotalDiscount","taxDiscount","totalLineDiscounts","balanceDue","prepaidTaxable","prepaidTax","totalPrepaid","id","uid","fuid","branchId","formattedShortNumber","can","paidAmount","userUid","customerUid","tableUids","lines","appliedDiscounts","payments","invoices","alerts"]},"GetOrderByTable_Data_Order_ShipTo":{"type":"object","properties":{"building":{"type":"string"},"street":{"type":"string"},"secondary":{"type":"string"},"district":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"uid":{"type":"string"}},"required":["building","street","postalCode","city","uid"]},"Record_5494b96e":{"type":"object","properties":{}},"OrderLineM":{"type":"object","properties":{"quantity":{"type":"number"},"note":{"type":"string"},"seats":{"type":"array","items":{"type":"number"}},"course":{"type":"number"},"status":{"type":"string","enum":["Comped","Draft","Fired","New","Ready","Rejected","Request","Sent","Served","Voided"]},"productType":{"type":"string","enum":["combo","prepared","raw","service","wallet-voucher"]},"sentAt":{"type":"string"},"sentPrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"firePrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"voidPrinting":{"$ref":"#/components/schemas/Record_5494b96e"},"lastPrintTime":{"type":"string"},"firedAt":{"type":"string"},"voidedAt":{"type":"string","nullable":true},"voidReasonId":{"type":"string","nullable":true},"voidWaste":{"type":"boolean","nullable":true},"requestedAt":{"type":"string","nullable":true},"acceptedAt":{"type":"string","nullable":true},"rejectedAt":{"type":"string","nullable":true},"rejectReasonId":{"type":"string","nullable":true},"price":{"type":"number"},"amount":{"type":"number"},"tax":{"type":"number"},"subtotal":{"type":"number"},"taxRate":{"type":"number"},"subtotalDiscounts":{"type":"number"},"taxDiscounts":{"type":"number"},"totalDiscounts":{"type":"number"},"gross":{"type":"number"},"dueAmount":{"type":"number"},"orderDiscountsSubtotal":{"type":"number"},"orderDiscountsTax":{"type":"number"},"orderAppliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM_OrderAppliedDiscountsItem"}},"voucherUid":{"type":"string"},"invoiceId":{"type":"string"},"comboLineId":{"type":"string"},"comboOptionUid":{"type":"string"},"locked":{"type":"boolean","nullable":true},"lockedBy":{"type":"string"},"lockedAt":{"type":"string"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"},"productUid":{"type":"string"},"uomUid":{"type":"string"},"appliedModifiers":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineM_AppliedModifiersItem"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"can":{"type":"array","items":{"type":"string","enum":["accept","comp","delete","discount","edit","fire","reject","request","send","void"]}},"subinventoryUid":{"type":"string"},"returns":{"type":"array","items":{"$ref":"#/components/schemas/ReturnLineM"}},"returnedQuantity":{"type":"number"}},"required":["quantity","seats","status","price","amount","tax","subtotal","taxRate","subtotalDiscounts","taxDiscounts","totalDiscounts","gross","dueAmount","orderDiscountsSubtotal","orderDiscountsTax","orderAppliedDiscounts","invoiceId","id","uid","productUid","appliedModifiers","appliedDiscounts","can","returns","returnedQuantity"]},"OrderLineM_OrderAppliedDiscountsItem":{"type":"object","properties":{"id":{"type":"string"},"amount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"}},"required":["id","amount","subtotal","tax"]},"OrderLineM_AppliedModifiersItem":{"type":"object","properties":{"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/AppliedModifierOptionM"}}},"required":["id","options"]},"AppliedModifierOptionM":{"type":"object","properties":{"quantity":{"type":"number"},"amount":{"type":"number"},"price":{"type":"number"},"visible":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"modifierUid":{"type":"string"}},"required":["quantity","amount","visible","id","modifierUid"]},"AppliedDiscountM":{"type":"object","properties":{"type":{"type":"string","enum":["custom-fixed","custom-percent","fixed","percent","reprice","unknown"]},"value":{"type":"number"},"excludeTax":{"type":"boolean"},"source":{"type":"string","enum":["deliverect","discount","loyalty-level","loyalty-points","loyalty-program","loyalty-tag"]},"sourceId":{"type":"string"},"locales":{"$ref":"#/components/schemas/Record_5494b96e"},"amount":{"type":"number"},"subtotalAmount":{"type":"number"},"taxAmount":{"type":"number"},"reasonId":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true},"invoiceId":{"type":"string","nullable":true},"id":{"type":"string"}},"required":["type","value","excludeTax","amount","subtotalAmount","taxAmount","id"]},"ReturnLineM":{"type":"object","properties":{"quantity":{"type":"number"},"waste":{"type":"boolean"},"invoiceId":{"type":"string"},"reasonId":{"type":"string"},"price":{"type":"number"},"amount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"gross":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"uid":{"type":"string"}},"required":["quantity","waste","invoiceId","price","amount","subtotal","tax","gross","id","uid"]},"PaymentM":{"type":"object","properties":{"type":{"type":"string","enum":["receipt","refund"]},"status":{"type":"string","enum":["complete","pending","progress","reversed"]},"completedAt":{"type":"string"},"reversedAt":{"type":"string"},"custom":{"type":"boolean"},"amount":{"type":"number"},"sourcePaymentId":{"type":"string","nullable":true},"transactionRef":{"type":"string","nullable":true},"attrs":{"type":"object"},"invoiceId":{"type":"string"},"note":{"type":"string","nullable":true},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"can":{"type":"array","items":{"type":"string","enum":["confirm","delete","edit","pay","print","refund"]}},"methodUid":{"type":"string"}},"required":["type","status","custom","amount","invoiceId","id","can"]},"InvoiceM":{"type":"object","properties":{"type":{"type":"string","enum":["credit-note","debit-note","prepayment","standard"]},"status":{"type":"string","enum":["closed","open"]},"number":{"type":"number"},"source":{"type":"string"},"closedAt":{"type":"string"},"referenceInvoiceId":{"type":"string"},"applyExpiresAt":{"type":"string"},"checkPrintCount":{"type":"number"},"invoicePrintCount":{"type":"number"},"totalDiscount":{"type":"number"},"taxDiscount":{"type":"number"},"subtotalDiscount":{"type":"number"},"subtotal":{"type":"number"},"tax":{"type":"number"},"gross":{"type":"number"},"taxable":{"type":"number"},"total":{"type":"number"},"totalLineDiscounts":{"type":"number"},"prepaidTaxable":{"type":"number"},"prepaidTax":{"type":"number"},"totalPrepaid":{"type":"number"},"balanceDue":{"type":"number"},"id":{"type":"string"},"uid":{"type":"string"},"paidAmount":{"type":"number"},"appliedInvoices":{"type":"array","items":{"$ref":"#/components/schemas/AppliedInvoiceM"}},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}},"lines":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceM_LinesItem"}},"can":{"type":"array","items":{"type":"string","enum":["close","delete","pre-print","print","send","update"]}}},"required":["type","status","totalDiscount","taxDiscount","subtotalDiscount","subtotal","tax","gross","taxable","total","totalLineDiscounts","prepaidTaxable","prepaidTax","totalPrepaid","balanceDue","id","uid","paidAmount","appliedInvoices","appliedDiscounts","lines","can"]},"AppliedInvoiceM":{"type":"object","properties":{"code":{"type":"string"},"balance":{"type":"number"},"taxableBalance":{"type":"number"},"taxBalance":{"type":"number"},"sourceDate":{"type":"string"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"uid":{"type":"string"}},"required":["code","balance","taxableBalance","taxBalance","sourceDate","uid"]},"InvoiceM_LinesItem":{"type":"object","properties":{"id":{"type":"string"},"uid":{"type":"string"},"price":{"type":"number"},"amount":{"type":"number"},"dueAmount":{"type":"number"},"tax":{"type":"number"},"subtotal":{"type":"number"},"taxRate":{"type":"number"},"gross":{"type":"number"},"quantity":{"type":"number"},"productUid":{"type":"string"},"subtotalDiscounts":{"type":"number"},"taxDiscounts":{"type":"number"},"totalDiscounts":{"type":"number"},"referenceLineId":{"type":"string"},"status":{"type":"string","enum":["Comped","Draft","Fired","New","Ready","Rejected","Request","Sent","Served","Voided"]},"appliedDiscounts":{"type":"array","items":{"$ref":"#/components/schemas/AppliedDiscountM"}}},"required":["id","uid","price","amount","dueAmount","tax","subtotal","taxRate","gross","quantity","productUid","subtotalDiscounts","taxDiscounts","totalDiscounts","status","appliedDiscounts"]},"GetOrderByTable_Data_Order_AlertsItem":{"type":"object","properties":{"type":{"type":"string","enum":["order-not-sent","pending-order-request"]}},"required":["type"]},"UserMap_1_89800dd9":{"type":"object","properties":{}},"TableSummaryM":{"type":"object","properties":{"name":{"type":"string"},"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number"},"height":{"type":"number"},"circle":{"type":"boolean","nullable":true},"minSeats":{"type":"number"},"maxSeats":{"type":"number"},"archived":{"type":"boolean"},"id":{"type":"string"},"areaId":{"type":"string"}},"required":["name","x","y","width","height","minSeats","maxSeats","id","areaId"]},"AreaSummaryM":{"type":"object","properties":{"locales":{"type":"object"},"backgroundImage":{"type":"string"},"id":{"type":"string"},"branchId":{"type":"string"}},"required":["locales","id","branchId"]},"PaymentMethodMap":{"type":"object","properties":{"locales":{"$ref":"#/components/schemas/__type_174bf132"},"visible":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"}},"required":["locales","visible","id"]},"__type_174bf132":{"type":"object","properties":{"ar":{"$ref":"#/components/schemas/__type_174bf132_Ar"},"en":{"$ref":"#/components/schemas/__type_174bf132_En"}},"required":["ar","en"]},"__type_174bf132_Ar":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"__type_174bf132_En":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"ProductM":{"type":"object","properties":{"image":{"type":"string"},"price":{"type":"number"},"locales":{"type":"object"},"calories":{"type":"number"},"sort":{"type":"number"},"allergies":{"type":"array","items":{"type":"string"}},"active":{"type":"boolean"},"posImageUrl":{"type":"string"},"type":{"type":"string","enum":["combo","prepared","raw","service","wallet-voucher"]},"sku":{"type":"string"},"inventory":{"type":"boolean"},"primaryUomUid":{"type":"string"},"voucherValidaty":{"type":"number"},"voucherPayLimit":{"type":"number"},"voucherSharingLimit":{"type":"number"},"voucherAccess":{"type":"string","enum":["anonymous","holder"]},"voucherDirectPay":{"type":"boolean"},"voucherTopup":{"type":"boolean"},"voucherAutoTopup":{"type":"boolean"},"voucherActivationEndDate":{"type":"string"},"id":{"type":"string"},"categoryId":{"type":"string"},"taxGroupUid":{"type":"string"},"bomUid":{"type":"string"},"listUids":{"type":"array","items":{"type":"string"}},"comboGroups":{"type":"array","items":{"$ref":"#/components/schemas/ComboGroupM"}},"modifiers":{"type":"array","items":{"$ref":"#/components/schemas/ModifierAssignmentM"}}},"required":["price","locales","id","categoryId","comboGroups","modifiers"]},"ComboGroupM":{"type":"object","properties":{"locales":{"type":"object"},"min":{"type":"number"},"max":{"type":"number"},"uid":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ComboOptionM"}}},"required":["locales","min","max","uid","options"]},"ComboOptionM":{"type":"object","properties":{"upcharge":{"type":"number"},"selected":{"type":"boolean"},"uid":{"type":"string"},"productUId":{"type":"string"}},"required":["uid","productUId"]},"ModifierAssignmentM":{"type":"object","properties":{"minSelection":{"type":"number"},"maxSelection":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ModifierOptionAssignmentM"}}},"required":["id","options"]},"ModifierOptionAssignmentM":{"type":"object","properties":{"defaultQuantity":{"type":"number"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"}},"required":["id"]},"ModifierMap":{"type":"object","properties":{"locales":{"type":"object"},"minSelection":{"type":"number"},"maxSelection":{"type":"number"},"id":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ModifierOptionMap"}}},"required":["locales","id"]},"ModifierOptionMap":{"type":"object","properties":{"id":{"type":"string"},"locales":{"type":"object"},"price":{"type":"number"},"isActive":{"type":"boolean"},"sortNumber":{"type":"number"},"multiple":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"uomAssignmentUid":{"type":"string"},"uomUid":{"type":"string"},"productUid":{"type":"string"}},"required":["id","locales","multiple"]},"DiscountMap":{"type":"object","properties":{"locales":{"$ref":"#/components/schemas/__type_174bf132"},"type":{"type":"string","enum":["fixed","percent","reprice"]},"value":{"type":"number"},"qualifications":{"type":"array","items":{"type":"string","enum":["line","order"]}},"orderTypes":{"type":"array","items":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]}},"max":{"type":"number"},"isActive":{"type":"boolean"},"excludeTax":{"type":"boolean"},"reasonRequired":{"type":"boolean"},"commentRequired":{"type":"boolean"},"createdAt":{"type":"string"},"createdVia":{"type":"string"},"createdBy":{"type":"string"},"updatedAt":{"type":"string"},"updatedVia":{"type":"string"},"updatedBy":{"type":"string"},"id":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRuleM"}}},"required":["locales","type","value","qualifications","orderTypes","isActive","excludeTax","id","rules"]},"DiscountRuleM":{"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/DiscountRuleM_ConditionsItem"}},"action":{"type":"string","enum":["exclude","include"]},"id":{"type":"string"}},"required":["conditions","action","id"]},"DiscountRuleM_ConditionsItem":{"type":"object","properties":{"key":{"type":"string","enum":["level","order-type","product-type"]},"operator":{"type":"string","enum":["contains","endsWith","equals","greater","greaterOrEquals","in","less","lessOrEquals","notEquals","startsWith"]},"value":{"type":"string"}},"required":["key","operator","value"]},"GetOrderByTableApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GetOrderByTable_Error"}},"required":["error"]},"GetOrderByTable_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/GetOrderByTable_ErrorCodes_enum"}]}},"required":["code"]},"GetOrderByTable_ErrorCodes_enum":{"type":"string","enum":["NO_ACTIVE_ORDER"]}}},"paths":{"/v1/om/orders/by-table/{tableUid}":{"get":{"operationId":"Orders_getByTable","parameters":[{"name":"tableUid","required":true,"in":"path","schema":{"type":"string"}},{"name":"organization-id","in":"header","required":true,"schema":{"type":"string"},"description":"Organization ID"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderByTableApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderByTableApiError"}}}}},"summary":"Returns the current open order for the specified table.","tags":["Orders"]}}}}
```