GET v2/Companies/{CompanyId}/Entities/{LocationId}/Promotions?EntityId={EntityId}
Returns promotions at and under a specific node in the company tree.
Information:
Base URL:
https://api.covasoft.net/pospromotions
Returns all promotions for a company at and under the EntityId node. For example, calling the endpoint with companyId = entityId will return all promotions defined in the company.
Request Information
URI Parameters
| Name | Description | Type | Additional information | 
|---|---|---|---|
| CompanyId | The unique Company Id that was provided in your on-boarding package. | integer | Required | 
| EntityId | The entityId of the subtree to retrieve promotions on and under. | integer | Required | 
| LocationId | string | None. | 
Body Parameters
None.
Response Information
Resource Description
Collection of PromotionsByLocationReturn| Name | Description | Type | Additional information | 
|---|---|---|---|
| Id | globally unique identifier | None. | |
| DiscountId | globally unique identifier | None. | |
| SelectedParentEntities | Collection of integer | None. | |
| Name | string | None. | |
| Period | PromotionsByLocationReturnPeriod | None. | |
| Status | string | None. | |
| Condition | PromotionsByLocationReturnCondition | None. | |
| Rule | PromotionsByLocationReturnRule | None. | |
| Audit | PromotionsByLocationReturnAudit | None. | 
Response Formats
application/json, text/json
            Sample:
[
  {
    "Id": "c20adebf-ad0e-4a51-a3b5-6c8377417209",
    "DiscountId": "7eec0141-7b1e-47bf-92ab-bd4e803cccc2",
    "SelectedParentEntities": [
      1,
      2
    ],
    "Name": "sample string 3",
    "Period": {
      "DateRanges": [
        {
          "StartDate": "2025-10-31T04:33:30.9148662+00:00",
          "EndDate": "2025-10-31T04:33:30.9148662+00:00"
        },
        {
          "StartDate": "2025-10-31T04:33:30.9148662+00:00",
          "EndDate": "2025-10-31T04:33:30.9148662+00:00"
        }
      ],
      "Tag": "sample string 1"
    },
    "Status": "sample string 4",
    "Condition": {
      "MatchAll": {
        "Products": {
          "Products": [
            "c84d232f-d991-4aa2-823a-0b6b6a757c4a",
            "b87743a3-b9bf-4dd4-8379-4ccfaf98f561"
          ],
          "Classifications": [
            1,
            2
          ],
          "Categories": [
            1,
            2
          ],
          "Tag": "sample string 1"
        }
      }
    },
    "Rule": {
      "Tag": "sample string 1",
      "Discount": {
        "Dollar": 1.0,
        "Tag": "sample string 2"
      }
    },
    "Audit": {
      "Created": {
        "On": "2025-10-31T04:33:30.9148662+00:00",
        "By": 2
      },
      "Activated": {
        "On": "2025-10-31T04:33:30.9148662+00:00",
        "By": 2
      },
      "Deactivated": {
        "On": "2025-10-31T04:33:30.9148662+00:00",
        "By": 2
      }
    }
  },
  {
    "Id": "c20adebf-ad0e-4a51-a3b5-6c8377417209",
    "DiscountId": "7eec0141-7b1e-47bf-92ab-bd4e803cccc2",
    "SelectedParentEntities": [
      1,
      2
    ],
    "Name": "sample string 3",
    "Period": {
      "DateRanges": [
        {
          "StartDate": "2025-10-31T04:33:30.9148662+00:00",
          "EndDate": "2025-10-31T04:33:30.9148662+00:00"
        },
        {
          "StartDate": "2025-10-31T04:33:30.9148662+00:00",
          "EndDate": "2025-10-31T04:33:30.9148662+00:00"
        }
      ],
      "Tag": "sample string 1"
    },
    "Status": "sample string 4",
    "Condition": {
      "MatchAll": {
        "Products": {
          "Products": [
            "c84d232f-d991-4aa2-823a-0b6b6a757c4a",
            "b87743a3-b9bf-4dd4-8379-4ccfaf98f561"
          ],
          "Classifications": [
            1,
            2
          ],
          "Categories": [
            1,
            2
          ],
          "Tag": "sample string 1"
        }
      }
    },
    "Rule": {
      "Tag": "sample string 1",
      "Discount": {
        "Dollar": 1.0,
        "Tag": "sample string 2"
      }
    },
    "Audit": {
      "Created": {
        "On": "2025-10-31T04:33:30.9148662+00:00",
        "By": 2
      },
      "Activated": {
        "On": "2025-10-31T04:33:30.9148662+00:00",
        "By": 2
      },
      "Deactivated": {
        "On": "2025-10-31T04:33:30.9148662+00:00",
        "By": 2
      }
    }
  }
]