Samples > Sample stores > Consumer direct sample store > IBM Gift Center for the Consumer direct sample store > IBM Gift Center > Customize the Web (presentation) layer > IBM Gift Center actions

GiftRegistryItemAdd action

This action adds an item to an existing gift registry. The gift registrant and co-registrant (if applicable) would typically add items, and need to first be authenticated to change the gift registry.

URL structure

http://host/path/

The fully qualified name of the WebSphere Commerce Server and the configuration path (for example, wcserver.mydomain.ibm.com is fully qualified).

name-value pair with the & character. For a detailed description of the parameters and their values, see the list entitled Parameter values." />

Parameter values

URL

Required: The URL to be called when the action completes successfully.

storeId

Required: The store reference number, which is required to help identify to which stores a gift registry belongs.

catEntryId_i

Required: The unique identifier for a catalog item.

partNumber_i

(Required if the catEntryId parameter is not specified) A unique identifier for the item to be added to the gift registry. If both the partNumber and catEngryId parameters are specified, the partNumber value takes precedence.

memberId_i

(Required if the partNumber parameter is specified) A unique identifier for, or owner of, the partNumber.

externalId

Required: The unique identifier for the gift registry.

errorViewName

Overrides the error view when an error occurs.

quantity_i

The quantity of this item to be added to the gift registry, specified by the gift registrant. The default is 1.

quantityBought_i

The quantity of this item already bought by a gift giver. This value must be greater than or equal to 0. The default is 0.

location

The method by which, or physical location where, the gift registrant created the gift registry (for example, online, by in-store kiosk, or through a call center). The default is online.

field1 through field5

Custom parameters, which you can use to capture data values for FIELD1 to FIELD5 in the GRFTITM database table.

Example

The following example adds item 5000 to a gift registry 888 at store 1001.

http://myhostname/webapp/wcs/stores/servlet/GiftRegistryItemAdd?URL=/webapp/wcs
/stores/servlet/&storeId=1001&catEntryId_1=5000&externalId=888

Behavior

• Upon successful completion, the specified URL is called.

• Adds a gift item to an existing gift registry.

• If the item to be added to the gift registry is already specified in the list of gifts, then the action updates the quantity of that item instead. Alternatively, a message notifies the gift registrant that the item already exists in the gift registry.

Exception conditions

• If a required parameter is not specified, the system throws an exception with the _ERR_CMD_MISSING_PARAMETER message key.

• If an invalid parameter is specified, the system throws an exception with the ERR_CMD_BAD_PARAMETER message key.

• If an invalid product is specified, the system throws an exception with the ERR_PROD_NOT_EXISTING message key. For this error, the action passes exception data in the form of name-value pairs. Specifically, multiplePartNumberList specifies the part numbers for invalid products, and multiplePartNumberQuantityList specifies the corresponding requested quantities (one for each part number).

• If a product is not eligible for the gift registry (for example, the product is being discontinued), the system throws an exception with the ERR_PROD_NOT_ELIGIBLE message key. For this error, the action passes exception data in the form of name-value pairs. Specifically, multiplePartNumberList specifies the part numbers for non-eligible products, and multiplePartNumberQuantityList specifies the corresponding requested quantities (one for each part number).

• If the system cannot find the gift registry profile to update, the system throws an exception with the _ERR_REGISTRY_NOT_FOUND message key.

• If the system cannot find the catalog entry in the system, the system throws an exception with the _ERR_PRODUCT_NOT_FOUND message key. For this error, the action passes exception data in the form of name-value pairs. Specifically, multiplePartNumberList specifies the part numbers for invalid catalog entries, and multiplePartNumberQuantityList specifies the corresponding requested quantities (one for each part number).

• If the system encounters a security problem, such as a user attempting to access the gift registry without the appropriate authorization, the system throws an exception with the _ERR_NOT_AUTHORIZED message key.

Related concepts

IBM Gift Center architecture

Related reference

IBM Gift Center actions

Overview of customizing IBM Gift Center

+

Search Tips   |   Advanced Search