GET v1/Companies/{companyId}/PromotionsForMenuBoard

This call is used to fetch all existing promotions for a company with a list of catalogIds that may apply to each promotion. Does not include information about the discount or how to apply it.

Information:

Base URL:

https://api.covasoft.net/promotions

Example of a call would be:

GET /Promotions/{companyId}/v1/Companies/PromotionsForMenuBoard
Host: api.covasoft.net
Authorization: Bearer {your token}
Accept: application/json

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId	The CompanyId of the promotions being requested	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of PromotionForMenuBoard

Name	Description	Type	Additional information
PromotionId	The unique Id for this promotion	globally unique identifier	None.
CompanyId	The company Id this promotion belongs to	integer	None.
Name	The name of the promotion	string	None.
Status	The status of the Promotion. 'Active' or 'Deleted'. Results from this endpoint will always be 'Active'	string	None.
HumanReadablePromotionType	A human readable string representing the type of promotion. Can be 'BOGO', 'Buy X Get Y', 'Bundle', 'Dollar Off', or 'Percent Off' Based on PromotionType. CheapestMatchedFor_ maps to 'BOGO'. MatchThenCheapestOtherFor_ maps to 'Buy X Get Y'. BundleFor_ maps to 'Bundle'. EachMatchedDollarOff maps to 'Dollar Off'. 'EachMatchedPercentOff' maps to 'Percent Off'.	string	None.
EnabledAtLocationIds	A list of the Location identifiers where this promotion is applicable	Collection of integer	None.
ICalVEventSchedule	An iCal formatted VEVENT string representing the period of time the promotion is active. See [iCal documentation](https://icalendar.org/) for more information. The PromotionId will always be included as the SUMMARY.	string	None.
CreatedByUserId	The userId that created this promotion.	integer	None.
CreatedDateTimeUtc	The DateTime this promotion was created.	date	None.
Version	The current version of this promotion. Increments by 1 for each change made to this promotion.	integer	None.
CatalogIds	A list of catalogIds that this promotion can apply to	Collection of globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PromotionId": "d2468e94-649e-4227-9a80-e8843804d624",
    "CompanyId": 2,
    "Name": "sample string 3",
    "Status": "sample string 4",
    "HumanReadablePromotionType": "sample string 5",
    "EnabledAtLocationIds": [
      1,
      2
    ],
    "ICalVEventSchedule": "sample string 6",
    "CreatedByUserId": 7,
    "CreatedDateTimeUtc": "2024-11-25T11:22:58.4726508+00:00",
    "Version": 9,
    "CatalogIds": [
      "69b275df-8ab8-43f4-80a4-3428e3680456",
      "2fcb6335-688c-49c9-af0e-28ae28d477b1"
    ]
  },
  {
    "PromotionId": "d2468e94-649e-4227-9a80-e8843804d624",
    "CompanyId": 2,
    "Name": "sample string 3",
    "Status": "sample string 4",
    "HumanReadablePromotionType": "sample string 5",
    "EnabledAtLocationIds": [
      1,
      2
    ],
    "ICalVEventSchedule": "sample string 6",
    "CreatedByUserId": 7,
    "CreatedDateTimeUtc": "2024-11-25T11:22:58.4726508+00:00",
    "Version": 9,
    "CatalogIds": [
      "69b275df-8ab8-43f4-80a4-3428e3680456",
      "2fcb6335-688c-49c9-af0e-28ae28d477b1"
    ]
  }
]