Pular para o conteúdo principal

Efetuar uma transferência por identificador externo

POSThttps://carchost.fieldcontrol.com.br/storages-movements-v2/transfers

Transfere um ou mais produtos entre dois depósitos, identificando depósitos e produtos pelo external.id cadastrado. Cada item gera uma saída na origem e uma entrada no destino. Requer o módulo de controle de 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.

originStorageExternalIdstringobrigatório

Identificador externo (external.id) do depósito de origem.

destinationStorageExternalIdstringobrigatório

Identificador externo (external.id) do depósito de destino.

notesstring

Observação gravada como descrição das movimentações.

itemslista de objetosobrigatório

Produtos transferidos. A transferência é atômica; se um item falhar, nada é gravado.

Campos de items
productExternalIdstringobrigatório

Identificador externo (external.id) do produto.

quantitynumberobrigatório

Quantidade transferida. Inteira para produtos medidos em unidade; até 3 casas decimais para as demais.

unitCostnumber

Custo unitário informado ao seu sistema de origem. Não altera o valor do produto no Field Control.

Respostas

  • 201

    Transferência efetuada.

  • 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): depósitos ou itens ausentes (reason: missing field), depósito ou produto não encontrado pelo identificador externo (reason: not found), produto sem saldo ou com saldo menor que a quantidade na origem (reason: Invalid removal), ou quantidade com casas decimais demais. Conta sem o módulo de controle de estoque: resourceNotAllowed.

  • 429

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

  • 500

    Erro inesperado no servidor.