VMIService Web Service

VMIService

Click here for a complete list of operations.

GetProductSalesReport

Test

The test form is only available for methods with primitive types as parameters.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /2.9.2.448/RetailiQ.Integration.VMI/VMIService.asmx HTTP/1.1
Host: vmiinternal176.iqmetrix.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.iqmetrix.com/GetProductSalesReport"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetProductSalesReport xmlns="http://www.iqmetrix.com">
      <Vendor>
        <VendorID>guid</VendorID>
        <Username>string</Username>
        <Password>string</Password>
        <Client>
          <ClientID>guid</ClientID>
          <Name>string</Name>
          <StoreID>int</StoreID>
          <VendorAccountNumber>string</VendorAccountNumber>
        </Client>
      </Vendor>
      <startDate>string</startDate>
      <endDate>string</endDate>
      <channelId>guid</channelId>
      <regionId>int</regionId>
      <districtId>int</districtId>
      <storeId>int</storeId>
    </GetProductSalesReport>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetProductSalesReportResponse xmlns="http://www.iqmetrix.com">
      <GetProductSalesReportResult>
        <ProductSalesReportData>
          <RqInvoiceIdByStore>string</RqInvoiceIdByStore>
          <VendorSKU>string</VendorSKU>
          <ProductSKU>string</ProductSKU>
          <InvoicedBy>string</InvoicedBy>
          <StoreID>int</StoreID>
          <DistrictName>string</DistrictName>
          <DistrictID>int</DistrictID>
          <RegionName>string</RegionName>
          <RegionID>int</RegionID>
          <ChannelName>string</ChannelName>
          <ChannelID>guid</ChannelID>
          <SoldOn>dateTime</SoldOn>
          <ProductItemID>int</ProductItemID>
          <Description>string</Description>
          <TrackingNumber>string</TrackingNumber>
          <Quantity>int</Quantity>
          <ListPrice>double</ListPrice>
          <Refund>boolean</Refund>
          <CategoryPath>string</CategoryPath>
        </ProductSalesReportData>
        <ProductSalesReportData>
          <RqInvoiceIdByStore>string</RqInvoiceIdByStore>
          <VendorSKU>string</VendorSKU>
          <ProductSKU>string</ProductSKU>
          <InvoicedBy>string</InvoicedBy>
          <StoreID>int</StoreID>
          <DistrictName>string</DistrictName>
          <DistrictID>int</DistrictID>
          <RegionName>string</RegionName>
          <RegionID>int</RegionID>
          <ChannelName>string</ChannelName>
          <ChannelID>guid</ChannelID>
          <SoldOn>dateTime</SoldOn>
          <ProductItemID>int</ProductItemID>
          <Description>string</Description>
          <TrackingNumber>string</TrackingNumber>
          <Quantity>int</Quantity>
          <ListPrice>double</ListPrice>
          <Refund>boolean</Refund>
          <CategoryPath>string</CategoryPath>
        </ProductSalesReportData>
      </GetProductSalesReportResult>
    </GetProductSalesReportResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /2.9.2.448/RetailiQ.Integration.VMI/VMIService.asmx HTTP/1.1
Host: vmiinternal176.iqmetrix.net
Content-Type: application/soap+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>
    <GetProductSalesReport xmlns="http://www.iqmetrix.com">
      <Vendor>
        <VendorID>guid</VendorID>
        <Username>string</Username>
        <Password>string</Password>
        <Client>
          <ClientID>guid</ClientID>
          <Name>string</Name>
          <StoreID>int</StoreID>
          <VendorAccountNumber>string</VendorAccountNumber>
        </Client>
      </Vendor>
      <startDate>string</startDate>
      <endDate>string</endDate>
      <channelId>guid</channelId>
      <regionId>int</regionId>
      <districtId>int</districtId>
      <storeId>int</storeId>
    </GetProductSalesReport>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+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>
    <GetProductSalesReportResponse xmlns="http://www.iqmetrix.com">
      <GetProductSalesReportResult>
        <ProductSalesReportData>
          <RqInvoiceIdByStore>string</RqInvoiceIdByStore>
          <VendorSKU>string</VendorSKU>
          <ProductSKU>string</ProductSKU>
          <InvoicedBy>string</InvoicedBy>
          <StoreID>int</StoreID>
          <DistrictName>string</DistrictName>
          <DistrictID>int</DistrictID>
          <RegionName>string</RegionName>
          <RegionID>int</RegionID>
          <ChannelName>string</ChannelName>
          <ChannelID>guid</ChannelID>
          <SoldOn>dateTime</SoldOn>
          <ProductItemID>int</ProductItemID>
          <Description>string</Description>
          <TrackingNumber>string</TrackingNumber>
          <Quantity>int</Quantity>
          <ListPrice>double</ListPrice>
          <Refund>boolean</Refund>
          <CategoryPath>string</CategoryPath>
        </ProductSalesReportData>
        <ProductSalesReportData>
          <RqInvoiceIdByStore>string</RqInvoiceIdByStore>
          <VendorSKU>string</VendorSKU>
          <ProductSKU>string</ProductSKU>
          <InvoicedBy>string</InvoicedBy>
          <StoreID>int</StoreID>
          <DistrictName>string</DistrictName>
          <DistrictID>int</DistrictID>
          <RegionName>string</RegionName>
          <RegionID>int</RegionID>
          <ChannelName>string</ChannelName>
          <ChannelID>guid</ChannelID>
          <SoldOn>dateTime</SoldOn>
          <ProductItemID>int</ProductItemID>
          <Description>string</Description>
          <TrackingNumber>string</TrackingNumber>
          <Quantity>int</Quantity>
          <ListPrice>double</ListPrice>
          <Refund>boolean</Refund>
          <CategoryPath>string</CategoryPath>
        </ProductSalesReportData>
      </GetProductSalesReportResult>
    </GetProductSalesReportResponse>
  </soap12:Body>
</soap12:Envelope>