---
title: "POST /api/bom-lines/list"
method: POST
path: "/api/bom-lines/list"
tags: ["Products/BOM-Lines"]
---

# POST /api/bom-lines/list

`POST /api/bom-lines/list`

## Request body

- object
  - `limit` integer — Number of results per page. The default and maximum vary per endpoint.
  - `page` integer — Page number (1-based). Defaults to 1.
  - `order` 'asc' | 'desc' | 'ASC' | 'DESC'
  - `sort` 'quantity' | 'weight' | 'createdAt' | 'updatedAt'
  - `bomHeaderId` string
  - `placementId` string
  - `styleId` string
  - `countryOfOrigin` string
  - `isMainComponent` boolean
  - `include` string[]

## Response `200`

Default Response

- object
  - `metadata` object, required
    - `success` boolean, required — True when the request succeeded.
    - `pagination` object
      - `page` number, required — Current page number (1-based).
      - `limit` number, required — Page size used for this response. Endpoint defaults vary — see each endpoint's limit parameter.
      - `total` number, required — Total number of records across all pages.
      - `totalPages` number, required — Total number of pages. Iterate until page reaches totalPages.
  - `data` object[], required
    - `id` string, required
    - `bomHeaderId` string, required
    - `placementId` string, required
    - `styleId` string, required
    - `quantity` number, required
    - `quantityUnit` string, required
    - `weight` number, required
    - `weightUnit` string, required
    - `countryOfOrigin` string, required
    - `isMainComponent` boolean, required
    - `createdAt` string, required
    - `createdByUserId` string, required
    - `createdByCompanyId` string, required
    - `updatedAt` string, required
    - `updatedByUserId` string, required
    - `updatedByCompanyId` string, required
    - `entity` object
      - `id` string, required
      - `externalId` string
      - `forCompanyId` string, required
      - `codes` object[], required
        - `codeId` string, required
        - `codeValue` string, required
      - `name` string, required
      - `suppliers` string[], required
      - `mainSupplier` string, required
      - `type` object — The component's style type. `quantityUnits` and `weightUnits` are the units this line's `quantityUnit`/`weightUnit` accept — the UoMs configured for the style type, or the platform-wide lists when it has none.
        - `id` string, required
        - `name` string, required
        - `quantityUnits` string[], required
        - `weightUnits` string[], required
    - `placement` object
      - `id` string, required
      - `value` string, required
      - `forCompanyId` string, required

---

[API](https://skmtc.net/retraced/apis/api-reference.md) · [All operations](https://skmtc.net/retraced/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/retraced/api-reference/revisions/60d6c901bc4e/schema)