List all BOMs for an entity

GET 
https://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

List of BOMs

application/json

Schema

Schema

results object[]
Array [
customIdstring
Custom ID of the BOM
namestring
Name of the BOM
descriptionstring
Description of the BOM
enabledboolean
Is the BOM active
createdAtdate-time
Created at date of the BOM
productTypestring
Product type of the BOM
productCustomIdstring
Custom ID of the product (item/style)
poNumberstring
Purchase order number of the BOM
attachments object[]
Attachments of the BOM
Array [
fileNamestring
File name of the attachment
fileUrlstring
URL of the attachment
]
contributions object[]
Contributors of the BOM
Array [
rolestring
Role of the contributor
Possible values: [bom_editor, bom_viewer]
orgCustomIdstringnullable
Custom ID of the contributor org
]
components object[]
Components of the BOM
Array [
customIdstring
Custom ID of the component
namestring
Name of the component
descriptionstring
Description of the component
supplierComponentIdstring
Supplier component ID
groupstring
Group of the component
unitYieldnumber
Unit yield of the component
yieldUomstring
Yield unit of the component
unitWeightnumber
Unit weight of the component
weightUomstring
Weight unit of the component
unitCostnumber
Unit cost of the component
totalYieldnumber
Total yield of the component
totalWeightnumber
Total weight of the component
costCurrencystring
Cost currency of the component
supplier object
namestring
Name of the supplier
customIdstring
Custom ID of the supplier
addressstring
Address of the supplier
citystring
City of the supplier
stateProvincestring
State/Province of the supplier
postalZipCodestring
Postal/Zip code of the supplier
countrystring
Country of the supplier
phonestring
Phone of the supplier
contactNamestring
Contact name of the supplier
contactEmailstring
Contact email of the supplier
contactPhonestring
Contact phone of the supplier
facilities object[]
Facilities of the component
Array [
namestring
Name of the facility
capabilitiesstring[]
Capabilities of the facility
customIdstring
Custom ID of the facility
addressstring
Address of the facility
citystring
City of the facility
stateProvincestring
State/Province of the facility
postalZipCodestring
Postal/Zip code of the facility
countrystring
Country of the facility
phonestring
Phone of the facility
contactNamestring
Contact name of the facility
contactEmailstring
Contact email of the facility
contactPhonestring
Contact phone of the facility
]
bom
]
]
countinteger
nextstringnullable
previousstringnullable

Example (auto)

{
  "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"
}

400

Bad Request

application/json

Schema

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[]
Array [
fileIdstring[]
Error messages for file ID field
Example: ["File not found: 550e8400-e29b-41d4-a716-446655440000"]
]
contributions object[]
Array [
rolestring[]
orgCustomIdstring[]
]
orgCustomIdstring[]
Error messages for local org custom ID
Example: ["Local organization with custom ID 'non_existent_org' not found"]

Example (auto)

{
  "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"
  ]
}

401

Unauthorized

404

Not Found

application/json

Schema

Schema

detailstring
Example: Not found.

Example (auto)

{
  "detail": "Not found."
}

500

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>'

Request Collapse all

Base URL

https://sight.inspectorio.com

Auth

ApiKeyAuth

Parameters

entity_type — pathrequired

---productitemmaterial

entity_custom_id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!