POST

Bulk Update Brands

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates multiple brands.

Each time a brand is updated, revision increments by 1. The current revision must be passed when updating a brand. This ensures you're working with the latest brand and prevents unintended overwrites.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Stores - all permissions
Manage Products
Brand write in v3 catalog
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/stores/v3/bulk/brands/update
Body Params
brandsArray <MaskedBrand>RequiredminItems 1maxItems 100

List of brands to update.

returnEntityboolean

Whether to return the full updated brand entities in the response.

Default: false

fieldsArray <string>maxItems 100

Fields to include in the response.

Supported values: ASSIGNED_PRODUCTS_COUNT

Response Object
resultsArray <BulkBrandsResult>maxItems 100

Brands updated by bulk action.

bulkActionMetadataBulkActionMetadata

Bulk action metadata.

Update multiple Brands

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
curl -X POST \
  'https://www.wixapis.com/stores/v3/bulk/brands/update' \
  -H 'Content-type: application/json' \
  -H 'Authorization:  <AUTH>' \
  -d '{
    "brands": [
        {
          "brand": {
            "id": "f436b313-8437-4b91-a650-dc394427378",
            "revision": "1",
            "name": "Asics"
          }
        },
        {
          "brand": {
            "id": "6a325aee-6c03-4934-a325-426b2a97ac52",
            "revision": "1",
            "name": "Nike Air Jordan"
          }
        },
        {
          "brand": {
            "id": "bea34149-958b-4a2b-ae29-cf69aca29106",
            "revision": "1",
            "name": "NB"
          }
        }
      ],
      "returnEntity": true
  }'
Response
JSON
{
  "results": [
    {
      "itemMetadata": {
        "id": "f436b313-8437-4b91-a650-dc394427378",
        "originalIndex": 0,
        "success": true
      },
      "item": {
        "id": "f436b313-8437-4b91-a650-dc394427378",
        "revision": "2",
        "createdDate": "2024-06-30T09:15:50.684Z",
        "updatedDate": "2024-07-01T09:57:04.124Z",
        "name": "Asics"
      }
    },
    {
      "itemMetadata": {
        "id": "bea34149-958b-4a2b-ae29-cf69aca29106",
        "originalIndex": 2,
        "success": true
      },
      "item": {
        "id": "bea34149-958b-4a2b-ae29-cf69aca29106",
        "revision": "2",
        "createdDate": "2024-06-30T09:15:50.684Z",
        "updatedDate": "2024-07-01T09:57:04.131Z",
        "name": "NB"
      }
    },
    {
      "itemMetadata": {
        "id": "6a325aee-6c03-4934-a325-426b2a97ac52",
        "originalIndex": 1,
        "success": false,
        "error": {
          "code": "INVALID_REVISION",
          "description": "Outdated revision for entity id",
          "data": {
            "revisionViolation": {
              "entityId": "6a325aee-6c03-4934-a325-426b2a97ac52"
            }
          }
        }
      }
    }
  ],
  "bulkActionMetadata": {
    "totalSuccesses": 2,
    "totalFailures": 1,
    "undetailedFailures": 0
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Brand Updated
Did this help?