# Discounts

## GET /v1/om/discounts

> Lists all discounts.

```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":{"GetDiscountsApiResponse":{"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/GetDiscounts_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"GetDiscounts_Data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DiscountMap"}}},"required":["items"]},"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"]},"__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"]},"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"]}}},"paths":{"/v1/om/discounts":{"get":{"operationId":"Discounts_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/GetDiscountsApiResponse"}}}}},"summary":"Lists all discounts.","tags":["Discounts"]}}}}
```

## POST /v1/om/discounts

> Creates a new discount.

```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":{"CreateDiscountApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/CreateDiscount_Params"}},"required":["params"]},"CreateDiscount_Params":{"type":"object","properties":{"locales":{"$ref":"#/components/schemas/CreateDiscount_Params_Locales"},"type":{"type":"string","enum":["fixed","percent","reprice"]},"value":{"type":"number"},"qualifications":{"type":"array","items":{"type":"string","enum":["line","order"]}},"isActive":{"type":"boolean"},"orderTypes":{"type":"array","items":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]}},"max":{"type":"number"},"minTotal":{"type":"number"},"withoutModifiers":{"type":"boolean"},"excludeTax":{"type":"boolean"},"reasonRequired":{"type":"boolean"},"commentRequired":{"type":"boolean"}},"required":["locales","type","value","qualifications","orderTypes"]},"CreateDiscount_Params_Locales":{"type":"object","properties":{"ar":{"$ref":"#/components/schemas/CreateDiscount_Params_Locales_Ar"},"en":{"$ref":"#/components/schemas/CreateDiscount_Params_Locales_En"}},"required":["ar","en"]},"CreateDiscount_Params_Locales_Ar":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"CreateDiscount_Params_Locales_En":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["name"]},"CreateDiscountApiResponse":{"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/CreateDiscount_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"CreateDiscount_Data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/CreateDiscount_Data_Item"}},"required":["item"]},"CreateDiscount_Data_Item":{"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"]},"__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"]},"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"]}}},"paths":{"/v1/om/discounts":{"post":{"operationId":"Discounts_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/CreateDiscountApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDiscountApiResponse"}}}}},"summary":"Creates a new discount.","tags":["Discounts"]}}}}
```

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

> Returns a discount.

```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":{"GetDiscountsApiResponse":{"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/GetDiscounts_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"GetDiscounts_Data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DiscountMap"}}},"required":["items"]},"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"]},"__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"]},"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"]}}},"paths":{"/v1/om/discounts/{uid}":{"get":{"operationId":"Discounts_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/GetDiscountsApiResponse"}}}}},"summary":"Returns a discount.","tags":["Discounts"]}}}}
```

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

> Updates a discount.

```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":{"UpdateDiscountApiRequest":{"type":"object","properties":{"params":{"$ref":"#/components/schemas/UpdateDiscount_Params"}},"required":["params"]},"UpdateDiscount_Params":{"type":"object","properties":{"id":{"type":"string"},"locales":{"type":"object"},"type":{"type":"string","enum":["fixed","percent","reprice"]},"value":{"type":"number"},"qualifications":{"type":"array","items":{"type":"string","enum":["line","order"]}},"isActive":{"type":"boolean"},"orderTypes":{"type":"array","items":{"type":"string","enum":["delivery","dine-in","pickup","to-go"]}},"max":{"type":"number"},"minTotal":{"type":"number"},"withoutModifiers":{"type":"boolean"},"excludeTax":{"type":"boolean"},"reasonRequired":{"type":"boolean"},"commentRequired":{"type":"boolean"}},"required":["id"]},"UpdateDiscountApiResponse":{"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/UpdateDiscount_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"UpdateDiscount_Data":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/UpdateDiscount_Data_Item"}},"required":["item"]},"UpdateDiscount_Data_Item":{"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"]},"__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"]},"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"]},"UpdateDiscountApiError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/UpdateDiscount_Error"}},"required":["error"]},"UpdateDiscount_Error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/UpdateDiscount_ErrorCodes_enum"}]}},"required":["code"]},"UpdateDiscount_ErrorCodes_enum":{"type":"string","enum":["NoChanges"]}}},"paths":{"/v1/om/discounts/{uid}":{"patch":{"operationId":"Discounts_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/UpdateDiscountApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDiscountApiResponse"}}}},"400":{"description":"Functional Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDiscountApiError"}}}}},"summary":"Updates a discount.","tags":["Discounts"]}}}}
```

## GET /v1/om/discounts/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"}},"schemas":{"ExportDiscountsApiResponse":{"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/ExportDiscounts_Data"}},"required":["app","service","warnings","instanceId","requestId","data"]},"ExportDiscounts_Data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DiscountMap"}},"next":{"type":"string"}},"required":["items"]},"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"]},"__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"]},"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"]}}},"paths":{"/v1/om/discounts/export":{"get":{"operationId":"Discounts_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":{"$ref":"#/components/schemas/ExportDiscountsApiResponse"}}}}},"summary":"Exports all orders with support for incremental fetching.","tags":["Discounts"]}}}}
```