Pular para o conteúdo principal

Atualizar uma peça

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

Atualiza uma peça. Envie só os campos que vão mudar. Os tipos de equipamento são alterados pelos endpoints próprios.

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 da peça.

Exemplo: YjJjM2Q0ZTUtZjZhNy04OTAxLWJjZGUtZjEyMzQ1Njc4OTAxOjIyOTE1.

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.

namestring

Nome da peça. Deve ser único na conta.

codestring

Código da peça. Deve ser único na conta.

partTypeIdstring

Identificador do tipo de peça.

descriptionstring

Descrição da peça.

imageUrlstring

URL da imagem da peça.

usageConditionstring

Condição de uso.

Valores aceitos: new, semi_new, used, refurbished, defective.

valuenumber

Valor unitário.

externalIdstring

Identificador da peça no seu sistema.

archivedboolean

Arquiva a peça.

minimalQuantitynumber

Quantidade mínima em estoque. Não pode ser negativa.

minimalQuantityAtRisknumber

Quantidade a partir da qual o estoque é considerado em risco. Não pode ser negativa.

equipmentTypeIdslista de string

Ignorado na atualização. Use os endpoints de tipos de equipamento da peça.

customFieldslista de objetos

Campos customizados. Quando enviado, substitui todos os campos atuais.

Campos de customFields
namestring

Nome do campo.

valuestring

Valor do campo.

typestringobrigatório

Tipo do campo. Ausente ou fora desta lista resulta em erro 500 e nada é gravado.

Valores aceitos: question, multiple-choice, date, number.

positioninteger

Posição de exibição. Padrão é a ordem no array, a partir de 1.

Respostas

  • 200

    Peça atualizada.

  • 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

    Corpo inválido, com as mesmas regras da criação (resourceValidationErr); quantidade mínima negativa; identificador da URL inválido (property: @.id). Peça inexistente: 422 resourceNotFound (não há 404). Identificador inválido ou de outra conta: uriValidationErr.

  • 429

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

  • 500

    Erro inesperado no servidor.