VMIService
Click here for a complete list of operations.
CreatePurchaseOrder
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: vmiinternal1.iqmetrix.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.iqmetrix.com/CreatePurchaseOrder" <?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> <CreatePurchaseOrder 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> <PurchaseOrder> <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> <ProductID>guid</ProductID> <ProductSKU>string</ProductSKU> <VendorSKU>string</VendorSKU> <ProductItemID>int</ProductItemID> <CategoryPath>string</CategoryPath> <MaximumLevel>int</MaximumLevel> <MinimumLevel>int</MinimumLevel> <ProductCost>decimal</ProductCost> <QuantityInStock>int</QuantityInStock> <QuantityOnOrder>int</QuantityOnOrder> <QuantityOnUncommittedOrder>int</QuantityOnUncommittedOrder> <QuantityOnBackOrder>int</QuantityOnBackOrder> <QuantityInTransfer>int</QuantityInTransfer> <QuantityTransferIn>int</QuantityTransferIn> <QuantityTransferOut>int</QuantityTransferOut> <QuantityOnRMA>int</QuantityOnRMA> <QuantityOnLoan>int</QuantityOnLoan> <QuantityCommittedOnOrderEntry>int</QuantityCommittedOnOrderEntry> <QuantitySuggestedByVendor>int</QuantitySuggestedByVendor> <QuantitySold>int</QuantitySold> <GrossQuantitySold>int</GrossQuantitySold> <GrossQuantityReturned>int</GrossQuantityReturned> <QuantityOrdered>int</QuantityOrdered> <QuantityReceived>int</QuantityReceived> <DateReceived>string</DateReceived> <ProductReceived>boolean</ProductReceived> <Enabled>boolean</Enabled> <MinMaxLocked>boolean</MinMaxLocked> <DoNotOrder>boolean</DoNotOrder> <DateEOL>dateTime</DateEOL> <RetailPrice>decimal</RetailPrice> <SalePrice>decimal</SalePrice> <SaleBegin>dateTime</SaleBegin> <SaleEnd>dateTime</SaleEnd> <ProductName>string</ProductName> </ProductInformation> <ProductInformation> <ProductID>guid</ProductID> <ProductSKU>string</ProductSKU> <VendorSKU>string</VendorSKU> <ProductItemID>int</ProductItemID> <CategoryPath>string</CategoryPath> <MaximumLevel>int</MaximumLevel> <MinimumLevel>int</MinimumLevel> <ProductCost>decimal</ProductCost> <QuantityInStock>int</QuantityInStock> <QuantityOnOrder>int</QuantityOnOrder> <QuantityOnUncommittedOrder>int</QuantityOnUncommittedOrder> <QuantityOnBackOrder>int</QuantityOnBackOrder> <QuantityInTransfer>int</QuantityInTransfer> <QuantityTransferIn>int</QuantityTransferIn> <QuantityTransferOut>int</QuantityTransferOut> <QuantityOnRMA>int</QuantityOnRMA> <QuantityOnLoan>int</QuantityOnLoan> <QuantityCommittedOnOrderEntry>int</QuantityCommittedOnOrderEntry> <QuantitySuggestedByVendor>int</QuantitySuggestedByVendor> <QuantitySold>int</QuantitySold> <GrossQuantitySold>int</GrossQuantitySold> <GrossQuantityReturned>int</GrossQuantityReturned> <QuantityOrdered>int</QuantityOrdered> <QuantityReceived>int</QuantityReceived> <DateReceived>string</DateReceived> <ProductReceived>boolean</ProductReceived> <Enabled>boolean</Enabled> <MinMaxLocked>boolean</MinMaxLocked> <DoNotOrder>boolean</DoNotOrder> <DateEOL>dateTime</DateEOL> <RetailPrice>decimal</RetailPrice> <SalePrice>decimal</SalePrice> <SaleBegin>dateTime</SaleBegin> <SaleEnd>dateTime</SaleEnd> <ProductName>string</ProductName> </ProductInformation> </ProductsOrdered> </PurchaseOrder> </CreatePurchaseOrder> </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> <CreatePurchaseOrderResponse xmlns="http://www.iqmetrix.com"> <CreatePurchaseOrderResult> <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> <ProductID>guid</ProductID> <ProductSKU>string</ProductSKU> <VendorSKU>string</VendorSKU> <ProductItemID>int</ProductItemID> <CategoryPath>string</CategoryPath> <MaximumLevel>int</MaximumLevel> <MinimumLevel>int</MinimumLevel> <ProductCost>decimal</ProductCost> <QuantityInStock>int</QuantityInStock> <QuantityOnOrder>int</QuantityOnOrder> <QuantityOnUncommittedOrder>int</QuantityOnUncommittedOrder> <QuantityOnBackOrder>int</QuantityOnBackOrder> <QuantityInTransfer>int</QuantityInTransfer> <QuantityTransferIn>int</QuantityTransferIn> <QuantityTransferOut>int</QuantityTransferOut> <QuantityOnRMA>int</QuantityOnRMA> <QuantityOnLoan>int</QuantityOnLoan> <QuantityCommittedOnOrderEntry>int</QuantityCommittedOnOrderEntry> <QuantitySuggestedByVendor>int</QuantitySuggestedByVendor> <QuantitySold>int</QuantitySold> <GrossQuantitySold>int</GrossQuantitySold> <GrossQuantityReturned>int</GrossQuantityReturned> <QuantityOrdered>int</QuantityOrdered> <QuantityReceived>int</QuantityReceived> <DateReceived>string</DateReceived> <ProductReceived>boolean</ProductReceived> <Enabled>boolean</Enabled> <MinMaxLocked>boolean</MinMaxLocked> <DoNotOrder>boolean</DoNotOrder> <DateEOL>dateTime</DateEOL> <RetailPrice>decimal</RetailPrice> <SalePrice>decimal</SalePrice> <SaleBegin>dateTime</SaleBegin> <SaleEnd>dateTime</SaleEnd> <ProductName>string</ProductName> </ProductInformation> <ProductInformation> <ProductID>guid</ProductID> <ProductSKU>string</ProductSKU> <VendorSKU>string</VendorSKU> <ProductItemID>int</ProductItemID> <CategoryPath>string</CategoryPath> <MaximumLevel>int</MaximumLevel> <MinimumLevel>int</MinimumLevel> <ProductCost>decimal</ProductCost> <QuantityInStock>int</QuantityInStock> <QuantityOnOrder>int</QuantityOnOrder> <QuantityOnUncommittedOrder>int</QuantityOnUncommittedOrder> <QuantityOnBackOrder>int</QuantityOnBackOrder> <QuantityInTransfer>int</QuantityInTransfer> <QuantityTransferIn>int</QuantityTransferIn> <QuantityTransferOut>int</QuantityTransferOut> <QuantityOnRMA>int</QuantityOnRMA> <QuantityOnLoan>int</QuantityOnLoan> <QuantityCommittedOnOrderEntry>int</QuantityCommittedOnOrderEntry> <QuantitySuggestedByVendor>int</QuantitySuggestedByVendor> <QuantitySold>int</QuantitySold> <GrossQuantitySold>int</GrossQuantitySold> <GrossQuantityReturned>int</GrossQuantityReturned> <QuantityOrdered>int</QuantityOrdered> <QuantityReceived>int</QuantityReceived> <DateReceived>string</DateReceived> <ProductReceived>boolean</ProductReceived> <Enabled>boolean</Enabled> <MinMaxLocked>boolean</MinMaxLocked> <DoNotOrder>boolean</DoNotOrder> <DateEOL>dateTime</DateEOL> <RetailPrice>decimal</RetailPrice> <SalePrice>decimal</SalePrice> <SaleBegin>dateTime</SaleBegin> <SaleEnd>dateTime</SaleEnd> <ProductName>string</ProductName> </ProductInformation> </ProductsOrdered> </CreatePurchaseOrderResult> </CreatePurchaseOrderResponse> </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: vmiinternal1.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> <CreatePurchaseOrder 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> <PurchaseOrder> <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> <ProductID>guid</ProductID> <ProductSKU>string</ProductSKU> <VendorSKU>string</VendorSKU> <ProductItemID>int</ProductItemID> <CategoryPath>string</CategoryPath> <MaximumLevel>int</MaximumLevel> <MinimumLevel>int</MinimumLevel> <ProductCost>decimal</ProductCost> <QuantityInStock>int</QuantityInStock> <QuantityOnOrder>int</QuantityOnOrder> <QuantityOnUncommittedOrder>int</QuantityOnUncommittedOrder> <QuantityOnBackOrder>int</QuantityOnBackOrder> <QuantityInTransfer>int</QuantityInTransfer> <QuantityTransferIn>int</QuantityTransferIn> <QuantityTransferOut>int</QuantityTransferOut> <QuantityOnRMA>int</QuantityOnRMA> <QuantityOnLoan>int</QuantityOnLoan> <QuantityCommittedOnOrderEntry>int</QuantityCommittedOnOrderEntry> <QuantitySuggestedByVendor>int</QuantitySuggestedByVendor> <QuantitySold>int</QuantitySold> <GrossQuantitySold>int</GrossQuantitySold> <GrossQuantityReturned>int</GrossQuantityReturned> <QuantityOrdered>int</QuantityOrdered> <QuantityReceived>int</QuantityReceived> <DateReceived>string</DateReceived> <ProductReceived>boolean</ProductReceived> <Enabled>boolean</Enabled> <MinMaxLocked>boolean</MinMaxLocked> <DoNotOrder>boolean</DoNotOrder> <DateEOL>dateTime</DateEOL> <RetailPrice>decimal</RetailPrice> <SalePrice>decimal</SalePrice> <SaleBegin>dateTime</SaleBegin> <SaleEnd>dateTime</SaleEnd> <ProductName>string</ProductName> </ProductInformation> <ProductInformation> <ProductID>guid</ProductID> <ProductSKU>string</ProductSKU> <VendorSKU>string</VendorSKU> <ProductItemID>int</ProductItemID> <CategoryPath>string</CategoryPath> <MaximumLevel>int</MaximumLevel> <MinimumLevel>int</MinimumLevel> <ProductCost>decimal</ProductCost> <QuantityInStock>int</QuantityInStock> <QuantityOnOrder>int</QuantityOnOrder> <QuantityOnUncommittedOrder>int</QuantityOnUncommittedOrder> <QuantityOnBackOrder>int</QuantityOnBackOrder> <QuantityInTransfer>int</QuantityInTransfer> <QuantityTransferIn>int</QuantityTransferIn> <QuantityTransferOut>int</QuantityTransferOut> <QuantityOnRMA>int</QuantityOnRMA> <QuantityOnLoan>int</QuantityOnLoan> <QuantityCommittedOnOrderEntry>int</QuantityCommittedOnOrderEntry> <QuantitySuggestedByVendor>int</QuantitySuggestedByVendor> <QuantitySold>int</QuantitySold> <GrossQuantitySold>int</GrossQuantitySold> <GrossQuantityReturned>int</GrossQuantityReturned> <QuantityOrdered>int</QuantityOrdered> <QuantityReceived>int</QuantityReceived> <DateReceived>string</DateReceived> <ProductReceived>boolean</ProductReceived> <Enabled>boolean</Enabled> <MinMaxLocked>boolean</MinMaxLocked> <DoNotOrder>boolean</DoNotOrder> <DateEOL>dateTime</DateEOL> <RetailPrice>decimal</RetailPrice> <SalePrice>decimal</SalePrice> <SaleBegin>dateTime</SaleBegin> <SaleEnd>dateTime</SaleEnd> <ProductName>string</ProductName> </ProductInformation> </ProductsOrdered> </PurchaseOrder> </CreatePurchaseOrder> </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> <CreatePurchaseOrderResponse xmlns="http://www.iqmetrix.com"> <CreatePurchaseOrderResult> <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> <ProductID>guid</ProductID> <ProductSKU>string</ProductSKU> <VendorSKU>string</VendorSKU> <ProductItemID>int</ProductItemID> <CategoryPath>string</CategoryPath> <MaximumLevel>int</MaximumLevel> <MinimumLevel>int</MinimumLevel> <ProductCost>decimal</ProductCost> <QuantityInStock>int</QuantityInStock> <QuantityOnOrder>int</QuantityOnOrder> <QuantityOnUncommittedOrder>int</QuantityOnUncommittedOrder> <QuantityOnBackOrder>int</QuantityOnBackOrder> <QuantityInTransfer>int</QuantityInTransfer> <QuantityTransferIn>int</QuantityTransferIn> <QuantityTransferOut>int</QuantityTransferOut> <QuantityOnRMA>int</QuantityOnRMA> <QuantityOnLoan>int</QuantityOnLoan> <QuantityCommittedOnOrderEntry>int</QuantityCommittedOnOrderEntry> <QuantitySuggestedByVendor>int</QuantitySuggestedByVendor> <QuantitySold>int</QuantitySold> <GrossQuantitySold>int</GrossQuantitySold> <GrossQuantityReturned>int</GrossQuantityReturned> <QuantityOrdered>int</QuantityOrdered> <QuantityReceived>int</QuantityReceived> <DateReceived>string</DateReceived> <ProductReceived>boolean</ProductReceived> <Enabled>boolean</Enabled> <MinMaxLocked>boolean</MinMaxLocked> <DoNotOrder>boolean</DoNotOrder> <DateEOL>dateTime</DateEOL> <RetailPrice>decimal</RetailPrice> <SalePrice>decimal</SalePrice> <SaleBegin>dateTime</SaleBegin> <SaleEnd>dateTime</SaleEnd> <ProductName>string</ProductName> </ProductInformation> <ProductInformation> <ProductID>guid</ProductID> <ProductSKU>string</ProductSKU> <VendorSKU>string</VendorSKU> <ProductItemID>int</ProductItemID> <CategoryPath>string</CategoryPath> <MaximumLevel>int</MaximumLevel> <MinimumLevel>int</MinimumLevel> <ProductCost>decimal</ProductCost> <QuantityInStock>int</QuantityInStock> <QuantityOnOrder>int</QuantityOnOrder> <QuantityOnUncommittedOrder>int</QuantityOnUncommittedOrder> <QuantityOnBackOrder>int</QuantityOnBackOrder> <QuantityInTransfer>int</QuantityInTransfer> <QuantityTransferIn>int</QuantityTransferIn> <QuantityTransferOut>int</QuantityTransferOut> <QuantityOnRMA>int</QuantityOnRMA> <QuantityOnLoan>int</QuantityOnLoan> <QuantityCommittedOnOrderEntry>int</QuantityCommittedOnOrderEntry> <QuantitySuggestedByVendor>int</QuantitySuggestedByVendor> <QuantitySold>int</QuantitySold> <GrossQuantitySold>int</GrossQuantitySold> <GrossQuantityReturned>int</GrossQuantityReturned> <QuantityOrdered>int</QuantityOrdered> <QuantityReceived>int</QuantityReceived> <DateReceived>string</DateReceived> <ProductReceived>boolean</ProductReceived> <Enabled>boolean</Enabled> <MinMaxLocked>boolean</MinMaxLocked> <DoNotOrder>boolean</DoNotOrder> <DateEOL>dateTime</DateEOL> <RetailPrice>decimal</RetailPrice> <SalePrice>decimal</SalePrice> <SaleBegin>dateTime</SaleBegin> <SaleEnd>dateTime</SaleEnd> <ProductName>string</ProductName> </ProductInformation> </ProductsOrdered> </CreatePurchaseOrderResult> </CreatePurchaseOrderResponse> </soap12:Body> </soap12:Envelope>