Wish Lists

The Wish Lists API allows you to:

  • Retrieve one or more wish lists for a shopper
  • Create, update, or delete a wish list
  • Add or remove a product from a wish list

Important: To enable the API, set the x-wish-list-enabled attribute to true for the client API key. Otherwise, the wish list API will not be available for a client.

Methods


					Host: api.digitalriver.com
Accept: application/json
Authorization: bearer your_access_token
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					{"wishLists": {
   "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists",
   "wishList":    [
            {
         "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID",
         "name": "My wish list"
      },
            {
         "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID",
         "name": "dreams come true"
      },
            {
         "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID",
         "name": "my wish list"
      }
   ]
}}
			
					Host: api.digitalriver.com
Accept: application/json
Authorization: bearer your_access_token
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					{"wishLists": {
   "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists",
   "wishList":    [
            {
         "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID",
         "id": "wish_list_ID",
         "name": "Automation's Wish List",
         "isPublic": "false",
         "totalItemsInWishList": 0,
         "lineItems": {}
      },
            {
         "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID",
         "id": "wish_list_ID",
         "name": "My wish list",
         "isPublic": "true",
         "totalItemsInWishList": 0,
         "lineItems": {}
      },
            {
         "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID",
         "id": "wish_list_ID",
         "name": "dreams come true",
         "isPublic": "true",
         "totalItemsInWishList": 0,
         "lineItems": {}
      },
            {
         "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID",
         "id": "wish_list_ID",
         "name": "my wish list",
         "isPublic": "true",
         "totalItemsInWishList": 0,
         "lineItems": {}
      }
   ]
}}
			
					Host: api.digitalriver.com
Accept: application/json
Authorization: bearer your_access_token
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_102)
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					{"wishList": {
   "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish-list_ID",
   "id": "wish-list_ID",
   "name": "`1234567890-=[]\\;',./~!@#$%^*()_+|}{\":?",
   "isPublic": "false",
   "totalItemsInWishList": 3,
   "lineItems": {"lineItem":    [
            {
         "quantity": 1,
         "pricing":          {
            "formattedListPrice": "$19.99",
            "formattedSalePriceWithQuantity": "$17.99"
         },
         "product":          {
            "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID",
            "parentProduct":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID",
               "relation": "https://developers.digitalriver.com/v1/shoppers/ProductsResource"
            },
            "displayName": "Class I",
            "thumbnailImage": "https://drh1.img.digitalriver.com/DRHM/Storefront/Company/demosft1/images/product/thumbnail/classIThumb.jpg",
            "addProductToCart":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=product_ID",
               "cartUri": "https://dispatch.digitalriver.com/v1/shoppers/me/carts/active?productId=product_ID"
            },
            "purchaseProduct":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID/purchase",
            }
         },
         "deleteProductFromWishList": {"uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID"}
      },
            {
         "quantity": 2,
         "pricing":          {
            "formattedListPrice": "$59.99",
            "formattedSalePriceWithQuantity": "$117.98"
         },
         "product":          {
            "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID",
            "displayName": "Class V",
            "thumbnailImage": "https://drh1.img.digitalriver.com/DRHM/Storefront/Company/demosft1/images/product/thumbnail/classVThumb_v2.jpg",
            "addProductToCart":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=product_ID",
               "cartUri": "https://dispatch.digitalriver.com/v1/shoppers/me/carts/active?productId=product_ID"
            },
            "purchaseProduct":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID/purchase",
            }
         },
         "deleteProductFromWishList": {"uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID"}
      }
   ]}
}}
			
					Host: api.digitalriver.com
Accept: application/json
Authorization: bearer your_access_token
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					{"wishList": {
   "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID",
   "id": "wish_list_ID",
   "name": "My wish list",
   "isPublic": "true",
   "totalItemsInWishList": 0,
   "lineItems": {}
}}
			
					Host: api.digitalriver.com
Accept: application/json
Authorization: bearer your_access_token
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
			
					{
	"wishList": {
		"name": "Birthday wish list",
		"isPublic": false
	}
}
			
					HTTP/1.1 201 Created
			
					201 Created

Location: https://api.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID

{
	wishList: {
		uri: "https://api.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID",
		id: "wish_list_ID",
		name: "John's Wish List",
		isPublic: "false",
		totalItemsInWishList: 0
	}
}
			
					Host: api.digitalriver.com
Accept: application/json
Authorization: bearer your_access_token
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
			
					The request body should be empty.
			
					HTTP/1.1 200 OK
			
					{"wishList": {
   "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish-list_ID",
   "id": "wish-list_ID",
   "name": "`1234567890-=[]\\;',./~!@#$%^*()_+|}{\":?",
   "isPublic": "false",
   "totalItemsInWishList": 3,
   "lineItems": {"lineItem":    [
            {
         "quantity": 1,
         "pricing":          {
            "formattedListPrice": "$19.99",
            "formattedSalePriceWithQuantity": "$17.99"
         },
         "product":          {
            "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID",
            "parentProduct":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID",
               "relation": "https://developers.digitalriver.com/v1/shoppers/ProductsResource"
            },
            "displayName": "Class I",
            "thumbnailImage": "https://drh1.img.digitalriver.com/DRHM/Storefront/Company/demosft1/images/product/thumbnail/classIThumb.jpg",
            "addProductToCart":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=product_ID",
               "cartUri": "https://dispatch.digitalriver.com/v1/shoppers/me/carts/active?productId=product_ID"
            },
            "purchaseProduct":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID/purchase",
            }
         },
         "deleteProductFromWishList": {"uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID"}
      },
            {
         "quantity": 2,
         "pricing":          {
            "formattedListPrice": "$59.99",
            "formattedSalePriceWithQuantity": "$117.98"
         },
         "product":          {
            "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID",
            "displayName": "Class V",
            "thumbnailImage": "https://drh1.img.digitalriver.com/DRHM/Storefront/Company/demosft1/images/product/thumbnail/classVThumb_v2.jpg",
            "addProductToCart":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/carts/active/line-items?productId=product_ID",
               "cartUri": "https://dispatch.digitalriver.com/v1/shoppers/me/carts/active?productId=product_ID"
            },
            "purchaseProduct":             {
               "uri": "https://dispatch.digitalriver.com/v1/shoppers/me/products/product_ID/purchase",
            }
         },
         "deleteProductFromWishList": {"uri": "https://dispatch.digitalriver.com/v1/shoppers/me/wish-lists/wish_list_ID"}
      }
   ]}
}}
			

Response Body Parameters

Fields
Data Type
Visibility
Description
deleteProductFromWishlist
link
default
Deletes the selected product from the wish list.
id
string
default
The cart ID. The ID is assigned automatically when you create a cart.
isPublic
Boolean
default
When true, this wish list is the default wish list for the shopper. 
lineItems
collection
default
A collection of line items. For more information, see the Line Items API.
name
string
default
The name of the wish list.
totalItemsInWishList
integer
default
The total number of items in the wish list.
wishList
link
default
A link to the wish list.