Get discount details

gethttps://core-api.ancon.io/api/v1.1/Tenants/{tenantId}/Discounts/{discountId}

View .md OpenAPI

Authorization

Access-Tokenheaderrequired
Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

tenantIdstring (uuid)required
discountIdstring (uuid)required

Header parameters

correlationIdstring
Correlation Id for the request

Responses

200OKapplication/json

discountobject | null
14 fields in discount
- idstring (uuid)
- namestring | null
- codestring | null
- allowMultipleUsesboolean
- discountTypeinteger (int32)
  Allowed values: 0, 1.
- orderFormatsinteger (int32)
  Allowed values: 0, 1, 2, 4, 8, 16, 32, 64, 128, 159, 191.
- validPeriodobject | null
  2 fields in validPeriod
  - fromstring (date-time)
  - tostring (date-time)
- validDayOfWeekinteger (int32)
  Allowed values: 0, 1, 2, 4, 8, 16, 31, 32, 64, 96, 127.
- validTimePeriodobject | null
  2 fields in validTimePeriod
  - fromstring (time)
  - durationstring (date-span)
- allValuenumber (double) | null
- discountAvailabilitiesinteger (int32)
  Allowed values: 0, 1, 2, 4, 8, 16, 32.
- productsarray<object> | null
  3 fields in products
  - idstring (uuid)
  - namestring | null
  - valuenumber (double)
- productGroupsarray<object> | null
  3 fields in productGroups
  - idstring (uuid)
  - namestring | null
  - valuenumber (double)
- outletsarray<object> | null
  2 fields in outlets
  - idstring (uuid)
  - namestring | null

401Unauthorizedapplication/json

messagestring | null

404Not Foundapplication/json

messagestring | null
errorCodestring (uuid)

Request

curl -X GET "https://core-api.ancon.io/api/v1.1/Tenants/{tenantId}/Discounts/{discountId}" \
  -H "Access-Token: $ANCON_TOKEN"

Response

{
  "discount": {
    "id": "e88400ca-e390-426b-8e05-6ff07a5b5140",
    "name": "Festival Event",
    "code": "FEST25",
    "allowMultipleUses": true,
    "discountType": 0,
    "orderFormats": 159,
    "validPeriod": {
      "from": "2023-01-01T00:00:00Z",
      "to": "2023-12-31T23:59:59Z"
    },
    "validDayOfWeek": 127,
    "validTimePeriod": {
      "from": "11:00:00",
      "duration": "08:00:00"
    },
    "allValue": null,
    "discountAvailabilities": 12,
    "products": null,
    "productGroups": [
      {
        "id": "15dc0def-e6b3-4c85-8531-24c83e679d0a",
        "name": "Food",
        "value": 0.25
      },
      {
        "id": "d71188a1-9fd7-4775-bf75-aafc84d0429e",
        "name": "Drinks",
        "value": 0.25
      }
    ],
    "outlets": [
      {
        "id": "cb1bac5d-732d-4841-b3e3-fb8ec3170d69",
        "name": "Superb Restaurant"
      }
    ]
  }
}

#Authorization

#Path parameters

#Header parameters

#Responses

Authorization

Path parameters

Header parameters

Responses