WebServices3 Web Service

WebServices3

Click here for a complete list of operations.

Catalog_InternalProduct_SearchByComplexPhrase

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 /WebServices3.asmx HTTP/1.1
Host: demo.bvcommerce.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3/Catalog_InternalProduct_SearchByComplexPhrase"

<?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>
    <Catalog_InternalProduct_SearchByComplexPhrase xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
      <ProductSearchCriteria>
        <Keyword>string</Keyword>
        <KeywordIsExact>boolean</KeywordIsExact>
        <ManufacturerId>string</ManufacturerId>
        <VendorId>string</VendorId>
        <ParentId>string</ParentId>
        <Status>Active or Disabled or NotSet</Status>
        <InventoryStatus>NotAvailable or Available or NotSet</InventoryStatus>
        <ProductTypeId>string</ProductTypeId>
        <CategoryId>string</CategoryId>
        <NotCategoryId>string</NotCategoryId>
        <MinPrice>decimal</MinPrice>
        <MaxPrice>decimal</MaxPrice>
        <ItemsAddedInLastXDays>int</ItemsAddedInLastXDays>
        <LastXNumberOfItemsAddedToStore>int</LastXNumberOfItemsAddedToStore>
        <SortOrder>NotSet or Ascending or Descending</SortOrder>
        <SortBy>ProductName or ManufacturerName or CreationDate or SitePrice or Vendor</SortBy>
        <ChoicesAndChoiceOptions>
          <Bvin>string</Bvin>
          <ChoiceOptionName>string</ChoiceOptionName>
          <ChoiceName>string</ChoiceName>
          <ChoiceDisplayName>string</ChoiceDisplayName>
          <ProductChoiceId>string</ProductChoiceId>
          <ChoiceOptionId>string</ChoiceOptionId>
        </ChoicesAndChoiceOptions>
        <ChoicesAndChoiceOptions>
          <Bvin>string</Bvin>
          <ChoiceOptionName>string</ChoiceOptionName>
          <ChoiceName>string</ChoiceName>
          <ChoiceDisplayName>string</ChoiceDisplayName>
          <ProductChoiceId>string</ProductChoiceId>
          <ChoiceOptionId>string</ChoiceOptionId>
        </ChoicesAndChoiceOptions>
        <SpecialProductTypeOne>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</SpecialProductTypeOne>
        <SpecialProductTypeTwo>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</SpecialProductTypeTwo>
        <ExcludedSpecialProductTypeOne>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</ExcludedSpecialProductTypeOne>
        <ExcludedSpecialProductTypeTwo>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</ExcludedSpecialProductTypeTwo>
        <CustomProperties>
          <PropertyBvin>string</PropertyBvin>
          <PropertyValue>string</PropertyValue>
        </CustomProperties>
        <CustomProperties>
          <PropertyBvin>string</PropertyBvin>
          <PropertyValue>string</PropertyValue>
        </CustomProperties>
      </ProductSearchCriteria>
      <shopperId>string</shopperId>
      <ignoreMetrics>boolean</ignoreMetrics>
      <startRowIndex>int</startRowIndex>
      <maximumRows>int</maximumRows>
      <rowCount>int</rowCount>
    </Catalog_InternalProduct_SearchByComplexPhrase>
  </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>
    <Catalog_InternalProduct_SearchByComplexPhraseResponse xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <Catalog_InternalProduct_SearchByComplexPhraseResult>
        <ProductSearchResultGroup>
          <GroupName>string</GroupName>
          <Products>
            <Product xsi:nil="true" />
            <Product xsi:nil="true" />
          </Products>
          <InfoMessage>string</InfoMessage>
        </ProductSearchResultGroup>
        <ProductSearchResultGroup>
          <GroupName>string</GroupName>
          <Products>
            <Product xsi:nil="true" />
            <Product xsi:nil="true" />
          </Products>
          <InfoMessage>string</InfoMessage>
        </ProductSearchResultGroup>
      </Catalog_InternalProduct_SearchByComplexPhraseResult>
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
      <rowCount>int</rowCount>
    </Catalog_InternalProduct_SearchByComplexPhraseResponse>
  </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 /WebServices3.asmx HTTP/1.1
Host: demo.bvcommerce.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>
    <Catalog_InternalProduct_SearchByComplexPhrase xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
      <ProductSearchCriteria>
        <Keyword>string</Keyword>
        <KeywordIsExact>boolean</KeywordIsExact>
        <ManufacturerId>string</ManufacturerId>
        <VendorId>string</VendorId>
        <ParentId>string</ParentId>
        <Status>Active or Disabled or NotSet</Status>
        <InventoryStatus>NotAvailable or Available or NotSet</InventoryStatus>
        <ProductTypeId>string</ProductTypeId>
        <CategoryId>string</CategoryId>
        <NotCategoryId>string</NotCategoryId>
        <MinPrice>decimal</MinPrice>
        <MaxPrice>decimal</MaxPrice>
        <ItemsAddedInLastXDays>int</ItemsAddedInLastXDays>
        <LastXNumberOfItemsAddedToStore>int</LastXNumberOfItemsAddedToStore>
        <SortOrder>NotSet or Ascending or Descending</SortOrder>
        <SortBy>ProductName or ManufacturerName or CreationDate or SitePrice or Vendor</SortBy>
        <ChoicesAndChoiceOptions>
          <Bvin>string</Bvin>
          <ChoiceOptionName>string</ChoiceOptionName>
          <ChoiceName>string</ChoiceName>
          <ChoiceDisplayName>string</ChoiceDisplayName>
          <ProductChoiceId>string</ProductChoiceId>
          <ChoiceOptionId>string</ChoiceOptionId>
        </ChoicesAndChoiceOptions>
        <ChoicesAndChoiceOptions>
          <Bvin>string</Bvin>
          <ChoiceOptionName>string</ChoiceOptionName>
          <ChoiceName>string</ChoiceName>
          <ChoiceDisplayName>string</ChoiceDisplayName>
          <ProductChoiceId>string</ProductChoiceId>
          <ChoiceOptionId>string</ChoiceOptionId>
        </ChoicesAndChoiceOptions>
        <SpecialProductTypeOne>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</SpecialProductTypeOne>
        <SpecialProductTypeTwo>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</SpecialProductTypeTwo>
        <ExcludedSpecialProductTypeOne>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</ExcludedSpecialProductTypeOne>
        <ExcludedSpecialProductTypeTwo>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</ExcludedSpecialProductTypeTwo>
        <CustomProperties>
          <PropertyBvin>string</PropertyBvin>
          <PropertyValue>string</PropertyValue>
        </CustomProperties>
        <CustomProperties>
          <PropertyBvin>string</PropertyBvin>
          <PropertyValue>string</PropertyValue>
        </CustomProperties>
      </ProductSearchCriteria>
      <shopperId>string</shopperId>
      <ignoreMetrics>boolean</ignoreMetrics>
      <startRowIndex>int</startRowIndex>
      <maximumRows>int</maximumRows>
      <rowCount>int</rowCount>
    </Catalog_InternalProduct_SearchByComplexPhrase>
  </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>
    <Catalog_InternalProduct_SearchByComplexPhraseResponse xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <Catalog_InternalProduct_SearchByComplexPhraseResult>
        <ProductSearchResultGroup>
          <GroupName>string</GroupName>
          <Products>
            <Product xsi:nil="true" />
            <Product xsi:nil="true" />
          </Products>
          <InfoMessage>string</InfoMessage>
        </ProductSearchResultGroup>
        <ProductSearchResultGroup>
          <GroupName>string</GroupName>
          <Products>
            <Product xsi:nil="true" />
            <Product xsi:nil="true" />
          </Products>
          <InfoMessage>string</InfoMessage>
        </ProductSearchResultGroup>
      </Catalog_InternalProduct_SearchByComplexPhraseResult>
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
      <rowCount>int</rowCount>
    </Catalog_InternalProduct_SearchByComplexPhraseResponse>
  </soap12:Body>
</soap12:Envelope>