Attributes

AdvertiserId integer

Unique identifier of the brand offering the promotion.

AdvertiserName string

Name of the brand offering the promotion.

AdvertiserLocation string

Location of the brand offering the promotion.

PromotionFileId string

Unique identifier of the promotion file.

PromotionIds integer

Unique identifier of the promotion. You need this value to retrieve a promotion.

PromotionTitle string

Description of the promotion.

NumberOfProducts integer

Number of products in the group.

PromotionEffectiveDates string

The dates (in ISO 8601 format) between which the promotion is active.

GenericRedemptionCode string

Specifies the code you can use online to redeem the promotion if one exists.

PromotionItemsUri string

Direct URI of an endpoint to call to view a list of items included in the promotion.

Uri string

The URI to call to retrieve this promotion’s details.

{
  "AdvertiserId": "12345",
  "AdvertiserName": "ACME Inc",
  "AdvertiserLocation": "United States",
  "PromotionFileId": "37",
  "PromotionIds": "123456789",
  "PromotionTitle": "Save 40% on Anvils with ACME Christmas",
  "PromotionEffectiveDates": "2022-12-13/2023-01-01",
  "GenericRedemptionCode": "ANVIL40",
  "PromotionItemsUri": "/Mediapartners/<AccountSID>/Catalogs/ItemSearch?Query=PromotionIds='123456789'",
  "Uri": "/Mediapartners/<AccountSID>/Promotions/123456789"
}