Produtos

Atualizar produto (parcial)

Este método é utilizado para atualizar um produto existente. É similar ao método PUT, porém a principal diferença é que campos que são arrays como variacoes, imagens e categorias, quando informados através deste método, serão apenas acrescentados, e não substituídos como acontece no PUT.

Exemplo: caso seja enviado um array com 1 imagem neste método para um produto que contenha 2 imagens, essa imagem será acrescentada no produto, ficando ele com 3 imagens. O mesmo acontece para variações e categorias. Em relação às variações, caso o controle de estoque seja impactado com a inclusão de uma variação, o estoque será zerado.

Os demais campos são possíveis de atualizar normalmente, conforme o método PUT.

patch/produtos/{produtoId}

Request

  • Base URL: https://app.vendizap.com/api
  • URL: https://app.vendizap.com/api/produtos/{produtoId}
  • Auth: API key in header X-Auth-Id and API key in header X-Auth-Secret

Request body

descricaostring required
preconumber
imagensstring[]

Array com Urls e/ou base64 das imagens. A primeira será a capa do produto.

detalhesstring
categoriasstring[]
unidadeVenda'Unidade' | 'Caixa' | 'Pacote' | 'Peça' | 'Quilo' | 'Porção' | 'Pedaço' | 'Metro' | 'Par' | 'Jogo'
unidadePreco'Unidade' | 'Caixa' | 'Pacote' | 'Peça' | 'Quilo' | 'Porção' | 'Pedaço' | 'Metro' | 'Par' | 'Jogo'
codigostring
eanstring

Código de barras (EAN/GTIN). Apenas para produto SEM variação — em produto com variação, o EAN é por combinação.

qtdeMinimanumber
qtdeMaximanumber
exibirboolean
destaqueboolean

Example request

{
  "descricao": "Produto API",
  "preco": 9.99,
  "promocao": {
    "dataHoraInicio": "2021-02-14 22:00:00",
    "dataHoraFim": "2021-02-24 20:59:59",
    "percentual": 10,
    "precoPromocional": 26.991
  },
  "imagens": [
    "https://www.vendizap.com/imagens/produto1.jpg",
    "https://www.vendizap.com/imagens/produto2.jpg"
  ],
  "detalhes": "Detalhes do produto de exemplo",
  "categorias": [],
  "variacoes": [
    {
      "id": "6037d8bb6df10513fb742d40",
      "obrigatoria": true,
      "variaveis": [
        {
          "id": "6037d8bb6df10513fb742d42"
        }
      ]
    }
  ],
  "combinacoes": [
    {
      "codigo": "SKU_P_AZUL",
      "preco": 12,
      "ean": "7891234567890",
      "combinacao": [
        {
          "variacao": "6037d8bb6df10513fb742d40",
          "variavel": "6037d8bb6df10513fb742d43"
        }
      ]
    }
  ],
  "dimensoes": {
    "altura": 10,
    "largura": 10,
    "comprimento": 10,
    "peso": 1
  },
  "unidadeVenda": "Unidade",
  "unidadePreco": "Unidade",
  "codigo": "10",
  "ean": "7891234567890",
  "exibir": true
}

Response

Produto atualizado parcialmente.

idstring

Example response

{
  "id": "6048f2b4b6fa7c28844582d5"
}

Changes

No recorded changes to this operation across all 1 revision of this API.