List all BOMs for an entity
GEThttps://sight.inspectorio.com/api/v1/customer-data/:entity_type/:entity_custom_id/boms
List all BOMs for an entity
Request​
Path Parameters
entity_type schemas-EntityTyperequired
Possible values: [product
, item
, material
]
entity_custom_id stringrequired
The custom ID of the entity that the BOM is attached to
Responses​
- 200
- 400
- 401
- 404
- 500
List of BOMs
- application/json
- Schema
- Example (auto)
Schema
results object[]
countinteger
nextstringnullable
previousstringnullable
{
"results": [
{
"customId": "string",
"name": "string",
"description": "string",
"enabled": true,
"createdAt": "2024-07-29T15:51:28.071Z",
"productType": "string",
"productCustomId": "string",
"poNumber": "string",
"attachments": [
{
"fileName": "string",
"fileUrl": "string"
}
],
"contributions": [
{
"role": "bom_editor",
"orgCustomId": "string"
}
],
"components": [
{
"customId": "string",
"name": "string",
"description": "string",
"supplierComponentId": "string",
"group": "string",
"unitYield": 0,
"yieldUom": "string",
"unitWeight": 0,
"weightUom": "string",
"unitCost": 0,
"totalYield": 0,
"totalWeight": 0,
"costCurrency": "string",
"supplier": {
"name": "string",
"customId": "string",
"address": "string",
"city": "string",
"stateProvince": "string",
"postalZipCode": "string",
"country": "string",
"phone": "string",
"contactName": "string",
"contactEmail": "string",
"contactPhone": "string"
},
"facilities": [
{
"name": "string",
"capabilities": [
"string"
],
"customId": "string",
"address": "string",
"city": "string",
"stateProvince": "string",
"postalZipCode": "string",
"country": "string",
"phone": "string",
"contactName": "string",
"contactEmail": "string",
"contactPhone": "string"
}
]
}
]
}
],
"count": 0,
"next": "string",
"previous": "string"
}
Bad Request
- application/json
- Schema
- Example (auto)
Schema
customIdstring[]
Error messages for custom ID field
Example:
["BOM with custom_id 'BOM-001' already exists for this product and purchase order"]
namestring[]
Error messages for name field
Example:
["BOM with name 'Manufacturing BOM for Winter Line' already exists for this product and purchase order"]
activestring[]
Error messages for active field
Example:
["This field is required."]
productTypestring[]
Error messages for product type field
Example:
["This field is required."]
productCustomIdstring[]
Error messages for product custom ID field
Example:
["This field is required."]
attachments object[]
contributions object[]
orgCustomIdstring[]
Error messages for local org custom ID
Example:
["Local organization with custom ID 'non_existent_org' not found"]
{
"customId": [
"BOM with custom_id 'BOM-001' already exists for this product and purchase order"
],
"name": [
"BOM with name 'Manufacturing BOM for Winter Line' already exists for this product and purchase order"
],
"active": [
"This field is required."
],
"productType": [
"This field is required."
],
"productCustomId": [
"This field is required."
],
"attachments": [
{
"fileId": [
"File not found: 550e8400-e29b-41d4-a716-446655440000"
]
}
],
"contributions": [
{
"role": [
"This field is required."
],
"orgCustomId": [
"This field is required."
]
}
],
"orgCustomId": [
"Local organization with custom ID 'non_existent_org' not found"
]
}
Unauthorized
Not Found
- application/json
- Schema
- Example (auto)
Schema
detailstring
Example:
Not found.
{
"detail": "Not found."
}
Internal Server Error
Authorization: apiKey
name: apiKeytype: apiKeyin: header
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L 'https://sight.inspectorio.com/api/v1/customer-data/:entity_type/:entity_custom_id/boms' \
-H 'Accept: application/json' \
-H 'apiKey: <apiKey>'
ResponseClear