Megaventory API v2017a

ProductBOMGet

Gets information on a product's bill of materials.

Uses your API Key and some Filters in an array format and returns the search results using the given filters. Optionally, you can use ReturnTopNRecords to limit the number of the results to the specified number (omit, or add ReturnTopNRecords = -1 to get all the available results). The ReturnTopNRecords chooses the top records in a ProductId descending order.

Examples:

A.
Return the first two mvProductBOMs objects whose product SKU contains the the characters "11". The results are returned as mvProductBOMs objects.

Value:

{ "Filters": [ { "FieldName": "Productsku", "SearchOperator": "Contains", "SearchValue": "11" } ], "ReturnTopNRecords": 2 }

Response:

{ "mvProductBOMs": [ { "ProductID": 27412, "ProductSKU": "prod111", "mvRawMaterials": [ { "ProductID": 27396, "ProductSKU": "PROD11", "ProductDescription": "PROD11", "RawMaterialQuantity": 2 } ] } ], "ResponseStatus": { "ErrorCode": "0" } }

To override the Content-type in your clients HTTP Accept Header, append the .soap12 suffix or ?format=soap12

HTTP + SOAP12

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap12 HTTP/1.1 
Host: api.megaventory.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<ProductBOMGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <Filters xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints">
    <Filter>
      <AndOr>And</AndOr>
      <FieldName>String</FieldName>
      <Group>Undefined</Group>
      <SearchOperator>Undefined</SearchOperator>
      <SearchValue>String</SearchValue>
    </Filter>
  </Filters>
  <ReturnTopNRecords xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints">0</ReturnTopNRecords>
  <APIKEY>String</APIKEY>
  <ProductSKU>String</ProductSKU>
  <ProductCategoryID>0</ProductCategoryID>
  <includeReferencedObjects>false</includeReferencedObjects>
</ProductBOMGet>

    </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<ProductBOMGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvProductBOMs xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:mvProductBOM>
      <d2p1:ProductID>0</d2p1:ProductID>
      <d2p1:ProductSKU>String</d2p1:ProductSKU>
      <d2p1:mvRawMaterials>
        <d2p1:mvRawMaterialItem i:nil="true" />
      </d2p1:mvRawMaterials>
    </d2p1:mvProductBOM>
  </mvProductBOMs>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <InternalErrorCode>String</InternalErrorCode>
</ProductBOMGetResponse>

    </soap12:Body>
</soap12:Envelope>