> 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 # BulkUpdateRibbons # Package: catalogV3 # Namespace: RibbonService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/bulk-update-ribbons.md ## Permission Scopes: Ribbon write in v3 catalog: SCOPE.STORES.RIBBON_WRITE ## Introduction Updates multiple ribbons. Each time a ribbon is updated, `revision` increments by 1. The current `revision` must be passed when updating a ribbon. This ensures you're working with the latest ribbon and prevents unintended overwrites. --- ## REST API ### Schema ``` Method: bulkUpdateRibbons Description: Updates multiple ribbons. Each time a ribbon is updated, `revision` increments by 1. The current `revision` must be passed when updating a ribbon. This ensures you're working with the latest ribbon and prevents unintended overwrites. URL: https://www.wixapis.com/stores/v3/bulk/ribbons/update Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: ribbons, ribbons.ribbon.id, ribbons.ribbon.revision Method parameters: param name: fields | type: array | description: Fields to include in the response. Supported values: `ASSIGNED_PRODUCTS_COUNT` - enum: ASSIGNED_PRODUCT_COUNT param name: returnEntity | type: returnEntity | description: Whether to return the full updated ribbon entities in the response. Default: `false` param name: ribbons | type: array | description: List of ribbons to update. | required: true - name: ribbon | type: Ribbon | description: Ribbon to update. - name: id | type: string | description: Ribbon GUID. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the ribbon is updated. To prevent conflicting changes, the current revision must be passed when updating the ribbon. Ignored when creating a ribbon. | required: true - name: name | type: string | description: Ribbon name. - name: fieldMask | type: | description: Explicit list of fields to update. Return type: BulkUpdateRibbonsResponse - name: results | type: array | description: Ribbons updated by bulk action. - name: itemMetadata | type: ItemMetadata | description: Bulk action metadata for ribbon. - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: item | type: Ribbon | description: Full ribbon entity. Returned only if `returnEntity: true` is passed in the request. - name: id | type: string | description: Ribbon GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the ribbon is updated. To prevent conflicting changes, the current revision must be passed when updating the ribbon. Ignored when creating a ribbon. - name: createdDate | type: string | description: Date and time the ribbon was created. - name: updatedDate | type: string | description: Date and time the ribbon was updated. - name: name | type: string | description: Ribbon name. - name: assignedProductCount | type: integer | description: Number of products this ribbon is assigned to. Includes both primary and additional ribbons. > **Note:** Returned only when you pass `"ASSIGNED_PRODUCT_COUNT"` to the `fields` array in Ribbon API requests. - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### Bulk update ribbons Update 2 ribbons at once. ```curl curl -X POST \ 'https://www.wixapis.com/stores/v3/bulk/ribbons/update' \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ -d '{ "ribbons": [ { "ribbon": { "id": "bf08b9e3-6e7e-42d8-b38c-a84256839108", "revision": "1", "name": "New Collection" } }, { "ribbon": { "id": "ff0a77c2-5ea5-4f45-afeb-580c80a8a95a", "revision": "2", "name": "New Arrival" } } ], "returnEntity": true }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.catalogV3.RibbonService.bulkUpdateRibbons(ribbons, options) Description: Updates multiple ribbons. Each time a ribbon is updated, `revision` increments by 1. The current `revision` must be passed when updating a ribbon. This ensures you're working with the latest ribbon and prevents unintended overwrites. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: ribbons, ribbons.ribbon._id, ribbons.ribbon.revision Method parameters: param name: options | type: BulkUpdateRibbonsOptions none - name: returnEntity | type: boolean | description: Whether to return the full updated ribbon entities in the response. Default: `false` - name: fields | type: array | description: Fields to include in the response. Supported values: `ASSIGNED_PRODUCTS_COUNT` - enum: ASSIGNED_PRODUCT_COUNT param name: ribbons | type: array | description: List of ribbons to update. | required: true - name: ribbon | type: Ribbon | description: Ribbon to update. - name: _id | type: string | description: Ribbon GUID. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the ribbon is updated. To prevent conflicting changes, the current revision must be passed when updating the ribbon. Ignored when creating a ribbon. | required: true - name: name | type: string | description: Ribbon name. - name: fieldMask | type: array | description: Explicit list of fields to update. Return type: PROMISE - name: results | type: array | description: Ribbons updated by bulk action. - name: itemMetadata | type: ItemMetadata | description: Bulk action metadata for ribbon. - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. - name: error | type: ApplicationError | description: Details about the error in case of failure. - name: code | type: string | description: Error code. - name: description | type: string | description: Description of the error. - name: data | type: object | description: Data related to the error. - name: item | type: Ribbon | description: Full ribbon entity. Returned only if `returnEntity: true` is passed in the request. - name: _id | type: string | description: Ribbon GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the ribbon is updated. To prevent conflicting changes, the current revision must be passed when updating the ribbon. Ignored when creating a ribbon. - name: _createdDate | type: Date | description: Date and time the ribbon was created. - name: _updatedDate | type: Date | description: Date and time the ribbon was updated. - name: name | type: string | description: Ribbon name. - name: assignedProductCount | type: integer | description: Number of products this ribbon is assigned to. Includes both primary and additional ribbons. > **Note:** Returned only when you pass `"ASSIGNED_PRODUCT_COUNT"` to the `fields` array in Ribbon API requests. - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. - name: totalFailures | type: integer | description: Number of items that couldn't be processed. - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. ``` ### Examples ### Bulk update ribbons ```javascript import { ribbonsV3 } from "@wix/stores"; const ribbons = [ { ribbon: { id: "bf08b9e3-6e7e-42d8-b38c-a84256839108", revision: "1", name: "New Collection" } }, { ribbon: { id: "ff0a77c2-5ea5-4f45-afeb-580c80a8a95a", revision: "2", name: "New Arrival" } } ]; const options = { returnEntity: true }; async function bulkUpdateRibbons() { const response = await ribbonsV3.bulkUpdateRibbons(ribbons, options); } /* Promise resolves to: * { * "results": [ * { * "itemMetadata": { "originalIndex": 0, "success": true, "_id": "bf08b9e3-..." }, * "item": { "_id": "bf08b9e3-...", "revision": "2", "name": "New Collection" } * }, * { * "itemMetadata": { "originalIndex": 1, "success": true, "_id": "ff0a77c2-..." }, * "item": { "_id": "ff0a77c2-...", "revision": "3", "name": "New Arrival" } * } * ], * "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 0 } * } */ ``` ### bulkUpdateRibbons (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 { ribbonsV3 } from '@wix/stores'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { ribbonsV3 }, // Include the auth strategy and host as relevant }); async function bulkUpdateRibbons(ribbons,options) { const response = await myWixClient.ribbonsV3.bulkUpdateRibbons(ribbons,options); }; ``` ---