StockService Web Service

StockService

Click here for a complete list of operations.

InventorySelect

Test

The test form is only available for requests from the local machine.

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 /RoseComServicesTest/RoseCommServiceV3/APIV1/StockService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/InventorySelect"

<?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>
    <InventorySelect xmlns="http://tempuri.org/">
      <pSearchParams>
        <Product>
          <ProductTypeName>string</ProductTypeName>
          <ProductCode>string</ProductCode>
          <ProductName>string</ProductName>
          <voucherType>int</voucherType>
          <ProductDescription>string</ProductDescription>
          <ProductCategory>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ProductCategory>
          <ProductDepartment>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ProductDepartment>
          <Manufacturer>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </Manufacturer>
          <AccountCode>string</AccountCode>
          <CostAccountCode>string</CostAccountCode>
          <DefaultSupplier>
            <SupplierReference>string</SupplierReference>
            <SupplierName>string</SupplierName>
            <POAddress xsi:nil="true" />
            <IsDefault>boolean</IsDefault>
          </DefaultSupplier>
          <SellingPrice>decimal</SellingPrice>
          <DealerPrice>decimal</DealerPrice>
          <DealerSpecialPrice>decimal</DealerSpecialPrice>
          <IsActive>boolean</IsActive>
          <TaxRate>decimal</TaxRate>
          <TaxGroup>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </TaxGroup>
          <CostPrice>decimal</CostPrice>
          <QtyInStock>decimal</QtyInStock>
          <ConnectabilityType>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ConnectabilityType>
          <IsTrackable>boolean</IsTrackable>
          <ProductCountry>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ProductCountry>
          <ProductClass>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ProductClass>
          <Model>string</Model>
          <Make>string</Make>
          <BasicPicture>base64Binary</BasicPicture>
          <WebPicture>base64Binary</WebPicture>
          <IsSharerTariff>boolean</IsSharerTariff>
          <ReplenishingFormula>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ReplenishingFormula>
          <Location>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </Location>
          <Site>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </Site>
          <QtyAvailableForSale>decimal</QtyAvailableForSale>
          <HandsetOption>int</HandsetOption>
          <RestockingFee>decimal</RestockingFee>
          <HandsetOptionValue>string</HandsetOptionValue>
          <ExcludeFromForecast>boolean</ExcludeFromForecast>
          <ExcludeFromKeyIndicator>boolean</ExcludeFromKeyIndicator>
          <ReorderQuantity>int</ReorderQuantity>
          <MinimumQuantity>int</MinimumQuantity>
          <MaximumQuantity>int</MaximumQuantity>
          <MonthlyCharge>decimal</MonthlyCharge>
          <AssessmentCode>string</AssessmentCode>
          <AssessmentRating>string</AssessmentRating>
          <TariffProfitability>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </TariffProfitability>
          <BonusBand>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </BonusBand>
          <IsOwnProduct>boolean</IsOwnProduct>
          <ApplicationID>int</ApplicationID>
          <DealerID>int</DealerID>
          <EffectiveDate>dateTime</EffectiveDate>
          <ReturnReasonID>int</ReturnReasonID>
        </Product>
        <SiteID>int</SiteID>
        <LocationID>int</LocationID>
        <IsMobileLocation>boolean</IsMobileLocation>
        <IsSkipMobileFilter>boolean</IsSkipMobileFilter>
        <sProductIDs>string</sProductIDs>
      </pSearchParams>
      <pAuthentication>
        <UserName>string</UserName>
        <Password>string</Password>
        <DealerCode>string</DealerCode>
        <PasswordLevel2>string</PasswordLevel2>
        <IsAuthenticated>boolean</IsAuthenticated>
        <NewPassword>string</NewPassword>
        <EmployeeID>int</EmployeeID>
        <AppServerPath>string</AppServerPath>
        <IsAPIUser>boolean</IsAPIUser>
      </pAuthentication>
    </InventorySelect>
  </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>
    <InventorySelectResponse xmlns="http://tempuri.org/">
      <InventorySelectResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Inventory>
            <IsDefault>boolean</IsDefault>
            <Product xsi:nil="true" />
            <QtyInStock>int</QtyInStock>
            <QtyOnOrder>int</QtyOnOrder>
            <QtyOnLoan>int</QtyOnLoan>
            <AvailableQtyForSale>int</AvailableQtyForSale>
            <QtyReserved>int</QtyReserved>
            <QtyReturnPool>int</QtyReturnPool>
            <Site xsi:nil="true" />
            <Location xsi:nil="true" />
            <QtyRepairPool>int</QtyRepairPool>
            <QtyLostPool>int</QtyLostPool>
          </Inventory>
          <Inventory>
            <IsDefault>boolean</IsDefault>
            <Product xsi:nil="true" />
            <QtyInStock>int</QtyInStock>
            <QtyOnOrder>int</QtyOnOrder>
            <QtyOnLoan>int</QtyOnLoan>
            <AvailableQtyForSale>int</AvailableQtyForSale>
            <QtyReserved>int</QtyReserved>
            <QtyReturnPool>int</QtyReturnPool>
            <Site xsi:nil="true" />
            <Location xsi:nil="true" />
            <QtyRepairPool>int</QtyRepairPool>
            <QtyLostPool>int</QtyLostPool>
          </Inventory>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </InventorySelectResult>
    </InventorySelectResponse>
  </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 /RoseComServicesTest/RoseCommServiceV3/APIV1/StockService.asmx HTTP/1.1
Host: rosecommunications.salestarconnect.com
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>
    <InventorySelect xmlns="http://tempuri.org/">
      <pSearchParams>
        <Product>
          <ProductTypeName>string</ProductTypeName>
          <ProductCode>string</ProductCode>
          <ProductName>string</ProductName>
          <voucherType>int</voucherType>
          <ProductDescription>string</ProductDescription>
          <ProductCategory>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ProductCategory>
          <ProductDepartment>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ProductDepartment>
          <Manufacturer>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </Manufacturer>
          <AccountCode>string</AccountCode>
          <CostAccountCode>string</CostAccountCode>
          <DefaultSupplier>
            <SupplierReference>string</SupplierReference>
            <SupplierName>string</SupplierName>
            <POAddress xsi:nil="true" />
            <IsDefault>boolean</IsDefault>
          </DefaultSupplier>
          <SellingPrice>decimal</SellingPrice>
          <DealerPrice>decimal</DealerPrice>
          <DealerSpecialPrice>decimal</DealerSpecialPrice>
          <IsActive>boolean</IsActive>
          <TaxRate>decimal</TaxRate>
          <TaxGroup>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </TaxGroup>
          <CostPrice>decimal</CostPrice>
          <QtyInStock>decimal</QtyInStock>
          <ConnectabilityType>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ConnectabilityType>
          <IsTrackable>boolean</IsTrackable>
          <ProductCountry>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ProductCountry>
          <ProductClass>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ProductClass>
          <Model>string</Model>
          <Make>string</Make>
          <BasicPicture>base64Binary</BasicPicture>
          <WebPicture>base64Binary</WebPicture>
          <IsSharerTariff>boolean</IsSharerTariff>
          <ReplenishingFormula>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </ReplenishingFormula>
          <Location>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </Location>
          <Site>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </Site>
          <QtyAvailableForSale>decimal</QtyAvailableForSale>
          <HandsetOption>int</HandsetOption>
          <RestockingFee>decimal</RestockingFee>
          <HandsetOptionValue>string</HandsetOptionValue>
          <ExcludeFromForecast>boolean</ExcludeFromForecast>
          <ExcludeFromKeyIndicator>boolean</ExcludeFromKeyIndicator>
          <ReorderQuantity>int</ReorderQuantity>
          <MinimumQuantity>int</MinimumQuantity>
          <MaximumQuantity>int</MaximumQuantity>
          <MonthlyCharge>decimal</MonthlyCharge>
          <AssessmentCode>string</AssessmentCode>
          <AssessmentRating>string</AssessmentRating>
          <TariffProfitability>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </TariffProfitability>
          <BonusBand>
            <ID>int</ID>
            <Name>string</Name>
            <DataType>int</DataType>
            <Length>int</Length>
            <IsMandatory>boolean</IsMandatory>
          </BonusBand>
          <IsOwnProduct>boolean</IsOwnProduct>
          <ApplicationID>int</ApplicationID>
          <DealerID>int</DealerID>
          <EffectiveDate>dateTime</EffectiveDate>
          <ReturnReasonID>int</ReturnReasonID>
        </Product>
        <SiteID>int</SiteID>
        <LocationID>int</LocationID>
        <IsMobileLocation>boolean</IsMobileLocation>
        <IsSkipMobileFilter>boolean</IsSkipMobileFilter>
        <sProductIDs>string</sProductIDs>
      </pSearchParams>
      <pAuthentication>
        <UserName>string</UserName>
        <Password>string</Password>
        <DealerCode>string</DealerCode>
        <PasswordLevel2>string</PasswordLevel2>
        <IsAuthenticated>boolean</IsAuthenticated>
        <NewPassword>string</NewPassword>
        <EmployeeID>int</EmployeeID>
        <AppServerPath>string</AppServerPath>
        <IsAPIUser>boolean</IsAPIUser>
      </pAuthentication>
    </InventorySelect>
  </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>
    <InventorySelectResponse xmlns="http://tempuri.org/">
      <InventorySelectResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Inventory>
            <IsDefault>boolean</IsDefault>
            <Product xsi:nil="true" />
            <QtyInStock>int</QtyInStock>
            <QtyOnOrder>int</QtyOnOrder>
            <QtyOnLoan>int</QtyOnLoan>
            <AvailableQtyForSale>int</AvailableQtyForSale>
            <QtyReserved>int</QtyReserved>
            <QtyReturnPool>int</QtyReturnPool>
            <Site xsi:nil="true" />
            <Location xsi:nil="true" />
            <QtyRepairPool>int</QtyRepairPool>
            <QtyLostPool>int</QtyLostPool>
          </Inventory>
          <Inventory>
            <IsDefault>boolean</IsDefault>
            <Product xsi:nil="true" />
            <QtyInStock>int</QtyInStock>
            <QtyOnOrder>int</QtyOnOrder>
            <QtyOnLoan>int</QtyOnLoan>
            <AvailableQtyForSale>int</AvailableQtyForSale>
            <QtyReserved>int</QtyReserved>
            <QtyReturnPool>int</QtyReturnPool>
            <Site xsi:nil="true" />
            <Location xsi:nil="true" />
            <QtyRepairPool>int</QtyRepairPool>
            <QtyLostPool>int</QtyLostPool>
          </Inventory>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </InventorySelectResult>
    </InventorySelectResponse>
  </soap12:Body>
</soap12:Envelope>