ProductData Web Service

ProductData

Click here for a complete list of operations.

getProduct

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 /promostandards/ProductData.asmx HTTP/1.1
Host: api.cbcorporate.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "getProduct"

<?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>
    <GetProductRequest xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/">
      <wsVersion xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</wsVersion>
      <id xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</id>
      <password xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</password>
      <localizationCountry xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</localizationCountry>
      <localizationLanguage xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</localizationLanguage>
      <productId xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</productId>
      <partId xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</partId>
      <colorName xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</colorName>
      <ApparelSizeArray xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">
        <apparelStyle>Unisex or Youth or Girls or Boys or Womens or WomensTall or Mens or MensTall</apparelStyle>
        <labelSize>L or M or S or XL or 2XL or 3XL or OSFA or 4XS or 3XS or 2XS or XS or 4XL or 5XL or CUSTOM</labelSize>
        <customSize>string</customSize>
      </ApparelSizeArray>
      <ApparelSizeArray xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">
        <apparelStyle>Unisex or Youth or Girls or Boys or Womens or WomensTall or Mens or MensTall</apparelStyle>
        <labelSize>L or M or S or XL or 2XL or 3XL or OSFA or 4XS or 3XS or 2XS or XS or 4XL or 5XL or CUSTOM</labelSize>
        <customSize>string</customSize>
      </ApparelSizeArray>
    </GetProductRequest>
  </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>
    <GetProductResponse xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/">
      <ErrorMessage>
        <code>int</code>
        <description>string</description>
        <stacktrace>string</stacktrace>
      </ErrorMessage>
      <Product>
        <productId xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</productId>
        <productName>string</productName>
        <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
        <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
        <ProductKeywordArray>
          <ProductKeyword>
            <keyword>string</keyword>
          </ProductKeyword>
          <ProductKeyword>
            <keyword>string</keyword>
          </ProductKeyword>
        </ProductKeywordArray>
        <productBrand>string</productBrand>
        <export>boolean</export>
        <ProductCategoryArray>
          <ProductCategory>
            <category>string</category>
            <subCategory>string</subCategory>
          </ProductCategory>
          <ProductCategory>
            <category>string</category>
            <subCategory>string</subCategory>
          </ProductCategory>
        </ProductCategoryArray>
        <RelatedProductArray>
          <RelatedProduct>
            <relationType>Substitute or CompanionSell or CommonGrouping</relationType>
            <productId>string</productId>
            <partId>string</partId>
          </RelatedProduct>
          <RelatedProduct>
            <relationType>Substitute or CompanionSell or CommonGrouping</relationType>
            <productId>string</productId>
            <partId>string</partId>
          </RelatedProduct>
        </RelatedProductArray>
        <ProductPartArray>
          <ProductPart>
            <partId xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</partId>
            <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
            <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
            <countryOfOrigin xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</countryOfOrigin>
            <ColorArray xsi:nil="true" />
            <primaryMaterial>string</primaryMaterial>
            <shape>string</shape>
            <ApparelSize xsi:nil="true" xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/" />
            <Dimension xsi:nil="true" />
            <leadTime>int</leadTime>
            <unspsc>string</unspsc>
            <gtin>string</gtin>
            <isRushService>boolean</isRushService>
            <ProductPackagingArray xsi:nil="true" />
            <ShippingPackageArray xsi:nil="true" />
            <endDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</endDate>
            <effectiveDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</effectiveDate>
            <isCloseout xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCloseout>
            <isCaution xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCaution>
            <cautionComment>string</cautionComment>
            <nmfcCode>decimal</nmfcCode>
            <nmfcDescription>string</nmfcDescription>
            <nmfcNumber>string</nmfcNumber>
            <isOnDemand>boolean</isOnDemand>
            <isHazmat>boolean</isHazmat>
          </ProductPart>
          <ProductPart>
            <partId xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</partId>
            <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
            <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
            <countryOfOrigin xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</countryOfOrigin>
            <ColorArray xsi:nil="true" />
            <primaryMaterial>string</primaryMaterial>
            <shape>string</shape>
            <ApparelSize xsi:nil="true" xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/" />
            <Dimension xsi:nil="true" />
            <leadTime>int</leadTime>
            <unspsc>string</unspsc>
            <gtin>string</gtin>
            <isRushService>boolean</isRushService>
            <ProductPackagingArray xsi:nil="true" />
            <ShippingPackageArray xsi:nil="true" />
            <endDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</endDate>
            <effectiveDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</effectiveDate>
            <isCloseout xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCloseout>
            <isCaution xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCaution>
            <cautionComment>string</cautionComment>
            <nmfcCode>decimal</nmfcCode>
            <nmfcDescription>string</nmfcDescription>
            <nmfcNumber>string</nmfcNumber>
            <isOnDemand>boolean</isOnDemand>
            <isHazmat>boolean</isHazmat>
          </ProductPart>
        </ProductPartArray>
        <lastChangeDate>dateTime</lastChangeDate>
        <creationDate>dateTime</creationDate>
        <endDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</endDate>
        <effectiveDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</effectiveDate>
        <isCaution xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCaution>
        <isCloseout xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCloseout>
        <cautionComment>string</cautionComment>
        <lineName>string</lineName>
      </Product>
    </GetProductResponse>
  </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 /promostandards/ProductData.asmx HTTP/1.1
Host: api.cbcorporate.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>
    <GetProductRequest xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/">
      <wsVersion xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</wsVersion>
      <id xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</id>
      <password xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</password>
      <localizationCountry xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</localizationCountry>
      <localizationLanguage xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</localizationLanguage>
      <productId xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</productId>
      <partId xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</partId>
      <colorName xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</colorName>
      <ApparelSizeArray xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">
        <apparelStyle>Unisex or Youth or Girls or Boys or Womens or WomensTall or Mens or MensTall</apparelStyle>
        <labelSize>L or M or S or XL or 2XL or 3XL or OSFA or 4XS or 3XS or 2XS or XS or 4XL or 5XL or CUSTOM</labelSize>
        <customSize>string</customSize>
      </ApparelSizeArray>
      <ApparelSizeArray xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">
        <apparelStyle>Unisex or Youth or Girls or Boys or Womens or WomensTall or Mens or MensTall</apparelStyle>
        <labelSize>L or M or S or XL or 2XL or 3XL or OSFA or 4XS or 3XS or 2XS or XS or 4XL or 5XL or CUSTOM</labelSize>
        <customSize>string</customSize>
      </ApparelSizeArray>
    </GetProductRequest>
  </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>
    <GetProductResponse xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/">
      <ErrorMessage>
        <code>int</code>
        <description>string</description>
        <stacktrace>string</stacktrace>
      </ErrorMessage>
      <Product>
        <productId xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</productId>
        <productName>string</productName>
        <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
        <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
        <ProductKeywordArray>
          <ProductKeyword>
            <keyword>string</keyword>
          </ProductKeyword>
          <ProductKeyword>
            <keyword>string</keyword>
          </ProductKeyword>
        </ProductKeywordArray>
        <productBrand>string</productBrand>
        <export>boolean</export>
        <ProductCategoryArray>
          <ProductCategory>
            <category>string</category>
            <subCategory>string</subCategory>
          </ProductCategory>
          <ProductCategory>
            <category>string</category>
            <subCategory>string</subCategory>
          </ProductCategory>
        </ProductCategoryArray>
        <RelatedProductArray>
          <RelatedProduct>
            <relationType>Substitute or CompanionSell or CommonGrouping</relationType>
            <productId>string</productId>
            <partId>string</partId>
          </RelatedProduct>
          <RelatedProduct>
            <relationType>Substitute or CompanionSell or CommonGrouping</relationType>
            <productId>string</productId>
            <partId>string</partId>
          </RelatedProduct>
        </RelatedProductArray>
        <ProductPartArray>
          <ProductPart>
            <partId xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</partId>
            <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
            <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
            <countryOfOrigin xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</countryOfOrigin>
            <ColorArray xsi:nil="true" />
            <primaryMaterial>string</primaryMaterial>
            <shape>string</shape>
            <ApparelSize xsi:nil="true" xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/" />
            <Dimension xsi:nil="true" />
            <leadTime>int</leadTime>
            <unspsc>string</unspsc>
            <gtin>string</gtin>
            <isRushService>boolean</isRushService>
            <ProductPackagingArray xsi:nil="true" />
            <ShippingPackageArray xsi:nil="true" />
            <endDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</endDate>
            <effectiveDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</effectiveDate>
            <isCloseout xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCloseout>
            <isCaution xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCaution>
            <cautionComment>string</cautionComment>
            <nmfcCode>decimal</nmfcCode>
            <nmfcDescription>string</nmfcDescription>
            <nmfcNumber>string</nmfcNumber>
            <isOnDemand>boolean</isOnDemand>
            <isHazmat>boolean</isHazmat>
          </ProductPart>
          <ProductPart>
            <partId xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</partId>
            <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
            <description xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</description>
            <countryOfOrigin xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">string</countryOfOrigin>
            <ColorArray xsi:nil="true" />
            <primaryMaterial>string</primaryMaterial>
            <shape>string</shape>
            <ApparelSize xsi:nil="true" xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/" />
            <Dimension xsi:nil="true" />
            <leadTime>int</leadTime>
            <unspsc>string</unspsc>
            <gtin>string</gtin>
            <isRushService>boolean</isRushService>
            <ProductPackagingArray xsi:nil="true" />
            <ShippingPackageArray xsi:nil="true" />
            <endDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</endDate>
            <effectiveDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</effectiveDate>
            <isCloseout xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCloseout>
            <isCaution xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCaution>
            <cautionComment>string</cautionComment>
            <nmfcCode>decimal</nmfcCode>
            <nmfcDescription>string</nmfcDescription>
            <nmfcNumber>string</nmfcNumber>
            <isOnDemand>boolean</isOnDemand>
            <isHazmat>boolean</isHazmat>
          </ProductPart>
        </ProductPartArray>
        <lastChangeDate>dateTime</lastChangeDate>
        <creationDate>dateTime</creationDate>
        <endDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</endDate>
        <effectiveDate xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">dateTime</effectiveDate>
        <isCaution xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCaution>
        <isCloseout xmlns="http://www.promostandards.org/WSDL/ProductDataService/1.0.0/SharedObjects/">boolean</isCloseout>
        <cautionComment>string</cautionComment>
        <lineName>string</lineName>
      </Product>
    </GetProductResponse>
  </soap12:Body>
</soap12:Envelope>