VMIService Web Service

VMIService

Click here for a complete list of operations.

CreateRMA

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

<?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>
    <CreateRMA 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>
      <RMA>
        <ProductData>
          <RMAProduct>
            <RQProductSku>string</RQProductSku>
            <RQProductID>int</RQProductID>
            <VendorSku>string</VendorSku>
            <SerialNumberRemoved>string</SerialNumberRemoved>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <TotalQuantity>int</TotalQuantity>
            <NonSellableQuantity>int</NonSellableQuantity>
            <QuantityReceived>int</QuantityReceived>
            <UnitCost>decimal</UnitCost>
            <ActionTaken>NotSet or Credit or Replacement or Rejected or Repaired or Removed</ActionTaken>
          </RMAProduct>
          <RMAProduct>
            <RQProductSku>string</RQProductSku>
            <RQProductID>int</RQProductID>
            <VendorSku>string</VendorSku>
            <SerialNumberRemoved>string</SerialNumberRemoved>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <TotalQuantity>int</TotalQuantity>
            <NonSellableQuantity>int</NonSellableQuantity>
            <QuantityReceived>int</QuantityReceived>
            <UnitCost>decimal</UnitCost>
            <ActionTaken>NotSet or Credit or Replacement or Rejected or Repaired or Removed</ActionTaken>
          </RMAProduct>
        </ProductData>
        <RMAID>int</RMAID>
        <RMAIDByStore>string</RMAIDByStore>
        <StoreID>int</StoreID>
        <VendorID>int</VendorID>
        <CreatedByVMI>boolean</CreatedByVMI>
        <VendorRMANumber>string</VendorRMANumber>
        <WayBillNumber>string</WayBillNumber>
        <ShippingMethod>string</ShippingMethod>
        <ShippingCost>decimal</ShippingCost>
        <Committed>unsignedByte</Committed>
        <DateCommitted>dateTime</DateCommitted>
        <ShippedAway>unsignedByte</ShippedAway>
        <Completed>unsignedByte</Completed>
        <Comments>string</Comments>
        <DateCreated>dateTime</DateCreated>
        <ReceivingComments>string</ReceivingComments>
        <CreditInvoiceNumber>string</CreditInvoiceNumber>
      </RMA>
    </CreateRMA>
  </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>
    <CreateRMAResponse xmlns="http://www.iqmetrix.com">
      <CreateRMAResult>
        <ProductData>
          <RMAProduct>
            <RQProductSku>string</RQProductSku>
            <RQProductID>int</RQProductID>
            <VendorSku>string</VendorSku>
            <SerialNumberRemoved>string</SerialNumberRemoved>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <TotalQuantity>int</TotalQuantity>
            <NonSellableQuantity>int</NonSellableQuantity>
            <QuantityReceived>int</QuantityReceived>
            <UnitCost>decimal</UnitCost>
            <ActionTaken>NotSet or Credit or Replacement or Rejected or Repaired or Removed</ActionTaken>
          </RMAProduct>
          <RMAProduct>
            <RQProductSku>string</RQProductSku>
            <RQProductID>int</RQProductID>
            <VendorSku>string</VendorSku>
            <SerialNumberRemoved>string</SerialNumberRemoved>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <TotalQuantity>int</TotalQuantity>
            <NonSellableQuantity>int</NonSellableQuantity>
            <QuantityReceived>int</QuantityReceived>
            <UnitCost>decimal</UnitCost>
            <ActionTaken>NotSet or Credit or Replacement or Rejected or Repaired or Removed</ActionTaken>
          </RMAProduct>
        </ProductData>
        <RMAID>int</RMAID>
        <RMAIDByStore>string</RMAIDByStore>
        <StoreID>int</StoreID>
        <VendorID>int</VendorID>
        <CreatedByVMI>boolean</CreatedByVMI>
        <VendorRMANumber>string</VendorRMANumber>
        <WayBillNumber>string</WayBillNumber>
        <ShippingMethod>string</ShippingMethod>
        <ShippingCost>decimal</ShippingCost>
        <Committed>unsignedByte</Committed>
        <DateCommitted>dateTime</DateCommitted>
        <ShippedAway>unsignedByte</ShippedAway>
        <Completed>unsignedByte</Completed>
        <Comments>string</Comments>
        <DateCreated>dateTime</DateCreated>
        <ReceivingComments>string</ReceivingComments>
        <CreditInvoiceNumber>string</CreditInvoiceNumber>
      </CreateRMAResult>
    </CreateRMAResponse>
  </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>
    <CreateRMA 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>
      <RMA>
        <ProductData>
          <RMAProduct>
            <RQProductSku>string</RQProductSku>
            <RQProductID>int</RQProductID>
            <VendorSku>string</VendorSku>
            <SerialNumberRemoved>string</SerialNumberRemoved>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <TotalQuantity>int</TotalQuantity>
            <NonSellableQuantity>int</NonSellableQuantity>
            <QuantityReceived>int</QuantityReceived>
            <UnitCost>decimal</UnitCost>
            <ActionTaken>NotSet or Credit or Replacement or Rejected or Repaired or Removed</ActionTaken>
          </RMAProduct>
          <RMAProduct>
            <RQProductSku>string</RQProductSku>
            <RQProductID>int</RQProductID>
            <VendorSku>string</VendorSku>
            <SerialNumberRemoved>string</SerialNumberRemoved>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <TotalQuantity>int</TotalQuantity>
            <NonSellableQuantity>int</NonSellableQuantity>
            <QuantityReceived>int</QuantityReceived>
            <UnitCost>decimal</UnitCost>
            <ActionTaken>NotSet or Credit or Replacement or Rejected or Repaired or Removed</ActionTaken>
          </RMAProduct>
        </ProductData>
        <RMAID>int</RMAID>
        <RMAIDByStore>string</RMAIDByStore>
        <StoreID>int</StoreID>
        <VendorID>int</VendorID>
        <CreatedByVMI>boolean</CreatedByVMI>
        <VendorRMANumber>string</VendorRMANumber>
        <WayBillNumber>string</WayBillNumber>
        <ShippingMethod>string</ShippingMethod>
        <ShippingCost>decimal</ShippingCost>
        <Committed>unsignedByte</Committed>
        <DateCommitted>dateTime</DateCommitted>
        <ShippedAway>unsignedByte</ShippedAway>
        <Completed>unsignedByte</Completed>
        <Comments>string</Comments>
        <DateCreated>dateTime</DateCreated>
        <ReceivingComments>string</ReceivingComments>
        <CreditInvoiceNumber>string</CreditInvoiceNumber>
      </RMA>
    </CreateRMA>
  </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>
    <CreateRMAResponse xmlns="http://www.iqmetrix.com">
      <CreateRMAResult>
        <ProductData>
          <RMAProduct>
            <RQProductSku>string</RQProductSku>
            <RQProductID>int</RQProductID>
            <VendorSku>string</VendorSku>
            <SerialNumberRemoved>string</SerialNumberRemoved>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <TotalQuantity>int</TotalQuantity>
            <NonSellableQuantity>int</NonSellableQuantity>
            <QuantityReceived>int</QuantityReceived>
            <UnitCost>decimal</UnitCost>
            <ActionTaken>NotSet or Credit or Replacement or Rejected or Repaired or Removed</ActionTaken>
          </RMAProduct>
          <RMAProduct>
            <RQProductSku>string</RQProductSku>
            <RQProductID>int</RQProductID>
            <VendorSku>string</VendorSku>
            <SerialNumberRemoved>string</SerialNumberRemoved>
            <VendorInvoiceNumber>string</VendorInvoiceNumber>
            <TotalQuantity>int</TotalQuantity>
            <NonSellableQuantity>int</NonSellableQuantity>
            <QuantityReceived>int</QuantityReceived>
            <UnitCost>decimal</UnitCost>
            <ActionTaken>NotSet or Credit or Replacement or Rejected or Repaired or Removed</ActionTaken>
          </RMAProduct>
        </ProductData>
        <RMAID>int</RMAID>
        <RMAIDByStore>string</RMAIDByStore>
        <StoreID>int</StoreID>
        <VendorID>int</VendorID>
        <CreatedByVMI>boolean</CreatedByVMI>
        <VendorRMANumber>string</VendorRMANumber>
        <WayBillNumber>string</WayBillNumber>
        <ShippingMethod>string</ShippingMethod>
        <ShippingCost>decimal</ShippingCost>
        <Committed>unsignedByte</Committed>
        <DateCommitted>dateTime</DateCommitted>
        <ShippedAway>unsignedByte</ShippedAway>
        <Completed>unsignedByte</Completed>
        <Comments>string</Comments>
        <DateCreated>dateTime</DateCreated>
        <ReceivingComments>string</ReceivingComments>
        <CreditInvoiceNumber>string</CreditInvoiceNumber>
      </CreateRMAResult>
    </CreateRMAResponse>
  </soap12:Body>
</soap12:Envelope>