Item Service, Version 3.0

42 Item Service, Version 3.0

This chapter provides the information necessary to send messages contained in Version 3.0 of the Data Privacy API. Information can be obtained using the Web Service Description Language (WSDL) in conjunction with a Simple Object Access Protocol (SOAP), XML Schema, and various methods contained in the classes of the API to provide the web service.

The URL for the WSDL is:

https://<servername>:<portNumber>/ws/v3_0/ItemService?wsdl

Where <servername> is the name or address of the server. The default port number is 443.

The information presented describes the methods and classes.

The format of the method and any arguments is shown along with an explanation of what the method does and any other information that is necessary to use the method properly. If an argument is shown in dark blue, it is a class and the class name is a link to a description of the class and its attributes.

The class section shows the attributes of the classes along with an explanation of each attribute and when necessary, when they are used.

Note:

Authentication is required. See Introduction for information on creating and implementing an authentication key.

Methods

This section presents the methods used in Version 3.0 of the Item Service.

addOrUpdateItem

string addOrUpdateItem(
                        ItemType item)
        throws RelateProcessingException

Variable	Required?	Description
item	Optional	New item information to add or update.

The addOrUpdateItem method adds a new item record, or updates an existing item record.

This method returns a string value.

addOrUpdateItemAttribute

string addOrUpdateItemAttribute(
                                 string itemId,
                                 ItemAttributeType[] attributeType,
string userId)
throws RelateProcessingException, AttributeException

Variable	Required?	Description
itemId	Optional	ID of the item to which the attribute is assigned.
attributeType	Optional	Array of attributes being updated and their new values.
userId	Required	ID of the user adding or updating the item attribute.

The addOrUpdateItemAttribute method adds or updates an attribute assigned to an item.

This method returns a string value.

addOrUpdateItemCrossReference

string addOrUpdateItemCrossReference(
              ItemCrossReferenceType itemCrossReference)
       throws RelateProcessingException

Variable	Required?	Description
itemCrossReference	Optional	New item cross reference information to add or update.
securityUserId	Required	ID of Customer Engagement user adding or updating the cross reference.

The addOrUpdateItemCrossReference method adds or updates a cross reference between different items IDs, such as between a Customer Engagement item ID and a UPC.

This method returns a string value.

removeItem

string removeItem(
                   ItemIDType item)
      throws RelateProcessingException

Variable	Required?	Description
item	Optional	ID of item to be removed.

The removeItem method removes an item from the system.This method returns a string value.

removeItemCrossReference

string removeItemCrossReference(
                                 ItemTypeID[] itemCrossReference)
        throws RelateProcessingException

Variable	Required?	Description
itemCrossReference	Optional	Array of item IDs to remove from cross references.

The removeItemCrossReference method removes an item ID from an item cross reference.

This method returns a string value.

Classes

This section presents the classes used in used in Version 3.0 of the Item Service.

AttributeException

For a description of this class, see Introduction.

BrandOwnerType

The getValue() function for the BrandOwnerType class returns a string value.

BrandOwnerType includes the following attribute:

Type	Attribute	Description
string	Name	Name of the brand owner.

DepthType

The getValue() function for the DepthType class returns a string value.

DepthType includes the following attribute:

Type	Attribute	Description
string	UnitOfMeasure	Unit of the depth measurement.

DiameterType

The getValue() function for the DiameterType class returns a string value.

DiameterType includes the following attribute:

Type	Attribute	Description
string	UnitOfMeasure	Unit of the diameter measurement.

HeightType

The getValue() function for the HeightType class returns a string value.

HeightType includes the following attribute:

Type	Attribute	Description
string	UnitOfMeasure	Unit of the height measurement.

ItemAttributeCodeValueType

The ItemAttributeCodeValueType contains the following elements:

Type	Element	Description
string	AttributeCode	ID of the attribute code. Used for culinary-type items.
string	AttributeValue	Value of the attribute code. Used for culinary-type items.

ItemAttributeType

The ItemAttributeType contains the following elements:

Type	Element	Description
string[]	AttributeValue	Array of values for the attribute.
ItemAttributeCodeValueType[]	AttributeCodeValue	Array of attribute code values.

ItemAttributeType includes the following attribute:

Type	Attribute	Description
string	Name	Attribute name.

ItemCrossReferenceType

The ItemCrossReferenceType contains the following elements:

Type	Element	Description
ItemIDType[]	ItemID	Array of item IDs to be crossreferenced with one another.
string	Manufacturer	Manufacturer of the item.
string	Vendor	Vendor for the item.

ItemCrossReferenceType includes the following attribute:

Type	Attribute	Description
string	Action	Action performed.

ItemIDType

The getValue() function for the ItemIDType class returns a string value.

ItemIDType includes the following attribute:

Type	Attribute	Description
string	Type	Type of ID (for example, ItemID or UPC).

ItemMeasurementsType

The ItemMeasurementsType contains the following elements:

Type	Element	Description
DepthType	Depth	Depth of the item.
HeightType	Height	Height of the item.
WidthType	Width	Width of the item.
DiameterType	Diameter	Diameter of the item.

ItemPriceType

The getValue() function for the ItemPriceType class returns a string value.

ItemPriceType includes the following attribute:

Type	Attribute	Description
string	ValueTypeCode	Type code identifying the method used for pricing the item.

ItemType

The ItemType contains the following elements:

Type	Element	Description
IItemIDType[]	ItemID	Array of item IDs.
string	Description	Description of the item.
MerchandiseHierarchyType[]	MerchandiseHierarchy	Merchandise hierarchy levels to which the item belongs.
ItemPriceType	ItemPrice	Price of the item.
string	Color	Color of the item.
ManufacturerType	Manufacturer	Manufacturer of the item.
MarketingType	Marketing	Marketing settings for the item.
BrandOwnerType	BrandOwner	Brand owner of the item.
ItemAttributeType[]	ItemAttribute	Array of attributes assigned to the item.
ItemMeasurementsType	ItemMeasurements	Measurements of the item.
TaxInformationType	TaxInformation	Tax information for the item.
string	ItemImageUrl	URL for an image of the item.

ItemType includes the following attributes:

Type	Attribute	Description
string	Action	Item action.
string	SerialNumberFlag	Indicates whether the item has a serial number.

ItemTypeID

The getValue() function for the ItemTypeID class returns a string value.

ItemTypeID includes the following attribute:

Type	Attribute	Description
string	Type	ID of the item type.

ManufacturerType

The ManufacturerType contains the following element:

Type	Element	Description
string	Name	Name of the manufacturer.

MarketingType

The MarketingType contains the following elements:

Type	Element	Description
string	Season	Season used for marketing.

MerchandiseHierarchyType

The getValue() function for the MerchandiseHierarchyType class returns a string value.

MerchandiseHierarchyType includes the following attributes:

Type	Attribute	Description
string	ID	ID of the merchandise hierarchy level.
string	Level	Type of merchandise hierarchy level.

RelateProcessingException

For a description of this class, see Introduction.

TaxInformationType

The TaxInformationType contains the following elements:

Type	Element	Description
string	TaxGroupID	ID of the tax group.
string	TaxExemptCode	ID code for the applicable tax exemption.
string	TaxAmount	Amount of the tax exemption.

WidthType

The getValue() function for the WidthType class returns a string value.

WidthType includes the following attribute:

Type	Attribute	Description
string	UnitOfMeasure	Unit of the width measurement.