Produto

(GET) por ID

    API Endpoint

        https://api.omnik.io/HUB/v1/products/{id}
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/products/{id}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "account": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "productData": {
    "active": true,
    "id": "string",
    "productName": "string",
    "description": "string",
    "descriptionHTML": "string",
    "brand": "string",
    "tags": "string",
    "warranty": 0,
    "variant": true,
    "unit": "string",
    "unitInitials": "string"
  },
  "codes": [
    {
      "code": "string"
    }
  ],
  "productDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "packageDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "taxData": {
    "icmsOriginId": "string",
    "icmsOriginName": "string",
    "ncmData": {
      "id": "string",
      "ncm": "string"
    }
  },
  "categoryData": {
    "id": "string",
    "code": "string",
    "name": "string"
  },
  "categories": [
    {
      "channel": "string",
      "tag": "string",
      "id1": "string",
      "name1": "string",
      "id2": "string",
      "name2": "string",
      "id3": "string",
      "name3": "string",
      "id4": "string",
      "name4": "string",
      "id5": "string",
      "name5": "string",
      "id6": "string",
      "name6": "string",
      "id7": "string",
      "name7": "string",
      "id8": "string",
      "name8": "string"
    }
  ],
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "required": true
    }
  ],
  "skus": [
    {
      "active": true,
      "skuData": {
        "id": "string",
        "tenant": "string",
        "sku": "string",
        "skuName": "string",
        "gtin": "string",
        "model": "string",
        "crossdockingDays": 0,
        "supplierCode": "string",
        "erpCode": "string",
        "establishmentCode": "string",
        "moderationStatus": "string",
        "moderationDate": "string",
        "productType": "string",
        "productCondition": "string",
        "description": "string",
        "descriptionHTML": "string"
      },
      "productData": {
        "id": "string"
      },
      "codes": [
        {
          "code": "string"
        }
      ],
      "errors": [
        {
          "code": "string",
          "type": "string",
          "message": "string"
        }
      ],
      "priceData": {
        "fromPrice": 0,
        "price": 0,
        "costPrice": 0
      },
      "stockData": {
        "stock": 0,
        "minStock": 0
      },
      "packageDimensionData": {
        "width": 0,
        "height": 0,
        "depth": 0,
        "grossWeight": 0
      },
      "images": [
        {
          "thumbnail": "string",
          "small": "string",
          "average": "string",
          "big": "string",
          "link": "string",
          "main": true,
          "number": 0
        }
      ],
      "attributes": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "marketplaces": [
        {
          "marketplace": "string",
          "marketPlaceId": "string",
          "commissionValue": 0,
          "lastUpdate": "1970-01-01T00:00:00.000000",
          "active": true
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Produto pelo ID

Path Parameters

Campo	Tipo	Descrição
id	string	(required) ID do Produto

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(optional) Tenant ID do Seller (se Operador)

Query Parameters

Campo	Tipo	Descrição
inventory	string	(optional) Incluir Estoque atualizado? Default: false

Response Parameters (2xx)

Campo	Tipo	Descrição
tenant	string	Tenant ID do Seller.
operator	string	Tenant ID do Operador (Hub).
account	string	ID da conta do Seller.
createDate	datetime	Data de criação do Produto.
lastUpdate	datetime	Data da última atualização.
productData	object	Dados do Produto: id, productName, description, descriptionHTML, brand, tags, warranty, variant, unit, unitInitials, active.
codes	array	Códigos adicionais do Produto.
productDimensionData	object	Dimensões físicas do Produto: width, height, depth, grossWeight.
packageDimensionData	object	Dimensões da embalagem: width, height, depth, grossWeight.
taxData	object	Dados fiscais: icmsOriginId, icmsOriginName, ncmData (id, ncm).
categoryData	object	Categoria principal: id, code, name.
categories	array	Categorias por marketplace/canal (até 8 níveis).
attributes	array	Atributos/especificações do Produto: id, name, value, required.
skus	array	Variações (SKUs) do Produto. Cada item contém: active, skuData, priceData, stockData, packageDimensionData, images, attributes, marketplaces.
skus[].skuData	object	Dados do SKU: id, sku, skuName, gtin, model, crossdockingDays, supplierCode, erpCode, moderationStatus, productType, productCondition.
skus[].priceData	object	Preços do SKU: fromPrice (preço de), price (preço por), costPrice (preço de custo).
skus[].stockData	object	Estoque do SKU: stock (saldo atual), minStock (estoque mínimo).
skus[].images	array	Imagens do SKU: thumbnail, small, average, big, link, main, number.
skus[].marketplaces	array	Marketplaces onde o SKU está publicado.
marketplaces	array	Marketplaces onde o Produto está publicado.

(GET) paginado

    API Endpoint

        https://api.omnik.io/HUB/v1/products/
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/products/' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "total": 0,
  "limit": 0,
  "offset": 0,
  "sort": "string",
  "values": [
    {
      "tenant": "string",
      "operator": "string",
      "account": "string",
      "createDate": "1970-01-01T00:00:00.000000",
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "productData": {
        "active": true,
        "id": "string",
        "productName": "string",
        "description": "string",
        "descriptionHTML": "string",
        "brand": "string",
        "tags": "string",
        "warranty": 0,
        "variant": true,
        "unit": "string",
        "unitInitials": "string"
      },
      "codes": [
        {
          "code": "string"
        }
      ],
      "productDimensionData": {
        "width": 0,
        "height": 0,
        "depth": 0,
        "grossWeight": 0
      },
      "packageDimensionData": {
        "width": 0,
        "height": 0,
        "depth": 0,
        "grossWeight": 0
      },
      "taxData": {
        "icmsOriginId": "string",
        "icmsOriginName": "string",
        "ncmData": {
          "id": "string",
          "ncm": "string"
        }
      },
      "categoryData": {
        "id": "string",
        "code": "string",
        "name": "string"
      },
      "categories": [
        {
          "channel": "string",
          "tag": "string",
          "id1": "string",
          "name1": "string",
          "id2": "string",
          "name2": "string",
          "id3": "string",
          "name3": "string",
          "id4": "string",
          "name4": "string",
          "id5": "string",
          "name5": "string",
          "id6": "string",
          "name6": "string",
          "id7": "string",
          "name7": "string",
          "id8": "string",
          "name8": "string"
        }
      ],
      "attributes": [
        {
          "id": "string",
          "name": "string",
          "value": "string",
          "required": true
        }
      ],
      "skus": [
        {
          "active": true,
          "skuData": {
            "id": "string",
            "tenant": "string",
            "sku": "string",
            "skuName": "string",
            "gtin": "string",
            "model": "string",
            "crossdockingDays": 0,
            "supplierCode": "string",
            "erpCode": "string",
            "establishmentCode": "string",
            "moderationStatus": "string",
            "moderationDate": "string",
            "productType": "string",
            "productCondition": "string",
            "description": "string",
            "descriptionHTML": "string"
          },
          "productData": {
            "id": "string"
          },
          "codes": [
            {
              "code": "string"
            }
          ],
          "errors": [
            {
              "code": "string",
              "type": "string",
              "message": "string"
            }
          ],
          "priceData": {
            "fromPrice": 0,
            "price": 0,
            "costPrice": 0
          },
          "stockData": {
            "stock": 0,
            "minStock": 0
          },
          "packageDimensionData": {
            "width": 0,
            "height": 0,
            "depth": 0,
            "grossWeight": 0
          },
          "images": [
            {
              "thumbnail": "string",
              "small": "string",
              "average": "string",
              "big": "string",
              "link": "string",
              "main": true,
              "number": 0
            }
          ],
          "attributes": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "marketplaces": [
            {
              "marketplace": "string",
              "marketPlaceId": "string",
              "commissionValue": 0,
              "lastUpdate": "1970-01-01T00:00:00.000000",
              "active": true
            }
          ]
        }
      ],
      "marketplaces": [
        {
          "marketplace": "string",
          "marketPlaceId": "string",
          "commissionValue": 0,
          "lastUpdate": "1970-01-01T00:00:00.000000",
          "active": true
        }
      ]
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de produto paginada

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(optional) Tenant ID do Seller (se Operador)

Query Parameters

Campo	Tipo	Descrição
offset	integer	(optional) indica a partir de onde ocorre um aumento
limit	integer	(optional) indica a quantidade de recursos a serem devolvidos, variando de 10 a no máximo 10
sort	string	(optional) indica por qual atributo a consulta deve ser classificada (lastUpdate ou createDate) (Default lastUpdate)
last_update	string($yyyy-MM-dd'T'HH:mm:ss)	(optional) last update
inventory	string	(optional) Incluir Estoque atualizado? Default: false

Response Parameters (2xx)

Campo	Tipo	Descrição
total	integer	Total de registros encontrados.
limit	integer	Quantidade de registros retornados por página.
offset	integer	Posição inicial da página consultada.
sort	string	Campo de ordenação utilizado.
values	array	Lista de Produtos. Cada item segue a mesma estrutura da consulta por ID (tenant, operator, productData, skus, marketplaces, etc.).

(POST) /products

    API Endpoint

        https://api.omnik.io/HUB/v1/products/
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/products/' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
--data '{
  "active": true,
  "tenant": "string",
  "account": "string",
  "productData": {
    "active": true,
    "productName": "string",
    "description": "string",
    "descriptionHTML": "string",
    "brand": "string",
    "tags": "string",
    "warranty": 0,
    "variant": true,
    "unit": "string",
    "unitInitials": "string"
  },
  "codes": [
    {
      "code": "string"
    }
  ],
  "productDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "packageDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "taxData": {
    "icmsOriginId": "string",
    "icmsOriginName": "string",
    "ncmData": {
      "id": "string",
      "ncm": "string"
    }
  },
  "categoryData": {
    "id": "string",
    "code": "string",
    "name": "string"
  },
  "categories": [
    {
      "channel": "string",
      "tag": "string",
      "id1": "string",
      "name1": "string",
      "id2": "string",
      "name2": "string",
      "id3": "string",
      "name3": "string",
      "id4": "string",
      "name4": "string",
      "id5": "string",
      "name5": "string",
      "id6": "string",
      "name6": "string",
      "id7": "string",
      "name7": "string",
      "id8": "string",
      "name8": "string"
    }
  ],
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "required": true
    }
  ],
  "skus": [
    {
      "active": true,
      "skuData": {
        "sku": "string",
        "skuName": "string",
        "gtin": "string",
        "model": "string",
        "crossdockingDays": 0,
        "supplierCode": "string",
        "erpCode": "string",
        "establishmentCode": "string",
        "moderationStatus": "string",
        "moderationDate": "string",
        "productType": "string",
        "productCondition": "string"
      },
      "codes": [
        {
          "code": "string"
        }
      ],
      "errors": [
        {
          "code": "string",
          "type": "string",
          "message": "string"
        }
      ],
      "priceData": {
        "fromPrice": 0,
        "price": 0,
        "costPrice": 0
      },
      "stockData": {
        "stock": 0,
        "minStock": 0
      },
      "packageDimensionData": {
        "width": 0,
        "height": 0,
        "depth": 0,
        "grossWeight": 0
      },
      "images": [
        {
          "thumbnail": "string",
          "small": "string",
          "average": "string",
          "big": "string",
          "link": "string",
          "main": true,
          "number": 0
        }
      ],
      "attributes": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}'
                
            

                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "account": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "productData": {
    "active": true,
    "id": "string",
    "productName": "string",
    "description": "string",
    "descriptionHTML": "string",
    "brand": "string",
    "tags": "string",
    "warranty": 0,
    "variant": true,
    "unit": "string",
    "unitInitials": "string"
  },
  "codes": [
    {
      "code": "string"
    }
  ],
  "productDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "packageDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "taxData": {
    "icmsOriginId": "string",
    "icmsOriginName": "string",
    "ncmData": {
      "id": "string",
      "ncm": "string"
    }
  },
  "categoryData": {
    "id": "string",
    "code": "string",
    "name": "string"
  },
  "categories": [
    {
      "channel": "string",
      "tag": "string",
      "id1": "string",
      "name1": "string",
      "id2": "string",
      "name2": "string",
      "id3": "string",
      "name3": "string",
      "id4": "string",
      "name4": "string",
      "id5": "string",
      "name5": "string",
      "id6": "string",
      "name6": "string",
      "id7": "string",
      "name7": "string",
      "id8": "string",
      "name8": "string"
    }
  ],
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "required": true
    }
  ],
  "skus": [
    {
      "active": true,
      "skuData": {
        "id": "string",
        "tenant": "string",
        "sku": "string",
        "skuName": "string",
        "gtin": "string",
        "model": "string",
        "crossdockingDays": 0,
        "supplierCode": "string",
        "erpCode": "string",
        "establishmentCode": "string",
        "moderationStatus": "string",
        "moderationDate": "string",
        "productType": "string",
        "productCondition": "string",
        "description": "string",
        "descriptionHTML": "string"
      },
      "productData": {
        "id": "string"
      },
      "codes": [
        {
          "code": "string"
        }
      ],
      "errors": [
        {
          "code": "string",
          "type": "string",
          "message": "string"
        }
      ],
      "priceData": {
        "fromPrice": 0,
        "price": 0,
        "costPrice": 0
      },
      "stockData": {
        "stock": 0,
        "minStock": 0
      },
      "packageDimensionData": {
        "width": 0,
        "height": 0,
        "depth": 0,
        "grossWeight": 0
      },
      "images": [
        {
          "thumbnail": "string",
          "small": "string",
          "average": "string",
          "big": "string",
          "link": "string",
          "main": true,
          "number": 0
        }
      ],
      "attributes": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "marketplaces": [
        {
          "marketplace": "string",
          "marketPlaceId": "string",
          "commissionValue": 0,
          "lastUpdate": "1970-01-01T00:00:00.000000",
          "active": true
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Incluir Produto. Se o Hub utilizar catálogo (utilizaCatalogo=true), os SKUs criados entram com moderacaoStatus=PENDENTE e precisam de aprovação antes de serem publicados.

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(optional) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
tenant	string	(required) Tenant ID do Seller.
productData.productName	string	(required) Nome do Produto.
productData.active	boolean	(optional) Produto ativo? Default: true.
productData.description	string	(optional) Descrição em texto plano.
productData.descriptionHTML	string	(optional) Descrição em HTML.
productData.brand	string	(optional) Marca do Produto.
productData.warranty	integer	(optional) Garantia em meses.
productData.variant	boolean	(optional) Possui variações?
packageDimensionData	object	(optional) Dimensões da embalagem: width, height, depth, grossWeight.
taxData	object	(optional) Dados fiscais: icmsOriginId, ncmData.ncm.
categoryData	object	(optional) Categoria principal: id, code, name.
attributes	array	(optional) Atributos/especificações: id, name, value.
skus	array	(required) Lista de SKUs. Cada item deve conter ao menos skuData.sku e skuData.skuName.
skus[].skuData.sku	string	(required) Código único do SKU no Seller.
skus[].skuData.skuName	string	(required) Nome do SKU.
skus[].priceData.price	number	(optional) Preço de venda.
skus[].priceData.fromPrice	number	(optional) Preço de (original).
skus[].stockData.stock	integer	(optional) Saldo de estoque.
skus[].images	array	(optional) Imagens do SKU: link, main, number.

Response Parameters (2xx)

Campo	Tipo	Descrição
tenant	string	Tenant ID do Seller.
operator	string	Tenant ID do Operador.
productData.id	string	ID interno gerado pelo Hub.
productData.productName	string	Nome do Produto.
skus	array	SKUs criados com seus respectivos IDs gerados, preços, estoque e imagens.
skus[].skuData.id	string	ID interno do SKU gerado pelo Hub.
skus[].moderationStatus	string	Status de moderação: PENDENTE (se catálogo ativo) ou APROVADO.
marketplaces	array	Marketplaces onde o Produto está publicado (vazio após criação).

(PUT) /products

    API Endpoint

        https://api.omnik.io/HUB/v1/products/{id}
            

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/products/{id}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
--data '{
  "active": true,
  "tenant": "string",
  "account": "string",
  "productData": {
    "active": true,
    "productName": "string",
    "description": "string",
    "descriptionHTML": "string",
    "brand": "string",
    "tags": "string",
    "warranty": 0,
    "variant": true,
    "unit": "string",
    "unitInitials": "string"
  },
  "codes": [
    {
      "code": "string"
    }
  ],
  "productDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "packageDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "taxData": {
    "icmsOriginId": "string",
    "icmsOriginName": "string",
    "ncmData": {
      "id": "string",
      "ncm": "string"
    }
  },
  "categoryData": {
    "id": "string",
    "code": "string",
    "name": "string"
  },
  "categories": [
    {
      "channel": "string",
      "tag": "string",
      "id1": "string",
      "name1": "string",
      "id2": "string",
      "name2": "string",
      "id3": "string",
      "name3": "string",
      "id4": "string",
      "name4": "string",
      "id5": "string",
      "name5": "string",
      "id6": "string",
      "name6": "string",
      "id7": "string",
      "name7": "string",
      "id8": "string",
      "name8": "string"
    }
  ],
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "required": true
    }
  ],
  "skus": [
    {
      "active": true,
      "skuData": {
        "sku": "string",
        "skuName": "string",
        "gtin": "string",
        "model": "string",
        "crossdockingDays": 0,
        "supplierCode": "string",
        "erpCode": "string",
        "establishmentCode": "string",
        "moderationStatus": "string",
        "moderationDate": "string",
        "productType": "string",
        "productCondition": "string"
      },
      "codes": [
        {
          "code": "string"
        }
      ],
      "errors": [
        {
          "code": "string",
          "type": "string",
          "message": "string"
        }
      ],
      "priceData": {
        "fromPrice": 0,
        "price": 0,
        "costPrice": 0
      },
      "stockData": {
        "stock": 0,
        "minStock": 0
      },
      "packageDimensionData": {
        "width": 0,
        "height": 0,
        "depth": 0,
        "grossWeight": 0
      },
      "images": [
        {
          "thumbnail": "string",
          "small": "string",
          "average": "string",
          "big": "string",
          "link": "string",
          "main": true,
          "number": 0
        }
      ],
      "attributes": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}'
                
            

                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "account": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "productData": {
    "active": true,
    "id": "string",
    "productName": "string",
    "description": "string",
    "descriptionHTML": "string",
    "brand": "string",
    "tags": "string",
    "warranty": 0,
    "variant": true,
    "unit": "string",
    "unitInitials": "string"
  },
  "codes": [
    {
      "code": "string"
    }
  ],
  "productDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "packageDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "taxData": {
    "icmsOriginId": "string",
    "icmsOriginName": "string",
    "ncmData": {
      "id": "string",
      "ncm": "string"
    }
  },
  "categoryData": {
    "id": "string",
    "code": "string",
    "name": "string"
  },
  "categories": [
    {
      "channel": "string",
      "tag": "string",
      "id1": "string",
      "name1": "string",
      "id2": "string",
      "name2": "string",
      "id3": "string",
      "name3": "string",
      "id4": "string",
      "name4": "string",
      "id5": "string",
      "name5": "string",
      "id6": "string",
      "name6": "string",
      "id7": "string",
      "name7": "string",
      "id8": "string",
      "name8": "string"
    }
  ],
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "required": true
    }
  ],
  "skus": [
    {
      "active": true,
      "skuData": {
        "id": "string",
        "tenant": "string",
        "sku": "string",
        "skuName": "string",
        "gtin": "string",
        "model": "string",
        "crossdockingDays": 0,
        "supplierCode": "string",
        "erpCode": "string",
        "establishmentCode": "string",
        "moderationStatus": "string",
        "moderationDate": "string",
        "productType": "string",
        "productCondition": "string",
        "description": "string",
        "descriptionHTML": "string"
      },
      "productData": {
        "id": "string"
      },
      "codes": [
        {
          "code": "string"
        }
      ],
      "errors": [
        {
          "code": "string",
          "type": "string",
          "message": "string"
        }
      ],
      "priceData": {
        "fromPrice": 0,
        "price": 0,
        "costPrice": 0
      },
      "stockData": {
        "stock": 0,
        "minStock": 0
      },
      "packageDimensionData": {
        "width": 0,
        "height": 0,
        "depth": 0,
        "grossWeight": 0
      },
      "images": [
        {
          "thumbnail": "string",
          "small": "string",
          "average": "string",
          "big": "string",
          "link": "string",
          "main": true,
          "number": 0
        }
      ],
      "attributes": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "marketplaces": [
        {
          "marketplace": "string",
          "marketPlaceId": "string",
          "commissionValue": 0,
          "lastUpdate": "1970-01-01T00:00:00.000000",
          "active": true
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Alterar Produto completamente (PUT substitui todos os campos). O campo skus é obrigatório e cada item deve conter skuData.

Path Parameters

Campo	Tipo	Descrição
id	string	(required) ID do Produto

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(optional) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
productData.productName	string	(required) Nome do Produto.
productData.active	boolean	(optional) Produto ativo?
productData.description	string	(optional) Descrição em texto plano.
productData.descriptionHTML	string	(optional) Descrição em HTML.
productData.brand	string	(optional) Marca.
packageDimensionData	object	(optional) Dimensões da embalagem: width, height, depth, grossWeight.
taxData	object	(optional) Dados fiscais: icmsOriginId, ncmData.ncm.
categoryData	object	(optional) Categoria principal: id, code, name.
attributes	array	(optional) Atributos: id, name, value.
skus	array	(required) Lista completa de SKUs. Cada item deve ter skuData com ao menos sku e skuName.

Response Parameters (2xx)

Campo	Tipo	Descrição
tenant	string	Tenant ID do Seller.
operator	string	Tenant ID do Operador.
productData	object	Dados atualizados do Produto.
skus	array	SKUs atualizados com preços, estoque, imagens e marketplaces.
marketplaces	array	Marketplaces onde o Produto está publicado.

(PATCH) /products

    API Endpoint

        https://api.omnik.io/HUB/v1/products/{id}
            

                
# Here is a curl example
curl --location --request \
PATCH 'https://api.omnik.io/HUB/v1/products/{id}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
--data '{
  "active": true,
  "tenant": "string",
  "account": "string",
  "productData": {
    "active": true,
    "productName": "string",
    "description": "string",
    "descriptionHTML": "string",
    "brand": "string",
    "tags": "string",
    "warranty": 0,
    "variant": true,
    "unit": "string",
    "unitInitials": "string"
  },
  "codes": [
    {
      "code": "string"
    }
  ],
  "productDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "packageDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "taxData": {
    "icmsOriginId": "string",
    "icmsOriginName": "string",
    "ncmData": {
      "id": "string",
      "ncm": "string"
    }
  },
  "categoryData": {
    "id": "string",
    "code": "string",
    "name": "string"
  },
  "categories": [
    {
      "channel": "string",
      "tag": "string",
      "id1": "string",
      "name1": "string",
      "id2": "string",
      "name2": "string",
      "id3": "string",
      "name3": "string",
      "id4": "string",
      "name4": "string",
      "id5": "string",
      "name5": "string",
      "id6": "string",
      "name6": "string",
      "id7": "string",
      "name7": "string",
      "id8": "string",
      "name8": "string"
    }
  ],
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "required": true
    }
  ],
  "skus": [
    {
      "active": true,
      "skuData": {
        "sku": "string",
        "skuName": "string",
        "gtin": "string",
        "model": "string",
        "crossdockingDays": 0,
        "supplierCode": "string",
        "erpCode": "string",
        "establishmentCode": "string",
        "moderationStatus": "string",
        "moderationDate": "string",
        "productType": "string",
        "productCondition": "string"
      },
      "codes": [
        {
          "code": "string"
        }
      ],
      "errors": [
        {
          "code": "string",
          "type": "string",
          "message": "string"
        }
      ],
      "priceData": {
        "fromPrice": 0,
        "price": 0,
        "costPrice": 0
      },
      "stockData": {
        "stock": 0,
        "minStock": 0
      },
      "packageDimensionData": {
        "width": 0,
        "height": 0,
        "depth": 0,
        "grossWeight": 0
      },
      "images": [
        {
          "thumbnail": "string",
          "small": "string",
          "average": "string",
          "big": "string",
          "link": "string",
          "main": true,
          "number": 0
        }
      ],
      "attributes": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}'
                
            

                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "account": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "productData": {
    "active": true,
    "id": "string",
    "productName": "string",
    "description": "string",
    "descriptionHTML": "string",
    "brand": "string",
    "tags": "string",
    "warranty": 0,
    "variant": true,
    "unit": "string",
    "unitInitials": "string"
  },
  "codes": [
    {
      "code": "string"
    }
  ],
  "productDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "packageDimensionData": {
    "width": 0,
    "height": 0,
    "depth": 0,
    "grossWeight": 0
  },
  "taxData": {
    "icmsOriginId": "string",
    "icmsOriginName": "string",
    "ncmData": {
      "id": "string",
      "ncm": "string"
    }
  },
  "categoryData": {
    "id": "string",
    "code": "string",
    "name": "string"
  },
  "categories": [
    {
      "channel": "string",
      "tag": "string",
      "id1": "string",
      "name1": "string",
      "id2": "string",
      "name2": "string",
      "id3": "string",
      "name3": "string",
      "id4": "string",
      "name4": "string",
      "id5": "string",
      "name5": "string",
      "id6": "string",
      "name6": "string",
      "id7": "string",
      "name7": "string",
      "id8": "string",
      "name8": "string"
    }
  ],
  "attributes": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "required": true
    }
  ],
  "skus": [
    {
      "active": true,
      "skuData": {
        "id": "string",
        "tenant": "string",
        "sku": "string",
        "skuName": "string",
        "gtin": "string",
        "model": "string",
        "crossdockingDays": 0,
        "supplierCode": "string",
        "erpCode": "string",
        "establishmentCode": "string",
        "moderationStatus": "string",
        "moderationDate": "string",
        "productType": "string",
        "productCondition": "string",
        "description": "string",
        "descriptionHTML": "string"
      },
      "productData": {
        "id": "string"
      },
      "codes": [
        {
          "code": "string"
        }
      ],
      "errors": [
        {
          "code": "string",
          "type": "string",
          "message": "string"
        }
      ],
      "priceData": {
        "fromPrice": 0,
        "price": 0,
        "costPrice": 0
      },
      "stockData": {
        "stock": 0,
        "minStock": 0
      },
      "packageDimensionData": {
        "width": 0,
        "height": 0,
        "depth": 0,
        "grossWeight": 0
      },
      "images": [
        {
          "thumbnail": "string",
          "small": "string",
          "average": "string",
          "big": "string",
          "link": "string",
          "main": true,
          "number": 0
        }
      ],
      "attributes": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "marketplaces": [
        {
          "marketplace": "string",
          "marketPlaceId": "string",
          "commissionValue": 0,
          "lastUpdate": "1970-01-01T00:00:00.000000",
          "active": true
        }
      ]
    }
  ],
  "marketplaces": [
    {
      "marketplace": "string",
      "marketPlaceId": "string",
      "commissionValue": 0,
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "active": true
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Alterar Produto parcialmente (PATCH atualiza apenas os campos enviados). Diferente do PUT, o campo skus é opcional.

Path Parameters

Campo	Tipo	Descrição
id	string	(required) ID do Produto

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(optional) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
productData	object	(optional) Campos do Produto a atualizar (productName, description, brand, etc).
packageDimensionData	object	(optional) Dimensões da embalagem.
taxData	object	(optional) Dados fiscais.
categoryData	object	(optional) Categoria principal.
attributes	array	(optional) Atributos a atualizar.
skus	array	(optional) SKUs a atualizar. Somente os campos enviados em cada SKU serão alterados. Identificação pelo skuData.id.

Response Parameters (2xx)

Campo	Tipo	Descrição
tenant	string	Tenant ID do Seller.
operator	string	Tenant ID do Operador.
productData	object	Dados atualizados do Produto.
skus	array	SKUs atualizados com preços, estoque, imagens e marketplaces.
marketplaces	array	Marketplaces onde o Produto está publicado.

(DELETE) /products

    API Endpoint

        https://api.omnik.io/HUB/v1/products/{id}
            

                
# Here is a curl example
curl --location --request \
DELETE 'https://api.omnik.io/HUB/v1/products/{id}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Deletar o Produto. Somente usuários com perfil HUB podem executar esta operação. Produtos publicados em marketplaces não podem ser removidos.

Path Parameters

Campo	Tipo	Descrição
id	string	(required) ID do Produto

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(optional) Tenant ID do Seller (se Operador)

Response Parameters (2xx)

Campo	Tipo	Descrição
code	integer	Código de resposta.
type	string	Tipo de resposta.
message	string	Mensagem de confirmação da exclusão.
messages	array	Lista de mensagens adicionais.