Skip to main content
GET
/
api
/
v1
/
bom
List Boms
curl --request GET \
  --url https://staging.cutmake.ai/api/v1/bom
{
  "data": [
    {
      "id": "<string>",
      "documentId": "<string>",
      "currentVersion": 123,
      "versionCount": 123,
      "styleId": "<string>",
      "style": {
        "id": "<string>",
        "documentId": "<string>",
        "name": "<string>",
        "refId": "<string>"
      },
      "latestVersion": {
        "id": "<string>",
        "documentId": "<string>",
        "versionNumber": 123,
        "changeDescription": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "submittedAt": "2023-11-07T05:31:56Z",
        "submittedById": "<string>",
        "approvedById": "<string>",
        "rejectionReason": "<string>"
      },
      "status": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "submittedAt": "2023-11-07T05:31:56Z",
      "createdById": "<string>",
      "submittedById": "<string>",
      "approvedById": "<string>",
      "versions": [
        {
          "id": "<string>",
          "documentId": "<string>",
          "versionNumber": 123,
          "changeDescription": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "createdById": "<string>",
          "status": "<string>",
          "submittedAt": "2023-11-07T05:31:56Z",
          "submittedById": "<string>",
          "approvedById": "<string>",
          "rejectionReason": "<string>",
          "lineItems": [
            {
              "id": "<string>",
              "billOfMaterialVersionId": "<string>",
              "grossConsumption": 123,
              "sellingTolerance": 123,
              "netSellingConsumption": 123,
              "buyingTolerance": 123,
              "netBuyingConsumption": 123,
              "materialCostInNativeCurrency": 123,
              "nativeCurrency": "<string>",
              "materialCostInUsd": 123,
              "estimatedMaterialPreparationLeadTime": 123,
              "assignedMaterialOptions": [
                {}
              ],
              "chosenAssignedMaterialId": "<string>",
              "chosenAssignedSkuId": "<string>",
              "category": "Uncategorized",
              "description": "<string>",
              "unit": "pc"
            }
          ],
          "groupedLineItems": [
            {
              "category": "<string>",
              "items": [
                {
                  "id": "<string>",
                  "billOfMaterialVersionId": "<string>",
                  "grossConsumption": 123,
                  "sellingTolerance": 123,
                  "netSellingConsumption": 123,
                  "buyingTolerance": 123,
                  "netBuyingConsumption": 123,
                  "materialCostInNativeCurrency": 123,
                  "nativeCurrency": "<string>",
                  "materialCostInUsd": 123,
                  "estimatedMaterialPreparationLeadTime": 123,
                  "assignedMaterialOptions": [
                    {}
                  ],
                  "chosenAssignedMaterialId": "<string>",
                  "chosenAssignedSkuId": "<string>",
                  "category": "Uncategorized",
                  "description": "<string>",
                  "unit": "pc"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 2,
    "total": 123
  }
}

Headers

X-Org-Id
string | null

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:25
Required range: 1 <= x <= 100
style_id
string | null
search
string | null

Response

Successful Response

data
BOMResponse · object[]
required
pagination
Pagination · object
required