Pular para o conteúdo principal

Efetuar uma movimentação

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

Registra uma entrada, uma saída ou uma transferência entre depósitos e atualiza o saldo do produto. O valor da movimentação é calculado pelo valor unitário do produto. 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.

typestringobrigatório

entry (entrada), removal (saída) ou transfer (transferência do depósito storageRemoval para o depósito storage).

Valores aceitos: entry, removal, transfer.

quantitynumberobrigatório

Quantidade, maior que zero. Inteira para produtos medidos em unidade; até 3 casas decimais para as demais medidas.

productobjectobrigatório
Campos de product
idstringobrigatório

Identificador do produto.

storageobjectobrigatório

Depósito da movimentação. Na transferência, é o depósito de destino.

Campos de storage
idstringobrigatório

Identificador do depósito.

storageRemovalobject

Depósito de origem. Obrigatório quando type é transfer, e diferente de storage.

Campos de storageRemoval
idstringobrigatório

Identificador do depósito de origem.

orderobject

Ordem de serviço vinculada à movimentação.

Campos de order
idstring

Identificador da ordem de serviço.

identifierstring

Identificador livre da movimentação no seu processo.

Até 255 caracteres.Aceita: null.

descriptionstring

Descrição da movimentação.

Até 1000 caracteres.Aceita: null.

externalobject
Campos de external
idstring

Identificador da movimentação no seu sistema.

Aceita: null.

minimalQuantitynumber

Quantidade mínima do produto no depósito. Só é considerada na primeira entrada do produto no depósito.

minimalQuantityAtRisknumber

Quantidade a partir da qual o estoque é considerado em risco; precisa ser maior que minimalQuantity. Só é considerada na primeira entrada do produto no depósito.

Respostas

  • 201

    Movimentação criada. Em type: transfer, a resposta é a transferência (StorageMovementTransfer), com os identificadores da saída e da entrada.

  • 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): produto, depósito ou ordem inexistentes (reason: not found), saída maior que o saldo ou de produto sem saldo (reason: Invalid removal), quantidade com casas decimais demais, ou transferência sem storageRemoval ou com depósitos iguais. 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.