WebServices3 Web Service

WebServices3

Click here for a complete list of operations.

Catalog_GiftCertificate_FindAll_WithPaging

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_GiftCertificate_FindAll_WithPaging"

<?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_GiftCertificate_FindAll_WithPaging 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>
      <startRowIndex>int</startRowIndex>
      <maximumRows>int</maximumRows>
      <rowCount>int</rowCount>
    </Catalog_GiftCertificate_FindAll_WithPaging>
  </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_GiftCertificate_FindAll_WithPagingResponse xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <Catalog_GiftCertificate_FindAll_WithPagingResult>
        <GiftCertificate>
          <LineItemId>string</LineItemId>
          <CertificateCode>string</CertificateCode>
          <DateIssued>dateTime</DateIssued>
          <OriginalAmount>decimal</OriginalAmount>
          <CurrentAmount>decimal</CurrentAmount>
          <IsValid>boolean</IsValid>
          <AssociatedProductId>string</AssociatedProductId>
          <AssociatedProduct ParentId="string">
            <Groups xsi:nil="true" />
            <SitePriceForDisplay>string</SitePriceForDisplay>
            <GlobalProduct xsi:nil="true" />
            <Sku>string</Sku>
            <ProductName>string</ProductName>
            <Upc>string</Upc>
            <Mpn>string</Mpn>
            <ProductTypeId>string</ProductTypeId>
            <AdditionalImages xsi:nil="true" />
            <ListPrice>decimal</ListPrice>
            <Reviews xsi:nil="true" />
            <RegularPrice>decimal</RegularPrice>
            <SitePrice>decimal</SitePrice>
            <CurrentPriceOverrideText>string</CurrentPriceOverrideText>
            <SitePriceOverrideText>string</SitePriceOverrideText>
            <SiteCost>decimal</SiteCost>
            <MetaKeywords>string</MetaKeywords>
            <MetaDescription>string</MetaDescription>
            <MetaTitle>string</MetaTitle>
            <TaxExempt>boolean</TaxExempt>
            <TaxClass>string</TaxClass>
            <NonShipping>boolean</NonShipping>
            <ShipSeparately>boolean</ShipSeparately>
            <ShippingMode>None or ShipFromSite or ShipFromVendor or ShipFromManufacturer</ShippingMode>
            <ShippingWeight>decimal</ShippingWeight>
            <ShippingLength>decimal</ShippingLength>
            <ShippingWidth>decimal</ShippingWidth>
            <ShippingHeight>decimal</ShippingHeight>
            <SpecialProductType>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</SpecialProductType>
            <Status>Active or Disabled or NotSet</Status>
            <ImageFileSmall>string</ImageFileSmall>
            <ImageFileSmallAlternateText>string</ImageFileSmallAlternateText>
            <ImageFileMedium>string</ImageFileMedium>
            <ImageFileMediumAlternateText>string</ImageFileMediumAlternateText>
            <CreationDate>dateTime</CreationDate>
            <MinimumQty>int</MinimumQty>
            <VariantDisplay>None or GridSingleSelection or GridMultipleSelection or IndividualFields</VariantDisplay>
            <ProductURL>string</ProductURL>
            <ChoicesAndInputs xsi:nil="true" />
            <ShortDescription>string</ShortDescription>
            <LongDescription>string</LongDescription>
            <ManufacturerId>string</ManufacturerId>
            <VendorId>string</VendorId>
            <GiftWrapAllowed>boolean</GiftWrapAllowed>
            <ExtraShipFee>decimal</ExtraShipFee>
            <Keywords>string</Keywords>
            <TemplateName>string</TemplateName>
            <PreContentColumnId>string</PreContentColumnId>
            <PostContentColumnId>string</PostContentColumnId>
            <RewriteUrl>string</RewriteUrl>
            <ChoiceCombinations xsi:nil="true" />
            <Categories xsi:nil="true" />
            <IsNew>boolean</IsNew>
            <GiftCertificateCodePattern>string</GiftCertificateCodePattern>
            <PreTransformLongDescription>string</PreTransformLongDescription>
            <HasVariants>boolean</HasVariants>
            <TrackInventory>boolean</TrackInventory>
            <OutOfStockMode>NotSet or RemoveFromStore or LeaveOnStore or OutOfStockAllowOrders or OutOfStockDisallowOrders</OutOfStockMode>
            <CustomProperties xsi:nil="true" />
            <GiftWrapPrice>decimal</GiftWrapPrice>
          </AssociatedProduct>
        </GiftCertificate>
        <GiftCertificate>
          <LineItemId>string</LineItemId>
          <CertificateCode>string</CertificateCode>
          <DateIssued>dateTime</DateIssued>
          <OriginalAmount>decimal</OriginalAmount>
          <CurrentAmount>decimal</CurrentAmount>
          <IsValid>boolean</IsValid>
          <AssociatedProductId>string</AssociatedProductId>
          <AssociatedProduct ParentId="string">
            <Groups xsi:nil="true" />
            <SitePriceForDisplay>string</SitePriceForDisplay>
            <GlobalProduct xsi:nil="true" />
            <Sku>string</Sku>
            <ProductName>string</ProductName>
            <Upc>string</Upc>
            <Mpn>string</Mpn>
            <ProductTypeId>string</ProductTypeId>
            <AdditionalImages xsi:nil="true" />
            <ListPrice>decimal</ListPrice>
            <Reviews xsi:nil="true" />
            <RegularPrice>decimal</RegularPrice>
            <SitePrice>decimal</SitePrice>
            <CurrentPriceOverrideText>string</CurrentPriceOverrideText>
            <SitePriceOverrideText>string</SitePriceOverrideText>
            <SiteCost>decimal</SiteCost>
            <MetaKeywords>string</MetaKeywords>
            <MetaDescription>string</MetaDescription>
            <MetaTitle>string</MetaTitle>
            <TaxExempt>boolean</TaxExempt>
            <TaxClass>string</TaxClass>
            <NonShipping>boolean</NonShipping>
            <ShipSeparately>boolean</ShipSeparately>
            <ShippingMode>None or ShipFromSite or ShipFromVendor or ShipFromManufacturer</ShippingMode>
            <ShippingWeight>decimal</ShippingWeight>
            <ShippingLength>decimal</ShippingLength>
            <ShippingWidth>decimal</ShippingWidth>
            <ShippingHeight>decimal</ShippingHeight>
            <SpecialProductType>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</SpecialProductType>
            <Status>Active or Disabled or NotSet</Status>
            <ImageFileSmall>string</ImageFileSmall>
            <ImageFileSmallAlternateText>string</ImageFileSmallAlternateText>
            <ImageFileMedium>string</ImageFileMedium>
            <ImageFileMediumAlternateText>string</ImageFileMediumAlternateText>
            <CreationDate>dateTime</CreationDate>
            <MinimumQty>int</MinimumQty>
            <VariantDisplay>None or GridSingleSelection or GridMultipleSelection or IndividualFields</VariantDisplay>
            <ProductURL>string</ProductURL>
            <ChoicesAndInputs xsi:nil="true" />
            <ShortDescription>string</ShortDescription>
            <LongDescription>string</LongDescription>
            <ManufacturerId>string</ManufacturerId>
            <VendorId>string</VendorId>
            <GiftWrapAllowed>boolean</GiftWrapAllowed>
            <ExtraShipFee>decimal</ExtraShipFee>
            <Keywords>string</Keywords>
            <TemplateName>string</TemplateName>
            <PreContentColumnId>string</PreContentColumnId>
            <PostContentColumnId>string</PostContentColumnId>
            <RewriteUrl>string</RewriteUrl>
            <ChoiceCombinations xsi:nil="true" />
            <Categories xsi:nil="true" />
            <IsNew>boolean</IsNew>
            <GiftCertificateCodePattern>string</GiftCertificateCodePattern>
            <PreTransformLongDescription>string</PreTransformLongDescription>
            <HasVariants>boolean</HasVariants>
            <TrackInventory>boolean</TrackInventory>
            <OutOfStockMode>NotSet or RemoveFromStore or LeaveOnStore or OutOfStockAllowOrders or OutOfStockDisallowOrders</OutOfStockMode>
            <CustomProperties xsi:nil="true" />
            <GiftWrapPrice>decimal</GiftWrapPrice>
          </AssociatedProduct>
        </GiftCertificate>
      </Catalog_GiftCertificate_FindAll_WithPagingResult>
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
      <rowCount>int</rowCount>
    </Catalog_GiftCertificate_FindAll_WithPagingResponse>
  </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_GiftCertificate_FindAll_WithPaging 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>
      <startRowIndex>int</startRowIndex>
      <maximumRows>int</maximumRows>
      <rowCount>int</rowCount>
    </Catalog_GiftCertificate_FindAll_WithPaging>
  </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_GiftCertificate_FindAll_WithPagingResponse xmlns="http://www.bvsoftware.com/Schemas/Bvc5/2006/01/WebServices3">
      <Catalog_GiftCertificate_FindAll_WithPagingResult>
        <GiftCertificate>
          <LineItemId>string</LineItemId>
          <CertificateCode>string</CertificateCode>
          <DateIssued>dateTime</DateIssued>
          <OriginalAmount>decimal</OriginalAmount>
          <CurrentAmount>decimal</CurrentAmount>
          <IsValid>boolean</IsValid>
          <AssociatedProductId>string</AssociatedProductId>
          <AssociatedProduct ParentId="string">
            <Groups xsi:nil="true" />
            <SitePriceForDisplay>string</SitePriceForDisplay>
            <GlobalProduct xsi:nil="true" />
            <Sku>string</Sku>
            <ProductName>string</ProductName>
            <Upc>string</Upc>
            <Mpn>string</Mpn>
            <ProductTypeId>string</ProductTypeId>
            <AdditionalImages xsi:nil="true" />
            <ListPrice>decimal</ListPrice>
            <Reviews xsi:nil="true" />
            <RegularPrice>decimal</RegularPrice>
            <SitePrice>decimal</SitePrice>
            <CurrentPriceOverrideText>string</CurrentPriceOverrideText>
            <SitePriceOverrideText>string</SitePriceOverrideText>
            <SiteCost>decimal</SiteCost>
            <MetaKeywords>string</MetaKeywords>
            <MetaDescription>string</MetaDescription>
            <MetaTitle>string</MetaTitle>
            <TaxExempt>boolean</TaxExempt>
            <TaxClass>string</TaxClass>
            <NonShipping>boolean</NonShipping>
            <ShipSeparately>boolean</ShipSeparately>
            <ShippingMode>None or ShipFromSite or ShipFromVendor or ShipFromManufacturer</ShippingMode>
            <ShippingWeight>decimal</ShippingWeight>
            <ShippingLength>decimal</ShippingLength>
            <ShippingWidth>decimal</ShippingWidth>
            <ShippingHeight>decimal</ShippingHeight>
            <SpecialProductType>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</SpecialProductType>
            <Status>Active or Disabled or NotSet</Status>
            <ImageFileSmall>string</ImageFileSmall>
            <ImageFileSmallAlternateText>string</ImageFileSmallAlternateText>
            <ImageFileMedium>string</ImageFileMedium>
            <ImageFileMediumAlternateText>string</ImageFileMediumAlternateText>
            <CreationDate>dateTime</CreationDate>
            <MinimumQty>int</MinimumQty>
            <VariantDisplay>None or GridSingleSelection or GridMultipleSelection or IndividualFields</VariantDisplay>
            <ProductURL>string</ProductURL>
            <ChoicesAndInputs xsi:nil="true" />
            <ShortDescription>string</ShortDescription>
            <LongDescription>string</LongDescription>
            <ManufacturerId>string</ManufacturerId>
            <VendorId>string</VendorId>
            <GiftWrapAllowed>boolean</GiftWrapAllowed>
            <ExtraShipFee>decimal</ExtraShipFee>
            <Keywords>string</Keywords>
            <TemplateName>string</TemplateName>
            <PreContentColumnId>string</PreContentColumnId>
            <PostContentColumnId>string</PostContentColumnId>
            <RewriteUrl>string</RewriteUrl>
            <ChoiceCombinations xsi:nil="true" />
            <Categories xsi:nil="true" />
            <IsNew>boolean</IsNew>
            <GiftCertificateCodePattern>string</GiftCertificateCodePattern>
            <PreTransformLongDescription>string</PreTransformLongDescription>
            <HasVariants>boolean</HasVariants>
            <TrackInventory>boolean</TrackInventory>
            <OutOfStockMode>NotSet or RemoveFromStore or LeaveOnStore or OutOfStockAllowOrders or OutOfStockDisallowOrders</OutOfStockMode>
            <CustomProperties xsi:nil="true" />
            <GiftWrapPrice>decimal</GiftWrapPrice>
          </AssociatedProduct>
        </GiftCertificate>
        <GiftCertificate>
          <LineItemId>string</LineItemId>
          <CertificateCode>string</CertificateCode>
          <DateIssued>dateTime</DateIssued>
          <OriginalAmount>decimal</OriginalAmount>
          <CurrentAmount>decimal</CurrentAmount>
          <IsValid>boolean</IsValid>
          <AssociatedProductId>string</AssociatedProductId>
          <AssociatedProduct ParentId="string">
            <Groups xsi:nil="true" />
            <SitePriceForDisplay>string</SitePriceForDisplay>
            <GlobalProduct xsi:nil="true" />
            <Sku>string</Sku>
            <ProductName>string</ProductName>
            <Upc>string</Upc>
            <Mpn>string</Mpn>
            <ProductTypeId>string</ProductTypeId>
            <AdditionalImages xsi:nil="true" />
            <ListPrice>decimal</ListPrice>
            <Reviews xsi:nil="true" />
            <RegularPrice>decimal</RegularPrice>
            <SitePrice>decimal</SitePrice>
            <CurrentPriceOverrideText>string</CurrentPriceOverrideText>
            <SitePriceOverrideText>string</SitePriceOverrideText>
            <SiteCost>decimal</SiteCost>
            <MetaKeywords>string</MetaKeywords>
            <MetaDescription>string</MetaDescription>
            <MetaTitle>string</MetaTitle>
            <TaxExempt>boolean</TaxExempt>
            <TaxClass>string</TaxClass>
            <NonShipping>boolean</NonShipping>
            <ShipSeparately>boolean</ShipSeparately>
            <ShippingMode>None or ShipFromSite or ShipFromVendor or ShipFromManufacturer</ShippingMode>
            <ShippingWeight>decimal</ShippingWeight>
            <ShippingLength>decimal</ShippingLength>
            <ShippingWidth>decimal</ShippingWidth>
            <ShippingHeight>decimal</ShippingHeight>
            <SpecialProductType>NotSet or Normal or GiftCertificate or ArbitrarilyPricedGiftCertificate or Kit</SpecialProductType>
            <Status>Active or Disabled or NotSet</Status>
            <ImageFileSmall>string</ImageFileSmall>
            <ImageFileSmallAlternateText>string</ImageFileSmallAlternateText>
            <ImageFileMedium>string</ImageFileMedium>
            <ImageFileMediumAlternateText>string</ImageFileMediumAlternateText>
            <CreationDate>dateTime</CreationDate>
            <MinimumQty>int</MinimumQty>
            <VariantDisplay>None or GridSingleSelection or GridMultipleSelection or IndividualFields</VariantDisplay>
            <ProductURL>string</ProductURL>
            <ChoicesAndInputs xsi:nil="true" />
            <ShortDescription>string</ShortDescription>
            <LongDescription>string</LongDescription>
            <ManufacturerId>string</ManufacturerId>
            <VendorId>string</VendorId>
            <GiftWrapAllowed>boolean</GiftWrapAllowed>
            <ExtraShipFee>decimal</ExtraShipFee>
            <Keywords>string</Keywords>
            <TemplateName>string</TemplateName>
            <PreContentColumnId>string</PreContentColumnId>
            <PostContentColumnId>string</PostContentColumnId>
            <RewriteUrl>string</RewriteUrl>
            <ChoiceCombinations xsi:nil="true" />
            <Categories xsi:nil="true" />
            <IsNew>boolean</IsNew>
            <GiftCertificateCodePattern>string</GiftCertificateCodePattern>
            <PreTransformLongDescription>string</PreTransformLongDescription>
            <HasVariants>boolean</HasVariants>
            <TrackInventory>boolean</TrackInventory>
            <OutOfStockMode>NotSet or RemoveFromStore or LeaveOnStore or OutOfStockAllowOrders or OutOfStockDisallowOrders</OutOfStockMode>
            <CustomProperties xsi:nil="true" />
            <GiftWrapPrice>decimal</GiftWrapPrice>
          </AssociatedProduct>
        </GiftCertificate>
      </Catalog_GiftCertificate_FindAll_WithPagingResult>
      <token>
        <ExpirationDate>dateTime</ExpirationDate>
        <ExpirationDateUTC>dateTime</ExpirationDateUTC>
        <UserBvin>string</UserBvin>
        <TokenRejected>boolean</TokenRejected>
        <IsExpired>boolean</IsExpired>
      </token>
      <rowCount>int</rowCount>
    </Catalog_GiftCertificate_FindAll_WithPagingResponse>
  </soap12:Body>
</soap12:Envelope>