StockService Web Service

StockService

Click here for a complete list of operations.

ProductListWithStock

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

<?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>
    <ProductListWithStock xmlns="http://tempuri.org/">
      <pSearchParams>
        <SupplierID>int</SupplierID>
        <SiteID>int</SiteID>
        <bOnlyTangible>boolean</bOnlyTangible>
        <AccountCode>string</AccountCode>
        <bIsActive>boolean</bIsActive>
        <CategoryID>int</CategoryID>
        <DepartmentID>int</DepartmentID>
        <ManufactureID>int</ManufactureID>
        <SearchString>string</SearchString>
        <LocationID>int</LocationID>
        <IsMobileLocation>boolean</IsMobileLocation>
        <DealerID>int</DealerID>
        <ApplicationID>int</ApplicationID>
        <EffectiveDate>dateTime</EffectiveDate>
        <CustomerTypeID>int</CustomerTypeID>
        <CountryID>int</CountryID>
        <ProductID>
          <long>long</long>
          <long>long</long>
        </ProductID>
        <ProductIDList>string</ProductIDList>
        <Name>string</Name>
        <AddedAfterDate>dateTime</AddedAfterDate>
        <ModifiedAfterDate>dateTime</ModifiedAfterDate>
        <DepartmentIDList>string</DepartmentIDList>
        <CategoryIDList>string</CategoryIDList>
        <IsOnlyCount>boolean</IsOnlyCount>
        <NoOfRecords>int</NoOfRecords>
        <PageSize>int</PageSize>
        <PageNumber>int</PageNumber>
      </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>
    </ProductListWithStock>
  </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>
    <ProductListWithStockResponse xmlns="http://tempuri.org/">
      <ProductListWithStockResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Product>
            <ProductTypeName>string</ProductTypeName>
            <ProductCode>string</ProductCode>
            <ProductName>string</ProductName>
            <voucherType>int</voucherType>
            <ProductDescription>string</ProductDescription>
            <ProductCategory xsi:nil="true" />
            <ProductDepartment xsi:nil="true" />
            <Manufacturer xsi:nil="true" />
            <AccountCode>string</AccountCode>
            <CostAccountCode>string</CostAccountCode>
            <DefaultSupplier xsi:nil="true" />
            <SellingPrice>decimal</SellingPrice>
            <DealerPrice>decimal</DealerPrice>
            <DealerSpecialPrice>decimal</DealerSpecialPrice>
            <IsActive>boolean</IsActive>
            <TaxRate>decimal</TaxRate>
            <TaxGroup xsi:nil="true" />
            <CostPrice>decimal</CostPrice>
            <QtyInStock>decimal</QtyInStock>
            <ConnectabilityType xsi:nil="true" />
            <IsTrackable>boolean</IsTrackable>
            <ProductCountry xsi:nil="true" />
            <ProductClass xsi:nil="true" />
            <Model>string</Model>
            <Make>string</Make>
            <BasicPicture>base64Binary</BasicPicture>
            <WebPicture>base64Binary</WebPicture>
            <IsSharerTariff>boolean</IsSharerTariff>
            <ReplenishingFormula xsi:nil="true" />
            <Location xsi:nil="true" />
            <Site xsi:nil="true" />
            <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 xsi:nil="true" />
            <BonusBand xsi:nil="true" />
            <IsOwnProduct>boolean</IsOwnProduct>
            <ApplicationID>int</ApplicationID>
            <DealerID>int</DealerID>
            <EffectiveDate>dateTime</EffectiveDate>
            <ReturnReasonID>int</ReturnReasonID>
          </Product>
          <Product>
            <ProductTypeName>string</ProductTypeName>
            <ProductCode>string</ProductCode>
            <ProductName>string</ProductName>
            <voucherType>int</voucherType>
            <ProductDescription>string</ProductDescription>
            <ProductCategory xsi:nil="true" />
            <ProductDepartment xsi:nil="true" />
            <Manufacturer xsi:nil="true" />
            <AccountCode>string</AccountCode>
            <CostAccountCode>string</CostAccountCode>
            <DefaultSupplier xsi:nil="true" />
            <SellingPrice>decimal</SellingPrice>
            <DealerPrice>decimal</DealerPrice>
            <DealerSpecialPrice>decimal</DealerSpecialPrice>
            <IsActive>boolean</IsActive>
            <TaxRate>decimal</TaxRate>
            <TaxGroup xsi:nil="true" />
            <CostPrice>decimal</CostPrice>
            <QtyInStock>decimal</QtyInStock>
            <ConnectabilityType xsi:nil="true" />
            <IsTrackable>boolean</IsTrackable>
            <ProductCountry xsi:nil="true" />
            <ProductClass xsi:nil="true" />
            <Model>string</Model>
            <Make>string</Make>
            <BasicPicture>base64Binary</BasicPicture>
            <WebPicture>base64Binary</WebPicture>
            <IsSharerTariff>boolean</IsSharerTariff>
            <ReplenishingFormula xsi:nil="true" />
            <Location xsi:nil="true" />
            <Site xsi:nil="true" />
            <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 xsi:nil="true" />
            <BonusBand xsi:nil="true" />
            <IsOwnProduct>boolean</IsOwnProduct>
            <ApplicationID>int</ApplicationID>
            <DealerID>int</DealerID>
            <EffectiveDate>dateTime</EffectiveDate>
            <ReturnReasonID>int</ReturnReasonID>
          </Product>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </ProductListWithStockResult>
    </ProductListWithStockResponse>
  </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>
    <ProductListWithStock xmlns="http://tempuri.org/">
      <pSearchParams>
        <SupplierID>int</SupplierID>
        <SiteID>int</SiteID>
        <bOnlyTangible>boolean</bOnlyTangible>
        <AccountCode>string</AccountCode>
        <bIsActive>boolean</bIsActive>
        <CategoryID>int</CategoryID>
        <DepartmentID>int</DepartmentID>
        <ManufactureID>int</ManufactureID>
        <SearchString>string</SearchString>
        <LocationID>int</LocationID>
        <IsMobileLocation>boolean</IsMobileLocation>
        <DealerID>int</DealerID>
        <ApplicationID>int</ApplicationID>
        <EffectiveDate>dateTime</EffectiveDate>
        <CustomerTypeID>int</CustomerTypeID>
        <CountryID>int</CountryID>
        <ProductID>
          <long>long</long>
          <long>long</long>
        </ProductID>
        <ProductIDList>string</ProductIDList>
        <Name>string</Name>
        <AddedAfterDate>dateTime</AddedAfterDate>
        <ModifiedAfterDate>dateTime</ModifiedAfterDate>
        <DepartmentIDList>string</DepartmentIDList>
        <CategoryIDList>string</CategoryIDList>
        <IsOnlyCount>boolean</IsOnlyCount>
        <NoOfRecords>int</NoOfRecords>
        <PageSize>int</PageSize>
        <PageNumber>int</PageNumber>
      </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>
    </ProductListWithStock>
  </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>
    <ProductListWithStockResponse xmlns="http://tempuri.org/">
      <ProductListWithStockResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <Product>
            <ProductTypeName>string</ProductTypeName>
            <ProductCode>string</ProductCode>
            <ProductName>string</ProductName>
            <voucherType>int</voucherType>
            <ProductDescription>string</ProductDescription>
            <ProductCategory xsi:nil="true" />
            <ProductDepartment xsi:nil="true" />
            <Manufacturer xsi:nil="true" />
            <AccountCode>string</AccountCode>
            <CostAccountCode>string</CostAccountCode>
            <DefaultSupplier xsi:nil="true" />
            <SellingPrice>decimal</SellingPrice>
            <DealerPrice>decimal</DealerPrice>
            <DealerSpecialPrice>decimal</DealerSpecialPrice>
            <IsActive>boolean</IsActive>
            <TaxRate>decimal</TaxRate>
            <TaxGroup xsi:nil="true" />
            <CostPrice>decimal</CostPrice>
            <QtyInStock>decimal</QtyInStock>
            <ConnectabilityType xsi:nil="true" />
            <IsTrackable>boolean</IsTrackable>
            <ProductCountry xsi:nil="true" />
            <ProductClass xsi:nil="true" />
            <Model>string</Model>
            <Make>string</Make>
            <BasicPicture>base64Binary</BasicPicture>
            <WebPicture>base64Binary</WebPicture>
            <IsSharerTariff>boolean</IsSharerTariff>
            <ReplenishingFormula xsi:nil="true" />
            <Location xsi:nil="true" />
            <Site xsi:nil="true" />
            <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 xsi:nil="true" />
            <BonusBand xsi:nil="true" />
            <IsOwnProduct>boolean</IsOwnProduct>
            <ApplicationID>int</ApplicationID>
            <DealerID>int</DealerID>
            <EffectiveDate>dateTime</EffectiveDate>
            <ReturnReasonID>int</ReturnReasonID>
          </Product>
          <Product>
            <ProductTypeName>string</ProductTypeName>
            <ProductCode>string</ProductCode>
            <ProductName>string</ProductName>
            <voucherType>int</voucherType>
            <ProductDescription>string</ProductDescription>
            <ProductCategory xsi:nil="true" />
            <ProductDepartment xsi:nil="true" />
            <Manufacturer xsi:nil="true" />
            <AccountCode>string</AccountCode>
            <CostAccountCode>string</CostAccountCode>
            <DefaultSupplier xsi:nil="true" />
            <SellingPrice>decimal</SellingPrice>
            <DealerPrice>decimal</DealerPrice>
            <DealerSpecialPrice>decimal</DealerSpecialPrice>
            <IsActive>boolean</IsActive>
            <TaxRate>decimal</TaxRate>
            <TaxGroup xsi:nil="true" />
            <CostPrice>decimal</CostPrice>
            <QtyInStock>decimal</QtyInStock>
            <ConnectabilityType xsi:nil="true" />
            <IsTrackable>boolean</IsTrackable>
            <ProductCountry xsi:nil="true" />
            <ProductClass xsi:nil="true" />
            <Model>string</Model>
            <Make>string</Make>
            <BasicPicture>base64Binary</BasicPicture>
            <WebPicture>base64Binary</WebPicture>
            <IsSharerTariff>boolean</IsSharerTariff>
            <ReplenishingFormula xsi:nil="true" />
            <Location xsi:nil="true" />
            <Site xsi:nil="true" />
            <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 xsi:nil="true" />
            <BonusBand xsi:nil="true" />
            <IsOwnProduct>boolean</IsOwnProduct>
            <ApplicationID>int</ApplicationID>
            <DealerID>int</DealerID>
            <EffectiveDate>dateTime</EffectiveDate>
            <ReturnReasonID>int</ReturnReasonID>
          </Product>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </ProductListWithStockResult>
    </ProductListWithStockResponse>
  </soap12:Body>
</soap12:Envelope>