# Order Lines

## POST /v1/om/order-lines

> Creates a new order line.

```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":{"CreateOrderLineApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/CreateOrderLine_Params"}},"required":["params"]},"CreateOrderLine_Params":{"type":"object","properties":{"orderId":{"type":"string"},"productId":{"type":"string"},"quantity":{"type":"number"},"seats":{"type":"array","items":{"type":"number"}},"course":{"type":"number"},"status":{"type":"string","enum":["Comped","Draft","Fired","New","Ready","Rejected","Request","Sent","Served","Voided"]},"invoiceId":{"type":"string"},"comboLineId":{"type":"string"},"comboOptionUid":{"type":"string"},"price":{"type":"number"},"skipCalculate":{"type":"boolean"},"note":{"type":"string"},"locked":{"type":"boolean","nullable":true}},"required":["orderId","productId","quantity"]},"CreateOrderLineApiResponse":{"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/CreateOrderLine_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"CreateOrderLine_Data":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"CreateOrderLineApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/CreateOrderLine_Error"}},"required":["error"]},"CreateOrderLine_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/CreateOrderLine_ErrorCodes_enum"}]}},"required":["code"]},"CreateOrderLine_ErrorCodes_enum":{"type":"string","enum":["INVALID_QUANTITY","INVOICE_CLOSED","INVOICE_NOT_FOUND","InvalidDeviceId","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED"]}}},"paths":{"/v1/om/order-lines":{"post":{"description":"","operationId":"OrderLines_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/CreateOrderLineApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderLineApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderLineApiError"}}}}},"summary":"Creates a new order line.","tags":["Order Lines"]}}}}
```

## DELETE /v1/om/order-lines/{uid}

> Deletes a draft order line.

```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":{"DeleteOrderLineApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/DeleteOrderLine_Params"}},"required":["params"]},"DeleteOrderLine_Params":{"type":"object","properties":{"id":{"type":"string"},"orderId":{"type":"string"}},"required":["id","orderId"]},"DeleteOrderLineApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/DeleteOrderLine_Error"}},"required":["error"]},"DeleteOrderLine_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/DeleteOrderLine_ErrorCodes_enum"}]}},"required":["code"]},"DeleteOrderLine_ErrorCodes_enum":{"type":"string","enum":["INVALID_OPERATION","INVOICE_CLOSED","INVOICE_NOT_FOUND","LINE_LOCKED","NOT_FOUND","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED"]}}},"paths":{"/v1/om/order-lines/{uid}":{"delete":{"operationId":"OrderLines_delete","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/DeleteOrderLineApiRequest"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteOrderLineApiError"}}}}},"summary":"Deletes a draft order line.","tags":["Order Lines"]}}}}
```

## PATCH /v1/om/order-lines/{uid}

> Updates an order line.

```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":{"UpdateOrderLineApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/UpdateOrderLine_Params"}},"required":["params"]},"UpdateOrderLine_Params":{"type":"object","properties":{"quantity":{"type":"number"},"seats":{"type":"array","items":{"type":"number"}},"status":{"type":"string","enum":["Comped","Draft","Fired","New","Ready","Rejected","Request","Sent","Served","Voided"]},"course":{"type":"number"},"note":{"type":"string"},"invoiceId":{"type":"string"},"locked":{"type":"boolean","nullable":true}}},"UpdateOrderLineApiResponse":{"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/UpdateOrderLine_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"UpdateOrderLine_Data":{"type":"object","properties":{"succeed":{"type":"boolean"}},"required":["succeed"]},"UpdateOrderLineApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/UpdateOrderLine_Error"}},"required":["error"]},"UpdateOrderLine_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/UpdateOrderLine_ErrorCodes_enum"}]}},"required":["code"]},"UpdateOrderLine_ErrorCodes_enum":{"type":"string","enum":["INVALID_QUANTITY","INVOICE_CLOSED","INVOICE_NOT_FOUND","LINE_LOCKED","NoChanges","NotFound","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED"]}}},"paths":{"/v1/om/order-lines/{uid}":{"patch":{"description":"","operationId":"OrderLines_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/UpdateOrderLineApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderLineApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderLineApiError"}}}}},"summary":"Updates an order line.","tags":["Order Lines"]}}}}
```

## PATCH /v1/om/order-lines/{uid}/void

> Voids an order line.

```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":{"VoidOrderLineApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/VoidOrderLine_Params"}},"required":["params"]},"VoidOrderLine_Params":{"type":"object","properties":{"waste":{"type":"boolean"},"reasonId":{"type":"string"}},"required":["waste","reasonId"]},"VoidOrderLineApiResponse":{"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/VoidOrderLine_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"VoidOrderLine_Data":{"type":"object","properties":{"succeed":{"type":"boolean"}},"required":["succeed"]},"VoidOrderLineApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/VoidOrderLine_Error"}},"required":["error"]},"VoidOrderLine_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/VoidOrderLine_ErrorCodes_enum"}]}},"required":["code"]},"VoidOrderLine_ErrorCodes_enum":{"type":"string","enum":["INVALID_OPERATION","INVOICE_CLOSED","INVOICE_NOT_FOUND","LINE_LOCKED","MISSING_PRODUCT","NOT_FOUND","NO_PERMISSION","ORDER_CANCELED","ORDER_CLOSED","PRINTERS_NOT_DEFINED","PRINTERS_OFFLINE","REASON_DISABLED","REASON_NOT_FOUND"]}}},"paths":{"/v1/om/order-lines/{uid}/void":{"patch":{"operationId":"OrderLines_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/VoidOrderLineApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidOrderLineApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidOrderLineApiError"}}}}},"summary":"Voids an order line.","tags":["Order Lines"]}}}}
```

## PATCH /v1/om/order-lines/{uid}/apply-modifier

> Applies a modifier to order line.

```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":{"ApplyModifierApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/ApplyModifier_Params"}},"required":["params"]},"ApplyModifier_Params":{"type":"object","properties":{"modifierId":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/ApplyModifier_Params_OptionsItem"}}},"required":["modifierId","options"]},"ApplyModifier_Params_OptionsItem":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"},"price":{"type":"number"}},"required":["id","quantity"]},"ApplyModifierApiResponse":{"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/ApplyModifier_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"ApplyModifier_Data":{"type":"object","properties":{}},"ApplyModifierApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ApplyModifier_Error"}},"required":["error"]},"ApplyModifier_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/ApplyModifier_ErrorCodes_enum"}]}},"required":["code"]},"ApplyModifier_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","INVOICE_NOT_FOUND","LINE_LOCKED","LINE_NOT_FOUND","OPTION_NOT_FOUND","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED"]}}},"paths":{"/v1/om/order-lines/{uid}/apply-modifier":{"patch":{"operationId":"OrderLines_modify","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/ApplyModifierApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyModifierApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyModifierApiError"}}}}},"summary":"Applies a modifier to order line.","tags":["Order Lines"]}}}}
```

## PATCH /v1/om/order-lines/{uid}/update-modifier

> Updates applied modifier option.

```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":{"UpdateAppliedModifierApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/UpdateAppliedModifier_Params"}},"required":["params"]},"UpdateAppliedModifier_Params":{"type":"object","properties":{"modifierId":{"type":"string"},"modifierOptionId":{"type":"string"},"quantity":{"type":"number"}},"required":["modifierId","modifierOptionId"]},"UpdateAppliedModifierApiResponse":{"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/UpdateAppliedModifier_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"UpdateAppliedModifier_Data":{"type":"object","properties":{}},"ApplyModifierApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ApplyModifier_Error"}},"required":["error"]},"ApplyModifier_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/ApplyModifier_ErrorCodes_enum"}]}},"required":["code"]},"ApplyModifier_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","INVOICE_NOT_FOUND","LINE_LOCKED","LINE_NOT_FOUND","OPTION_NOT_FOUND","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED"]}}},"paths":{"/v1/om/order-lines/{uid}/update-modifier":{"patch":{"operationId":"OrderLines_updateModifier","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/UpdateAppliedModifierApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppliedModifierApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyModifierApiError"}}}}},"summary":"Updates applied modifier option.","tags":["Order Lines"]}}}}
```

## PATCH /v1/om/order-lines/{uid}/discount

> Applies a discount at line 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":{"ApplyLineDiscountApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/ApplyLineDiscount_Params"}},"required":["params"]},"ApplyLineDiscount_Params":{"type":"object","properties":{"discountId":{"type":"string"},"reasonId":{"type":"string"},"comment":{"type":"string"}},"required":["discountId"]},"ApplyLineDiscountApiResponse":{"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/ApplyLineDiscount_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"ApplyLineDiscount_Data":{"type":"object","properties":{}},"ApplyLineDiscountApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ApplyLineDiscount_Error"}},"required":["error"]},"ApplyLineDiscount_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/ApplyLineDiscount_ErrorCodes_enum"}]}},"required":["code"]},"ApplyLineDiscount_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","INVOICE_NOT_FOUND","LINE_NOT_FOUND","NO_PERMISSION","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED","REASON_REQUIRED"]}}},"paths":{"/v1/om/order-lines/{uid}/discount":{"patch":{"operationId":"OrderLines_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/ApplyLineDiscountApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyLineDiscountApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyLineDiscountApiError"}}}}},"summary":"Applies a discount at line level","tags":["Order Lines"]}}}}
```

## PATCH /v1/om/order-lines/{uid}/update-discount

> Updates applied discount at line 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":{"UpdateAppliedLineDiscountApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/UpdateAppliedLineDiscount_Params"}},"required":["params"]},"UpdateAppliedLineDiscount_Params":{"type":"object","properties":{"discountId":{"type":"string"},"reasonId":{"type":"string","nullable":true},"comment":{"type":"string","nullable":true}},"required":["discountId"]},"UpdateAppliedLineDiscountApiResponse":{"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/UpdateAppliedLineDiscount_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"UpdateAppliedLineDiscount_Data":{"type":"object","properties":{"succeed":{"type":"boolean"}},"required":["succeed"]},"UpdateAppliedLineDiscountApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/UpdateAppliedLineDiscount_Error"}},"required":["error"]},"UpdateAppliedLineDiscount_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/UpdateAppliedLineDiscount_ErrorCodes_enum"}]}},"required":["code"]},"UpdateAppliedLineDiscount_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","INVOICE_NOT_FOUND","LINE_NOT_FOUND","NO_PERMISSION","NoChanges","NotFound","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED","REASON_DISABLED","REASON_NOT_FOUND","REASON_REQUIRED"]}}},"paths":{"/v1/om/order-lines/{uid}/update-discount":{"patch":{"operationId":"OrderLines_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/UpdateAppliedLineDiscountApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppliedLineDiscountApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppliedLineDiscountApiError"}}}}},"summary":"Updates applied discount at line level.","tags":["Order Lines"]}}}}
```

## PATCH /v1/om/order-lines/{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":{"CancelLineDiscountApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/CancelLineDiscount_Params"}},"required":["params"]},"CancelLineDiscount_Params":{"type":"object","properties":{"discountId":{"type":"string"}},"required":["discountId"]},"CancelLineDiscountApiResponse":{"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/CancelLineDiscount_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"CancelLineDiscount_Data":{"type":"object","properties":{}},"CancelLineDiscountApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/CancelLineDiscount_Error"}},"required":["error"]},"CancelLineDiscount_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/CancelLineDiscount_ErrorCodes_enum"}]}},"required":["code"]},"CancelLineDiscount_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","INVOICE_NOT_FOUND","NO_PERMISSION","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED"]}}},"paths":{"/v1/om/order-lines/{uid}/cancel-discount":{"patch":{"operationId":"OrderLines_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/CancelLineDiscountApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelLineDiscountApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelLineDiscountApiError"}}}}},"summary":"Cancels a discount at order level.","tags":["Order Lines"]}}}}
```