Pular para o conteúdo principal

Criar uma unidade de peça

POSThttps://carchost.fieldcontrol.com.br/part-units

Cadastra uma unidade física de uma peça, opcionalmente já em um estoque.

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.

partIdstringobrigatório

Identificador da peça.

codestringobrigatório

Código da unidade (ex. número de série).

descriptionstring

Descrição da unidade.

usageConditionstring

Condição de uso.

Valores aceitos: new, semi_new, used, refurbished, defective.Padrão: new.

valuenumber

Valor da unidade.

storageIdstring

Estoque de entrada. Com estoque, a API registra uma movimentação de entrada e a unidade fica available (ou under_review em estoque de triagem); sem estoque, fica available.

externalIdstring

Identificador da unidade no seu sistema.

archivedboolean

Arquiva a unidade.

Padrão: false.

Respostas

  • 201

    Unidade de 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): partId ou code ausentes (reason: missing required field), peça ou estoque inexistentes, usageCondition inválida, ou campo de situação enviado (reason: transition field not allowed in create/update).

  • 429

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

  • 500

    Erro inesperado no servidor.