VMIService Web Service

VMIService

Click here for a complete list of operations.

GetClientPurchaseOrdersByStatus

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

<?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>
    <GetClientPurchaseOrdersByStatus 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>
      <isCommitted>boolean</isCommitted>
      <isCompleted>boolean</isCompleted>
      <startDate>string</startDate>
      <endDate>string</endDate>
    </GetClientPurchaseOrdersByStatus>
  </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>
    <GetClientPurchaseOrdersByStatusResponse xmlns="http://www.iqmetrix.com">
      <GetClientPurchaseOrdersByStatusResult>
        <PurchaseOrderInformation>
          <PurchaseOrderID>guid</PurchaseOrderID>
          <PurchaseOrderData>
            <PurchaseOrderID>guid</PurchaseOrderID>
            <RetailiQPurchaseOrderID>int</RetailiQPurchaseOrderID>
            <RetailiQPurchaseOrderNumber>string</RetailiQPurchaseOrderNumber>
            <ShipToStoreID>int</ShipToStoreID>
            <ShipToVendorAccountNumber>string</ShipToVendorAccountNumber>
            <BillToStoreID>int</BillToStoreID>
            <BillToVendorAccountNumber>string</BillToVendorAccountNumber>
            <OrderTotal>decimal</OrderTotal>
            <ShippingTotal>decimal</ShippingTotal>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <EstimatedArrivalDate>string</EstimatedArrivalDate>
            <Comments>string</Comments>
            <ShipToStoreName>string</ShipToStoreName>
            <BillToStoreName>string</BillToStoreName>
            <VendorName>string</VendorName>
            <CreatedByVMI>boolean</CreatedByVMI>
            <CreatedDate>string</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
          </PurchaseOrderData>
          <ProductsOrdered>
            <ProductInformation xsi:nil="true" />
            <ProductInformation xsi:nil="true" />
          </ProductsOrdered>
          <ProductsReceived>
            <ProductInformation xsi:nil="true" />
            <ProductInformation xsi:nil="true" />
          </ProductsReceived>
          <SerialsReceived>
            <ProductSerialNumber xsi:nil="true" />
            <ProductSerialNumber xsi:nil="true" />
          </SerialsReceived>
        </PurchaseOrderInformation>
        <PurchaseOrderInformation>
          <PurchaseOrderID>guid</PurchaseOrderID>
          <PurchaseOrderData>
            <PurchaseOrderID>guid</PurchaseOrderID>
            <RetailiQPurchaseOrderID>int</RetailiQPurchaseOrderID>
            <RetailiQPurchaseOrderNumber>string</RetailiQPurchaseOrderNumber>
            <ShipToStoreID>int</ShipToStoreID>
            <ShipToVendorAccountNumber>string</ShipToVendorAccountNumber>
            <BillToStoreID>int</BillToStoreID>
            <BillToVendorAccountNumber>string</BillToVendorAccountNumber>
            <OrderTotal>decimal</OrderTotal>
            <ShippingTotal>decimal</ShippingTotal>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <EstimatedArrivalDate>string</EstimatedArrivalDate>
            <Comments>string</Comments>
            <ShipToStoreName>string</ShipToStoreName>
            <BillToStoreName>string</BillToStoreName>
            <VendorName>string</VendorName>
            <CreatedByVMI>boolean</CreatedByVMI>
            <CreatedDate>string</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
          </PurchaseOrderData>
          <ProductsOrdered>
            <ProductInformation xsi:nil="true" />
            <ProductInformation xsi:nil="true" />
          </ProductsOrdered>
          <ProductsReceived>
            <ProductInformation xsi:nil="true" />
            <ProductInformation xsi:nil="true" />
          </ProductsReceived>
          <SerialsReceived>
            <ProductSerialNumber xsi:nil="true" />
            <ProductSerialNumber xsi:nil="true" />
          </SerialsReceived>
        </PurchaseOrderInformation>
      </GetClientPurchaseOrdersByStatusResult>
    </GetClientPurchaseOrdersByStatusResponse>
  </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>
    <GetClientPurchaseOrdersByStatus 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>
      <isCommitted>boolean</isCommitted>
      <isCompleted>boolean</isCompleted>
      <startDate>string</startDate>
      <endDate>string</endDate>
    </GetClientPurchaseOrdersByStatus>
  </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>
    <GetClientPurchaseOrdersByStatusResponse xmlns="http://www.iqmetrix.com">
      <GetClientPurchaseOrdersByStatusResult>
        <PurchaseOrderInformation>
          <PurchaseOrderID>guid</PurchaseOrderID>
          <PurchaseOrderData>
            <PurchaseOrderID>guid</PurchaseOrderID>
            <RetailiQPurchaseOrderID>int</RetailiQPurchaseOrderID>
            <RetailiQPurchaseOrderNumber>string</RetailiQPurchaseOrderNumber>
            <ShipToStoreID>int</ShipToStoreID>
            <ShipToVendorAccountNumber>string</ShipToVendorAccountNumber>
            <BillToStoreID>int</BillToStoreID>
            <BillToVendorAccountNumber>string</BillToVendorAccountNumber>
            <OrderTotal>decimal</OrderTotal>
            <ShippingTotal>decimal</ShippingTotal>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <EstimatedArrivalDate>string</EstimatedArrivalDate>
            <Comments>string</Comments>
            <ShipToStoreName>string</ShipToStoreName>
            <BillToStoreName>string</BillToStoreName>
            <VendorName>string</VendorName>
            <CreatedByVMI>boolean</CreatedByVMI>
            <CreatedDate>string</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
          </PurchaseOrderData>
          <ProductsOrdered>
            <ProductInformation xsi:nil="true" />
            <ProductInformation xsi:nil="true" />
          </ProductsOrdered>
          <ProductsReceived>
            <ProductInformation xsi:nil="true" />
            <ProductInformation xsi:nil="true" />
          </ProductsReceived>
          <SerialsReceived>
            <ProductSerialNumber xsi:nil="true" />
            <ProductSerialNumber xsi:nil="true" />
          </SerialsReceived>
        </PurchaseOrderInformation>
        <PurchaseOrderInformation>
          <PurchaseOrderID>guid</PurchaseOrderID>
          <PurchaseOrderData>
            <PurchaseOrderID>guid</PurchaseOrderID>
            <RetailiQPurchaseOrderID>int</RetailiQPurchaseOrderID>
            <RetailiQPurchaseOrderNumber>string</RetailiQPurchaseOrderNumber>
            <ShipToStoreID>int</ShipToStoreID>
            <ShipToVendorAccountNumber>string</ShipToVendorAccountNumber>
            <BillToStoreID>int</BillToStoreID>
            <BillToVendorAccountNumber>string</BillToVendorAccountNumber>
            <OrderTotal>decimal</OrderTotal>
            <ShippingTotal>decimal</ShippingTotal>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <EstimatedArrivalDate>string</EstimatedArrivalDate>
            <Comments>string</Comments>
            <ShipToStoreName>string</ShipToStoreName>
            <BillToStoreName>string</BillToStoreName>
            <VendorName>string</VendorName>
            <CreatedByVMI>boolean</CreatedByVMI>
            <CreatedDate>string</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
          </PurchaseOrderData>
          <ProductsOrdered>
            <ProductInformation xsi:nil="true" />
            <ProductInformation xsi:nil="true" />
          </ProductsOrdered>
          <ProductsReceived>
            <ProductInformation xsi:nil="true" />
            <ProductInformation xsi:nil="true" />
          </ProductsReceived>
          <SerialsReceived>
            <ProductSerialNumber xsi:nil="true" />
            <ProductSerialNumber xsi:nil="true" />
          </SerialsReceived>
        </PurchaseOrderInformation>
      </GetClientPurchaseOrdersByStatusResult>
    </GetClientPurchaseOrdersByStatusResponse>
  </soap12:Body>
</soap12:Envelope>