Promotion

List promotions

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Restaurant/{micrositeName}/Promotion

Gets the promotions for the specified restaurant.

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

micrositeNamestringRequired

The restaurant's microsite name.

Query parameters

promotionIdsinteger · int32[]Required

The Ids of the promotions to return.

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

A promotion that can be booked.

Idinteger · int32Optional

The promotion Id.

NamestringOptional

The name of the promotion.

DescriptionstringOptional

A longer description of the promotion.

MayRequireCreditCardbooleanOptional

Indicates that the promotion may require a credit card to be booked.

MayRequireDepositbooleanOptional

Indicates that the promotion may require a deposit to be booked.

HorizontalImageUrlstringOptional

Path to a landscape promotional image

VerticalImageUrlstringOptional

Path to a portrait promotional image

PromotionTypeCodesstring[]Optional

The promotion codes of the promotion types that this promotion has.

FullPricenumber · doubleOptional

The full price of the promotion.

PartySizeOperatorstring · enumOptional

The type of limit on the number of people the promotion is available for.

Possible values:

PartySizeLimitinteger · int32Optional

Party size limit

PartySizeMinCoversinteger · int32Optional

Party size minimum covers

PartySizeMaxCoversinteger · int32Optional

Party size maximum covers

LimitTypestring · enumOptional

The limit type of total covers available for the promotion

Possible values:

MaxNumberOfSoldinteger · int32Optional

Maximum number Of covers available for the LimitType

MenuVersionIdinteger · int32Optional

The ID value of the most updated version of the menu attached to a promotion

MenuNamestringOptional

The menu name of the menu attached to the promotion

TakeawayTypestring · enumOptional

The takeaway type of the promotion, or 0 if the promotion is not a takeaway

Possible values:

MenuUrlstringOptional

The url of the menu attached to the promotion

IsInternalOnlybooleanOptional

Whether the promotion is features only on the internal channel or not

get

/api/ConsumerApi/v1/Restaurant/{micrositeName}/Promotion

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Restaurant/{micrositeName}/Promotion?promotionIds=1 HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "MayRequireCreditCard": true,
    "MayRequireDeposit": true,
    "HorizontalImageUrl": "sample string 6",
    "VerticalImageUrl": "sample string 7",
    "Translations": [
      {
        "LanguageCode": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      {
        "LanguageCode": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      }
    ],
    "PromotionTypeCodes": [
      "sample string 1",
      "sample string 2"
    ],
    "ValidityPeriods": [
      {
        "StartDate": "2025-09-18T14:22:57",
        "EndDate": "2025-09-18T14:22:57",
        "StartTime": "00:00:00.1234567",
        "EndTime": "00:00:00.1234567",
        "Frequency": [
          0,
          0
        ],
        "IsAlwaysApply": true,
        "DayVariables": [
          {
            "DayOfWeek": 0,
            "Price": 1.1
          },
          {
            "DayOfWeek": 0,
            "Price": 1.1
          }
        ]
      },
      {
        "StartDate": "2025-09-18T14:22:57",
        "EndDate": "2025-09-18T14:22:57",
        "StartTime": "00:00:00.1234567",
        "EndTime": "00:00:00.1234567",
        "Frequency": [
          0,
          0
        ],
        "IsAlwaysApply": true,
        "DayVariables": [
          {
            "DayOfWeek": 0,
            "Price": 1.1
          },
          {
            "DayOfWeek": 0,
            "Price": 1.1
          }
        ]
      }
    ],
    "FullPrice": 1.1,
    "PartySizeOperator": 0,
    "PartySizeLimit": 8,
    "PartySizeMinCovers": 9,
    "PartySizeMaxCovers": 10,
    "LimitType": 0,
    "MaxNumberOfSold": 11,
    "MenuVersionId": 1,
    "MenuName": "sample string 12",
    "TakeawayType": 0,
    "MenuUrl": "sample string 13",
    "IsInternalOnly": true,
    "AdvertisementPeriod": {
      "StartDate": "sample string 1",
      "EndDate": "sample string 2"
    }
  }
]

List promotions

get

https://preprodapim.hos.accessacloud.com/rd-consumer-apihttps://apim.hos.accessacloud.com/rd-consumer-api

/api/ConsumerApi/v1/Restaurant/{micrositeName}/Promotions

Gets all the promotions for the specified restaurant.

Authorizations

bearerAuth

HTTPRequired

Bearer token using a JWT

Path parameters

micrositeNamestringRequired

The restaurant's microsite name.

Query parameters

startDatestring · date-timeRequired

The start date.

endDatestring · date-timeRequired

The end date.

channelCodesstring[]Required

The channel codes

api-versionstringOptional

Responses

200

OK

application/jsontext/jsonapplication/problem+jsonapplication/xmltext/xml

A promotion that can be booked.

Idinteger · int32Optional

The promotion Id.

NamestringOptional

The name of the promotion.

DescriptionstringOptional

A longer description of the promotion.

MayRequireCreditCardbooleanOptional

Indicates that the promotion may require a credit card to be booked.

MayRequireDepositbooleanOptional

Indicates that the promotion may require a deposit to be booked.

HorizontalImageUrlstringOptional

Path to a landscape promotional image

VerticalImageUrlstringOptional

Path to a portrait promotional image

PromotionTypeCodesstring[]Optional

The promotion codes of the promotion types that this promotion has.

FullPricenumber · doubleOptional

The full price of the promotion.

PartySizeOperatorstring · enumOptional

The type of limit on the number of people the promotion is available for.

Possible values:

PartySizeLimitinteger · int32Optional

Party size limit

PartySizeMinCoversinteger · int32Optional

Party size minimum covers

PartySizeMaxCoversinteger · int32Optional

Party size maximum covers

LimitTypestring · enumOptional

The limit type of total covers available for the promotion

Possible values:

MaxNumberOfSoldinteger · int32Optional

Maximum number Of covers available for the LimitType

MenuVersionIdinteger · int32Optional

The ID value of the most updated version of the menu attached to a promotion

MenuNamestringOptional

The menu name of the menu attached to the promotion

TakeawayTypestring · enumOptional

The takeaway type of the promotion, or 0 if the promotion is not a takeaway

Possible values:

MenuUrlstringOptional

The url of the menu attached to the promotion

IsInternalOnlybooleanOptional

Whether the promotion is features only on the internal channel or not

get

/api/ConsumerApi/v1/Restaurant/{micrositeName}/Promotions

HTTPcURLJavaScriptPython

GET /rd-consumer-api/api/ConsumerApi/v1/Restaurant/{micrositeName}/Promotions?startDate=2026-03-10T04%3A06%3A47.650Z&endDate=2026-03-10T04%3A06%3A47.650Z&channelCodes=text HTTP/1.1
Host: preprodapim.hos.accessacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "MayRequireCreditCard": true,
    "MayRequireDeposit": true,
    "HorizontalImageUrl": "sample string 6",
    "VerticalImageUrl": "sample string 7",
    "Translations": [
      {
        "LanguageCode": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      {
        "LanguageCode": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      }
    ],
    "PromotionTypeCodes": [
      "sample string 1",
      "sample string 2"
    ],
    "ValidityPeriods": [
      {
        "StartDate": "2025-09-18T14:22:57",
        "EndDate": "2025-09-18T14:22:57",
        "StartTime": "00:00:00.1234567",
        "EndTime": "00:00:00.1234567",
        "Frequency": [
          0,
          0
        ],
        "IsAlwaysApply": true,
        "DayVariables": [
          {
            "DayOfWeek": 0,
            "Price": 1.1
          },
          {
            "DayOfWeek": 0,
            "Price": 1.1
          }
        ]
      },
      {
        "StartDate": "2025-09-18T14:22:57",
        "EndDate": "2025-09-18T14:22:57",
        "StartTime": "00:00:00.1234567",
        "EndTime": "00:00:00.1234567",
        "Frequency": [
          0,
          0
        ],
        "IsAlwaysApply": true,
        "DayVariables": [
          {
            "DayOfWeek": 0,
            "Price": 1.1
          },
          {
            "DayOfWeek": 0,
            "Price": 1.1
          }
        ]
      }
    ],
    "FullPrice": 1.1,
    "PartySizeOperator": 0,
    "PartySizeLimit": 8,
    "PartySizeMinCovers": 9,
    "PartySizeMaxCovers": 10,
    "LimitType": 0,
    "MaxNumberOfSold": 11,
    "MenuVersionId": 1,
    "MenuName": "sample string 12",
    "TakeawayType": 0,
    "MenuUrl": "sample string 13",
    "IsInternalOnly": true,
    "AdvertisementPeriod": {
      "StartDate": "sample string 1",
      "EndDate": "sample string 2"
    }
  }
]