> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ResolvePromotions # Package: catalogV3 # Namespace: PromotionsService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/promotions-v3/resolve-promotions.md ## Permission Scopes: Read v3 catalog: SCOPE.STORES.CATALOG_READ ## Introduction Resolves effective promotions for a category. Only enabled promotions are returned, sorted by position in ascending order. A promotion is effective for the category when it's assigned to the category directly, or when it's assigned to any of the category's ancestors with `appliedToSubcategories` set to `true`. A promotion that's effective at several positions is returned once per position. Conflicts are resolved separately for each position: when multiple promotions are effective at the same position, the promotion with the latest activation date takes precedence, with the promotion ID as a tie-breaker. The activation date is the later of the promotion's creation date and the date it was last enabled. --- ## REST API ### Schema ``` Method: resolvePromotions Description: Resolves effective promotions for a category. Only enabled promotions are returned, sorted by position in ascending order. A promotion is effective for the category when it's assigned to the category directly, or when it's assigned to any of the category's ancestors with `appliedToSubcategories` set to `true`. A promotion that's effective at several positions is returned once per position. Conflicts are resolved separately for each position: when multiple promotions are effective at the same position, the promotion with the latest activation date takes precedence, with the promotion GUID as a tie-breaker. The activation date is the later of the promotion's creation date and the date it was last enabled. URL: https://www.wixapis.com/stores/v3/promotions/resolve Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: categoryId Method parameters: query param name: categoryId | type: categoryId | description: Category GUID to resolve effective promotions for. | required: true | validation: format GUID Return type: ResolvePromotionsResponse - name: promotions | type: array | description: Enabled promotions that are effective for the category, sorted by position in ascending order. - name: promotion | type: Promotion | description: Promotion. - name: id | type: string | description: Promotion GUID. | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the promotion is updated. To prevent conflicting changes, the current revision must be passed when updating the promotion. | validation: format int64 - name: createdDate | type: string | description: Date and time the promotion was created. | validation: format date-time - name: updatedDate | type: string | description: Date and time the promotion was last updated. | validation: format date-time - name: name | type: string | description: Promotion name. | validation: minLength 1, maxLength 50 - name: media | type: PromotionMedia | description: Promotion media. - ONE-OF: - name: id | type: string | description: Set media by GUID of an existing file in Wix Media Manager. | validation: minLength 1, maxLength 200 - name: url | type: string | description: Set media using an external media URL. When provided, Wix Media Manager imports the media asynchronously. During import: - `image` is empty. - The promotion is saved as disabled regardless of the requested `enabled` value. Once the import completes successfully, the promotion's `image` is populated and `enabled` is set to the originally requested value. If the import fails, the promotion's entire `media` object is cleared and the promotion stays disabled. To retry, set new media. | validation: format WEB_URL - name: altText | type: string | description: Image alt text. | validation: minLength 1, maxLength 1000 - name: displayName | type: string | description: Media display name. Overrides the default media name. Can be passed only when the media is set by a URL in this item's `url` field. | validation: maxLength 80 - name: mediaType | type: MediaType | description: Media type. - enum: - IMAGE: Image media type. - name: uploadId | type: string | description: GUID of the asynchronous media import that Wix Media Manager runs when media is set with a `url`. | validation: format GUID - name: destinationUrl | type: string | description: URL the promotion redirects to when a customer clicks the banner. | validation: format WEB_URL - name: categories | type: array | description: Categories the promotion is directly assigned to. A promotion may also appear in subcategories when `appliedToSubcategories` is `true` for a directly assigned category. | validation: maxItems 1000 - name: id | type: string | description: Category GUID. | validation: format GUID - name: position | type: integer | description: Position of the promotion within the category, starting from 1. Must be provided for each category assignment — omitting it fails validation, because positions start from 1. | validation: minimum 1 - name: appliedToSubcategories | type: boolean | description: Whether the promotion also appears in this category's subcategories. When inherited by a subcategory, the promotion keeps the same position. Default: `false` - name: enabled | type: boolean | description: Whether the promotion is enabled. When creating or updating with `media.url`, this value takes effect only after the media import completes successfully. See `media.url` for details. Default: `false` - name: extendedFields | type: ExtendedFields | description: Custom field data for the promotion object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). | validation: format map - name: tags | type: Tags | description: Tags for organizing and filtering promotions. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. | validation: maxItems 100, maxLength 5 - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: position | type: integer | description: Position of the promotion within the category, starting from 1. | validation: minimum 1 Possible Errors: HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: CATEGORY_NOT_FOUND | Description: Couldn't find the category. ``` ### Examples ### Resolve Promotions Resolves the effective promotions for a category, sorted by position in ascending order. ```curl curl -X GET \ 'https://www.wixapis.com/stores/v3/promotions/resolve?categoryId=f6c2e4a1-8b3d-4e5f-9a1b-2c3d4e5f6a7b' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.stores.promotionsV3.resolvePromotions(categoryId) Description: Resolves effective promotions for a category. Only enabled promotions are returned, sorted by position in ascending order. A promotion is effective for the category when it's assigned to the category directly, or when it's assigned to any of the category's ancestors with `appliedToSubcategories` set to `true`. A promotion that's effective at several positions is returned once per position. Conflicts are resolved separately for each position: when multiple promotions are effective at the same position, the promotion with the latest activation date takes precedence, with the promotion GUID as a tie-breaker. The activation date is the later of the promotion's creation date and the date it was last enabled. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: categoryId Method parameters: param name: categoryId | type: string | description: Category GUID to resolve effective promotions for. | required: true | validation: format GUID Return type: PROMISE - name: promotions | type: array | description: Enabled promotions that are effective for the category, sorted by position in ascending order. - name: promotion | type: Promotion | description: Promotion. - name: _id | type: string | description: Promotion GUID. | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the promotion is updated. To prevent conflicting changes, the current revision must be passed when updating the promotion. | validation: format int64 - name: _createdDate | type: Date | description: Date and time the promotion was created. - name: _updatedDate | type: Date | description: Date and time the promotion was last updated. - name: name | type: string | description: Promotion name. | validation: minLength 1, maxLength 50 - name: media | type: PromotionMedia | description: Promotion media. - ONE-OF: - name: _id | type: string | description: Set media by GUID of an existing file in Wix Media Manager. | validation: minLength 1, maxLength 200 - name: url | type: string | description: Set media using an external media URL. When provided, Wix Media Manager imports the media asynchronously. During import: - `image` is empty. - The promotion is saved as disabled regardless of the requested `enabled` value. Once the import completes successfully, the promotion's `image` is populated and `enabled` is set to the originally requested value. If the import fails, the promotion's entire `media` object is cleared and the promotion stays disabled. To retry, set new media. | validation: format WEB_URL - name: altText | type: string | description: Image alt text. | validation: minLength 1, maxLength 1000 - name: displayName | type: string | description: Media display name. Overrides the default media name. Can be passed only when the media is set by a URL in this item's `url` field. | validation: maxLength 80 - name: mediaType | type: MediaType | description: Media type. - enum: - IMAGE: Image media type. - name: uploadId | type: string | description: GUID of the asynchronous media import that Wix Media Manager runs when media is set with a `url`. | validation: format GUID - name: destinationUrl | type: string | description: URL the promotion redirects to when a customer clicks the banner. | validation: format WEB_URL - name: categories | type: array | description: Categories the promotion is directly assigned to. A promotion may also appear in subcategories when `appliedToSubcategories` is `true` for a directly assigned category. | validation: maxItems 1000 - name: _id | type: string | description: Category GUID. | validation: format GUID - name: position | type: integer | description: Position of the promotion within the category, starting from 1. Must be provided for each category assignment — omitting it fails validation, because positions start from 1. | validation: minimum 1 - name: appliedToSubcategories | type: boolean | description: Whether the promotion also appears in this category's subcategories. When inherited by a subcategory, the promotion keeps the same position. Default: `false` - name: enabled | type: boolean | description: Whether the promotion is enabled. When creating or updating with `media.url`, this value takes effect only after the media import completes successfully. See `media.url` for details. Default: `false` - name: extendedFields | type: ExtendedFields | description: Custom field data for the promotion object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). | validation: format map - name: tags | type: Tags | description: Tags for organizing and filtering promotions. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. | validation: maxItems 100, maxLength 5 - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: position | type: integer | description: Position of the promotion within the category, starting from 1. | validation: minimum 1 Possible Errors: HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: CATEGORY_NOT_FOUND | Description: Couldn't find the category. ``` ### Examples ### Resolve effective promotions for a category Returns the enabled promotions that apply to a category, sorted by position, after conflict resolution. ```javascript import { promotionsV3 } from "@wix/stores"; const categoryId = "81d38d30-5dc6-42e1-8efe-afafc0170056"; async function resolvePromotions() { const response = await promotionsV3.resolvePromotions(categoryId); return response; } /* Promise resolves to: * { * "promotions": [ * { * "promotion": { * "_id": "25fc9c97-1ecf-47a1-9350-5766867d307e", * "name": "Summer Sale Banner", * "enabled": true * }, * "position": 1 * } * ] * } */ ``` ### resolvePromotions (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { promotionsV3 } from '@wix/stores'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { promotionsV3 }, // Include the auth strategy and host as relevant }); async function resolvePromotions(categoryId) { const response = await myWixClient.promotionsV3.resolvePromotions(categoryId); }; ``` ---