Pular para o conteúdo principal

Atualizar um produto ou serviço

PUThttps://carchost.fieldcontrol.com.br/products-services/{id}

Atualiza um produto ou serviço. Envie o registro completo: o corpo segue as mesmas regras da criação. storageProducts é ignorado; o saldo em estoque muda por movimentações.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Parâmetros de caminho

idstringobrigatório

Identificador do produto ou serviço.

Exemplo: NmIzYWU1NGItN2IxNi00NzQ2LTg4ZmUtOGM2ZjY3YzlhOTMxOjIyOTE1.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

namestringobrigatório

Nome do produto ou serviço.

Até 100 caracteres.

typestring ou numberobrigatório

product ou service. Número ou outro texto resulta em erro 500.

Valores aceitos: product, service.

descriptionstring

Descrição.

Até 2000 caracteres.

measurestringobrigatório

Unidade de medida, obrigatória também para serviços. Valores fora desta lista são gravados como unity. kilogram é gravado, mas volta como null nas respostas.

Valores aceitos: unity, centimeter, meter, liter, milliliter, kilogram.

valuenumberobrigatório

Valor unitário.

archivedbooleanobrigatório

Arquiva o produto ou serviço.

externalobject
Campos de external
idstring

Identificador no seu sistema.

Até 100 caracteres.Aceita: null.

storageProductslista de objetos

Saldo inicial em cada estoque. Só é considerado na criação de produtos (type: product) em contas com o módulo de controle de estoque: a API registra uma movimentação de entrada por item. Ignorado na atualização.

Campos de storageProducts
storageobjectobrigatório
Campos de storage
idstringobrigatório

Identificador do estoque.

quantitynumberobrigatório

Quantidade de entrada.

minimalQuantitynumber

Quantidade mínima do produto no estoque.

Aceita: null.

minimalQuantityAtRisknumber

Quantidade a partir da qual o estoque é considerado em risco.

Aceita: null.

Respostas

  • 200

    Produto ou serviço atualizado.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 422

    Identificador inválido ou de outra conta na URL (uriValidationErr), registro inexistente (resourceValidationErr com message: product/service not found; não há 404) ou corpo inválido.

    resourceValidationErr →
  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.