GET v2/BomMasters?fields={fields}&where={where}&order={order}&page={page}&rows={rows}
Get a list of BOM Masters.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
fields |
A comma-separated list of field names |
string |
None. |
where |
A where clause |
string |
None. |
order |
An order by clause |
string |
None. |
page |
The page number (default: 1) |
integer |
Default value is 1 |
rows |
Rows per page (default: 50, maximum: 250) |
integer |
Default value is 50 |
Body Parameters
None.
Response Information
Resource Description
Collection of BomMasterV2| Name | Description | Type | Additional information |
|---|---|---|---|
Products |
Collection of BomProduct |
None. |
|
Id |
A unique Job ID. |
integer |
None. |
CreatedDate |
Created date time. |
date |
None. |
ModifiedDate |
Last modified date time. |
date |
None. |
CreatedBy |
Created by User ID. |
integer |
None. |
ModifiedBy |
Modified by User ID. |
integer |
None. |
ProductionNotes |
Production Notes. |
string |
None. |
Reference |
The unique Job reference. |
string |
Max length: 20 |
Response Formats
application/json, text/json
Sample:
[
{
"products": [
{
"id": 1,
"productId": 4,
"productOptionId": 5,
"type": "Undefined",
"sort": 6,
"code": "sample string 7",
"name": "sample string 8",
"option1": "sample string 9",
"option2": "sample string 10",
"option3": "sample string 11",
"notes": "sample string 12",
"qty": 13.0,
"unitCost": 14.0,
"components": [
{
"id": 2,
"productId": 5,
"productOptionId": 6,
"type": "Undefined",
"sort": 7,
"code": "sample string 8",
"name": "sample string 9",
"option1": "sample string 10",
"option2": "sample string 11",
"option3": "sample string 12",
"notes": "sample string 13",
"qty": 14.0,
"unitCost": 15.0
},
{
"id": 2,
"productId": 5,
"productOptionId": 6,
"type": "Undefined",
"sort": 7,
"code": "sample string 8",
"name": "sample string 9",
"option1": "sample string 10",
"option2": "sample string 11",
"option3": "sample string 12",
"notes": "sample string 13",
"qty": 14.0,
"unitCost": 15.0
}
]
},
{
"id": 1,
"productId": 4,
"productOptionId": 5,
"type": "Undefined",
"sort": 6,
"code": "sample string 7",
"name": "sample string 8",
"option1": "sample string 9",
"option2": "sample string 10",
"option3": "sample string 11",
"notes": "sample string 12",
"qty": 13.0,
"unitCost": 14.0,
"components": [
{
"id": 2,
"productId": 5,
"productOptionId": 6,
"type": "Undefined",
"sort": 7,
"code": "sample string 8",
"name": "sample string 9",
"option1": "sample string 10",
"option2": "sample string 11",
"option3": "sample string 12",
"notes": "sample string 13",
"qty": 14.0,
"unitCost": 15.0
},
{
"id": 2,
"productId": 5,
"productOptionId": 6,
"type": "Undefined",
"sort": 7,
"code": "sample string 8",
"name": "sample string 9",
"option1": "sample string 10",
"option2": "sample string 11",
"option3": "sample string 12",
"notes": "sample string 13",
"qty": 14.0,
"unitCost": 15.0
}
]
}
],
"id": 1,
"createdDate": "2025-11-27T05:54:38.5581274+13:00",
"modifiedDate": "2025-11-27T05:54:38.5581274+13:00",
"createdBy": 3,
"modifiedBy": 4,
"productionNotes": "sample string 5",
"reference": "sample string 6"
},
{
"products": [
{
"id": 1,
"productId": 4,
"productOptionId": 5,
"type": "Undefined",
"sort": 6,
"code": "sample string 7",
"name": "sample string 8",
"option1": "sample string 9",
"option2": "sample string 10",
"option3": "sample string 11",
"notes": "sample string 12",
"qty": 13.0,
"unitCost": 14.0,
"components": [
{
"id": 2,
"productId": 5,
"productOptionId": 6,
"type": "Undefined",
"sort": 7,
"code": "sample string 8",
"name": "sample string 9",
"option1": "sample string 10",
"option2": "sample string 11",
"option3": "sample string 12",
"notes": "sample string 13",
"qty": 14.0,
"unitCost": 15.0
},
{
"id": 2,
"productId": 5,
"productOptionId": 6,
"type": "Undefined",
"sort": 7,
"code": "sample string 8",
"name": "sample string 9",
"option1": "sample string 10",
"option2": "sample string 11",
"option3": "sample string 12",
"notes": "sample string 13",
"qty": 14.0,
"unitCost": 15.0
}
]
},
{
"id": 1,
"productId": 4,
"productOptionId": 5,
"type": "Undefined",
"sort": 6,
"code": "sample string 7",
"name": "sample string 8",
"option1": "sample string 9",
"option2": "sample string 10",
"option3": "sample string 11",
"notes": "sample string 12",
"qty": 13.0,
"unitCost": 14.0,
"components": [
{
"id": 2,
"productId": 5,
"productOptionId": 6,
"type": "Undefined",
"sort": 7,
"code": "sample string 8",
"name": "sample string 9",
"option1": "sample string 10",
"option2": "sample string 11",
"option3": "sample string 12",
"notes": "sample string 13",
"qty": 14.0,
"unitCost": 15.0
},
{
"id": 2,
"productId": 5,
"productOptionId": 6,
"type": "Undefined",
"sort": 7,
"code": "sample string 8",
"name": "sample string 9",
"option1": "sample string 10",
"option2": "sample string 11",
"option3": "sample string 12",
"notes": "sample string 13",
"qty": 14.0,
"unitCost": 15.0
}
]
}
],
"id": 1,
"createdDate": "2025-11-27T05:54:38.5581274+13:00",
"modifiedDate": "2025-11-27T05:54:38.5581274+13:00",
"createdBy": 3,
"modifiedBy": 4,
"productionNotes": "sample string 5",
"reference": "sample string 6"
}
]
