Pular para o conteúdo principal

Valor em estoque de um depósito

GEThttps://carchost.fieldcontrol.com.br/storages-v2/{id}/total-value

Soma o valor em estoque de um depósito, considerando só produtos não arquivados. Um identificador que não é de um depósito da conta retorna 0; um identificador malformado resulta em erro 500. Requer o módulo de controle de estoque.

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

Requisição​

Parâmetros de caminho

idstringobrigatório

Identificador do depósito.

Exemplo: MWY5ZGE5YzgtZDY3MC00NWJhLTk0MGUtNzQxYjk3ODI0MzllOjIyOTE1.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Respostas

  • 200

    Valor total do depósito.

  • 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

    Erro de validação. Conta sem o módulo de controle de estoque: resourceNotAllowed.

    resourceValidationErr →
  • 429

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

  • 500

    Erro inesperado no servidor.