Skip to main content
POST
/
boms
Create a BOM
curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/boms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "items": [
    {
      "product_id": 123,
      "quantity": 1,
      "sku": "<string>",
      "note": "<string>",
      "uom_id": 123,
      "order": 1
    }
  ],
  "extra_costs": [
    {
      "name": "<string>",
      "quantity": 1,
      "unit_price": 1
    }
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "items": [
      {
        "id": 123,
        "bom_id": 123,
        "product_id": 123,
        "quantity": 123,
        "product": {
          "id": 123,
          "name": "<string>",
          "sku": "<string>",
          "description": "<string>"
        },
        "base_quantity": 123,
        "note": "<string>",
        "uom_id": 123,
        "unit_of_measure": {
          "id": 123,
          "name": "<string>"
        },
        "order": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "extra_costs": [
      {
        "id": 123,
        "name": "<string>",
        "quantity": 123,
        "unit_price": 123,
        "line_total": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To obtain a token, contact [email protected]

Body

application/json
name
string
required

BOM name (must be unique)

Maximum string length: 255
items
object[]
required

BOM items (components/products)

Minimum array length: 1
extra_costs
object[] | null

Additional costs associated with the BOM

Response

Successful response

data
object