{"id":"645d5336-7c3a-4337-939b-34935f82de61","createdDate":"2024-08-15T11:28:24.442Z","updatedDate":"2024-08-15T11:28:24.442Z","resourceId":"d8dd83e3-88d7-4d6e-afd8-aaf1618d6187","api":{"schema":{"object":{"displayName":"Brand Object","description":"A brand is a visible property of a product.\nAdding brands to your products can help improve site and product visibility on search engines.","slug":"brand-object","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","legacyExamples":[{"title":"Brand","content":"{\n \"brand\": {\n \"id\": \"35cfd6ff-2c0d-4e68-b881-2fc78942a3c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T11:46:29.372Z\",\n \"updatedDate\": \"2024-06-27T11:46:29.372Z\",\n \"name\": \"Adidas\",\n \"assignedProductsCount\": 0\n }\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"methods":[{"summary":"Create Brand","description":"Creates a brand.\n\nTo assign the brand to a product, include the `brand.id` or `brand.name`\nwhen [creating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) or\n[updating](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) a product.","operationId":"com.wix.stores.catalog.brand.v3.BrandService.CreateBrand","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.CreateBrandResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/brands","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/brands","destinationPath":"/v3/brands","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateBrandRequest","description":"","properties":{"brand":{"description":"Brand to create.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","summary":"brand","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["brand","brand.name"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Brand Created","description":"Triggered when a brand is created.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.CreateBrandRequest","responseMessage":"com.wix.stores.catalog.brand.v3.CreateBrandResponse"},"legacyExamples":[{"name":"CreateBrand","type":"METHOD","content":{"title":"Create a Brand","description":"Create a brand with name.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/brands' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brand\": {\n \"name\": \"Saucony\"\n }\n }'","response":"{\n \"brand\": {\n \"id\": \"9b1eee8a-2171-455b-807f-1c1e6aa5553b\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T19:45:33.740Z\",\n \"updatedDate\": \"2024-06-27T19:45:33.740Z\",\n \"name\": \"Saucony\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/brands","rpcOnly":false,"triggeredEvents":[{"title":"Brand Created","description":"Triggered when a brand is created.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.CreateBrandRequest","responseMessage":"com.wix.stores.catalog.brand.v3.CreateBrandResponse"},"legacyExamples":[{"name":"CreateBrand","type":"METHOD","content":{"title":"Create a Brand","description":"Create a brand with name.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/brands' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brand\": {\n \"name\": \"Saucony\"\n }\n }'","response":"{\n \"brand\": {\n \"id\": \"9b1eee8a-2171-455b-807f-1c1e6aa5553b\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T19:45:33.740Z\",\n \"updatedDate\": \"2024-06-27T19:45:33.740Z\",\n \"name\": \"Saucony\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Create Brand","slugifiedName":"create-brand"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Brand write in v3 catalog","scopeId":"SCOPE.STORES.BRAND_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Get Brand","description":"Retrieves a brand.","operationId":"com.wix.stores.catalog.brand.v3.BrandService.GetBrand","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"brandId","description":"Brand 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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.GetBrandResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/brands","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/brands","destinationPath":"/v3/brands","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.GetBrandRequest","responseMessage":"com.wix.stores.catalog.brand.v3.GetBrandResponse"},"legacyExamples":[{"name":"GetBrand","type":"METHOD","content":{"title":"Get brand by ID","description":"Brand fields should include the amount of products using this brand.","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/brands/9b1eee8a-2171-455b-807f-1c1e6aa5553b?fields=ASSIGNED_PRODUCTS_COUNT' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\","response":"{\n \"brand\": {\n \"id\": \"9b1eee8a-2171-455b-807f-1c1e6aa5553b\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T19:45:33.740Z\",\n \"updatedDate\": \"2024-06-27T19:52:47.620Z\",\n \"name\": \"Saucony\",\n \"assignedProductsCount\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"get","path":"/v3/brands/{brandId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.GetBrandRequest","responseMessage":"com.wix.stores.catalog.brand.v3.GetBrandResponse"},"legacyExamples":[{"name":"GetBrand","type":"METHOD","content":{"title":"Get brand by ID","description":"Brand fields should include the amount of products using this brand.","request":"curl -X GET \\\n 'https://www.wixapis.com/stores/v3/brands/9b1eee8a-2171-455b-807f-1c1e6aa5553b?fields=ASSIGNED_PRODUCTS_COUNT' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\","response":"{\n \"brand\": {\n \"id\": \"9b1eee8a-2171-455b-807f-1c1e6aa5553b\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T19:45:33.740Z\",\n \"updatedDate\": \"2024-06-27T19:52:47.620Z\",\n \"name\": \"Saucony\",\n \"assignedProductsCount\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Brand","slugifiedName":"get-brand"},"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 brands in catalog v3","scopeId":"SCOPE.STORES.BRAND_READ"},{"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"}]},{"summary":"Delete Brand","description":"Deletes a brand.\n\n> **Note:** Deleting a brand will also remove it from all products it is assigned to.","operationId":"com.wix.stores.catalog.brand.v3.BrandService.DeleteBrand","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"brandId","description":"Brand ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.DeleteBrandResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/brands","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/brands","destinationPath":"/v3/brands","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Brand Deleted","description":"Triggered when a brand is deleted.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.DeleteBrandRequest","responseMessage":"com.wix.stores.catalog.brand.v3.DeleteBrandResponse"},"legacyExamples":[{"name":"DeleteBrand","type":"METHOD","content":{"title":"Delete Brand","description":"Delete brand by ID.","request":"curl -X DELETE \\\n 'https://www.wixapis.com/stores/v3/brands/9b1eee8a-2171-455b-807f-1c1e6aa5553b' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"delete","path":"/v3/brands/{brandId}","rpcOnly":false,"triggeredEvents":[{"title":"Brand Deleted","description":"Triggered when a brand is deleted.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.DeleteBrandRequest","responseMessage":"com.wix.stores.catalog.brand.v3.DeleteBrandResponse"},"legacyExamples":[{"name":"DeleteBrand","type":"METHOD","content":{"title":"Delete Brand","description":"Delete brand by ID.","request":"curl -X DELETE \\\n 'https://www.wixapis.com/stores/v3/brands/9b1eee8a-2171-455b-807f-1c1e6aa5553b' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Delete Brand","slugifiedName":"delete-brand"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Brand write in v3 catalog","scopeId":"SCOPE.STORES.BRAND_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Update Brand","description":"Updates a brand.\n\nEach time the brand is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating the brand.\nThis ensures you're working with the latest brand and prevents unintended overwrites.","operationId":"com.wix.stores.catalog.brand.v3.BrandService.UpdateBrand","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"brand.id","description":"Brand ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.UpdateBrandResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/brands","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/brands","destinationPath":"/v3/brands","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateBrandRequest","description":"","properties":{"brand":{"description":"Brand to update.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","summary":"brand","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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["brand","brand.id","brand.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Brand Updated","description":"Triggered when a brand is updated.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.UpdateBrandRequest","responseMessage":"com.wix.stores.catalog.brand.v3.UpdateBrandResponse"},"legacyExamples":[{"name":"UpdateBrand","type":"METHOD","content":{"title":"Update a Brand","description":"Update a brand's name, by ID and revision.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/brands/6a325aee-6c03-4934-a325-426b2a97ac52' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brand\": {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"revision\": \"1\",\n \"name\": \"Nike Air\"\n }\n }'","response":"{\n \"brand\": {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-27T10:09:35.986Z\",\n \"updatedDate\": \"2024-06-30T11:12:24.936Z\",\n \"name\": \"Nike Air\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"patch","path":"/v3/brands/{brand.id}","rpcOnly":false,"triggeredEvents":[{"title":"Brand Updated","description":"Triggered when a brand is updated.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.UpdateBrandRequest","responseMessage":"com.wix.stores.catalog.brand.v3.UpdateBrandResponse"},"legacyExamples":[{"name":"UpdateBrand","type":"METHOD","content":{"title":"Update a Brand","description":"Update a brand's name, by ID and revision.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/brands/6a325aee-6c03-4934-a325-426b2a97ac52' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brand\": {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"revision\": \"1\",\n \"name\": \"Nike Air\"\n }\n }'","response":"{\n \"brand\": {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-27T10:09:35.986Z\",\n \"updatedDate\": \"2024-06-30T11:12:24.936Z\",\n \"name\": \"Nike Air\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Update Brand","slugifiedName":"update-brand"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Brand write in v3 catalog","scopeId":"SCOPE.STORES.BRAND_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Query Brands","description":"Retrieves a list of up to 100 brands, 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 [Brands: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/brands-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":"com.wix.stores.catalog.brand.v3.BrandService.QueryBrands","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.QueryBrandsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/brands","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/brands","destinationPath":"/v3/brands","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryBrandsRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.QueryBrandsRequest","responseMessage":"com.wix.stores.catalog.brand.v3.QueryBrandsResponse"},"legacyExamples":[{"name":"QueryBrands","type":"METHOD","content":{"title":"Query brands by Created Date","description":"Get brands that were created after a specific date.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/brands/query' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"filter\": {\n \"createdDate\": {\n \"$gte\": \"2024-06-20T00:00:00.000Z\"\n }\n }\n }\n }'","response":"{\n \"brands\": [\n {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T10:09:35.986Z\",\n \"updatedDate\": \"2024-06-27T10:09:35.986Z\",\n \"name\": \"Nike\"\n },\n {\n \"id\": \"35cfd6ff-2c0d-4e68-b881-2fc78942a3c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T11:46:29.372Z\",\n \"updatedDate\": \"2024-06-27T11:57:23.510Z\",\n \"name\": \"Adidas\",\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/brands/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_READ"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.QueryBrandsRequest","responseMessage":"com.wix.stores.catalog.brand.v3.QueryBrandsResponse"},"legacyExamples":[{"name":"QueryBrands","type":"METHOD","content":{"title":"Query brands by Created Date","description":"Get brands that were created after a specific date.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/brands/query' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"query\": {\n \"filter\": {\n \"createdDate\": {\n \"$gte\": \"2024-06-20T00:00:00.000Z\"\n }\n }\n }\n }'","response":"{\n \"brands\": [\n {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T10:09:35.986Z\",\n \"updatedDate\": \"2024-06-27T10:09:35.986Z\",\n \"name\": \"Nike\"\n },\n {\n \"id\": \"35cfd6ff-2c0d-4e68-b881-2fc78942a3c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T11:46:29.372Z\",\n \"updatedDate\": \"2024-06-27T11:57:23.510Z\",\n \"name\": \"Adidas\",\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"cursors\": {},\n \"hasNext\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Query Brands","slugifiedName":"query-brands"},"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 brands in catalog v3","scopeId":"SCOPE.STORES.BRAND_READ"},{"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"}]},{"summary":"Bulk Create Brands","description":"Creates multiple brands.","operationId":"com.wix.stores.catalog.brand.v3.BrandService.BulkCreateBrands","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.BulkCreateBrandsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/brands","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/brands","destinationPath":"/v3/bulk/brands","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkCreateBrandsRequest","description":"","properties":{"brands":{"description":"Brands to create.","minItems":1,"maxItems":100,"title":"brands","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full created brand entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["brands","brands.name"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Brand Created","description":"Triggered when a brand is created.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.BulkCreateBrandsRequest","responseMessage":"com.wix.stores.catalog.brand.v3.BulkCreateBrandsResponse"},"legacyExamples":[{"name":"BulkCreateBrands","type":"METHOD","content":{"title":"Create multiple Brands","description":"Request to create 4 brands. 3 of them are created successfully and 1 fails due to a unique constraint violation.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/brands/create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brands\": [\n {\n \"name\": \"ASICS\"\n },\n {\n \"name\": \"Altra\"\n },\n {\n \"name\": \"Altra\"\n },\n {\n \"name\": \"New Balance\"\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"f436b313-8437-4b91-a650-dc3944273781\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"f436b313-8437-4b91-a650-dc3944273781\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-30T09:15:50.684Z\",\n \"updatedDate\": \"2024-06-30T09:15:50.684Z\",\n \"name\": \"ASICS\"\n }\n },\n {\n \"itemMetadata\": {\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"ALREADY_EXISTS\",\n \"description\": \"Unique constraint violation\",\n \"data\": {\n \"uniqueConstraintViolation\": {\n \"fieldPaths\": [\n {\n \"paths\": [\n \"name\"\n ]\n }\n ]\n }\n }\n }\n },\n \"item\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"createdDate\": \"1970-01-01T00:00:00Z\",\n \"updatedDate\": \"1970-01-01T00:00:00Z\",\n \"name\": \"Altra\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"46d027d6-c157-4ef9-8a94-c5ef65f372e1\",\n \"originalIndex\": 2,\n \"success\": true\n },\n \"item\": {\n \"id\": \"46d027d6-c157-4ef9-8a94-c5ef65f372e1\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-30T09:15:50.684Z\",\n \"updatedDate\": \"2024-06-30T09:15:50.684Z\",\n \"name\": \"Altra\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"bea34149-958b-4a2b-ae29-cf69aca29106\",\n \"originalIndex\": 3,\n \"success\": true\n },\n \"item\": {\n \"id\": \"bea34149-958b-4a2b-ae29-cf69aca29106\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-30T09:15:50.684Z\",\n \"updatedDate\": \"2024-06-30T09:15:50.684Z\",\n \"name\": \"New Balance\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 3,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/brands/create","rpcOnly":false,"triggeredEvents":[{"title":"Brand Created","description":"Triggered when a brand is created.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.BulkCreateBrandsRequest","responseMessage":"com.wix.stores.catalog.brand.v3.BulkCreateBrandsResponse"},"legacyExamples":[{"name":"BulkCreateBrands","type":"METHOD","content":{"title":"Create multiple Brands","description":"Request to create 4 brands. 3 of them are created successfully and 1 fails due to a unique constraint violation.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/brands/create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brands\": [\n {\n \"name\": \"ASICS\"\n },\n {\n \"name\": \"Altra\"\n },\n {\n \"name\": \"Altra\"\n },\n {\n \"name\": \"New Balance\"\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"f436b313-8437-4b91-a650-dc3944273781\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"f436b313-8437-4b91-a650-dc3944273781\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-30T09:15:50.684Z\",\n \"updatedDate\": \"2024-06-30T09:15:50.684Z\",\n \"name\": \"ASICS\"\n }\n },\n {\n \"itemMetadata\": {\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"ALREADY_EXISTS\",\n \"description\": \"Unique constraint violation\",\n \"data\": {\n \"uniqueConstraintViolation\": {\n \"fieldPaths\": [\n {\n \"paths\": [\n \"name\"\n ]\n }\n ]\n }\n }\n }\n },\n \"item\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"createdDate\": \"1970-01-01T00:00:00Z\",\n \"updatedDate\": \"1970-01-01T00:00:00Z\",\n \"name\": \"Altra\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"46d027d6-c157-4ef9-8a94-c5ef65f372e1\",\n \"originalIndex\": 2,\n \"success\": true\n },\n \"item\": {\n \"id\": \"46d027d6-c157-4ef9-8a94-c5ef65f372e1\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-30T09:15:50.684Z\",\n \"updatedDate\": \"2024-06-30T09:15:50.684Z\",\n \"name\": \"Altra\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"bea34149-958b-4a2b-ae29-cf69aca29106\",\n \"originalIndex\": 3,\n \"success\": true\n },\n \"item\": {\n \"id\": \"bea34149-958b-4a2b-ae29-cf69aca29106\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-30T09:15:50.684Z\",\n \"updatedDate\": \"2024-06-30T09:15:50.684Z\",\n \"name\": \"New Balance\"\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 3,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Create Brands","slugifiedName":"bulk-create-brands"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Brand write in v3 catalog","scopeId":"SCOPE.STORES.BRAND_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Update Brands","description":"Updates multiple brands.\n\nEach time a brand is updated, `revision` increments by 1.\nThe current `revision` must be passed when updating a brand.\nThis ensures you're working with the latest brand and prevents unintended overwrites.","operationId":"com.wix.stores.catalog.brand.v3.BrandService.BulkUpdateBrands","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.BulkUpdateBrandsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/brands","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/brands","destinationPath":"/v3/bulk/brands","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateBrandsRequest","description":"","properties":{"brands":{"description":"List of brands to update.","minItems":1,"maxItems":100,"title":"brands","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.MaskedBrand"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full updated brand 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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["brands","brands.brand.id","brands.brand.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Brand Updated","description":"Triggered when a brand is updated.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.BulkUpdateBrandsRequest","responseMessage":"com.wix.stores.catalog.brand.v3.BulkUpdateBrandsResponse"},"legacyExamples":[{"name":"BulkUpdateBrands","type":"METHOD","content":{"title":"Update multiple Brands","description":"Update 3 brand names, by ID and revision. The results include the updated entities, due to `returnEntity: true` requested. The 1st and 3rd are successfully updated, the 2nd fails due to outdated revision. The results are not necessarily returned in the original order but the `itemMetadata.originalIndex` notes which requested entity it is.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/brands/update' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brands\": [\n {\n \"brand\": {\n \"id\": \"f436b313-8437-4b91-a650-dc394427378\",\n \"revision\": \"1\",\n \"name\": \"Asics\"\n }\n },\n {\n \"brand\": {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"revision\": \"1\",\n \"name\": \"Nike Air Jordan\"\n }\n },\n {\n \"brand\": {\n \"id\": \"bea34149-958b-4a2b-ae29-cf69aca29106\",\n \"revision\": \"1\",\n \"name\": \"NB\"\n }\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"f436b313-8437-4b91-a650-dc394427378\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"f436b313-8437-4b91-a650-dc394427378\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-30T09:15:50.684Z\",\n \"updatedDate\": \"2024-07-01T09:57:04.124Z\",\n \"name\": \"Asics\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"bea34149-958b-4a2b-ae29-cf69aca29106\",\n \"originalIndex\": 2,\n \"success\": true\n },\n \"item\": {\n \"id\": \"bea34149-958b-4a2b-ae29-cf69aca29106\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-30T09:15:50.684Z\",\n \"updatedDate\": \"2024-07-01T09:57:04.131Z\",\n \"name\": \"NB\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"INVALID_REVISION\",\n \"description\": \"Outdated revision for entity id\",\n \"data\": {\n \"revisionViolation\": {\n \"entityId\": \"6a325aee-6c03-4934-a325-426b2a97ac52\"\n }\n }\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/brands/update","rpcOnly":false,"triggeredEvents":[{"title":"Brand Updated","description":"Triggered when a brand is updated.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_updated","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_UPDATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.BulkUpdateBrandsRequest","responseMessage":"com.wix.stores.catalog.brand.v3.BulkUpdateBrandsResponse"},"legacyExamples":[{"name":"BulkUpdateBrands","type":"METHOD","content":{"title":"Update multiple Brands","description":"Update 3 brand names, by ID and revision. The results include the updated entities, due to `returnEntity: true` requested. The 1st and 3rd are successfully updated, the 2nd fails due to outdated revision. The results are not necessarily returned in the original order but the `itemMetadata.originalIndex` notes which requested entity it is.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/brands/update' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brands\": [\n {\n \"brand\": {\n \"id\": \"f436b313-8437-4b91-a650-dc394427378\",\n \"revision\": \"1\",\n \"name\": \"Asics\"\n }\n },\n {\n \"brand\": {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"revision\": \"1\",\n \"name\": \"Nike Air Jordan\"\n }\n },\n {\n \"brand\": {\n \"id\": \"bea34149-958b-4a2b-ae29-cf69aca29106\",\n \"revision\": \"1\",\n \"name\": \"NB\"\n }\n }\n ],\n \"returnEntity\": true\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"f436b313-8437-4b91-a650-dc394427378\",\n \"originalIndex\": 0,\n \"success\": true\n },\n \"item\": {\n \"id\": \"f436b313-8437-4b91-a650-dc394427378\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-30T09:15:50.684Z\",\n \"updatedDate\": \"2024-07-01T09:57:04.124Z\",\n \"name\": \"Asics\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"bea34149-958b-4a2b-ae29-cf69aca29106\",\n \"originalIndex\": 2,\n \"success\": true\n },\n \"item\": {\n \"id\": \"bea34149-958b-4a2b-ae29-cf69aca29106\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-06-30T09:15:50.684Z\",\n \"updatedDate\": \"2024-07-01T09:57:04.131Z\",\n \"name\": \"NB\"\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"originalIndex\": 1,\n \"success\": false,\n \"error\": {\n \"code\": \"INVALID_REVISION\",\n \"description\": \"Outdated revision for entity id\",\n \"data\": {\n \"revisionViolation\": {\n \"entityId\": \"6a325aee-6c03-4934-a325-426b2a97ac52\"\n }\n }\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 2,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Update Brands","slugifiedName":"bulk-update-brands"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Brand write in v3 catalog","scopeId":"SCOPE.STORES.BRAND_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Get Or Create Brand","description":"Retrieves a brand by name, or creates a brand if one with the passed `brandName` doesn't exist.","operationId":"com.wix.stores.catalog.brand.v3.BrandService.GetOrCreateBrand","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.GetOrCreateBrandResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/brands","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/brands","destinationPath":"/v3/brands","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"GetOrCreateBrandRequest","description":"","properties":{"brandName":{"description":"Brand name to retrieve or create.","minLength":1,"maxLength":50,"title":"brandName","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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["brandName"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Brand Created","description":"Triggered when a brand is created.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_GET_OR_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.GetOrCreateBrandRequest","responseMessage":"com.wix.stores.catalog.brand.v3.GetOrCreateBrandResponse"},"legacyExamples":[{"name":"GetOrCreateBrand","type":"METHOD","content":{"title":"Get or Create a brand","description":"Get an existing brand using GetOrCreate method. Response should also include the amount of products using this brand.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/brands/get-or-create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brandName\": \"Adidas\"\n \"fields\": [\n \"ASSIGNED_PRODUCTS_COUNT\"\n ]\n }'","response":"{\n \"brand\": {\n \"id\": \"35cfd6ff-2c0d-4e68-b881-2fc78942a3c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T11:46:29.372Z\",\n \"updatedDate\": \"2024-06-27T11:57:23.510Z\",\n \"name\": \"Adidas\",\n \"assignedProductsCount\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/brands/get-or-create","rpcOnly":false,"triggeredEvents":[{"title":"Brand Created","description":"Triggered when a brand is created.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_GET_OR_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.GetOrCreateBrandRequest","responseMessage":"com.wix.stores.catalog.brand.v3.GetOrCreateBrandResponse"},"legacyExamples":[{"name":"GetOrCreateBrand","type":"METHOD","content":{"title":"Get or Create a brand","description":"Get an existing brand using GetOrCreate method. Response should also include the amount of products using this brand.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/brands/get-or-create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brandName\": \"Adidas\"\n \"fields\": [\n \"ASSIGNED_PRODUCTS_COUNT\"\n ]\n }'","response":"{\n \"brand\": {\n \"id\": \"35cfd6ff-2c0d-4e68-b881-2fc78942a3c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T11:46:29.372Z\",\n \"updatedDate\": \"2024-06-27T11:57:23.510Z\",\n \"name\": \"Adidas\",\n \"assignedProductsCount\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Get Or Create Brand","slugifiedName":"get-or-create-brand"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Brand write in v3 catalog","scopeId":"SCOPE.STORES.BRAND_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Get Or Create Brands","description":"Retrieves multiple brands by name, or creates multiple brands if those with the passed `ribbonNames` don't exist.","operationId":"com.wix.stores.catalog.brand.v3.BrandService.BulkGetOrCreateBrands","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.BulkGetOrCreateBrandsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/brands","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/brands","destinationPath":"/v3/bulk/brands","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkGetOrCreateBrandsRequest","description":"","properties":{"brandNames":{"description":"Brand names to retrieve or create.","minLength":1,"maxLength":50,"minItems":1,"maxItems":100,"title":"brandNames","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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["brandNames"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Brand Created","description":"Triggered when a brand is created.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_GET_OR_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.BulkGetOrCreateBrandsRequest","responseMessage":"com.wix.stores.catalog.brand.v3.BulkGetOrCreateBrandsResponse"},"legacyExamples":[{"name":"BulkGetOrCreateBrands","type":"METHOD","content":{"title":"Get or Create multiple brands","description":"Retrieve an existing brand \"Adidas\" and create a new brand \"Reef\" using BulkGetOrCreate method.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/brands/get-or-create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brandNames\": [\n \"Adidas\",\n \"Reef\"\n ],\n \"fields\": [\n \"ASSIGNED_PRODUCTS_COUNT\"\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"35cfd6ff-2c0d-4e68-b881-2fc78942a3c4\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"35cfd6ff-2c0d-4e68-b881-2fc78942a3c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T11:46:29.372Z\",\n \"updatedDate\": \"2024-06-27T11:57:23.510Z\",\n \"name\": \"Adidas\",\n \"assignedProductsCount\": 2\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"afa50d66-b001-4904-be2a-9f8fc562533d\",\n \"originalIndex\": 1,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"afa50d66-b001-4904-be2a-9f8fc562533d\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-01T10:13:17.229Z\",\n \"updatedDate\": \"2024-07-01T10:13:17.229Z\",\n \"name\": \"Reef\",\n \"assignedProductsCount\": 0\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/brands/get-or-create","rpcOnly":false,"triggeredEvents":[{"title":"Brand Created","description":"Triggered when a brand is created.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_created","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_GET_OR_CREATE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.BulkGetOrCreateBrandsRequest","responseMessage":"com.wix.stores.catalog.brand.v3.BulkGetOrCreateBrandsResponse"},"legacyExamples":[{"name":"BulkGetOrCreateBrands","type":"METHOD","content":{"title":"Get or Create multiple brands","description":"Retrieve an existing brand \"Adidas\" and create a new brand \"Reef\" using BulkGetOrCreate method.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/brands/get-or-create' \\\n -H 'Content-type: application/json' \\\n -H 'Authorization: ' \\\n -d '{\n \"brandNames\": [\n \"Adidas\",\n \"Reef\"\n ],\n \"fields\": [\n \"ASSIGNED_PRODUCTS_COUNT\"\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"35cfd6ff-2c0d-4e68-b881-2fc78942a3c4\",\n \"originalIndex\": 0,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"35cfd6ff-2c0d-4e68-b881-2fc78942a3c4\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-06-27T11:46:29.372Z\",\n \"updatedDate\": \"2024-06-27T11:57:23.510Z\",\n \"name\": \"Adidas\",\n \"assignedProductsCount\": 2\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"afa50d66-b001-4904-be2a-9f8fc562533d\",\n \"originalIndex\": 1,\n \"success\": true,\n \"error\": null\n },\n \"item\": {\n \"id\": \"afa50d66-b001-4904-be2a-9f8fc562533d\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-01T10:13:17.229Z\",\n \"updatedDate\": \"2024-07-01T10:13:17.229Z\",\n \"name\": \"Reef\",\n \"assignedProductsCount\": 0\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 Brands","slugifiedName":"bulk-get-or-create-brands"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Brand write in v3 catalog","scopeId":"SCOPE.STORES.BRAND_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]},{"summary":"Bulk Delete Brands","description":"Deletes multiple brands.","operationId":"com.wix.stores.catalog.brand.v3.BrandService.BulkDeleteBrands","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.BulkDeleteBrandsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/stores/v3/bulk/brands","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/stores/v3/bulk/brands","destinationPath":"/v3/bulk/brands","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkDeleteBrandsRequest","description":"","properties":{"brandIds":{"description":"IDs of brands to delete.","format":"GUID","minItems":1,"maxItems":100,"title":"brandIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["brandIds"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Brand Deleted","description":"Triggered when a brand is deleted.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.BulkDeleteBrandsRequest","responseMessage":"com.wix.stores.catalog.brand.v3.BulkDeleteBrandsResponse"},"legacyExamples":[{"name":"BulkDeleteBrands","type":"METHOD","content":{"title":"Delete multiple Brands","description":"Delete 2 brands by ID. One of them exists and the other does not.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/brands/delete' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"brandIds\": [\n \"6b6ef077-ccd9-4e7f-b70a-51d1b6703b95\",\n \"4846bad2-883e-4a4d-aad8-98609cd97dbf\"\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"6b6ef077-ccd9-4e7f-b70a-51d1b6703b95\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"4846bad2-883e-4a4d-aad8-98609cd97dbf\",\n \"originalIndex\": 0,\n \"success\": false,\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"description\": \"Entity not found\",\n \"data\": {\n \"notFound\": {\n \"entityId\": \"4846bad2-883e-4a4d-aad8-98609cd97dbf\"\n }\n }\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git"},"httpMethod":"post","path":"/v3/bulk/brands/delete","rpcOnly":false,"triggeredEvents":[{"title":"Brand Deleted","description":"Triggered when a brand is deleted.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.stores.catalog.v3.brand_deleted","sourceRepo":"git@github.com:wix-private/ecom.git"}],"serviceName":"com.wix.stores.catalog.brand.v3.BrandService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["WIX_STORES.BRAND_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"}],"protoArtifactId":"com.wixpress.stores:brand","serviceArtifactId":"com.wixpress.stores.brand","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wix.stores.catalog.brand.v3.BulkDeleteBrandsRequest","responseMessage":"com.wix.stores.catalog.brand.v3.BulkDeleteBrandsResponse"},"legacyExamples":[{"name":"BulkDeleteBrands","type":"METHOD","content":{"title":"Delete multiple Brands","description":"Delete 2 brands by ID. One of them exists and the other does not.","request":"curl -X POST \\\n 'https://www.wixapis.com/stores/v3/bulk/brands/delete' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"brandIds\": [\n \"6b6ef077-ccd9-4e7f-b70a-51d1b6703b95\",\n \"4846bad2-883e-4a4d-aad8-98609cd97dbf\"\n ]\n }'","response":"{\n \"results\": [\n {\n \"itemMetadata\": {\n \"id\": \"6b6ef077-ccd9-4e7f-b70a-51d1b6703b95\",\n \"originalIndex\": 1,\n \"success\": true\n }\n },\n {\n \"itemMetadata\": {\n \"id\": \"4846bad2-883e-4a4d-aad8-98609cd97dbf\",\n \"originalIndex\": 0,\n \"success\": false,\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"description\": \"Entity not found\",\n \"data\": {\n \"notFound\": {\n \"entityId\": \"4846bad2-883e-4a4d-aad8-98609cd97dbf\"\n }\n }\n }\n }\n }\n ],\n \"bulkActionMetadata\": {\n \"totalSuccesses\": 1,\n \"totalFailures\": 1,\n \"undetailedFailures\": 0\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/ecom.git","contentLink":{"displayName":"Bulk Delete Brands","slugifiedName":"bulk-delete-brands"},"permissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Brand write in v3 catalog","scopeId":"SCOPE.STORES.BRAND_WRITE"},{"name":"Manage v3 catalog","scopeId":"SCOPE.STORES.CATALOG_WRITE"},{"name":"Product write in v3 catalog","scopeId":"SCOPE.STORES.PRODUCT_WRITE"}]}],"webhooks":[{"summary":"Brand Created","title":"Brand Created","description":"Triggered when a brand is created.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.stores.catalog.v3.brand_created","legacyExamples":[{"name":"BrandCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"8678d9a4-e61b-484e-94b2-5b092a39217f\",\n \"entityFqdn\": \"wix.stores.catalog.v3.brand\",\n \"slug\": \"created\",\n \"entityId\": \"37522df6-f7c5-42ec-83d1-5e59c40843ca\",\n \"createdEvent\": {\n \"entityAsJson\": {\n \"id\": \"37522df6-f7c5-42ec-83d1-5e59c40843ca\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-07-01T11:56:52.212Z\",\n \"updatedDate\": \"2024-07-01T11:56:52.212Z\",\n \"name\": \"Under Armor\"\n }\n },\n \"eventTime\": \"2024-07-01T11:56:52.325058005Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","contentLink":{"displayName":"Brand Created","slugifiedName":"brand-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 brands in catalog v3","scopeId":"SCOPE.STORES.BRAND_READ"},{"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"}]},{"summary":"Brand Updated","title":"Brand Updated","description":"Triggered when a brand is updated.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.stores.catalog.v3.brand_updated","legacyExamples":[{"name":"BrandUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"a22f47ff-3549-43e6-973e-302b37da3b26\",\n \"entityFqdn\": \"wix.stores.catalog.v3.brand\",\n \"slug\": \"updated\",\n \"entityId\": \"37522df6-f7c5-42ec-83d1-5e59c40843ca\",\n \"updatedEvent\": {\n \"currentEntityAsJson\": {\n \"id\": \"37522df6-f7c5-42ec-83d1-5e59c40843ca\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-07-01T11:56:52.212Z\",\n \"updatedDate\": \"2024-07-01T12:03:59.698Z\",\n \"name\": \"Under Armour\"\n }\n },\n \"eventTime\": \"2024-07-01T12:03:59.844203454Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"2\"\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","contentLink":{"displayName":"Brand Updated","slugifiedName":"brand-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 brands in catalog v3","scopeId":"SCOPE.STORES.BRAND_READ"},{"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"}]},{"summary":"Brand Deleted","title":"Brand Deleted","description":"Triggered when a brand is deleted.","permissions":["WIX_STORES.BRAND_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.stores.catalog.v3.brand","serviceName":"com.wix.stores.catalog.brand.v3.BrandService","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Stores - all permissions","scopeId":"SCOPE.DC-STORES-MEGA.MANAGE-STORES"},{"name":"Manage Products","scopeId":"SCOPE.DC-STORES.MANAGE-PRODUCTS"},{"name":"Read Stores - all read permissions","scopeId":"SCOPE.DC-STORES-MEGA.READ-STORES"},{"name":"Read Products","scopeId":"SCOPE.DC-STORES.READ-PRODUCTS"},{"name":"Manage Orders","scopeId":"SCOPE.DC-STORES.MANAGE-ORDERS"}],"eventType":"wix.stores.catalog.v3.brand_deleted","legacyExamples":[{"name":"BrandDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"567688d4-175a-48b2-8b9b-49064536437f\",\n \"entityFqdn\": \"wix.stores.catalog.v3.brand\",\n \"slug\": \"deleted\",\n \"entityId\": \"37522df6-f7c5-42ec-83d1-5e59c40843ca\",\n \"deletedEvent\": {\n \"movedToTrash\": true\n },\n \"eventTime\": \"2024-07-01T12:12:30.229132303Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"15\"\n}"}],"sourceRepo":"git@github.com:wix-private/ecom.git","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","contentLink":{"displayName":"Brand Deleted","slugifiedName":"brand-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 brands in catalog v3","scopeId":"SCOPE.STORES.BRAND_READ"},{"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"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Wix Brand API\n\nThe Wix Stores Brand API allows you to create and manage brands that can be assigned to products using the Products API. \n\nThis API provides all the necessary functionality to manage a bank of brands, which can be applied to products to ensure a consistent brand experience across your store. \n\nThis integration enhances product visibility and customer engagement, making it easier for customers to find products based on their brand preferences.\n\n\nWith the Wix Brand API, your app can:\n- Create and manage a bank of brands.\n- Retrieve information about existing brands.\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n* The site owner must have the Wix Stores app installed.\n* Your app has the necessary permissions to access the Brand API.\n\n## Sample flows\n* [Create a product with a new brand](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/brands-v3/sample-use-cases-and-flows)\n* [Assign existing brand to a product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/brands-v3/sample-use-cases-and-flows)"},{"displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows","content":"# Sample Use Cases and Flows\n\nThis article shares some potential use cases for your app and provides sample flows for creating, managing, and assigning brands to products effectively.\nThis can be a helpful jumping off point as you plan your app's implementation.\n\n## Create a product with a new brand\n\nIn order to assign a new non-existing brand to new product, you can provide a brand name to Create Product request.\n\nTo do this, your app can create a product with [Create Product](fallback::./product-v3/create-product)\n and assign the brand to the product by passing a new `brand.name` :\n```json\n{\n \"product\": {\n \"name\": \"Running Shoes\",\n \"brand\": {\n \"name\": \"Adidas\"\n },\n \"productType\": \"PHYSICAL\",\n \"physical_properties\": {},\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"basePrice\": {\n \"amount\": \"100\"\n }\n }\n }\n ] \n }\n }\n}\n```\n> Note that if a brand with `brand.name` already exists, it will assign the existing brand to the product.\n\n## Assign existing brand to a product\n\nIn order to assign an existing brand to a product, you need to assign it on Update Product Request.\n\nTo do this, your app can follow these steps:\n\n1. Select an existing brand from the bank to be assigned to the product.\n\n2. Update a product with [Update Product](fallback::./product-v3/update-product)\n and assign the brand to the product by passing `brand.id` or `brand.name`:\n```json\n{\n \"product\": {\n \"name\": \"Running Shoes\",\n \"revision\": \"1\",\n \"brand\": {\n \"id\": \"b64c0262-ecce-4d01-a98d-fc45004a3d93\"\n }\n }\n}\n```\n> Note that a brand can be assigned to a product either by passing `brand.name` or by passing `brand.id`.\n\n## Edit Brand\n\nIn order to edit an existing brand, you need to edit it with Update Brand Request.\n\nTo do this, your app can follow these steps:\n\n1. Select an existing brand from the bank to be updated.\n\n2. Use the Id of the selected brand to update the name by calling [Update Brand](fallback::./brands-v3/update-a-brand)\n with `brand.id` and the new name:\n```json\n{\n \"brand\": {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"revision\": \"1\",\n \"name\": \"Nike Air\"\n }\n}\n```\n\n## Delete multiple Brands\n\nIn order to delete an existing brands, you need to delete it with Bulk Delete Request.\n\nTo do this, your app can follow these steps:\n\n1. Select the IDs of existing brands from the bank to be deleted.\n\n2. Delete brands with [Bulk Delete Brands](fallback::./brands-v3/delete-multiple-Brands)\n with list of the brands IDs:\n```json\n{\n \"brandIds\": [\n \"6b6ef077-ccd9-4e7f-b70a-51d1b6703b95\",\n \"4846bad2-883e-4a4d-aad8-98609cd97dbf\"\n ]\n}\n```\n\n"}],"components":{"schemas":{"com.wix.stores.catalog.brand.v3.Brand":{"type":"object","properties":{"id":{"description":"Brand 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 brand is updated.\nTo prevent conflicting changes,\nthe current revision must be passed when updating the brand.\n\nIgnored when creating a brand.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the brand was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the brand was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Brand name.\n>**Note:** `name` must be unique.","minLength":1,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assignedProductsCount":{"description":"Number of products this brand is assigned to.\n> **Note:** Returned only when you pass `\"ASSIGNED_PRODUCTS_COUNT\"` to the `fields` array in Brand API requests.","readOnly":true,"title":"assignedProductsCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Brand","description":"A brand is a visible property of a product.\nAdding brands to your products can help improve site and product visibility on search engines."},"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":""},"com.wix.stores.catalog.brand.v3.CreateBrandRequest":{"type":"object","properties":{"brand":{"description":"Brand to create.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","summary":"brand","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateBrandRequest","description":""},"com.wix.stores.catalog.brand.v3.CreateBrandResponse":{"type":"object","properties":{"brand":{"description":"Created brand.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","summary":"brand","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateBrandResponse","description":""},"com.wix.stores.catalog.brand.v3.GetBrandRequest":{"type":"object","properties":{"brandId":{"description":"Brand ID.","format":"GUID","title":"brandId","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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetBrandRequest","description":""},"com.wix.stores.catalog.brand.v3.RequestedFields":{"type":"string","description":"","title":"RequestedFields","enum":["UNKNOWN_REQUESTED_FIELD","ASSIGNED_PRODUCTS_COUNT"]},"com.wix.stores.catalog.brand.v3.GetBrandResponse":{"type":"object","properties":{"brand":{"description":"Brand.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","summary":"brand","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetBrandResponse","description":""},"com.wix.stores.catalog.brand.v3.UpdateBrandRequest":{"type":"object","properties":{"brand":{"description":"Brand to update.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","summary":"brand","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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateBrandRequest","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":""},"com.wix.stores.catalog.brand.v3.UpdateBrandResponse":{"type":"object","properties":{"brand":{"description":"Updated brand.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","summary":"brand","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateBrandResponse","description":""},"com.wix.stores.catalog.brand.v3.DeleteBrandRequest":{"type":"object","properties":{"brandId":{"description":"Brand ID.","format":"GUID","title":"brandId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteBrandRequest","description":""},"com.wix.stores.catalog.brand.v3.DeleteBrandResponse":{"type":"object","properties":{},"title":"DeleteBrandResponse","description":""},"com.wix.stores.catalog.brand.v3.QueryBrandsRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryBrandsRequest","description":""},"com.wix.stores.catalog.brand.v3.upstream.wix.common.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":5,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.CursorQuery.pagingMethod"}]},"com.wix.stores.catalog.brand.v3.upstream.wix.common.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/com.wix.stores.catalog.brand.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":""},"com.wix.stores.catalog.brand.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/com.wix.stores.catalog.brand.v3.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"com.wix.stores.catalog.brand.v3.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wix.stores.catalog.brand.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":""},"com.wix.stores.catalog.brand.v3.QueryBrandsResponse":{"type":"object","properties":{"brands":{"description":"List of brands.","minItems":1,"maxItems":100,"title":"brands","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryBrandsResponse","description":""},"com.wix.stores.catalog.brand.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/com.wix.stores.catalog.brand.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":""},"com.wix.stores.catalog.brand.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":""},"com.wix.stores.catalog.brand.v3.BulkCreateBrandsRequest":{"type":"object","properties":{"brands":{"description":"Brands to create.","minItems":1,"maxItems":100,"title":"brands","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full created brand entities in the response.\n\nDefault: `false`","title":"returnEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateBrandsRequest","description":""},"com.wix.stores.catalog.brand.v3.BulkCreateBrandsResponse":{"type":"object","properties":{"results":{"description":"Brands created by bulk action.","maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.BulkBrandsResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateBrandsResponse","description":""},"com.wix.stores.catalog.brand.v3.BulkBrandsResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for brand.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Full brand entity.\n\nReturned only if `returnEntity: true` is passed in the request.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkBrandsResult","description":""},"com.wix.stores.catalog.brand.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":""},"com.wix.stores.catalog.brand.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":""},"com.wix.stores.catalog.brand.v3.BulkUpdateBrandsRequest":{"type":"object","properties":{"brands":{"description":"List of brands to update.","minItems":1,"maxItems":100,"title":"brands","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.MaskedBrand"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnEntity":{"description":"Whether to return the full updated brand 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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateBrandsRequest","description":""},"com.wix.stores.catalog.brand.v3.MaskedBrand":{"type":"object","properties":{"brand":{"description":"Brand to update.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","summary":"brand","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MaskedBrand","description":""},"com.wix.stores.catalog.brand.v3.BulkUpdateBrandsResponse":{"type":"object","properties":{"results":{"description":"Brands updated by bulk action.","maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.BulkBrandsResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateBrandsResponse","description":""},"com.wix.stores.catalog.brand.v3.GetOrCreateBrandRequest":{"type":"object","properties":{"brandName":{"description":"Brand name to retrieve or create.","minLength":1,"maxLength":50,"title":"brandName","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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetOrCreateBrandRequest","description":""},"com.wix.stores.catalog.brand.v3.GetOrCreateBrandResponse":{"type":"object","properties":{"brand":{"description":"Brand.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.Brand","summary":"brand","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetOrCreateBrandResponse","description":""},"com.wix.stores.catalog.brand.v3.BulkGetOrCreateBrandsRequest":{"type":"object","properties":{"brandNames":{"description":"Brand names to retrieve or create.","minLength":1,"maxLength":50,"minItems":1,"maxItems":100,"title":"brandNames","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/com.wix.stores.catalog.brand.v3.RequestedFields"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkGetOrCreateBrandsRequest","description":""},"com.wix.stores.catalog.brand.v3.BulkGetOrCreateBrandsResponse":{"type":"object","properties":{"results":{"description":"Brands retrieved or created by bulk action.","maxItems":100,"title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.BulkBrandsResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkGetOrCreateBrandsResponse","description":""},"com.wix.stores.catalog.brand.v3.BulkDeleteBrandsRequest":{"type":"object","properties":{"brandIds":{"description":"IDs of brands to delete.","format":"GUID","minItems":1,"maxItems":100,"title":"brandIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteBrandsRequest","description":""},"com.wix.stores.catalog.brand.v3.BulkDeleteBrandsResponse":{"type":"object","properties":{"results":{"description":"Brands deleted by bulk action.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.BulkDeleteBrandsResponse.BulkBrandsResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteBrandsResponse","description":""},"com.wix.stores.catalog.brand.v3.BulkDeleteBrandsResponse.BulkBrandsResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk action metadata for brand.","$ref":"#/components/schemas/com.wix.stores.catalog.brand.v3.upstream.wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkBrandsResult","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":"Brand","description":"A brand is a visible property of a product.\nAdding brands to your products can help improve site and product visibility on search engines.","fqdn":"wix.stores.catalog.v3.brand"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Wix Brand API\n\nThe Wix Stores Brand API allows you to create and manage brands that can be assigned to products using the Products API. \n\nThis API provides all the necessary functionality to manage a bank of brands, which can be applied to products to ensure a consistent brand experience across your store. \n\nThis integration enhances product visibility and customer engagement, making it easier for customers to find products based on their brand preferences.\n\n\nWith the Wix Brand API, your app can:\n- Create and manage a bank of brands.\n- Retrieve information about existing brands.\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n* The site owner must have the Wix Stores app installed.\n* Your app has the necessary permissions to access the Brand API.\n\n## Sample flows\n* [Create a product with a new brand](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/brands-v3/sample-use-cases-and-flows)\n* [Assign existing brand to a product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/brands-v3/sample-use-cases-and-flows)"},{"displayName":"Sample Use Cases and Flows","slugifyName":"sample-use-cases-and-flows","content":"# Sample Use Cases and Flows\n\nThis article shares some potential use cases for your app and provides sample flows for creating, managing, and assigning brands to products effectively.\nThis can be a helpful jumping off point as you plan your app's implementation.\n\n## Create a product with a new brand\n\nIn order to assign a new non-existing brand to new product, you can provide a brand name to Create Product request.\n\nTo do this, your app can create a product with [Create Product](fallback::./product-v3/create-product)\n and assign the brand to the product by passing a new `brand.name` :\n```json\n{\n \"product\": {\n \"name\": \"Running Shoes\",\n \"brand\": {\n \"name\": \"Adidas\"\n },\n \"productType\": \"PHYSICAL\",\n \"physical_properties\": {},\n \"variantsInfo\": {\n \"variants\": [\n {\n \"price\": {\n \"basePrice\": {\n \"amount\": \"100\"\n }\n }\n }\n ] \n }\n }\n}\n```\n> Note that if a brand with `brand.name` already exists, it will assign the existing brand to the product.\n\n## Assign existing brand to a product\n\nIn order to assign an existing brand to a product, you need to assign it on Update Product Request.\n\nTo do this, your app can follow these steps:\n\n1. Select an existing brand from the bank to be assigned to the product.\n\n2. Update a product with [Update Product](fallback::./product-v3/update-product)\n and assign the brand to the product by passing `brand.id` or `brand.name`:\n```json\n{\n \"product\": {\n \"name\": \"Running Shoes\",\n \"revision\": \"1\",\n \"brand\": {\n \"id\": \"b64c0262-ecce-4d01-a98d-fc45004a3d93\"\n }\n }\n}\n```\n> Note that a brand can be assigned to a product either by passing `brand.name` or by passing `brand.id`.\n\n## Edit Brand\n\nIn order to edit an existing brand, you need to edit it with Update Brand Request.\n\nTo do this, your app can follow these steps:\n\n1. Select an existing brand from the bank to be updated.\n\n2. Use the Id of the selected brand to update the name by calling [Update Brand](fallback::./brands-v3/update-a-brand)\n with `brand.id` and the new name:\n```json\n{\n \"brand\": {\n \"id\": \"6a325aee-6c03-4934-a325-426b2a97ac52\",\n \"revision\": \"1\",\n \"name\": \"Nike Air\"\n }\n}\n```\n\n## Delete multiple Brands\n\nIn order to delete an existing brands, you need to delete it with Bulk Delete Request.\n\nTo do this, your app can follow these steps:\n\n1. Select the IDs of existing brands from the bank to be deleted.\n\n2. Delete brands with [Bulk Delete Brands](fallback::./brands-v3/delete-multiple-Brands)\n with list of the brands IDs:\n```json\n{\n \"brandIds\": [\n \"6b6ef077-ccd9-4e7f-b70a-51d1b6703b95\",\n \"4846bad2-883e-4a4d-aad8-98609cd97dbf\"\n ]\n}\n```\n\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Get Brand

Permission Scopes