# Obtém saldo em estoque

Obtém informações sobre a quantidade produto em todos os estoques.

Endpoint: GET /api/v3/products/{productId}/balance
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Path parameters:

  - `productId` (integer, required)
    ID do produto.

## Response 200 fields (application/json):

  - `data` (object)
    Representa um produto nos estoques;

  - `data.product` (object)
    Informações de produto.

  - `data.product.id` (integer)
    Identificador único do produto na CPlug.
    Example: 1

  - `data.product.name` (string)
    Nome do produto.
    Example: "Produto simples"

  - `data.product.sku` (string)
    Código do produto.
    Example: "A747"

  - `data.product.unit_of_measure` (object)
    Unidade de medida do produto.

  - `data.product.unit_of_measure.abbreviation` (string)
    Símbolo da unidade de medida.
    Example: "Un"

  - `data.product.unit_of_measure.precision` (integer)
    Precisão da unidade de medida.
    Example: 2

  - `data.balance` (number)
    Indica a quantidade total do produto nos estoques.
    Example: 10

  - `data.stocks` (array)
    Lista de estoques.

  - `data.stocks.stock_name` (string)
    Nome do estoque.
    Example: "Estoque padrão"

  - `data.stocks.product_stock_options` (array)
    Lista de estoques.

  - `data.stocks.product_stock_options.balance` (number)
    Indica a quantidade do produto no estoque.
    Example: 10

  - `data.stocks.product_stock_options.options` (array)
    Lista de estoques.

  - `data.stocks.product_stock_options.options.option_id` (number)
    Identificador único da opção.
    Example: 1

  - `data.stocks.product_stock_options.options.name` (string)
    Nome da opção.
    Example: "Opção 01"

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields