# Returns

## POST /v1/om/return-lines

> Creates a return line for a specified 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":{"CreateReturnLineApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/CreateReturnLine_Params"}},"required":["params"]},"CreateReturnLine_Params":{"type":"object","properties":{"lineId":{"type":"string"},"orderId":{"type":"string"},"invoiceId":{"type":"string"},"quantity":{"type":"number"},"reasonId":{"type":"string"},"waste":{"type":"boolean"}},"required":["lineId","orderId","invoiceId","quantity","waste"]},"CreateReturnLineApiResponse":{"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/CreateReturnLine_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"CreateReturnLine_Data":{"type":"object","properties":{"uid":{"type":"string"}},"required":["uid"]},"CreateReturnLineApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/CreateReturnLine_Error"}},"required":["error"]},"CreateReturnLine_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/CreateReturnLine_ErrorCodes_enum"}]}},"required":["code"]},"CreateReturnLine_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","INVOICE_NOT_FOUND","LIMIT_EXCEEDED","LINE_NOT_FOUND","NoChanges","NotFound","ORDER_CANCELED","ORDER_CLOSED","REASON_DISABLED","REASON_NOT_FOUND"]}}},"paths":{"/v1/om/return-lines":{"post":{"operationId":"ReturnLines_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/CreateReturnLineApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnLineApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnLineApiError"}}}}},"summary":"Creates a return line for a specified order line.","tags":["Returns"]}}}}
```

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

> Deletes a return 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":{"DeleteReturnLineApiResponse":{"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/DeleteReturnLine_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"DeleteReturnLine_Data":{"type":"object","properties":{"succeed":{"type":"boolean"}},"required":["succeed"]},"DeleteReturnLineApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/DeleteReturnLine_Error"}},"required":["error"]},"DeleteReturnLine_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/DeleteReturnLine_ErrorCodes_enum"}]}},"required":["code"]},"DeleteReturnLine_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","INVOICE_NOT_FOUND","NO_PERMISSION","NoChanges","NotFound","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED","REASON_DISABLED","REASON_NOT_FOUND"]}}},"paths":{"/v1/om/return-lines/{uid}":{"delete":{"operationId":"ReturnLines_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/DeleteReturnLineApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReturnLineApiError"}}}}},"summary":"Deletes a return line.","tags":["Returns"]}}}}
```

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

> Updates a return 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":{"UpdateReturnLineApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/UpdateReturnLine_Params"}},"required":["params"]},"UpdateReturnLine_Params":{"type":"object","properties":{"uid":{"type":"string"},"waste":{"type":"boolean"},"reasonId":{"type":"string"},"quantity":{"type":"number"}},"required":["uid"]},"UpdateReturnLineApiResponse":{"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/UpdateReturnLine_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"UpdateReturnLine_Data":{"type":"object","properties":{"succeed":{"type":"boolean"}},"required":["succeed"]},"UpdateReturnLineApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/UpdateReturnLine_Error"}},"required":["error"]},"UpdateReturnLine_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/UpdateReturnLine_ErrorCodes_enum"}]}},"required":["code"]},"UpdateReturnLine_ErrorCodes_enum":{"type":"string","enum":["INVOICE_CLOSED","INVOICE_NOT_FOUND","LIMIT_EXCEEDED","LINE_NOT_FOUND","NO_PERMISSION","NoChanges","ORDER_CANCELED","ORDER_CLOSED","ORDER_INVOICED","REASON_DISABLED","REASON_NOT_FOUND"]}}},"paths":{"/v1/om/return-lines/{uid}":{"patch":{"operationId":"ReturnLines_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/UpdateReturnLineApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnLineApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnLineApiError"}}}}},"summary":"Updates a return line.","tags":["Returns"]}}}}
```