Criação de Produtos

Cria produto ou atualiza suas informações. Para atualizações, todos os dados de produto previamente existentes serão substituídos pelos desta requisição.

Para remoção de produtos, basta informar os campos apiKey, secretKey e status: "removed". Caso o produto nunca tenha sido enviado anteriormente, um código 404 é retornado como resposta da requisição.

Path Params

productId
stringrequired

Identificador único do produto. Quando um produto possui uma lista de SKUs, este campo funciona como seu agrupador.

Body Params

apiKey
stringrequired

ID interno de identificação da sua loja.

Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br

secretKey
stringrequired

Chave de acesso para autenticar a requisição. Pode ser substituída pelo parâmetro origin quando a requisição é feita via frontend para não expor a chave.

Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br

name
stringrequired

Título do produto.

description
string

Breve descrição do produto em texto plano, sem tags HTML e quebras de linhas.

url
stringrequired

URL da página de detalhes do produto.

Exemplo: //www.mystore.com/product/P123.html

status
stringrequired

Disponibilidade do produto em estoque.

Valores possíveis: available, unavailable ou removed

images
Objectrequired
Objeto chave valor contendo as resoluções do produto como chave e as URLs de imagens do produto como valor. A imagem selecionada por padrão será provida pela chave default.
{
  "default": "https://mystore.com/products/1234/images/200x200.png",
  "200": "https://mystore.com/products/1234/images/200x200.png",
  "400": "https://mystore.com/products/1234/images/400x400.png"
}
categories
string[] | Category[]required
Conjunto de categorias relacionadas ao produto.

price
numberrequired

Preço de comercialização do produto.

oldPrice
number

Preço anterior do produto.

brand
string

Marca do produto.

salesChannel
string

O identificador de sales channel do produto

skus
Sku[]required
Cada variante possível do produto vira um objeto dentro de skus.
installment
Installment
Objeto contento as opções de parcelamento do produto

details
Object

Objeto para atribuição de detalhes específicos do produto. Pode conter qualquer chave/valor válido para um JSO (Javascript Object).
{
  "hasSpecificRule": true,
  "myCompanyCode": "1234"
}

tags
string[]

Conjunto de tags relacionadas ao produto.

published
string

Data de adição do produto ao catálogo no formato YYYY-MM-DD.

Exemplo: 2015-02-04

unit
string

Unidade de medida utilizada na comercialização do produto. Informe somente para produtos que possuem quantidades fracionárias.

Exemplo: "M", "M(2)", "KG"

stock
number

Quantidade de itens disponíveis em estoque.

eanCode
string

Código EAN do produto

Edit this page on GitHub
New Product
import axios from 'axios'

await axios.put('https://collect.chaordicsystems.com/v7/products/123', {
  apiKey: 'api-sample',
  secretKey: 'v8s+tGw2kuCKX33TYeFUOA==',
  name: 'Refrigerator X',
  description: 'Any description',
  url: '/products/123.html',
  brand: 'Marca do Produto',
  images: {
    default: "/products/123_default.png"
  },
  status: 'AVAILABLE',
  categories: ['kitchen', 'refrigerators'],
  specs: {
    voltage: ['110V', '220V']
  },
  eanCode: 'F123',
  skus: [
    {
      sku: '1.1',
      specs: {
        voltage: '110V'
      },
      status: 'unavailable',
      price: 110.43
    },
    {
      sku: '1.2',
      specs: {
        voltage: '220V'
      },
      status: 'available',
      price: 120.43
    }
  ],
  price: 1000,        
  details: {
    rating: '4'
  },
  installment: {
    count: 10,
    price: 100
  },
  oldPrice: 1200,
  published: '2015-05-05'
});
Remove Product
import axios from 'axios'

await axios.put('https://collect.chaordicsystems.com/v7/products/123', {
  apiKey: 'api-sample',
  secretKey: 'v8s+tGw2kuCKX33TYeFUOA==',
  status: 'REMOVED'
});
curl
curl -0 -v -X PUT "https://collect.chaordicsystems.com/v7/products/123" \
  -H "Content-type: application/json" \
  -d @- << EOF
  {
    "apiKey": "api-sample",
    "secretKey": "v8s+tGw2kuCKX33TYeFUOA==",
    "name": "Refrigerator X",
    "description": "Any description",
    "url": "/products/123.html",
    "brand": "Marca do Produto",
    "images": {
      "default": "/products/123_default.png"
    },
    "status": "AVAILABLE",
    "categories": ["kitchen", "refrigerators"],
    "specs": {
      "voltage": ["110V", "220V"]
    },
    "eanCode": "F123",
    "skus": [
      {
        "sku": "1.1",
        "specs": {
          "voltage": "110V"
        },
        "status": "unavailable",
        "price": 110.43
      },
      {
        "sku": "1.2",
        "specs": {
          "voltage": "220V"
        },
        "status": "available",
        "price": 120.43
      }
    ],
    "price": 1000,        
    "details": {
      "rating": "4"
    },
    "installment": {
      "count": 10,
      "price": 100
    },
    "oldPrice": 1200,
    "published": "2015-05-05"
  }
EOF