# Lista as composições

Retorna as composições de um produto específico com filtros opcionais.

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

## Path parameters:

  - `productId` (integer, required)
    Identificador único do produto.
    Example: 3

## Query parameters:

  - `search` (string)
    Termo de busca para filtrar composições (pode ser código de barras, nome, etc.).
    Example: "5981945248564"

  - `items_id` (string)
    Identificador específico do item para filtrar.
    Example: "1,2,3"

  - `barcode` (string)
    Código de barras para filtrar composições.
    Example: "5981945248564"

  - `categories_id` (string)
    Identificador da categoria para filtrar composições.
    Example: "1,2,3"

  - `withComponent` (boolean)
    Incluir informações detalhadas dos componentes.
    Example: true

  - `withDisabled` (boolean)
    Incluir composições desabilitadas na resposta.
    Example: true

## Response 200 fields (application/json):

  - `data` (object)
    Dados da resposta.

  - `data.product` (object)
    Dados do produto principal.

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

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

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

  - `data.product.category` (object)
    Categoria do produto.

  - `data.product.category.id` (integer)
    Identificador único da categoria.
    Example: 7

  - `data.product.category.name` (string)
    Nome da categoria.
    Example: "Mercadoria para Revenda"

  - `data.product.image_url` (null,string)
    URL da imagem do produto.

  - `data.product.unitary_value` (object)
    Valor unitário do produto.

  - `data.product.unitary_value.amount` (number, required)
    Valor expresso como um número decimal das principais unidades monetárias
    Example: 99.95

  - `data.product.unitary_value.currency` (string, required)
    Código de moeda de 3 letras conforme definido pela ISO-4217
    Example: "BRL"

  - `data.max_remove_components` (integer)
    Número máximo de componentes que podem ser removidos.
    Example: 4

  - `data.compositions` (array)
    Lista das composições do produto.

  - `data.compositions.id` (integer)
    Identificador único da composição.
    Example: 2

  - `data.compositions.id_component` (integer)
    Identificador do componente.
    Example: 5

  - `data.compositions.amount` (number)
    Quantidade do componente na composição.
    Example: 1.05

  - `data.compositions.value` (object)
    Valor do componente na composição.

  - `data.compositions.disabled` (boolean)
    Indica se o componente está desabilitado.

  - `data.compositions.is_optional` (boolean)
    Indica se o componente é opcional.
    Example: true

  - `data.compositions.order` (integer)
    Ordem do componente na composição.
    Example: 126

  - `data.compositions.component` (object)
    Dados completos do produto componente.

  - `data.compositions.component.id` (integer)
    Identificador único do produto componente.
    Example: 5

  - `data.compositions.component.name` (string)
    Nome do produto componente.
    Example: "Penas"

  - `data.compositions.component.sku` (string)
    Código SKU do produto componente.
    Example: "5"

  - `data.compositions.component.category` (object)
    Categoria do produto componente.

  - `data.compositions.component.image_url` (null,string)
    URL da imagem do produto componente.

  - `data.compositions.component.unitary_value` (object)
    Valor unitário do produto componente.

## 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