TOP

AddUpdateProduct()

Part Of: Product Webservice 3.0

WSDL:

https://webservices.vin65.com/V300/ProductService.cfc?wsdl

Australian URL:

https://webservices.aus.vin65.com/V300/ProductService.cfc?wsdl

Description:

Use the AddUpdateProduct() function to add or update a product in Vin65. Required fields are indicated by a '*'

**Note - You must send all product attributes in an update request or they will be cleared out. Recommended practice is to getProductDetails prior to update and sync the changes then push the full product up**

Parameters:

Attribute Data Type Default Description
WebsiteID* UUID   Only required for Enterprise Webservices
UUID of the Vin65 Website
ProductID UUID   UUID of the Vin65 Product
Type*

Enumerated
("Product", "Wine", "Spirit", "WineProduct", "Bundle", "GiftCard", "EventTicket", "MarketingCollateral")

   
Brand String 50   If Mode eq 'CreateAttributes' Brand will be created on the fly.  If Mode eq 'Strict' Brand must exist or add/update will error.
Title String 255    
POSTitle String 50    
SubTitle String 255    
ActionMessage String 255    
IsActive Boolean 0  
IsDisplayOnWebsite Boolean 0  
Description      
Description:Teaser String    
Description:Descripton: String    
WineProperties      
WineProperties:BottlesInCase Integer    
WineProperties:BottleSize String 50   If Mode eq 'CreateAttributes' BottleSize will be created on the fly. If Mode eq 'Strict' BottleSize must exist or add/update will error.
WineProperties:BottleSizeInML Integer   If Mode eq 'CreateAttributes' BottleSize will be created on the fly. If Mode eq 'Strict' BottleSize must exist or add/update will error.
WineProperties:Vintage Integer    
WineProperties:Type String 50   Required if Varietal Provided.
If Mode eq 'CreateAttributes' Type will be created on the fly. If Mode eq 'Strict' Type must exist or add/update will error.
WineProperties:Varietal String 255   If Mode eq 'CreateAttributes' Varietal will be created on the fly. If Mode eq 'Strict' Varietal must exist or add/update will error.
WineProperties:Region String 255   Required if Appellation Provided.
If Mode eq 'CreateAttributes' Region will be created on the fly. If Mode eq 'Strict' Region must exist or add/update will error.
WineProperties:Appellation String 255   If Mode eq 'CreateAttributes' Appellation will be created on the fly. If Mode eq 'Strict' Appellation must exist or add/update will error.
WineProperties:WSRating Integer    
WineProperties:WAndSRating Integer    
WineProperties:CGRating Integer    
WineProperties:RPRating Integer    
WineProperties:JHRating Integer    
WineProperties:STRating Integer    
WineProperties:WNRating Integer    
WineProperties:WERating Integer    
WineProperties:WARating Integer    
WineProperties:WBRating Integer    
WineProperties:AvgRating Numeric   Vin65 Calculated Field
WineProperties:HarvestDate String 255    
WineProperties:Sugar String 255    
WineProperties:Acid String 255    
WineProperties:PH String 255    
WineProperties:Fermentation String 255    
WineProperties:BottlingDate String 255    
WineProperties:ResidualSugar String 255    
WineProperties:Tannin String 255    
WineProperties:Alcohol String 255    
WineProperties:TastingNotes String    
WineProperties:Ratings String    
WineProperties:Awards String    
WineProperties:VineyardDesignation String 255    
WineProperties:VineyardNotes String    
WineProperties:ProductionNotes String    
WineProperties:WineMakerNotes String    
WineProperties:FoodPairingNotes String    
WineProperties:Production String    
WineProperties:OtherNotes String    
SpiritProperties      
SpiritProperties:Type String 255    
SpiritProperties:Country String 255    
SpiritProperties:Region String 255    
Photos      
Photos:Photo String 250   Required if Photo Provided
Photos:Title String 255    
Photos:Caption String    
Photos:DisplayOrder Integer    
BundleItems      
BundleItems:Quantity Integer   Required if Type is Bundle
BundleItems:SKU String 50  

Required if Type is Bundle.
SKU must exist before bundle can be created.

Media      
Media:Type Enumerated
("PDF")
  Required if Media Provided
Media:File String 255   Required if Media Provided
Media:Thumbnail String 255    
Media:Title String 255   Required if Media Provided
Media:Caption String 255    
Media:DisplayOrder Integer    
VintageNotes      
VintageNotes:Vintage Integer   Required if Vintage Note Provided
VintageNotes:Note String   Required if Vintage Note Provided
SKUs      
SKUs:SKU String 50   Required for all SKUs
SKUs:CostOfGood Numeric    
SKUs:UPCCode String 255    
SKUs:UnitDescription String 255    
SKUs:MinOrderQty Integer 1  
SKUs:MaxOrderQty Integer    
SKUs:OrderInMultiplesOf Integer    
SKUs:Weight Numeric 0  
SKUs:IsNonTaxable Boolean 0  
SKUs:IsNoShippingCharge Boolean    
SKUs:DisplayOrder Integer    
SKUs:Prices      
SKUs:Prices:PriceLevel String 50   Price Level must exist or add/update will error.
SKUs:Prices:Price Numeric   Required for all SKU Prices
SKUs:Prices:SalePrice Numeric    
SKUs:Prices:PriceQuantity Integer    
SKUs:IsInventoryOn Boolean 0  
SKUs:Inventory      
SKUs:Inventory:InventoryPool* String 50   Inventory Pool must exist or add/update will error.
SKUs:Inventory:CurrentInventory Integer    
DateAdded Date/Time    
DateModified Date/Time    

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <AddUpdateProductDetail>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <Product>
        <WebsiteID></WebsiteID>
        <ProductID></ProductID>
        <Type>Wine</Type>
        <Brand></Brand>
        <Title>Merlot Via Webservice</Title>
        <SubTitle></SubTitle>
        <POSTitle></POSTitle>
        <ActionMessage></ActionMessage>
        <IsActive>false</IsActive>
        <IsDisplayOnWebsite>false</IsDisplayOnWebsite>
        <Description>
          <Teaser></Teaser>
          <Description></Description>
        </Description>
        <WineProperties>
          <BottlesInCase></BottlesInCase>
          <BottleSize>750ml</BottleSize>
          <Vintage></Vintage>
          <Type>Red</Type>
          <Varietal>Merlot</Varietal>
          <Region>Australia</Region>
          <Appellation></Appellation>
          <WSRating></W SRating>
          <WAndSRating></WAndSRating>
          <CGRating></CGRating>
          <RPRating></RPRating>
          <JHRating></JHRating>
          <STRating></STRating>
          <WNRating></WNRating>
          <WERating></WERating>
          <WARating></WARating>
          <WBRating></WBRating>
          <AvgRating></AvgRating>
          <HarvestDate></HarvestDate>
          <Sugar></Sugar>
          <Acid></Acid>
          <PH></PH>
          <Fermentation></Fermentation>
          <BottlingDate></BottlingDate>
          <ResidualSugar></ResidualSugar>
          <Tannin></Tannin>
          <Alcohol></Alcohol>
          <TastingNotes></TastingNotes>
          <Ratings></Ratings>
          <Awards></Awards>
          <VineyardDesignation></VineyardDesignation>
          <VineyardNotes></VineyardNotes>
          <ProductionNotes></ProductionNotes>
          <WineMakerNotes></WineMakerNotes>
          <FoodPairingNotes></FoodPairingNotes>
          <Production></Production>
          <OtherNotes></OtherNotes>
        </WineProperties>
        <Photos>
          <Photo>
            <Photo>Tinsel.jpg</Photo>
            <Title>Testing</Title>
            <Caption></Caption>
            <DisplayOrder>1</DisplayOrder>
          </Photo>
        </Photos>
        <Media>
          <Media>
            <Type>PDF</Type>
            <File>123.jpg</File>
            <Thumbnail></Thumbnail>
            <Title>Media Title</Title>
            <Caption>Caption</Caption>
            <DisplayOrder></DisplayOrder>
          </Media>
          <Media>
            <Type>PDF</Type>
            <File>1234.jpg</File>
            <Thumbnail></Thumbnail>
            <Title>Media2 Title</Title>
            <Caption>Caption2</Caption>
            <DisplayOrder>2</DisplayOrder>
          </Media>
        </Media>
        <VintageNotes>
          <VintageNote>
            <Vintage>2000</Vintage>
            <Note>this is the notes</Note>
          </VintageNote>
          <VintageNote>
            <Vintage>2001</Vintage>
            <Note>this is the notes</Note>
          </VintageNote>
        </VintageNotes>
        <SKUs>
          <SKU>
            <SKU>Merlot</SKU>
            <CostOfGood>10.00</CostOfGood>
            <UPCCode></UPCCode>
            <UnitDescription></UnitDescription>
            <MinOrderQty></MinOrderQty>
            <MaxOrderQty></MaxOrderQty>
            <OrderInMultiplesOf></OrderInMultiplesOf>
            <Weight></Weight>
            <IsNonTaxable></IsNonTaxable>
            <IsNoShippingCharge></IsNoShippingCharge>
            <DisplayOrder></DisplayOrder>
            <Prices>
              <Price>
                <PriceLevel></PriceLevel>
                <Price>200.00</Price>
                <SalePrice></SalePrice>
                <PriceQuantity></PriceQuantity>
              </Price>
            </Prices>
            <IsInventoryOn>1</IsInventoryOn>
            <Inventory>
              <Inventory>
                <InventoryPool></InventoryPool>
                <CurrentInventory>20</CurrentInventory>
              </Inventory>
            </Inventory>
          </SKU>
        </SKUs>
      </Product>
      <Mode>Strict</Mode>
    </Request>
  </AddUpdateProductDetail>
</soap:Body>  
</soap:Envelope>  

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="ht tp://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <AddUpdateProductDetailResponse>
    <AddUpdateProductDetailReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <ProductID>1ce73176-e448-faac-3d8f-a52333091695</ProductID>
      <RecordCount>1</RecordCount>
    </AddUpdateProductDetailReturn>
  </AddUpdateProductDetailResponse>
</soapenv:Body>
</soapenv:Envelope>   

Page Top