StockService Web Service

StockService

Click here for a complete list of operations.

TrackableItemList

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 /RosecomLive/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/TrackableItemList"

<?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>
    <TrackableItemList xmlns="http://tempuri.org/">
      <pSearchParams>
        <SiteID>int</SiteID>
        <LocationID>int</LocationID>
        <ProductID>long</ProductID>
        <ItemStatusID>int</ItemStatusID>
        <IsOnlyAvailableForSale>boolean</IsOnlyAvailableForSale>
        <PageSize>int</PageSize>
        <PageNumber>int</PageNumber>
        <ExcludeList>
          <long>long</long>
          <long>long</long>
        </ExcludeList>
        <SearchOption>int</SearchOption>
        <RangeFrom>string</RangeFrom>
        <RangeTo>string</RangeTo>
      </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>
    </TrackableItemList>
  </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>
    <TrackableItemListResponse xmlns="http://tempuri.org/">
      <TrackableItemListResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <TrackableItem>
            <TrackableItemNumbers xsi:nil="true" />
            <ItemStatus xsi:nil="true" />
            <BatchNumber>string</BatchNumber>
            <BatchQuantity>int</BatchQuantity>
            <Site xsi:nil="true" />
            <Location xsi:nil="true" />
            <Container xsi:nil="true" />
            <ActualCost>decimal</ActualCost>
            <ReceivedDate>dateTime</ReceivedDate>
            <DespatchedDate>dateTime</DespatchedDate>
            <SupplierID>int</SupplierID>
            <SaleOrderDetailID>long</SaleOrderDetailID>
            <Note>string</Note>
            <IsOverSell>boolean</IsOverSell>
            <RANumber>string</RANumber>
          </TrackableItem>
          <TrackableItem>
            <TrackableItemNumbers xsi:nil="true" />
            <ItemStatus xsi:nil="true" />
            <BatchNumber>string</BatchNumber>
            <BatchQuantity>int</BatchQuantity>
            <Site xsi:nil="true" />
            <Location xsi:nil="true" />
            <Container xsi:nil="true" />
            <ActualCost>decimal</ActualCost>
            <ReceivedDate>dateTime</ReceivedDate>
            <DespatchedDate>dateTime</DespatchedDate>
            <SupplierID>int</SupplierID>
            <SaleOrderDetailID>long</SaleOrderDetailID>
            <Note>string</Note>
            <IsOverSell>boolean</IsOverSell>
            <RANumber>string</RANumber>
          </TrackableItem>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </TrackableItemListResult>
    </TrackableItemListResponse>
  </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 /RosecomLive/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>
    <TrackableItemList xmlns="http://tempuri.org/">
      <pSearchParams>
        <SiteID>int</SiteID>
        <LocationID>int</LocationID>
        <ProductID>long</ProductID>
        <ItemStatusID>int</ItemStatusID>
        <IsOnlyAvailableForSale>boolean</IsOnlyAvailableForSale>
        <PageSize>int</PageSize>
        <PageNumber>int</PageNumber>
        <ExcludeList>
          <long>long</long>
          <long>long</long>
        </ExcludeList>
        <SearchOption>int</SearchOption>
        <RangeFrom>string</RangeFrom>
        <RangeTo>string</RangeTo>
      </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>
    </TrackableItemList>
  </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>
    <TrackableItemListResponse xmlns="http://tempuri.org/">
      <TrackableItemListResult>
        <IsError>boolean</IsError>
        <ErrorCode>int</ErrorCode>
        <ErrorMessage>string</ErrorMessage>
        <BusinessObjectList>
          <TrackableItem>
            <TrackableItemNumbers xsi:nil="true" />
            <ItemStatus xsi:nil="true" />
            <BatchNumber>string</BatchNumber>
            <BatchQuantity>int</BatchQuantity>
            <Site xsi:nil="true" />
            <Location xsi:nil="true" />
            <Container xsi:nil="true" />
            <ActualCost>decimal</ActualCost>
            <ReceivedDate>dateTime</ReceivedDate>
            <DespatchedDate>dateTime</DespatchedDate>
            <SupplierID>int</SupplierID>
            <SaleOrderDetailID>long</SaleOrderDetailID>
            <Note>string</Note>
            <IsOverSell>boolean</IsOverSell>
            <RANumber>string</RANumber>
          </TrackableItem>
          <TrackableItem>
            <TrackableItemNumbers xsi:nil="true" />
            <ItemStatus xsi:nil="true" />
            <BatchNumber>string</BatchNumber>
            <BatchQuantity>int</BatchQuantity>
            <Site xsi:nil="true" />
            <Location xsi:nil="true" />
            <Container xsi:nil="true" />
            <ActualCost>decimal</ActualCost>
            <ReceivedDate>dateTime</ReceivedDate>
            <DespatchedDate>dateTime</DespatchedDate>
            <SupplierID>int</SupplierID>
            <SaleOrderDetailID>long</SaleOrderDetailID>
            <Note>string</Note>
            <IsOverSell>boolean</IsOverSell>
            <RANumber>string</RANumber>
          </TrackableItem>
        </BusinessObjectList>
        <ActualRecordsCount>int</ActualRecordsCount>
        <MetaData>string</MetaData>
        <BusinessObjectBool>boolean</BusinessObjectBool>
      </TrackableItemListResult>
    </TrackableItemListResponse>
  </soap12:Body>
</soap12:Envelope>