Pular para o conteúdo principal

Criar uma peça

POSThttps://carchost.fieldcontrol.com.br/parts

Cria uma peça, já com os tipos de equipamento em que pode ser instalada e os campos customizados.

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

Requisição​

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 da peça. Deve ser único na conta.

codestringobrigatório

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

partTypeIdstringobrigatório

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.Padrão: new.

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

Identificadores dos tipos de equipamento em que a peça pode ser instalada. Só é considerado na criação.

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

  • 201

    Peça criada.

  • 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 (resourceValidationErr): name, code ou partTypeId ausentes (reason: missing required field), name ou code já usados na conta (reason: duplicate), tipo de peça inexistente ou usageCondition inválida.

  • 429

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

  • 500

    Erro inesperado no servidor.