Veetro Web Service Methods


Click here for a complete list of operations.

GetCatalogItemSearchResults

[Deprecated - see GetCatalogItemSearchResults2]

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 /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/GetCatalogItemSearchResults"

<?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>
    <GetCatalogItemSearchResults xmlns="http://schema.veetro.com">
      <StartIndex>int</StartIndex>
      <FetchSize>int</FetchSize>
      <SortColumn>string</SortColumn>
      <Ascending>boolean</Ascending>
      <Keywords>string</Keywords>
      <type>Product or Subscription</type>
    </GetCatalogItemSearchResults>
  </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>
    <GetCatalogItemSearchResultsResponse xmlns="http://schema.veetro.com">
      <GetCatalogItemSearchResultsResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <CatalogItem>
            <CatalogItemID>int</CatalogItemID>
            <CatalogItemCategoryID>int</CatalogItemCategoryID>
            <DateCreated>dateTime</DateCreated>
            <DateLastModified>dateTime</DateLastModified>
            <SKU>string</SKU>
            <UPC>long</UPC>
            <EAN>long</EAN>
            <Type>Product or Subscription</Type>
            <Name>string</Name>
            <DescriptionHtml>string</DescriptionHtml>
            <Unit>None or Minute or Hour or Day or Week or Month or Year or Kilogram or Litre or Gallon or Pound or Item or MegaByte or GigaByte or Instance or User or BiWeek or Word or Line or Student or Class or Foot or Metre or Pair or Inch or Cm or Kit or Piece or Mile or Kilometer or Ct or Voucher or Page or SquareFoot or Tonne or TroyOunce or Case or Location or Each or SquareYard or SquareMeter or Second</Unit>
            <Tag>string</Tag>
            <Brand>string</Brand>
            <Order>int</Order>
            <SubscriptionInterval>int</SubscriptionInterval>
            <SubscriptionIntervalType>None or Minute or Hour or Day or Week or Month or Year</SubscriptionIntervalType>
            <Active>boolean</Active>
            <CommissionValue>double</CommissionValue>
            <CommissionType>None or Fixed_Amount or Percentage</CommissionType>
            <CommissionFlags>None or Pay_For_Every_Renewal</CommissionFlags>
            <EntityID_Commission>int</EntityID_Commission>
            <Supplier xsi:nil="true" />
            <Prices xsi:nil="true" />
            <Promotions xsi:nil="true" />
            <Dependencies xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <PhotoUrl>string</PhotoUrl>
            <CustomFields xsi:nil="true" />
            <Tags xsi:nil="true" />
          </CatalogItem>
          <CatalogItem>
            <CatalogItemID>int</CatalogItemID>
            <CatalogItemCategoryID>int</CatalogItemCategoryID>
            <DateCreated>dateTime</DateCreated>
            <DateLastModified>dateTime</DateLastModified>
            <SKU>string</SKU>
            <UPC>long</UPC>
            <EAN>long</EAN>
            <Type>Product or Subscription</Type>
            <Name>string</Name>
            <DescriptionHtml>string</DescriptionHtml>
            <Unit>None or Minute or Hour or Day or Week or Month or Year or Kilogram or Litre or Gallon or Pound or Item or MegaByte or GigaByte or Instance or User or BiWeek or Word or Line or Student or Class or Foot or Metre or Pair or Inch or Cm or Kit or Piece or Mile or Kilometer or Ct or Voucher or Page or SquareFoot or Tonne or TroyOunce or Case or Location or Each or SquareYard or SquareMeter or Second</Unit>
            <Tag>string</Tag>
            <Brand>string</Brand>
            <Order>int</Order>
            <SubscriptionInterval>int</SubscriptionInterval>
            <SubscriptionIntervalType>None or Minute or Hour or Day or Week or Month or Year</SubscriptionIntervalType>
            <Active>boolean</Active>
            <CommissionValue>double</CommissionValue>
            <CommissionType>None or Fixed_Amount or Percentage</CommissionType>
            <CommissionFlags>None or Pay_For_Every_Renewal</CommissionFlags>
            <EntityID_Commission>int</EntityID_Commission>
            <Supplier xsi:nil="true" />
            <Prices xsi:nil="true" />
            <Promotions xsi:nil="true" />
            <Dependencies xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <PhotoUrl>string</PhotoUrl>
            <CustomFields xsi:nil="true" />
            <Tags xsi:nil="true" />
          </CatalogItem>
        </Results>
      </GetCatalogItemSearchResultsResult>
    </GetCatalogItemSearchResultsResponse>
  </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 /xml HTTP/1.1
Host: admin.worketc.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>
    <GetCatalogItemSearchResults xmlns="http://schema.veetro.com">
      <StartIndex>int</StartIndex>
      <FetchSize>int</FetchSize>
      <SortColumn>string</SortColumn>
      <Ascending>boolean</Ascending>
      <Keywords>string</Keywords>
      <type>Product or Subscription</type>
    </GetCatalogItemSearchResults>
  </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>
    <GetCatalogItemSearchResultsResponse xmlns="http://schema.veetro.com">
      <GetCatalogItemSearchResultsResult>
        <RecordCount>int</RecordCount>
        <Description>string</Description>
        <SQL>string</SQL>
        <FetchSize>int</FetchSize>
        <Page>int</Page>
        <StartIndex>int</StartIndex>
        <EndIndex>int</EndIndex>
        <Results>
          <CatalogItem>
            <CatalogItemID>int</CatalogItemID>
            <CatalogItemCategoryID>int</CatalogItemCategoryID>
            <DateCreated>dateTime</DateCreated>
            <DateLastModified>dateTime</DateLastModified>
            <SKU>string</SKU>
            <UPC>long</UPC>
            <EAN>long</EAN>
            <Type>Product or Subscription</Type>
            <Name>string</Name>
            <DescriptionHtml>string</DescriptionHtml>
            <Unit>None or Minute or Hour or Day or Week or Month or Year or Kilogram or Litre or Gallon or Pound or Item or MegaByte or GigaByte or Instance or User or BiWeek or Word or Line or Student or Class or Foot or Metre or Pair or Inch or Cm or Kit or Piece or Mile or Kilometer or Ct or Voucher or Page or SquareFoot or Tonne or TroyOunce or Case or Location or Each or SquareYard or SquareMeter or Second</Unit>
            <Tag>string</Tag>
            <Brand>string</Brand>
            <Order>int</Order>
            <SubscriptionInterval>int</SubscriptionInterval>
            <SubscriptionIntervalType>None or Minute or Hour or Day or Week or Month or Year</SubscriptionIntervalType>
            <Active>boolean</Active>
            <CommissionValue>double</CommissionValue>
            <CommissionType>None or Fixed_Amount or Percentage</CommissionType>
            <CommissionFlags>None or Pay_For_Every_Renewal</CommissionFlags>
            <EntityID_Commission>int</EntityID_Commission>
            <Supplier xsi:nil="true" />
            <Prices xsi:nil="true" />
            <Promotions xsi:nil="true" />
            <Dependencies xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <PhotoUrl>string</PhotoUrl>
            <CustomFields xsi:nil="true" />
            <Tags xsi:nil="true" />
          </CatalogItem>
          <CatalogItem>
            <CatalogItemID>int</CatalogItemID>
            <CatalogItemCategoryID>int</CatalogItemCategoryID>
            <DateCreated>dateTime</DateCreated>
            <DateLastModified>dateTime</DateLastModified>
            <SKU>string</SKU>
            <UPC>long</UPC>
            <EAN>long</EAN>
            <Type>Product or Subscription</Type>
            <Name>string</Name>
            <DescriptionHtml>string</DescriptionHtml>
            <Unit>None or Minute or Hour or Day or Week or Month or Year or Kilogram or Litre or Gallon or Pound or Item or MegaByte or GigaByte or Instance or User or BiWeek or Word or Line or Student or Class or Foot or Metre or Pair or Inch or Cm or Kit or Piece or Mile or Kilometer or Ct or Voucher or Page or SquareFoot or Tonne or TroyOunce or Case or Location or Each or SquareYard or SquareMeter or Second</Unit>
            <Tag>string</Tag>
            <Brand>string</Brand>
            <Order>int</Order>
            <SubscriptionInterval>int</SubscriptionInterval>
            <SubscriptionIntervalType>None or Minute or Hour or Day or Week or Month or Year</SubscriptionIntervalType>
            <Active>boolean</Active>
            <CommissionValue>double</CommissionValue>
            <CommissionType>None or Fixed_Amount or Percentage</CommissionType>
            <CommissionFlags>None or Pay_For_Every_Renewal</CommissionFlags>
            <EntityID_Commission>int</EntityID_Commission>
            <Supplier xsi:nil="true" />
            <Prices xsi:nil="true" />
            <Promotions xsi:nil="true" />
            <Dependencies xsi:nil="true" />
            <Delete>boolean</Delete>
            <RemoveParentLinks>boolean</RemoveParentLinks>
            <PhotoUrl>string</PhotoUrl>
            <CustomFields xsi:nil="true" />
            <Tags xsi:nil="true" />
          </CatalogItem>
        </Results>
      </GetCatalogItemSearchResultsResult>
    </GetCatalogItemSearchResultsResponse>
  </soap12:Body>
</soap12:Envelope>