> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/partner-api-reference/reference/promotions/promotions.md). # Promotions Endpoints for listing and retrieving brand promotions available to your partner account. ## List promotions > Returns a list of all brand promotions currently available to your account. ```json {"openapi":"3.1.0","info":{"title":"Partner Promotions API","version":"16"},"tags":[{"name":"Promotions","description":"Endpoints for listing and retrieving brand promotions available to your partner account."}],"servers":[{"url":"https://api.impact.com","description":"Production server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Promotion":{"type":"object","properties":{"AdvertiserId":{"type":"string","description":"Unique identifier of the brand offering the promotion."},"AdvertiserName":{"type":"string","description":"Name of the brand offering the promotion."},"AdvertiserLocation":{"type":"string","description":"Country in which the brand offering the promotion is based."},"PromotionFileId":{"type":"string","description":"Unique identifier of the promotion file (the upload batch this promotion was loaded from). Use this for traceability when a brand bulk-uploads promotions."},"PromotionIds":{"type":"string","description":"Unique identifier for this promotion. Despite the plural name, this is a single ID for one promotion — use it as the path `Id` when calling Retrieve a promotion."},"PromotionTitle":{"type":"string","description":"The marketing headline for the promotion, suitable for displaying to your audience."},"NumberOfProducts":{"type":"integer","description":"The number of products covered by this promotion."},"PromotionEffectiveDates":{"type":"string","description":"The date range during which the promotion is active, in ISO 8601 interval format: `/`."},"GenericRedemptionCode":{"type":"string","description":"The promo code your audience can apply at checkout to redeem this promotion. Empty when the promotion is automatically applied or has no associated code."},"PromotionItemsUri":{"type":"string","description":"API resource path that returns the items covered by this promotion. This is a pre-filtered search against the Catalogs API."},"Uri":{"type":"string","description":"Unique reference to this promotion in the impact.com API."}}}}},"paths":{"/Mediapartners/{AccountSID}/Promotions":{"get":{"summary":"List promotions","description":"Returns a list of all brand promotions currently available to your account.","operationId":"listPromotions","tags":["Promotions"],"parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Unique identifier for the partner account.","schema":{"type":"string"}}],"responses":{"200":{"description":"An array of promotion objects.","content":{"application/json":{"schema":{"type":"object","properties":{"Promotions":{"type":"array","items":{"$ref":"#/components/schemas/Promotion"}}}}}}}}}}}} ``` ## Retrieve a promotion > Retrieves the details of a single promotion. Pass the value of \`PromotionIds\` (from a List Promotions response) as the path \`Id\`.
```json {"openapi":"3.1.0","info":{"title":"Partner Promotions API","version":"16"},"tags":[{"name":"Promotions","description":"Endpoints for listing and retrieving brand promotions available to your partner account."}],"servers":[{"url":"https://api.impact.com","description":"Production server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Promotion":{"type":"object","properties":{"AdvertiserId":{"type":"string","description":"Unique identifier of the brand offering the promotion."},"AdvertiserName":{"type":"string","description":"Name of the brand offering the promotion."},"AdvertiserLocation":{"type":"string","description":"Country in which the brand offering the promotion is based."},"PromotionFileId":{"type":"string","description":"Unique identifier of the promotion file (the upload batch this promotion was loaded from). Use this for traceability when a brand bulk-uploads promotions."},"PromotionIds":{"type":"string","description":"Unique identifier for this promotion. Despite the plural name, this is a single ID for one promotion — use it as the path `Id` when calling Retrieve a promotion."},"PromotionTitle":{"type":"string","description":"The marketing headline for the promotion, suitable for displaying to your audience."},"NumberOfProducts":{"type":"integer","description":"The number of products covered by this promotion."},"PromotionEffectiveDates":{"type":"string","description":"The date range during which the promotion is active, in ISO 8601 interval format: `/`."},"GenericRedemptionCode":{"type":"string","description":"The promo code your audience can apply at checkout to redeem this promotion. Empty when the promotion is automatically applied or has no associated code."},"PromotionItemsUri":{"type":"string","description":"API resource path that returns the items covered by this promotion. This is a pre-filtered search against the Catalogs API."},"Uri":{"type":"string","description":"Unique reference to this promotion in the impact.com API."}}}}},"paths":{"/Mediapartners/{AccountSID}/Promotions/{Id}":{"get":{"summary":"Retrieve a promotion","description":"Retrieves the details of a single promotion. Pass the value of `PromotionIds` (from a List Promotions response) as the path `Id`.\n","operationId":"retrievePromotion","tags":["Promotions"],"parameters":[{"name":"AccountSID","in":"path","required":true,"description":"Unique identifier for the partner account.","schema":{"type":"string"}},{"name":"Id","in":"path","required":true,"description":"The unique identifier of the promotion (matches `PromotionIds` from a List Promotions response).","schema":{"type":"string"}}],"responses":{"200":{"description":"A promotion object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Promotion"}}}},"404":{"description":"No promotion exists with the supplied Id."}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://integrations.impact.com/partner-api-reference/reference/promotions/promotions.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.