Megaventory API v2017a

<back to all web services

CustomReportGetData

Gets Custom Report DataUses your API key and a CustomReportId to return data based on the Custom Report. If the Custom Report has parameters, you can specify them using the CustomReportParameters object. Optionally, you may use the Page and Limit parameters to control the data you receive. Use Page to specify a subset of data and Limit to set the maximum number of entries (up to 1000) for that subset.

Date1 and Date2 should be in format "yyyy-MM-dd".

Examples:



Return the first three rows of data from a Custom Report with ID 12345, passing parameters for Text1, Date1, and Date2.
Text1 is a string and has a value of 18.
Date1 is a date and has a value of 2025 January 1st.
Date2 is a date and has a value of 2025 May 1st.


Value: 

 {
  "CustomReportId": "12345",
  "CustomReportParameters": {
    "Text1": "18",
    "Date1": "2025-01-01",
    "Date2": "2025-05-01"
  },
  "Page": 1,
  "Limit": 3
}

Response: 

{
  "Rows": [
    {
      "Index": 0,
      "Data": [
        {
          "ColumnId": "0",
          "ColumnName": "ID",
          "Value": 34168
        },
        {
          "ColumnId": "1",
          "ColumnName": "SKU",
          "Value": "48813623343"
        },
        {
          "ColumnId": "2",
          "ColumnName": "Barcode",
          "Value": "234rdsw388"
        }
      ]
    },
    {
      "Index": 1,
      "Data": [
        {
          "ColumnId": "0",
          "ColumnName": "ID",
          "Value": 34356
        },
        {
          "ColumnId": "1",
          "ColumnName": "SKU",
          "Value": "6564534434"
        },
        {
          "ColumnId": "2",
          "ColumnName": "Barcode",
          "Value": "sdfs56"
        }
      ]
    },
    {
      "Index": 2,
      "Data": [
        {
          "ColumnId": "0",
          "ColumnName": "ID",
          "Value": 34100
        },
        {
          "ColumnId": "1",
          "ColumnName": "SKU",
          "Value": "233324354"
        },
        {
          "ColumnId": "2",
          "ColumnName": "Barcode",
          "Value": "gb65g53"
        }
      ]
    }
  ],
  "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>

<CustomReportGetData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <APIKEY>String</APIKEY>
  <CustomReportId>0</CustomReportId>
  <CustomReportParameters xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:Date1>String</d2p1:Date1>
    <d2p1:Date2>String</d2p1:Date2>
    <d2p1:MultipleValues1 xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:MultipleValues1>
    <d2p1:Text1>String</d2p1:Text1>
    <d2p1:Text2>String</d2p1:Text2>
    <d2p1:Text3>String</d2p1:Text3>
    <d2p1:Text4>String</d2p1:Text4>
  </CustomReportParameters>
  <Page>0</Page>
  <Limit>0</Limit>
</CustomReportGetData>

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

<CustomReportGetDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <Rows xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:MvCustomReportRow>
      <d2p1:Data>
        <d2p1:MvCustomReportColumn>
          <d2p1:ColumnId>String</d2p1:ColumnId>
          <d2p1:ColumnName>String</d2p1:ColumnName>
          <d2p1:Value />
        </d2p1:MvCustomReportColumn>
      </d2p1:Data>
      <d2p1:Index>0</d2p1:Index>
    </d2p1:MvCustomReportRow>
  </Rows>
  <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>
</CustomReportGetDataResponse>

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