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

GiftRegistryItemDelete action

This action removes an item from an existing gift registry. The gift registrant and co-registrant (if applicable) would typically remove 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 is successfully completed.

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.

externalId

Required: The unique identifier for the gift registry.

errorViewName

Overrides the error view when an error occurs.

giftItemId

(Required if the partNumber_i or memberId_i parameter is not specified) A unique identifier for the item to be removed from the gift registry. If the giftItemId_i, catEngryId, and partNumber parameters are specified, the giftItemId_i value takes precedence.

partNumber_i

(Required if the catEntryId parameter is not specified) A unique identifier for the item to be removed from 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.

Example

The following example removes item 5000 from gift registry 888 at store 1001.

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

Behavior

• Upon successful completion, the specified URL is called.

• Removes a gift item from an existing gift registry. The gift to be removed must be one that exists in the gift registry (for example, it cannot be one that has already been purchased by a gift giver).

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 deletion (for example, the product has already been purchased), 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 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