Pular para o conteúdo principal

Adicionar um produto à ordem

POSThttps://carchost.fieldcontrol.com.br/orders/{id}/products-v2

Adiciona um produto à ordem de serviço e recalcula os totais. Em contas com o módulo de controle de estoque, retira o produto do depósito informado. Uma ordem aceita até 150 produtos.

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 ordem de serviço.

Exemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

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.

productobjectobrigatório
Campos de product
idstringobrigatório

Identificador do produto.

quantitynumberobrigatório

Quantidade.

valuenumber ou string

Valor unitário. Omitido usa o valor do produto; null grava 0. Em contas com o módulo de controle de estoque, é sempre o valor do produto.

Aceita: null.

storageobject

Depósito de onde o produto sai. Obrigatório em contas com o módulo de controle de estoque: a API registra uma movimentação de saída e recusa quantidades maiores que o saldo.

Campos de storage
idstringobrigatório
descriptionstring

Descrição gravada na movimentação de estoque.

Respostas

  • 201

    Produto adicionado.

  • 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.

  • 404

    Recurso não encontrado. O corpo da resposta é vazio.

  • 422

    Corpo inválido (resourceValidationErr): produto inexistente, já adicionado (reason: already exists), limite de 150 produtos, ou, com controle de estoque, depósito ausente, produto sem saldo no depósito ou quantidade maior que o saldo (reason: not enough). Identificador da ordem inválido: uriValidationErr.

  • 429

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

  • 500

    Erro inesperado no servidor.