Megaventory API v2017a

<back to all web services

ProductCategoryGet

Gets information on existing product categoriesUses your API Key and some Filters in an array format and returns the search results using 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 DiscountID descending order.

Examples:



A.

Get all the existing product categories (as mvProductCategories objects).

Value: 

{}


Response: 

{
   "mvProductCategories": [
      {
         "ProductCategoryID": 14,
         "ProductCategoryName": "Double Sided DVDs",
         "ProductCategoryDescription": ""
      },
      {
         "ProductCategoryID": 13,
         "ProductCategoryName": "Gold Colored Cases",
         "ProductCategoryDescription": "DVD/Bluray cases in gold color."
      },
      {
         "ProductCategoryID": 12,
         "ProductCategoryName": "DVD bundles",
         "ProductCategoryDescription": "DVD bundles"
      },
      {
         "ProductCategoryID": 11,
         "ProductCategoryName": "DVDs in Case",
         "ProductCategoryDescription": "DVDs in Case"
      },
      {
         "ProductCategoryID": 10,
         "ProductCategoryName": "Cases",
         "ProductCategoryDescription": "Cases"
      },
      {
         "ProductCategoryID": 9,
         "ProductCategoryName": "DVDs",
         "ProductCategoryDescription": "DVDs"
      }
   ],
   "ResponseStatus": {
      "ErrorCode": "0"
   }
}


B.

Returns the first mvProductCategory object with a ProductCategoryName that contains "case" with a description which contains the word "DVD".
We can add two Filters by using the AndOr operator as shown below:

Value: 

 {
   "Filters": [
      {
         "FieldName": "ProductCategoryName",
         "SearchOperator": "Contains",
         "SearchValue": "case"
      },
      {
         "AndOr": "And",
         "FieldName": "ProductCategoryDescription",
         "SearchOperator": "Contains",
         "SearchValue": "DVD"
      }
   ],
   "ReturnTopNRecords": 1
}


Response: 

{
   "mvProductCategories": [
      {
         "ProductCategoryID": 13,
         "ProductCategoryName": "Gold Colored Cases",
         "ProductCategoryDescription": "DVD/Bluray cases in gold color."
      }
   ],
   "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>

<ProductCategoryGet 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>
  <showDeleted>showOnlyUndeleted</showDeleted>
</ProductCategoryGet>

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

<ProductCategoryGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvProductCategories xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:mvProductCategory>
      <d2p1:ProductCategoryID>0</d2p1:ProductCategoryID>
      <d2p1:ProductCategoryName>String</d2p1:ProductCategoryName>
      <d2p1:ProductCategoryDescription>String</d2p1:ProductCategoryDescription>
    </d2p1:mvProductCategory>
  </mvProductCategories>
  <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>
</ProductCategoryGetResponse>

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