Products Attributes

Attributes are relevant information for category filters and to differentiate SKUs from your product. The more attributes your product has the more chances it will have to appear in the category filter.

Here are some examples of attributes that are mandatory in the marketplace by category, such as:

  • Voltage - For appliances category

  • Color - For fashion category

  • Size - For fashion category

  • Flavor - For Sport & Nutrition category

It does not mean that your products should be limited to just these attributes, for example, in the following fashion category we have other attributes such as brand and others.

For a better understanding of mandatory attributes, imagine a fashion shop selling in the marketplace, the MKTP needs to have the color and size information of a T-shirt, as these are attributes of differentiation for each SKU of the product, and thus the marketplace will make available the options that your store has available for sale.

Now that you understand the importance of this information, let's practice! How does the integration send this data to Skyhub?

The fields available at the endpoint: https://api.skyhub.com.br/attributes and their types are:

Status

Type

Descrição

name

String

Internal attribute identifier

label

String

attribute label, this string displayed on the SkyHub

options

Array

Optional field: Lists attribute options, if it is of type "select" example, [red, blue, white] for a color attribute

Integration will need to use the POST method through the following endpoint:

https://api.skyhub.com.br/attributes

The information to be sent must be in the request BODY as follows:

To update a particular product that was created in Skyhub, you must use the PUT (Update) method through the following endpoint:

https://api.skyhub.com.br/attributes/{attribute_name}

To be updated the information needs to be in the body of the request as follows:

{
"attribute": {
"label": "Atributo Exemplo",
"options": [
"blue",
"blue",
"blue"
]
}
}

As a best practice, we strongly recommend that the attribute be created separately for posting (link) to the product you wish to create on SkyHub.

Do not follow the above practice raises SkyHub's processing rate and may lead to less efficient returns from our API. This is because of a validation that our tool does that is to verify if the attribute already exists, and if it does not exist, SkyHub does the creation.

As a test, we'll create an attribute in a Skyhub account using rest tools (like DHC / Postman). In practice it works as follows:

With the attribute created, we will consult it on SkyHub through the left side menu, Skyhub> Attributes:

In the screen below, the Label field is the "Label" field displayed in the API. The Código field is the "Name" field displayed in the API.

Now let's create a product, making use of the previously created attribute and "telling" to SkyHub, that this product will have an already existing attribute on SkyHub.

To create a product, we use the POST method and the Endpoint https://api.skyhub.com.br/product with the following BODY:

Check in our API Explorer