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 PromotionsByLocationReturnName | 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": "532ec348-3cb7-4f26-921e-6373f633afb0", "DiscountId": "4bdbfd55-f7e5-49cd-93c3-02d44f941d2c", "SelectedParentEntities": [ 1, 2 ], "Name": "sample string 3", "Period": { "DateRanges": [ { "StartDate": "2024-11-25T11:41:52.5628377+00:00", "EndDate": "2024-11-25T11:41:52.5628377+00:00" }, { "StartDate": "2024-11-25T11:41:52.5628377+00:00", "EndDate": "2024-11-25T11:41:52.5628377+00:00" } ], "Tag": "sample string 1" }, "Status": "sample string 4", "Condition": { "MatchAll": { "Products": { "Products": [ "93abc33a-3e7f-4b34-a1f3-1c366394bf76", "41d01fb7-da8f-43f3-b9fa-77e418c11a1a" ], "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": "2024-11-25T11:41:52.5628377+00:00", "By": 2 }, "Activated": { "On": "2024-11-25T11:41:52.5628377+00:00", "By": 2 }, "Deactivated": { "On": "2024-11-25T11:41:52.5628377+00:00", "By": 2 } } }, { "Id": "532ec348-3cb7-4f26-921e-6373f633afb0", "DiscountId": "4bdbfd55-f7e5-49cd-93c3-02d44f941d2c", "SelectedParentEntities": [ 1, 2 ], "Name": "sample string 3", "Period": { "DateRanges": [ { "StartDate": "2024-11-25T11:41:52.5628377+00:00", "EndDate": "2024-11-25T11:41:52.5628377+00:00" }, { "StartDate": "2024-11-25T11:41:52.5628377+00:00", "EndDate": "2024-11-25T11:41:52.5628377+00:00" } ], "Tag": "sample string 1" }, "Status": "sample string 4", "Condition": { "MatchAll": { "Products": { "Products": [ "93abc33a-3e7f-4b34-a1f3-1c366394bf76", "41d01fb7-da8f-43f3-b9fa-77e418c11a1a" ], "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": "2024-11-25T11:41:52.5628377+00:00", "By": 2 }, "Activated": { "On": "2024-11-25T11:41:52.5628377+00:00", "By": 2 }, "Deactivated": { "On": "2024-11-25T11:41:52.5628377+00:00", "By": 2 } } } ]