Brand Tutorial

How to create a brand with media files

To create a brand with media files and add it to a product created beforehand, follow the process below:

1

Create a brand

2

Upload brand images

3

Update an existing product with brand information

Before you start

Ensure that you have created a product.

For instructions, check out How to add your first product.

Create a brand

To create a brand and add media files to it, you need to send a request to the Adding a new brand endpoint.

To test the endpoint, open the API reference or check the example of a curl request.

API Reference

curl -i -X POST 
  https://api.emporix.io/brand/brands 
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' 
  -H 'Content-Language: en' 
  -H 'Content-Type: application/json' 
  -d '{
    "name": "Sample brand",
    "description": "Description of the sample brand.",
    "localizedName": {
        "en": "Brand one"
    },
    "localizedDescription": {
        "en": "Description of <strong>Brand one</strong> in HTML."
    }
}'

Executing a request to create a brand returns a response that includes an "id" field, which should then be used when uploading an image.

Upload an image

To include an image for a brand, you need to upload the image to the database by sending a multipart request to the Creating an asset endpoint. The brandId is necessary to provide.

API Reference

curl -L 
  --request POST 
  --url 'https://api.emporix.io/media/{tenant}/assets' 
  --header 'Content-Type: multipart/form-data' 
  --data '{
    "file": {
      "externalValue": "https://res.cloudinary.com/saas-ag/image/upload/v1695804155/emporix-logo-white-2f5e621206edefea6015fb4793959376_nswfbz.png"
    },
    "body": {
      "type": "BLOB",
      "access": "PUBLIC",
      "refIds": [
        {
          "id": "123e06ecf0452c2d6c0b81392",
          "type": "BRAND"
        }
      ],
      "details": {
        "filename": "theBestImage",
        "mimeType": "image/jpg"
      }
    }
  }'

Update an existing product with brand information

To specify a brand for a product, you need to provide the brandId field on product level which should be used. You can add brands either during the creation of the product, or by updating a product that already exists in the system.

To update the existing product with brand information, you need to send a request to the Partially updating a product endpoint.

API Reference

curl -i -X PATCH 
  'https://api.emporix.io/product/{tenant}/products/{productId}?skipVariantGeneration=false&doIndex=true' 
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' 
  -H 'Content-Language: string' 
  -H 'Content-Type: application/json' 
  -d '{
    "published": true
    "brandId":"123e06ecf0452c2d6c0b81392"
  }'