Pular para o conteúdo principal

Atualizar um produto

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

Atualiza um produto. Envie o produto completo: o corpo segue as mesmas regras da criação.

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.

Exemplo: MzYzMjgxZGEtNzIxMS00ZTU5LTg0MzMtYjc5Y2UyYTEwYzk0OjIyOTE1.

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.

Até 100 caracteres.

descriptionstring

Descrição do produto.

Até 2000 caracteres.

codestringobrigatório

Código do produto. Deve ser único entre os produtos da conta.

measurestringobrigatório

Unidade de medida. 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 do produto.

archivedbooleanobrigatório

Arquiva o produto.

externalobject
Campos de external
idstring

Identificador do produto no seu sistema.

Até 100 caracteres.Aceita: null.

productTypeobjectobrigatório

Tipo do produto, por id ou por name. Com name, a API usa o primeiro tipo da conta cujo nome contém o texto informado, sem diferenciar maiúsculas e minúsculas.

Campos de productType
idstring

Identificador do tipo de produto.

namestring

Nome (ou parte do nome) do tipo de produto.

Respostas

  • 200

    Produto 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), produto inexistente (resourceValidationErr com message: product/service not found; não há 404), corpo inválido ou code já usado por outro produto da conta.

    resourceValidationErr →
  • 429

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

  • 500

    Erro inesperado no servidor.