This class provides RESTful services to get and manage a shopper's wish lists. Note: You must enable the multiple wish lists feature in the Management Center Store Management tool.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler
| HTTP Method | Path | Description |
|---|---|---|
| GET | /store/{storeId}/wishlist/{externalId} | Gets the shopper's wish list by ExternalId or by ExternalId and GuestAccesskey. If only ExternalId is specified, the user must be authenticated. |
| GET | /store/{storeId}/wishlist/{externalId}/item | Gets the shopper's wish list items by wish list ExternalId or by ExternalId and GuestAccesskey. If only ExternalId is specified, the user must be authenticated. |
| GET | /store/{storeId}/wishlist/@default | Gets the shopper's default wish list. |
| GET | /store/{storeId}/wishlist/@self | Gets all of the shopper's wish lists. |
| POST | /store/{storeId}/wishlist | Creates a wish list, either empty or with items. |
| POST | /store/{storeId}/wishlist/{externalId}?action={action} | Process a wish list. |
| PUT | /store/{storeId}/wishlist/{externalId} | Updates the wish list to change the description or to add or update an item. |
| DELETE | /store/{storeId}/wishlist/{externalId} | Deletes a wish list or delete an item from a wish list. Specify an itemId or a productId to delete only that item from the wish list; otherwise the entire wish list will be deleted. When both itemId and productId are provided, itemId will be used ONLY. |
Gets the shopper's wish list by ExternalId or by ExternalId and GuestAccesskey. If only ExternalId is specified, the user must be authenticated.
findWishlistByExternalId
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| externalId | Wish list external identifier. | path | string | true | N/A |
| storeId | The store identifier. | path | string | true | N/A |
| guestAccessKey | Wish list guest access key. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 404 | The specified resource couldn't be found. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
Gets the shopper's wish list items by wish list ExternalId or by ExternalId and GuestAccesskey. If only ExternalId is specified, the user must be authenticated.
findWishlistItemsByExternalId
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| externalId | Wish list external identifier. | path | string | true | N/A |
| storeId | The store identifier. | path | string | true | N/A |
| guestAccessKey | Wish list guest access key. | query | string | false | false |
| pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
| pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/wishlist/10003/item?pageSize=12&pageNumber=1&responseFormat=json
200
{
"GiftList": [
{
"accessSpecifier": "Private",
"description": "Wish List",
"descriptionName": "Wish List",
"event": "0",
"externalIdentifier": "10003",
"giftCardAccepted": "false",
"item": [
{
"giftListItemID": "10002",
"itemCreatedTime": "2014-11-20T14:33:46.090Z",
"itemLastUpdate": "2014-11-20T14:33:46.090Z",
"location": "online",
"partNumber": "HFU032_320101",
"productId": "12837",
"productOwnerID": "7000000000000000002",
"quantityBought": "0.0",
"quantityRequested": "1.0"
}
],
"optForEmail": "false",
"registry": "true",
"state": "Default",
"storeId": "10001",
"storeName": "Wish List",
"storeOwnerID": "10003",
"uniqueID": "10003"
}
],
"recordSetComplete": "true",
"recordSetCount": "1",
"recordSetStartNumber": "0",
"recordSetTotal": "1",
"resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/wishlist\/10003\/item?pageSize=12&pageNumber=1&responseFormat=json",
"resourceName": "wishlist"
}
Gets the shopper's default wish list.
findWishlistByUserId_default
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/wishlist/@default?responseFormat=json
200
{
"GiftList": [
{
"accessSpecifier": "Private",
"createdTime": "2014-11-20T14:33:45.944Z",
"description": "Wish List",
"descriptionName": "Wish List",
"event": "WishList",
"externalIdentifier": "10003",
"giftCardAccepted": "false",
"guestAccessKey": "-49e2f4d1:149cc3e97d1:-6cdb",
"lastUpdate": "2014-11-20T14:33:45.944Z",
"location": "online",
"optForEmail": "false",
"registry": "false",
"registryAccessKey": "-49e2f4d1:149cc3e97d1:-6cda",
"state": "Default",
"storeId": "10001",
"storeName": "Wish List",
"storeOwnerID": "10003",
"uniqueID": "10003"
}
],
"recordSetComplete": "true",
"recordSetCount": "1",
"recordSetStartNumber": "0",
"recordSetTotal": "1",
"resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/wishlist\/@default?responseFormat=json",
"resourceName": "wishlist"
}
Gets all of the shopper's wish lists.
findWishlist
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
Creates a wish list, either empty or with items.
createWishlist
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request body for creating a wishlist or wishlist item. | body | com.ibm.commerce.rest.wishlist.handler.WishlistHandler$CreateBodyParameterDescription | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 201 | The requested resource has been created. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListResponse
POST /wcs/resources/store/10001/wishlist?responseFormat=json
{
"description": "Wish List",
"descriptionName": "Wish List",
"registry": "false"
}
201
{
"descriptionName": "Wish List",
"storeId": "10001",
"uniqueID": "10502"
}
Process a wish list.
processWishlist
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| externalId | Wish list external identifier. | path | string | true | N/A |
| body | The request body for the e-mail announcements made about the gift list by the registrants to friends and family. | body | com.ibm.commerce.rest.wishlist.handler.WishlistHandler$ProcessBodyParameterDescription | false | N/A |
| action | The action of the rest service. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 201 | The requested resource has been created. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListResponse
Updates the wish list to change the description or to add or update an item.
updateWishlist
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| externalId | Wish list external identifier. | path | string | true | N/A |
| addItem | When set to true, a new item in a request will be added to the wishlist. When false or missing, the wishlist description and/or item will be updated with the information in the request. Default is false. | query | string | false | false |
| body | The request body for updating a wishlist description or wishlist item. | body | com.ibm.commerce.rest.wishlist.handler.WishlistHandler$UpdateBodyParameterDescription | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListUpdateResponse
PUT /wcs/resources/store/10001/wishlist/10502?addItem=true&responseFormat=json
{
"item": [
{
"productId": "10706",
"quantityRequested": "1"
}
]
}
200
{
"item": [
{
"giftListItemID": "10501"
}
],
"uniqueID": "10502"
}
Deletes a wish list or delete an item from a wish list. Specify an itemId or a productId to delete only that item from the wish list; otherwise the entire wish list will be deleted. When both itemId and productId are provided, itemId will be used ONLY.
deleteWishlist
false
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| externalId | Wish list external identifier. | path | string | true | N/A |
| itemId | Specifies the id of the wish list item to be deleted. If this parameter and productId are missing or blank, the entire wishlist will be deleted. | query | string | false | false |
| productId | Specifies the id of the wish list product to be deleted. If this parameter and itemId are missing or blank, the entire wishlist will be deleted. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$DeleteWishListResponse
DELETE /wcs/resources/store/10001/wishlist/10003?itemId=10002&responseFormat=json
200
{
"item": [
{
"giftListItemID": "10002"
}
],
"uniqueID": "10003"
}
| Name | Data Type | Required |
|---|---|---|
| primary | string | false |
| userData | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.address.userData | false |
| country | string | false |
| addressLine | string array | false |
| postalCode | string | false |
| type | string | false |
| internalOfficeAddress | string | false |
| city | string | false |
| stateOrProvinceName | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.address.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| contactInfoNickName | string | true |
| organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier.organizationIdentifier | false |
| personIdentifier | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier.personIdentifier | false |
| Name | Data Type | Required |
|---|---|---|
| uniqueID | string | false |
| distinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier.personIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| distinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| identifier | string | false |
| Name | Data Type | Required |
|---|---|---|
| middleName | string | false |
| lastName | string | false |
| personTitle | string | false |
| businessTitle | string | false |
| firstName | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress1.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress2.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress2.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax1.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax2.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax2.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.mobilePhone1.userData | false |
| country | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.mobilePhone1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone1.userData | false |
| type | string | false |
| publish | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone2.userData | false |
| type | string | false |
| publish | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone2.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.foundation.common.datatypes.ContactInfoType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| purchaserAddress | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress | false |
| registrantMemo | string | false |
| noteSent | string | true |
| purchasedItemDetails | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails | false |
| messageForRegistrant | string | false |
| purchaseDate | string | true |
| status | string | false |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.userData | false |
| location | string | true |
| dateCreated | string | false |
| purchaseRecordIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaseRecordIdentifier | false |
| giftListItemID | string | false |
| lastUpdate | string | false |
| Name | Data Type | Required |
|---|---|---|
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.userData | false |
| itemShippedToRegistrant | string | false |
| transactionID | string | false |
| orderItemIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.orderItemIdentifier | false |
| quantity | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.quantity | true |
| itemBought | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought | true |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| storeIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought.externalIdentifier.storeIdentifier | false |
| partNumber | string | true |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalOrderItemID | string | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| primary | string | false |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.address.userData | false |
| country | string | false |
| addressLine | string array | false |
| postalCode | string | false |
| type | string | false |
| internalOfficeAddress | string | false |
| city | string | false |
| stateOrProvinceName | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.address.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| contactInfoNickName | string | true |
| organizationIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier.organizationIdentifier | false |
| personIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier.personIdentifier | false |
| Name | Data Type | Required |
|---|---|---|
| uniqueID | string | false |
| distinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier.personIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| distinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| identifier | string | false |
| Name | Data Type | Required |
|---|---|---|
| middleName | string | false |
| lastName | string | false |
| personTitle | string | false |
| businessTitle | string | false |
| firstName | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress1.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress2.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress2.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax1.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax2.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax2.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.mobilePhone1.userData | false |
| country | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.mobilePhone1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone1.userData | false |
| type | string | false |
| publish | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone2.userData | false |
| type | string | false |
| publish | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone2.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.userData | false |
| registrantID | string | false |
| registrantAddress | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress | false |
| relation | string | false |
| personIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.personIdentifier | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.personIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| distinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| identifier | string | false |
| Name | Data Type | Required |
|---|---|---|
| primary | string | false |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.address.userData | false |
| country | string | false |
| addressLine | string array | false |
| postalCode | string | false |
| type | string | false |
| internalOfficeAddress | string | false |
| city | string | false |
| stateOrProvinceName | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.address.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| contactInfoNickName | string | true |
| organizationIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier.organizationIdentifier | false |
| personIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier.personIdentifier | false |
| Name | Data Type | Required |
|---|---|---|
| uniqueID | string | false |
| distinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier.personIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| distinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| identifier | string | false |
| Name | Data Type | Required |
|---|---|---|
| middleName | string | false |
| lastName | string | false |
| personTitle | string | false |
| businessTitle | string | false |
| firstName | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress1.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress2.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress2.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax1.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax2.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax2.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.mobilePhone1.userData | false |
| country | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.mobilePhone1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone1.userData | false |
| type | string | false |
| publish | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone1.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone2.userData | false |
| type | string | false |
| publish | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone2.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
Description of the post input body to create a wishlist or item.
| Name | Data Type | Required |
|---|---|---|
| item | com.ibm.commerce.rest.wishlist.handler.WishlistHandler$CreateBodyParameterDescription$WishlistItemBodyDescription array | false |
| giftCardAccepted | string | false |
| descriptionName | string | false |
| accessSpecifier | string | false |
| description | string | false |
Wishlist item body.
| Name | Data Type | Required |
|---|---|---|
| quantityRequested | string | false |
| location | string | true |
| productId | string | true |
| partNumber | string | false |
Wish list delete response.
| Name | Data Type | Required |
|---|---|---|
| uniqueID | string | true |
Description of the post input body to process the wishlist.
| Name | Data Type | Required |
|---|---|---|
| announcement | com.ibm.commerce.rest.wishlist.handler.WishlistHandler$ProcessBodyParameterDescription$AnnouncementBodyDescription array | false |
Announcement body.
| Name | Data Type | Required |
|---|---|---|
| senderName | string | true |
| message | string | false |
| emailRecipient | com.ibm.commerce.rest.wishlist.handler.WishlistHandler$ProcessBodyParameterDescription$AnnouncementBodyDescription$EmailRecipient array | false |
| senderEmailAddress | string | true |
The recipients of the e-mail.
| Name | Data Type | Required |
|---|---|---|
| recipientEmail | string | true |
| recipientName | string | true |
| addressingMethod | string | true |
Description of the post input body to update the wishlist or item.
| Name | Data Type | Required |
|---|---|---|
| item | com.ibm.commerce.rest.wishlist.handler.WishlistHandler$UpdateBodyParameterDescription$WishlistItemBodyDescription array | false |
| descriptionName | string | false |
| description | string | false |
Wishlist item body.
| Name | Data Type | Required |
|---|---|---|
| quantityRequested | string | false |
| productId | string | false |
| partNumber | string | false |
| giftListItemID | string | true |
Wish list change response.
| Name | Data Type | Required |
|---|---|---|
| item | com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListResponse$Item array | false |
| storeId | string | true |
| uniqueID | string | true |
Wishlist item body.
| Name | Data Type | Required |
|---|---|---|
| giftListItemID | string | true |
Wish list change response.
| Name | Data Type | Required |
|---|---|---|
| item | com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListUpdateResponse$Item array | false |
| uniqueID | string | true |
Wishlist item body.
| Name | Data Type | Required |
|---|---|---|
| giftListItemID | string | true |
| Name | Data Type | Required |
|---|---|---|
| recordSetTotal | string | false |
| recordSetComplete | string | false |
| recordSetStartNumber | string | false |
| recordSetCount | string | false |
| GiftList | wishlist-wishlist_item array | false |
| Name | Data Type | Required |
|---|---|---|
| announcement | wishlist-wishlist_item.announcement array | false |
| storeName | string | false |
| guestMessage | string | false |
| state | string | false |
| item | wishlist-wishlist_item.item array | false |
| externalIdentifier | string | false |
| createdTime | string | false |
| event | string | false |
| storeId | string | false |
| registryAccessKey | string | false |
| guestAccessKey | string | false |
| manageAccessPassword | string | false |
| userDataField | wishlist-wishlist_item.userDataField array | false |
| optForEmail | string | false |
| descriptionName | string | false |
| giftCardAccepted | string | false |
| registrant | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType | false |
| uniqueID | string | false |
| storeOwnerID | string | false |
| purchaseRecord | com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType array | false |
| location | string | false |
| coRegistrant | com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType array | false |
| postEventAddress | com.ibm.commerce.foundation.common.datatypes.ContactInfoType | false |
| accessSpecifier | string | true |
| description | string | false |
| registry | string | false |
| preEventAddress | com.ibm.commerce.foundation.common.datatypes.ContactInfoType | false |
| lastUpdate | string | false |
| Name | Data Type | Required |
|---|---|---|
| senderName | string | true |
| giftListAnnouncementID | string | false |
| userData | wishlist-wishlist_item.announcement.userData | false |
| sentDate | string | false |
| message | string | true |
| emailRecipient | wishlist-wishlist_item.announcement.emailRecipient array | true |
| senderEmailAddress | string | true |
| Name | Data Type | Required |
|---|---|---|
| recipientEmail | wishlist-wishlist_item.announcement.emailRecipient.recipientEmail | true |
| recipientName | string | true |
| addressingMethod | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | wishlist-wishlist_item.announcement.emailRecipient.recipientEmail.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | wishlist-wishlist_item.announcement.emailRecipient.recipientEmail.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | true |
| userData | wishlist-wishlist_item.announcement.senderEmailAddress.userData | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | wishlist-wishlist_item.announcement.senderEmailAddress.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | wishlist-wishlist_item.announcement.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| itemCreatedTime | string | false |
| quantityRequested | string | false |
| userDataField | wishlist-wishlist_item.item.userDataField array | false |
| storeIdentifier | com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType | false |
| productId | string | false |
| quantityRequestedUom | string | false |
| itemLastUpdate | string | false |
| location | string | false |
| quantityBought | string | false |
| attribute | wishlist-wishlist_item.item.attribute array | false |
| giftListItemID | string | false |
| partNumber | string | true |
| quantityBoughtUom | string | false |
| productOwnerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| name | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |