Skip to main content
POST
/
products
API para criação de produtos
curl --request POST \
  --url https://api.shopnext.ai/v1/products \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Geladeira Frost Free 400L",
  "categoryPath": "Eletrodomésticos > Geladeiras",
  "referenceId": "geladeira-400l-001",
  "variants": [
    {
      "name": "Branco 110V",
      "ean": "7891234567890",
      "images": [
        {
          "url": "https://exemplo.com/imagem-geladeira.jpg"
        }
      ],
      "referenceId": "gel-branco-001",
      "metadata": {
        "cor": "Branco"
      }
    },
    {
      "name": "Inox 220V",
      "ean": "7891234567891",
      "images": [
        {
          "url": "https://exemplo.com/imagem-geladeira-inox.jpg"
        }
      ],
      "referenceId": "gel-inox-002",
      "metadata": {
        "cor": "Inox"
      }
    }
  ],
  "description": "Geladeira Frost Free com capacidade de 400 litros, baixo consumo de energia e prateleiras ajustáveis.",
  "brandName": "Electrolux",
  "metadata": {
    "voltagem": "110V",
    "litros": "375"
  }
}
'
{
  "product": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
x-api-key
string
header
required

Api key generated in ShopNext.AI app

Body

application/json
​
name
string
required

Nome do Produto

Example:

"Geladeira Frost Free 400L"

​
categoryPath
string
required

Categoria do Produto. Se tiver mais de um nível separe por ">"

Example:

"Eletrodomésticos > Geladeiras"

​
referenceId
string
required

ID Externo do Produto

Example:

"geladeira-400l-001"

​
variants
object[]
required

Lista de variantes do produto

Example:
[
  {
    "name": "Branco 110V",
    "ean": "7891234567890",
    "images": [
      {
        "url": "https://exemplo.com/imagem-geladeira.jpg"
      }
    ],
    "referenceId": "gel-branco-001",
    "metadata": { "cor": "Branco" }
  },
  {
    "name": "Inox 220V",
    "ean": "7891234567891",
    "images": [
      {
        "url": "https://exemplo.com/imagem-geladeira-inox.jpg"
      }
    ],
    "referenceId": "gel-inox-002",
    "metadata": { "cor": "Inox" }
  }
]
​
description
string

Descrição do Produto

Example:

"Geladeira Frost Free com capacidade de 400 litros, baixo consumo de energia e prateleiras ajustáveis."

​
brandName
string

Marca do Produto

Example:

"Electrolux"

​
metadata
object

Campos de produto personalizados, podem ser utilizados no enriquecimento

Example:
{ "voltagem": "110V", "litros": "375" }

Response

Default Response

​
product
object
required