{"id":"0e274333-7897-4357-bca5-baa6edf36a68","createdDate":"2024-08-20T14:48:54.649Z","updatedDate":"2024-08-20T14:48:54.649Z","resourceId":"3630aed2-61f0-4bee-b2eb-2edbe493e867","api":{"schema":{"object":{"displayName":"Ribbon Object","description":"A Ribbon is a visual element that you can assign to products to highlight them on your site.","slug":"ribbon-object","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","legacyExamples":[{"title":"Ribbon","content":"{\n \"ribbon\": {\n \"id\": \"2254c3b3-6bbd-457d-b868-9122657c5d1c\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T08:34:04.787Z\",\n \"updatedDate\": \"2024-06-26T08:34:04.787Z\",\n \"name\": \"New Arrival!\",\n \"assignedProductCount\": 3\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Create Ribbon","description":"Creates a ribbon.\n\nTo assign the ribbon to a product, include the `ribbon.id` or `ribbon.name` when [creating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) or [updating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) a product.","operationId":"wix.stores.catalog.ribbon.v3.RibbonService.CreateRibbon","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.CreateRibbonResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/ribbons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/ribbons","destinationPath":"/v3/ribbons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateRibbonRequest","description":"","properties":{"ribbon":{"description":"Ribbon to create.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","summary":"ribbon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["ribbon","ribbon.name"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.CreateRibbonRequest","responseMessage":"wix.stores.catalog.ribbon.v3.CreateRibbonResponse"},"legacyExamples":[{"name":"CreateRibbon","type":"METHOD","content":{"title":"Create a ribbon","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/ribbons' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbon\": {\n \"name\": \"New Offer!\"\n }\n }'","response":"{\n \"ribbon\": {\n \"id\": \"2254c3b3-6bbd-457d-b868-9122657c5d1c\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T08:34:04.787Z\",\n \"updatedDate\": \"2024-06-26T08:34:04.787Z\",\n \"name\": \"New Offer!\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/ribbons","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.CreateRibbonRequest","responseMessage":"wix.stores.catalog.ribbon.v3.CreateRibbonResponse"},"legacyExamples":[{"name":"CreateRibbon","type":"METHOD","content":{"title":"Create a ribbon","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/ribbons' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbon\": {\n \"name\": \"New Offer!\"\n }\n }'","response":"{\n \"ribbon\": {\n \"id\": \"2254c3b3-6bbd-457d-b868-9122657c5d1c\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T08:34:04.787Z\",\n \"updatedDate\": \"2024-06-26T08:34:04.787Z\",\n \"name\": \"New Offer!\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Ribbon","slugifiedName":"create-ribbon"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"}]},{"summary":"Get Ribbon","description":"Retrieves a ribbon.","operationId":"wix.stores.catalog.ribbon.v3.RibbonService.GetRibbon","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"ribbonId","description":"Ribbon ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"fields","in":"query","description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","required":false,"schema":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.GetRibbonResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/ribbons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/ribbons","destinationPath":"/v3/ribbons","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.GetRibbonRequest","responseMessage":"wix.stores.catalog.ribbon.v3.GetRibbonResponse"},"legacyExamples":[{"name":"GetRibbon","type":"METHOD","order":2,"content":{"title":"Get a ribbon with assignedProductCount","description":"Get ribbon with additional requested field assignedProductCount","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/ribbons/395153b7-430f-49a9-be4b-6e7eef1e020e?fields=ASSIGNED_PRODUCT_COUNT' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: '","response":"{\n \"ribbon\": {\n \"id\": \"395153b7-430f-49a9-be4b-6e7eef1e020e\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-30T11:04:39.920Z\",\n \"updatedDate\": \"2024-06-30T11:04:39.920Z\",\n \"name\": \"On Sale\",\n \"assignedProductCount\": 3\n }\n}"}},{"name":"GetRibbon","type":"METHOD","order":1,"content":{"title":"Get a ribbon","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/ribbons/2254c3b3-6bbd-457d-b868-9122657c5d1c' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: '","response":"{\n \"ribbon\": {\n \"id\": \"2254c3b3-6bbd-457d-b868-9122657c5d1c\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T08:34:04.787Z\",\n \"updatedDate\": \"2024-06-26T08:34:04.787Z\",\n \"name\": \"New Arrival!\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v3/ribbons/{ribbonId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.GetRibbonRequest","responseMessage":"wix.stores.catalog.ribbon.v3.GetRibbonResponse"},"legacyExamples":[{"name":"GetRibbon","type":"METHOD","order":2,"content":{"title":"Get a ribbon with assignedProductCount","description":"Get ribbon with additional requested field assignedProductCount","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/ribbons/395153b7-430f-49a9-be4b-6e7eef1e020e?fields=ASSIGNED_PRODUCT_COUNT' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: '","response":"{\n \"ribbon\": {\n \"id\": \"395153b7-430f-49a9-be4b-6e7eef1e020e\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-30T11:04:39.920Z\",\n \"updatedDate\": \"2024-06-30T11:04:39.920Z\",\n \"name\": \"On Sale\",\n \"assignedProductCount\": 3\n }\n}"}},{"name":"GetRibbon","type":"METHOD","order":1,"content":{"title":"Get a ribbon","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/ribbons/2254c3b3-6bbd-457d-b868-9122657c5d1c' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: '","response":"{\n \"ribbon\": {\n \"id\": \"2254c3b3-6bbd-457d-b868-9122657c5d1c\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T08:34:04.787Z\",\n \"updatedDate\": \"2024-06-26T08:34:04.787Z\",\n \"name\": \"New Arrival!\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Ribbon","slugifiedName":"get-ribbon"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"}]},{"summary":"Delete Ribbon","description":"Deletes a ribbon.\n\n\n> **Note:** Deleting a ribbon will also remove it from all products it is assigned to.","operationId":"wix.stores.catalog.ribbon.v3.RibbonService.DeleteRibbon","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"ribbonId","description":"Ribbon ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.DeleteRibbonResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/ribbons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/ribbons","destinationPath":"/v3/ribbons","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.DeleteRibbonRequest","responseMessage":"wix.stores.catalog.ribbon.v3.DeleteRibbonResponse"},"legacyExamples":[{"name":"DeleteRibbon","type":"METHOD","content":{"title":"Delete a ribbon","request":"curl -X DELETE \\\n 'https://www.wixapis.com/stores/v3/ribbons/2254c3b3-6bbd-457d-b868-9122657c5d1c' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: '"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v3/ribbons/{ribbonId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.DeleteRibbonRequest","responseMessage":"wix.stores.catalog.ribbon.v3.DeleteRibbonResponse"},"legacyExamples":[{"name":"DeleteRibbon","type":"METHOD","content":{"title":"Delete a ribbon","request":"curl -X DELETE \\\n 'https://www.wixapis.com/stores/v3/ribbons/2254c3b3-6bbd-457d-b868-9122657c5d1c' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: '"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Ribbon","slugifiedName":"delete-ribbon"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"}]},{"summary":"Update Ribbon","description":"Updates a ribbon.\n\n\nEach time the ribbon is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating the ribbon.\nThis ensures you're working with the latest ribbon and prevents unintended overwrites.","operationId":"wix.stores.catalog.ribbon.v3.RibbonService.UpdateRibbon","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"ribbon.id","description":"Ribbon ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.UpdateRibbonResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/ribbons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/ribbons","destinationPath":"/v3/ribbons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateRibbonRequest","description":"","properties":{"ribbon":{"description":"Ribbon to update.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","summary":"ribbon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["ribbon","ribbon.id","ribbon.revision"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.UpdateRibbonRequest","responseMessage":"wix.stores.catalog.ribbon.v3.UpdateRibbonResponse"},"legacyExamples":[{"name":"UpdateRibbon","type":"METHOD","content":{"title":"Update a ribbon","request":"curl -X PATCH \\\n 'https://www.wixapis.com/stores/v3/ribbons/2254c3b3-6bbd-457d-b868-9122657c5d1c' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbon\": {\n \"name\": \"New!\",\n \"revision\": \"1\"\n }\n }'","response":"{\n \"ribbon\": {\n \"id\": \"2254c3b3-6bbd-457d-b868-9122657c5d1c\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T08:34:04.787Z\",\n \"updatedDate\": \"2024-06-26T08:39:24.371Z\",\n \"name\": \"New!\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v3/ribbons/{ribbon.id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.UpdateRibbonRequest","responseMessage":"wix.stores.catalog.ribbon.v3.UpdateRibbonResponse"},"legacyExamples":[{"name":"UpdateRibbon","type":"METHOD","content":{"title":"Update a ribbon","request":"curl -X PATCH \\\n 'https://www.wixapis.com/stores/v3/ribbons/2254c3b3-6bbd-457d-b868-9122657c5d1c' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbon\": {\n \"name\": \"New!\",\n \"revision\": \"1\"\n }\n }'","response":"{\n \"ribbon\": {\n \"id\": \"2254c3b3-6bbd-457d-b868-9122657c5d1c\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T08:34:04.787Z\",\n \"updatedDate\": \"2024-06-26T08:39:24.371Z\",\n \"name\": \"New!\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Ribbon","slugifiedName":"update-ribbon"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"}]},{"summary":"Query Ribbons","description":"Retrieves a list of up to 100 ribbons, given the provided filtering, sorting, and cursor paging.\nPass supported values to the `fields` array in the request to include those fields in the response.\n\n\nQuery Brands runs with these defaults, which you can override:\n\n- `createdDate` is sorted in `DESC` order\n- `cursorPaging.limit` is `100`\n\nFor field support for filters and sorting,\nsee [Ribbons: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/supported-filters-and-sorting).\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\nand [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).","operationId":"wix.stores.catalog.ribbon.v3.RibbonService.QueryRibbons","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.QueryRibbonsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/ribbons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/ribbons","destinationPath":"/v3/ribbons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryRibbonsRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.query.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.QueryRibbonsRequest","responseMessage":"wix.stores.catalog.ribbon.v3.QueryRibbonsResponse"},"legacyExamples":[{"name":"QueryRibbons","type":"METHOD","order":2,"content":{"title":"Query ribbons with cursor paging","description":"This is the followup query to the query ribbons example. It demonstrates how to use cursor paging to retrieve the next page of ribbons.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/ribbons/query' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"cursorPaging\": {\n \"cursor\": \"d8c06edfa2eef21fd087e1f5b2ed0daa259694e7.EiQqIgogCgRuYW1lEhgqFgoUCgskc3RhcnRzV2l0aBIFGgNOZXcaLQoMX2NyZWF0ZWREYXRlEAEaGyoZChcKCiR0aW1lc3RhbXASCREAYJzLOwV5QiIkZjQ4MGY3NmQtZjJkOS00NzliLTg5NzgtNjQ4NmYwNmY0NzJk\"\n }\n }\n }'","response":"{\n \"ribbons\": [\n {\n \"id\": \"2254c3b3-6bbd-457d-b868-9122657c5d1c\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T08:34:04.787Z\",\n \"updatedDate\": \"2024-06-26T08:39:24.371Z\",\n \"name\": \"New!\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"prev\": \"f0c0028f5a13813719b4480f620a0afb2bb96954.CAESJCoiCiAKBG5hbWUSGCoWChQKCyRzdGFydHNXaXRoEgUaA05ldxotCgxfY3JlYXRlZERhdGUQARobKhkKFwoKJHRpbWVzdGFtcBIJEQAwd-M6BXlCIiQyMjU0YzNiMy02YmJkLTQ1N2QtYjg2OC05MTIyNjU3YzVkMWM\"\n },\n \"hasNext\": false\n }\n}"}},{"name":"QueryRibbons","type":"METHOD","order":1,"content":{"title":"Query ribbons","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/ribbons/query' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"filter\": {\"name\": {\"$startsWith\":\"New\"}},\n \"sort\": [{\"fieldName\":\"createdDate\",\"order\":\"DESC\"}],\n \"cursorPaging\": {\"limit\": 2}\n }\n }'","response":"{\n \"ribbons\": [\n {\n \"id\": \"438f0fc0-8913-4da3-bb1d-047bb92c3569\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:00:04.066Z\",\n \"updatedDate\": \"2024-06-26T09:00:04.066Z\",\n \"name\": \"New Offer!\"\n },\n {\n \"id\": \"f480f76d-f2d9-479b-8978-6486f06f472d\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T08:49:55.654Z\",\n \"updatedDate\": \"2024-06-26T08:49:55.654Z\",\n \"name\": \"New collection\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": \"d8c06edfa2eef21fd087e1f5b2ed0daa259694e7.EiQqIgogCgRuYW1lEhgqFgoUCgskc3RhcnRzV2l0aBIFGgNOZXcaLQoMX2NyZWF0ZWREYXRlEAEaGyoZChcKCiR0aW1lc3RhbXASCREAYJzLOwV5QiIkZjQ4MGY3NmQtZjJkOS00NzliLTg5NzgtNjQ4NmYwNmY0NzJk\"\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/ribbons/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.QueryRibbonsRequest","responseMessage":"wix.stores.catalog.ribbon.v3.QueryRibbonsResponse"},"legacyExamples":[{"name":"QueryRibbons","type":"METHOD","order":2,"content":{"title":"Query ribbons with cursor paging","description":"This is the followup query to the query ribbons example. It demonstrates how to use cursor paging to retrieve the next page of ribbons.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/ribbons/query' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"cursorPaging\": {\n \"cursor\": \"d8c06edfa2eef21fd087e1f5b2ed0daa259694e7.EiQqIgogCgRuYW1lEhgqFgoUCgskc3RhcnRzV2l0aBIFGgNOZXcaLQoMX2NyZWF0ZWREYXRlEAEaGyoZChcKCiR0aW1lc3RhbXASCREAYJzLOwV5QiIkZjQ4MGY3NmQtZjJkOS00NzliLTg5NzgtNjQ4NmYwNmY0NzJk\"\n }\n }\n }'","response":"{\n \"ribbons\": [\n {\n \"id\": \"2254c3b3-6bbd-457d-b868-9122657c5d1c\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T08:34:04.787Z\",\n \"updatedDate\": \"2024-06-26T08:39:24.371Z\",\n \"name\": \"New!\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"prev\": \"f0c0028f5a13813719b4480f620a0afb2bb96954.CAESJCoiCiAKBG5hbWUSGCoWChQKCyRzdGFydHNXaXRoEgUaA05ldxotCgxfY3JlYXRlZERhdGUQARobKhkKFwoKJHRpbWVzdGFtcBIJEQAwd-M6BXlCIiQyMjU0YzNiMy02YmJkLTQ1N2QtYjg2OC05MTIyNjU3YzVkMWM\"\n },\n \"hasNext\": false\n }\n}"}},{"name":"QueryRibbons","type":"METHOD","order":1,"content":{"title":"Query ribbons","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/ribbons/query' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"filter\": {\"name\": {\"$startsWith\":\"New\"}},\n \"sort\": [{\"fieldName\":\"createdDate\",\"order\":\"DESC\"}],\n \"cursorPaging\": {\"limit\": 2}\n }\n }'","response":"{\n \"ribbons\": [\n {\n \"id\": \"438f0fc0-8913-4da3-bb1d-047bb92c3569\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:00:04.066Z\",\n \"updatedDate\": \"2024-06-26T09:00:04.066Z\",\n \"name\": \"New Offer!\"\n },\n {\n \"id\": \"f480f76d-f2d9-479b-8978-6486f06f472d\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T08:49:55.654Z\",\n \"updatedDate\": \"2024-06-26T08:49:55.654Z\",\n \"name\": \"New collection\"\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {\n \"next\": \"d8c06edfa2eef21fd087e1f5b2ed0daa259694e7.EiQqIgogCgRuYW1lEhgqFgoUCgskc3RhcnRzV2l0aBIFGgNOZXcaLQoMX2NyZWF0ZWREYXRlEAEaGyoZChcKCiR0aW1lc3RhbXASCREAYJzLOwV5QiIkZjQ4MGY3NmQtZjJkOS00NzliLTg5NzgtNjQ4NmYwNmY0NzJk\"\n },\n \"hasNext\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Ribbons","slugifiedName":"query-ribbons"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"}]},{"summary":"Bulk Create Ribbons","description":"Creates multiple ribbons.","operationId":"wix.stores.catalog.ribbon.v3.RibbonService.BulkCreateRibbons","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.BulkCreateRibbonsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/ribbons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/ribbons","destinationPath":"/v3/bulk/ribbons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateRibbonsRequest","description":"","properties":{"ribbons":{"description":"Ribbons to create.","minItems":1,"maxItems":100,"title":"ribbons","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full created ribbon entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["ribbons","ribbons.name"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.BulkCreateRibbonsRequest","responseMessage":"wix.stores.catalog.ribbon.v3.BulkCreateRibbonsResponse"},"legacyExamples":[{"name":"BulkCreateRibbons","type":"METHOD","content":{"title":"Bulk create ribbons","description":"Create 2 ribbons at once.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/ribbons/create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbons\": [\n {\n \"name\": \"New Offer!\"\n },\n {\n \"name\": \"New collection\"\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"9d80c64a-b39f-4b7c-b47a-2ba0e840b740\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"9d80c64a-b39f-4b7c-b47a-2ba0e840b740\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:15:22.092Z\",\n \"updatedDate\": \"2024-06-26T09:15:22.092Z\",\n \"name\": \"New Offer!\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"d9f4daa3-d122-4e84-a6b4-432f3e48cfe4\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"d9f4daa3-d122-4e84-a6b4-432f3e48cfe4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:15:22.092Z\",\n \"updatedDate\": \"2024-06-26T09:15:22.092Z\",\n \"name\": \"New collection\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/ribbons/create","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.BulkCreateRibbonsRequest","responseMessage":"wix.stores.catalog.ribbon.v3.BulkCreateRibbonsResponse"},"legacyExamples":[{"name":"BulkCreateRibbons","type":"METHOD","content":{"title":"Bulk create ribbons","description":"Create 2 ribbons at once.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/ribbons/create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbons\": [\n {\n \"name\": \"New Offer!\"\n },\n {\n \"name\": \"New collection\"\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"9d80c64a-b39f-4b7c-b47a-2ba0e840b740\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"9d80c64a-b39f-4b7c-b47a-2ba0e840b740\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:15:22.092Z\",\n \"updatedDate\": \"2024-06-26T09:15:22.092Z\",\n \"name\": \"New Offer!\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"d9f4daa3-d122-4e84-a6b4-432f3e48cfe4\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"d9f4daa3-d122-4e84-a6b4-432f3e48cfe4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:15:22.092Z\",\n \"updatedDate\": \"2024-06-26T09:15:22.092Z\",\n \"name\": \"New collection\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Create Ribbons","slugifiedName":"bulk-create-ribbons"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"}]},{"summary":"Bulk Update Ribbons","description":"Updates multiple ribbons.\n\nEach time a ribbon is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating a ribbon.\nThis ensures you're working with the latest ribbon and prevents unintended overwrites.","operationId":"wix.stores.catalog.ribbon.v3.RibbonService.BulkUpdateRibbons","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.BulkUpdateRibbonsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/ribbons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/ribbons","destinationPath":"/v3/bulk/ribbons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateRibbonsRequest","description":"","properties":{"ribbons":{"description":"List of ribbons to update.","minItems":1,"maxItems":100,"title":"ribbons","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.MaskedRibbon"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full updated ribbon entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["ribbons","ribbons.ribbon.id","ribbons.ribbon.revision"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.BulkUpdateRibbonsRequest","responseMessage":"wix.stores.catalog.ribbon.v3.BulkUpdateRibbonsResponse"},"legacyExamples":[{"name":"BulkUpdateRibbons","type":"METHOD","content":{"title":"Bulk update ribbons","description":"Update 2 ribbons at once.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/ribbons/update' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbons\": [\n {\n \"ribbon\": {\n \"id\": \"bf08b9e3-6e7e-42d8-b38c-a84256839108\",\n \"revision\": \"1\",\n \"name\": \"New Collection\"\n }\n },\n {\n \"ribbon\": {\n \"id\": \"ff0a77c2-5ea5-4f45-afeb-580c80a8a95a\",\n \"revision\": \"2\",\n \"name\": \"New Arrival\"\n }\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bf08b9e3-6e7e-42d8-b38c-a84256839108\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"bf08b9e3-6e7e-42d8-b38c-a84256839108\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T10:56:59.411Z\",\n \"updatedDate\": \"2024-06-26T11:03:13.362Z\",\n \"name\": \"New Collection\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"ff0a77c2-5ea5-4f45-afeb-580c80a8a95a\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"ff0a77c2-5ea5-4f45-afeb-580c80a8a95a\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T10:54:34.491Z\",\n \"updatedDate\": \"2024-06-26T11:03:13.362Z\",\n \"name\": \"New Arrival\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/ribbons/update","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.BulkUpdateRibbonsRequest","responseMessage":"wix.stores.catalog.ribbon.v3.BulkUpdateRibbonsResponse"},"legacyExamples":[{"name":"BulkUpdateRibbons","type":"METHOD","content":{"title":"Bulk update ribbons","description":"Update 2 ribbons at once.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/ribbons/update' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbons\": [\n {\n \"ribbon\": {\n \"id\": \"bf08b9e3-6e7e-42d8-b38c-a84256839108\",\n \"revision\": \"1\",\n \"name\": \"New Collection\"\n }\n },\n {\n \"ribbon\": {\n \"id\": \"ff0a77c2-5ea5-4f45-afeb-580c80a8a95a\",\n \"revision\": \"2\",\n \"name\": \"New Arrival\"\n }\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"bf08b9e3-6e7e-42d8-b38c-a84256839108\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"bf08b9e3-6e7e-42d8-b38c-a84256839108\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-26T10:56:59.411Z\",\n \"updatedDate\": \"2024-06-26T11:03:13.362Z\",\n \"name\": \"New Collection\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"ff0a77c2-5ea5-4f45-afeb-580c80a8a95a\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"ff0a77c2-5ea5-4f45-afeb-580c80a8a95a\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T10:54:34.491Z\",\n \"updatedDate\": \"2024-06-26T11:03:13.362Z\",\n \"name\": \"New Arrival\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Ribbons","slugifiedName":"bulk-update-ribbons"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"}]},{"summary":"Get Or Create Ribbon","description":"Retrieves a ribbon by name, or creates a ribbon if one with the passed `ribbonName` doesn't exist.","operationId":"wix.stores.catalog.ribbon.v3.RibbonService.GetOrCreateRibbon","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.GetOrCreateRibbonResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/ribbons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/ribbons","destinationPath":"/v3/ribbons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"GetOrCreateRibbonRequest","description":"","properties":{"ribbonName":{"description":"Ribbon name to retrieve or create.","minLength":1,"maxLength":30,"title":"ribbonName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["ribbonName"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_GET_OR_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.GetOrCreateRibbonRequest","responseMessage":"wix.stores.catalog.ribbon.v3.GetOrCreateRibbonResponse"},"legacyExamples":[{"name":"GetOrCreateRibbon","type":"METHOD","content":{"title":"Get or create a ribbon","description":"Fetches the ribbon by name, or creates it if it doesn't exist.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/ribbons/get-or-create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbonName\": \"New Arrival\"\n }'","response":"{\n \"ribbon\": {\n \"id\": \"ff0a77c2-5ea5-4f45-afeb-580c80a8a95a\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T10:54:34.491Z\",\n \"updatedDate\": \"2024-06-26T11:03:13.362Z\",\n \"name\": \"New Arrival\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/ribbons/get-or-create","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_GET_OR_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.GetOrCreateRibbonRequest","responseMessage":"wix.stores.catalog.ribbon.v3.GetOrCreateRibbonResponse"},"legacyExamples":[{"name":"GetOrCreateRibbon","type":"METHOD","content":{"title":"Get or create a ribbon","description":"Fetches the ribbon by name, or creates it if it doesn't exist.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/ribbons/get-or-create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbonName\": \"New Arrival\"\n }'","response":"{\n \"ribbon\": {\n \"id\": \"ff0a77c2-5ea5-4f45-afeb-580c80a8a95a\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T10:54:34.491Z\",\n \"updatedDate\": \"2024-06-26T11:03:13.362Z\",\n \"name\": \"New Arrival\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Or Create Ribbon","slugifiedName":"get-or-create-ribbon"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"}]},{"summary":"Bulk Get Or Create Ribbons","description":"Retrieves multiple ribbons by name, or creates multiple ribbons if those with the passed `ribbonNames` don't exist.","operationId":"wix.stores.catalog.ribbon.v3.RibbonService.BulkGetOrCreateRibbons","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.BulkGetOrCreateRibbonsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/ribbons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/ribbons","destinationPath":"/v3/bulk/ribbons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkGetOrCreateRibbonsRequest","description":"","properties":{"ribbonNames":{"description":"Ribbon names to retrieve or create.","minLength":1,"maxLength":30,"minItems":1,"maxItems":100,"title":"ribbonNames","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["ribbonNames"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_GET_OR_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.BulkGetOrCreateRibbonsRequest","responseMessage":"wix.stores.catalog.ribbon.v3.BulkGetOrCreateRibbonsResponse"},"legacyExamples":[{"name":"BulkGetOrCreateRibbons","type":"METHOD","content":{"title":"Bulk get or create ribbons","description":"Bulk fetches the ribbons by names, or creates them if they do not exist.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/ribbons/get-or-create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbonNames\": [\n \"New Offer!\",\n \"New collection\"\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"9d80c64a-b39f-4b7c-b47a-2ba0e840b740\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"9d80c64a-b39f-4b7c-b47a-2ba0e840b740\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:15:22.092Z\",\n \"updatedDate\": \"2024-06-26T09:15:22.092Z\",\n \"name\": \"New Offer!\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"d9f4daa3-d122-4e84-a6b4-432f3e48cfe4\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"d9f4daa3-d122-4e84-a6b4-432f3e48cfe4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:15:22.092Z\",\n \"updatedDate\": \"2024-06-26T09:15:22.092Z\",\n \"name\": \"New collection\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/ribbons/get-or-create","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_GET_OR_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.BulkGetOrCreateRibbonsRequest","responseMessage":"wix.stores.catalog.ribbon.v3.BulkGetOrCreateRibbonsResponse"},"legacyExamples":[{"name":"BulkGetOrCreateRibbons","type":"METHOD","content":{"title":"Bulk get or create ribbons","description":"Bulk fetches the ribbons by names, or creates them if they do not exist.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/ribbons/get-or-create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbonNames\": [\n \"New Offer!\",\n \"New collection\"\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"9d80c64a-b39f-4b7c-b47a-2ba0e840b740\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"9d80c64a-b39f-4b7c-b47a-2ba0e840b740\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:15:22.092Z\",\n \"updatedDate\": \"2024-06-26T09:15:22.092Z\",\n \"name\": \"New Offer!\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"d9f4daa3-d122-4e84-a6b4-432f3e48cfe4\",\n \"originalIndex\": 1,\n \"success\": true\n },\n \"item\": {\n \"id\": \"d9f4daa3-d122-4e84-a6b4-432f3e48cfe4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-26T09:15:22.092Z\",\n \"updatedDate\": \"2024-06-26T09:15:22.092Z\",\n \"name\": \"New collection\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Get Or Create Ribbons","slugifiedName":"bulk-get-or-create-ribbons"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"}]},{"summary":"Bulk Delete Ribbons","description":"Deletes multiple ribbons.","operationId":"wix.stores.catalog.ribbon.v3.RibbonService.BulkDeleteRibbons","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.BulkDeleteRibbonsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/ribbons","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/ribbons","destinationPath":"/v3/bulk/ribbons","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkDeleteRibbonsRequest","description":"","properties":{"ribbonIds":{"description":"IDs of ribbons to delete.","format":"GUID","minItems":1,"maxItems":100,"title":"ribbonIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["ribbonIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.BulkDeleteRibbonsRequest","responseMessage":"wix.stores.catalog.ribbon.v3.BulkDeleteRibbonsResponse"},"legacyExamples":[{"name":"BulkDeleteRibbons","type":"METHOD","content":{"title":"Bulk delete ribbons","description":"Delete 2 ribbons at once","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/ribbons/delete' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbonIds\": [\n \"b3b45015-5fc8-45c0-bf72-d1c4271e0439\",\n \"a05cae3a-d9e3-45c2-8811-01d682ed828c\"\n ]\n }'","response":"{\n \"results\": [\n {\n \"id\": \"b3b45015-5fc8-45c0-bf72-d1c4271e0439\",\n \"originalIndex\": 0,\n \"success\": true\n },\n {\n \"id\": \"a05cae3a-d9e3-45c2-8811-01d682ed828c\",\n \"originalIndex\": 1,\n \"success\": true\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/ribbons/delete","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.stores.catalog.ribbon.v3.RibbonService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.RIBBON_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"}],"protoArtifactId":"com.wixpress.stores:ribbon","serviceArtifactId":"com.wixpress.stores.ribbon","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.stores.catalog.ribbon.v3.BulkDeleteRibbonsRequest","responseMessage":"wix.stores.catalog.ribbon.v3.BulkDeleteRibbonsResponse"},"legacyExamples":[{"name":"BulkDeleteRibbons","type":"METHOD","content":{"title":"Bulk delete ribbons","description":"Delete 2 ribbons at once","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/ribbons/delete' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"ribbonIds\": [\n \"b3b45015-5fc8-45c0-bf72-d1c4271e0439\",\n \"a05cae3a-d9e3-45c2-8811-01d682ed828c\"\n ]\n }'","response":"{\n \"results\": [\n {\n \"id\": \"b3b45015-5fc8-45c0-bf72-d1c4271e0439\",\n \"originalIndex\": 0,\n \"success\": true\n },\n {\n \"id\": \"a05cae3a-d9e3-45c2-8811-01d682ed828c\",\n \"originalIndex\": 1,\n \"success\": true\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 0,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Delete Ribbons","slugifiedName":"bulk-delete-ribbons"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Ribbon write in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_WRITE"}]}],"webhooks":[{"summary":"Ribbon Created","title":"Ribbon Created","description":"","permissions":["WIX_STORES.RIBBON_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.ribbon","serviceName":"","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.stores.catalog.v3.ribbon_created","legacyExamples":[],"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","contentLink":{"displayName":"Ribbon Created","slugifiedName":"ribbon-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"}]},{"summary":"Ribbon Updated","title":"Ribbon Updated","description":"","permissions":["WIX_STORES.RIBBON_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.ribbon","serviceName":"","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.stores.catalog.v3.ribbon_updated","legacyExamples":[{"name":"RibbonUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"ba385b4d-fb1e-4a8e-ba02-d35eb5089c05\",\n \"entityFqdn\": \"wix.stores.catalog.v3.ribbon\",\n \"slug\": \"updated\",\n \"entityId\": \"bf08b9e3-6e7e-42d8-b38c-a84256839108\",\n \"updatedEvent\": {\n \"currentEntityAsJson\": {\n \"id\": \"bf08b9e3-6e7e-42d8-b38c-a84256839108\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T10:56:59.411Z\",\n \"updatedDate\": \"2024-06-30T11:46:05.845Z\",\n \"name\": \"New!\"\n }\n },\n \"eventTime\": \"2024-06-30T11:46:05.974279353Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"3\"\n}"}],"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","contentLink":{"displayName":"Ribbon Updated","slugifiedName":"ribbon-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"}]},{"summary":"Ribbon Deleted","title":"Ribbon Deleted","description":"","permissions":["WIX_STORES.RIBBON_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.ribbon","serviceName":"","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.stores.catalog.v3.ribbon_deleted","legacyExamples":[{"name":"RibbonDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"a0b4a0b9-8a80-4776-99d3-fdf75b807800\",\n \"entityFqdn\": \"wix.stores.catalog.v3.ribbon\",\n \"slug\": \"deleted\",\n \"entityId\": \"bf08b9e3-6e7e-42d8-b38c-a84256839101\",\n \"deletedEvent\": {\n \"movedToTrash\": true,\n \"deletedEntityAsJson\": {\n \"id\": \"bf08b9e3-6e7e-42d8-b38c-a84256839101\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-06-26T10:56:59.411Z\",\n \"updatedDate\": \"2024-06-30T11:46:05.845Z\",\n \"name\": \"New!\"\n }\n },\n \"eventTime\": \"2024-06-30T11:48:24.411366865Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"13\"\n}"}],"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","contentLink":{"displayName":"Ribbon Deleted","slugifiedName":"ribbon-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Read v3 catalog","scopeId":"SCOPE.STORES.CATALOG_READ"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"},{"name":"Read ribbons in v3 catalog","scopeId":"SCOPE.STORES.RIBBON_READ"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Ribbons\n\nThe Ribbons API allows you to create and manage ribbons,\nwhich can then be assigned to products using the [Products API](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/introduction).\n\nRibbons enhance product visibility and customer engagement by highlighting specific product features or promotions.\nUse ribbons to draw attention to key product information such as new arrivals, bestsellers, limited stock, or any custom label that you feel will enhance product visibility and sales.\n\nThis API provides all the necessary functionality to manage a bank of ribbons,\nwhich can be applied to products to ensure a consistent ribbon experience across your store.\n\nWith the Ribbons API, you can:\n- Create and manage a bank of ribbons.\n- Retrieve information about existing ribbons.\n\n## Before you begin\nIt’s important to note the following point before starting to code:\n* The site owner must install the Wix Stores app.\n\n## Sample flows\n* [Create a product with a new ribbon](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/sample-use-cases-and-flows)\n* [Assign existing ribbon to a product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/sample-use-cases-and-flows)"},{"displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows","content":"# Ribbons: Sample Use Cases and Flows\n\nThis article shares a possible use case your app could support, as well as sample flows that could support this use case.\nThis can be a helpful jumping-off point as you plan your app's implementation.\n\n## Create a product with a new ribbon\n\nTo create a product and assign a new ribbon with a single API call:\nCall [Create Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) and pass\na new `product.ribbon.name` to the `product.ribbon` field.\n\nNote: if you pass the `ribbon.name` of a ribbon you've already created, that ribbon will be assigned to the product.\n\n## Assign an existing ribbon to a product\n\nThe Ribbons API allows you to create, update, and manage multiple ribbons.\nYou can then use and reuse these ribbons and assign them across multiple products.\n\nTo create and assign a ribbon to a product:\n1. Call [Create Ribbon](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/create-ribbon).\n2. Save the `ribbon.id` or `ribbon.name` from your newly created ribbon.\n3. Call [Create Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product)\n or [Update Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product),\n and pass either the `ribbon.id` or the `ribbon.name` to the `product.ribbon` field."},{"displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting","content":"# Ribbons: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the ribbon object:\n\n| Field | Supported Filters | Sortable |\n|---------------|------------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `createdDate` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `name` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | Sortable |\n\n\n__Related content:__\n[API Query Language](fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\n[Query Ribbons](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/query-ribbons)"}],"components":{"schemas":{"wix.stores.catalog.ribbon.v3.Ribbon":{"type":"object","properties":{"id":{"description":"Ribbon ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the ribbon is updated.\nTo prevent conflicting changes,\nthe current revision must be passed when updating the ribbon.\n\nIgnored when creating a ribbon.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the ribbon was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the ribbon was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Ribbon name.","minLength":1,"maxLength":30,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assignedProductCount":{"description":"Number of products this ribbon is assigned to.\n> **Note:** Returned only when you pass `\"ASSIGNED_PRODUCT_COUNT\"` to the `fields` array in Ribbon API requests.","readOnly":true,"title":"assignedProductCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Ribbon","description":"A Ribbon is a visual element that you can assign to products to highlight them on your site."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache":{"type":"object","properties":{"reason":{"description":"tell us why you're invalidating the cache. You don't need to add your app name","maxLength":256,"title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"localDc":{"description":"Is local DS","title":"localDc","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InvalidateCache","description":"","oneOf":[{"description":"","summary":"getBy","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.getBy"}]},"com.wixpress.html.cache.invalidate.InvalidateCache.getBy":{"type":"object","title":"getBy","properties":{"metaSiteId":{"description":"Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteId":{"description":"Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"app":{"description":"Invalidate by App","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.App","summary":"app","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"page":{"description":"Invalidate by page id","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.Page","summary":"page","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uri":{"description":"Invalidate by URI path","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.URI","summary":"uri","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"file":{"description":"Invalidate by file (for media files such as PDFs)","$ref":"#/components/schemas/com.wixpress.html.cache.invalidate.InvalidateCache.File","summary":"file","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.html.cache.invalidate.InvalidateCache.App":{"type":"object","properties":{"appDefId":{"description":"The AppDefId","minLength":1,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"The instance Id","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"App","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.Page":{"type":"object","properties":{"metaSiteId":{"description":"the msid the page is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pageId":{"description":"Invalidate by Page ID","minLength":1,"title":"pageId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Page","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.URI":{"type":"object","properties":{"metaSiteId":{"description":"the msid the URI is on","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uriPath":{"description":"URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes","minLength":1,"title":"uriPath","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"URI","description":""},"com.wixpress.html.cache.invalidate.InvalidateCache.File":{"type":"object","properties":{"metaSiteId":{"description":"the msid the file is related to","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fileName":{"description":"Invalidate by filename (for media files such as PDFs)","minLength":1,"maxLength":256,"title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"File","description":""},"wix.stores.catalog.ribbon.v3.CreateRibbonRequest":{"type":"object","properties":{"ribbon":{"description":"Ribbon to create.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","summary":"ribbon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateRibbonRequest","description":""},"wix.stores.catalog.ribbon.v3.CreateRibbonResponse":{"type":"object","properties":{"ribbon":{"description":"Created ribbon.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","summary":"ribbon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateRibbonResponse","description":""},"wix.stores.catalog.ribbon.v3.GetRibbonRequest":{"type":"object","properties":{"ribbonId":{"description":"Ribbon ID.","format":"GUID","title":"ribbonId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetRibbonRequest","description":""},"wix.stores.catalog.ribbon.v3.RequestedFields":{"type":"string","description":"","title":"RequestedFields","enum":["UNKNOWN_REQUESTED_FIELD","ASSIGNED_PRODUCT_COUNT"]},"wix.stores.catalog.ribbon.v3.GetRibbonResponse":{"type":"object","properties":{"ribbon":{"description":"Ribbon.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","summary":"ribbon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetRibbonResponse","description":""},"wix.stores.catalog.ribbon.v3.UpdateRibbonRequest":{"type":"object","properties":{"ribbon":{"description":"Ribbon to update.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","summary":"ribbon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateRibbonRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"wix.stores.catalog.ribbon.v3.UpdateRibbonResponse":{"type":"object","properties":{"ribbon":{"description":"Updated Ribbon.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","summary":"ribbon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateRibbonResponse","description":""},"wix.stores.catalog.ribbon.v3.DeleteRibbonRequest":{"type":"object","properties":{"ribbonId":{"description":"Ribbon ID.","format":"GUID","title":"ribbonId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteRibbonRequest","description":""},"wix.stores.catalog.ribbon.v3.DeleteRibbonResponse":{"type":"object","properties":{},"title":"DeleteRibbonResponse","description":""},"wix.stores.catalog.ribbon.v3.QueryRibbonsRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.query.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryRibbonsRequest","description":""},"wix.stores.catalog.ribbon.v3.upstream.wix.query.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","maxItems":4,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.query.CursorQuery.pagingMethod"}]},"wix.stores.catalog.ribbon.v3.upstream.wix.query.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.stores.catalog.ribbon.v3.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.stores.catalog.ribbon.v3.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.stores.catalog.ribbon.v3.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Maximum number of items to return in the results.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":16000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"wix.stores.catalog.ribbon.v3.QueryRibbonsResponse":{"type":"object","properties":{"ribbons":{"description":"List of ribbons.","minItems":1,"maxItems":100,"title":"ribbons","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryRibbonsResponse","description":""},"wix.stores.catalog.ribbon.v3.upstream.wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursor strings that point to the next page, previous page, or both.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.stores.catalog.ribbon.v3.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.stores.catalog.ribbon.v3.BulkCreateRibbonsRequest":{"type":"object","properties":{"ribbons":{"description":"Ribbons to create.","minItems":1,"maxItems":100,"title":"ribbons","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full created ribbon entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateRibbonsRequest","description":""},"wix.stores.catalog.ribbon.v3.BulkCreateRibbonsResponse":{"type":"object","properties":{"results":{"description":"Ribbons created by bulk action.","maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.BulkRibbonResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateRibbonsResponse","description":""},"wix.stores.catalog.ribbon.v3.BulkRibbonResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for ribbon.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Full ribbon entity.\n\nReturned only if `returnEntity: true` is passed in the request.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRibbonResult","description":""},"wix.stores.catalog.ribbon.v3.upstream.wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"wix.stores.catalog.ribbon.v3.upstream.wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"wix.stores.catalog.ribbon.v3.BulkUpdateRibbonsRequest":{"type":"object","properties":{"ribbons":{"description":"List of ribbons to update.","minItems":1,"maxItems":100,"title":"ribbons","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.MaskedRibbon"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full updated ribbon entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateRibbonsRequest","description":""},"wix.stores.catalog.ribbon.v3.MaskedRibbon":{"type":"object","properties":{"ribbon":{"description":"Ribbon to update.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","summary":"ribbon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MaskedRibbon","description":""},"wix.stores.catalog.ribbon.v3.BulkUpdateRibbonsResponse":{"type":"object","properties":{"results":{"description":"Ribbons updated by bulk action.","maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.BulkRibbonResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateRibbonsResponse","description":""},"wix.stores.catalog.ribbon.v3.GetOrCreateRibbonRequest":{"type":"object","properties":{"ribbonName":{"description":"Ribbon name to retrieve or create.","minLength":1,"maxLength":30,"title":"ribbonName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetOrCreateRibbonRequest","description":""},"wix.stores.catalog.ribbon.v3.GetOrCreateRibbonResponse":{"type":"object","properties":{"ribbon":{"description":"Ribbon.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.Ribbon","summary":"ribbon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetOrCreateRibbonResponse","description":""},"wix.stores.catalog.ribbon.v3.BulkGetOrCreateRibbonsRequest":{"type":"object","properties":{"ribbonNames":{"description":"Ribbon names to retrieve or create.","minLength":1,"maxLength":30,"minItems":1,"maxItems":100,"title":"ribbonNames","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Fields to include in the response.\n\nSupported values: `ASSIGNED_PRODUCTS_COUNT`","maxItems":100,"title":"fields","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkGetOrCreateRibbonsRequest","description":""},"wix.stores.catalog.ribbon.v3.BulkGetOrCreateRibbonsResponse":{"type":"object","properties":{"results":{"description":"Ribbons retrieved or created by bulk action.","maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.BulkRibbonResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkGetOrCreateRibbonsResponse","description":""},"wix.stores.catalog.ribbon.v3.BulkDeleteRibbonsRequest":{"type":"object","properties":{"ribbonIds":{"description":"IDs of ribbons to delete.","format":"GUID","minItems":1,"maxItems":100,"title":"ribbonIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteRibbonsRequest","description":""},"wix.stores.catalog.ribbon.v3.BulkDeleteRibbonsResponse":{"type":"object","properties":{"results":{"description":"Ribbons deleted by bulk action.","maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.BulkDeleteRibbonsResponse.BulkRibbonResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteRibbonsResponse","description":""},"wix.stores.catalog.ribbon.v3.BulkDeleteRibbonsResponse.BulkRibbonResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for ribbon.","$ref":"#/components/schemas/wix.stores.catalog.ribbon.v3.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRibbonResult","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Ribbon","description":"A Ribbon is a visual element that you can assign to products to highlight them on your site.","fqdn":"wix.stores.catalog.v3.ribbon"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Ribbons\n\nThe Ribbons API allows you to create and manage ribbons,\nwhich can then be assigned to products using the [Products API](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/introduction).\n\nRibbons enhance product visibility and customer engagement by highlighting specific product features or promotions.\nUse ribbons to draw attention to key product information such as new arrivals, bestsellers, limited stock, or any custom label that you feel will enhance product visibility and sales.\n\nThis API provides all the necessary functionality to manage a bank of ribbons,\nwhich can be applied to products to ensure a consistent ribbon experience across your store.\n\nWith the Ribbons API, you can:\n- Create and manage a bank of ribbons.\n- Retrieve information about existing ribbons.\n\n## Before you begin\nIt’s important to note the following point before starting to code:\n* The site owner must install the Wix Stores app.\n\n## Sample flows\n* [Create a product with a new ribbon](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/sample-use-cases-and-flows)\n* [Assign existing ribbon to a product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/sample-use-cases-and-flows)"},{"displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows","content":"# Ribbons: Sample Use Cases and Flows\n\nThis article shares a possible use case your app could support, as well as sample flows that could support this use case.\nThis can be a helpful jumping-off point as you plan your app's implementation.\n\n## Create a product with a new ribbon\n\nTo create a product and assign a new ribbon with a single API call:\nCall [Create Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) and pass\na new `product.ribbon.name` to the `product.ribbon` field.\n\nNote: if you pass the `ribbon.name` of a ribbon you've already created, that ribbon will be assigned to the product.\n\n## Assign an existing ribbon to a product\n\nThe Ribbons API allows you to create, update, and manage multiple ribbons.\nYou can then use and reuse these ribbons and assign them across multiple products.\n\nTo create and assign a ribbon to a product:\n1. Call [Create Ribbon](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/create-ribbon).\n2. Save the `ribbon.id` or `ribbon.name` from your newly created ribbon.\n3. Call [Create Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product)\n or [Update Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product),\n and pass either the `ribbon.id` or the `ribbon.name` to the `product.ribbon` field."},{"displayName":"Supported Filters and Sorting","slugifyName":"supported-filters-and-sorting","content":"# Ribbons: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting for the ribbon object:\n\n| Field | Supported Filters | Sortable |\n|---------------|------------------------------------------------------------------------|----------|\n| `id` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | |\n| `createdDate` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$le`, `$gt`, `$ge` | Sortable |\n| `name` | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith` | Sortable |\n\n\n__Related content:__\n[API Query Language](fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\n[Query Ribbons](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/query-ribbons)"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Bulk Create Ribbons

Permission Scopes