Http Method | Resource | Description |
---|---|---|
GET | /Product_lists | Retrieves a list of all product lists as defined by the given search term (hence email, firstname, lastname). If no search term is given all owned product lists will be retrieved. |
GET | /Product_lists/{List_id} | Retrieves a product list by id. |
PATCH | /Product_lists/{List_id} | Changes a product list. Changeable properties are the name, description and if the list is public. |
GET | /Product_lists/{List_id}/Items | Retrieves a product list's items. |
POST | /Product_lists/{List_id}/Items | Adds a product to a product list. |
PATCH | /Product_lists/{List_id}/Items/{Item_id} | Change an item of a product list. You can change the priority, quantity and if this item is public. |
DELETE | /Product_lists/{List_id}/Items/{Item_id} | Deletes an item of a product list. |
Retrieves a list of all product lists as defined by the given search term (hence email, firstname, lastname). If no search term is given all owned product lists will be retrieved.
Url
GET http://hostname:port/dw/shop/v15_6/product_lists?email={String}&firstname={String}&lastname={String}
Formats
json, xml
Authentication
Name | Description |
---|---|
None | No authentication. |
Response Document
Query Parameters
Parameter | Type | Description | Constraints |
---|---|---|---|
String | email address of the customer, the product lists belong to | ||
firstname | String | first name of the customer, the product lists belong to | |
lastname | String | last name of the customer, the product lists belong to |
In case of a failure Fault Document is returned.
Faults
Status | Type | Arguments | Description |
---|---|---|---|
400 |
ProductListSearchTermException
|
Indicates that the anonymous customer did not provide a proper search term. | |
401 |
CustomerNotAuthenticatedException
|
Indicates that the customer is not authenticated and must be logged in. |
Sample
REQUEST:
GET /dw/shop/v15_6/product_lists?firstname=john&lastname=doe HTTP/1.1
Host: example.com
Cookie: dwcustomer_9727b83e8e864fa4b6902a37bc70a12d=cdT3mHBc4s8q4y1bE9qaLNQIaW;
dwsid=pATvWUO3KSdt-Kmcy-8-RsxKnoO4BMDwoec7ACVlW6tZNnhaOL7gt7mHqL-h7QYn5TyE61z0DeSMCqxngsWeHw==;
dwsecuretoken_9727b83e8e864fa4b6902a37bc70a12d=5Kx5-2P7jj5WoxeTiWwHNBJ6QV39Io5SNA==;
dwanonymous_9727b83e8e864fa4b6902a37bc70a12d=acwoUwjMGdrNan1VP6HmIghWOJ
RESPONSE:
Cache-Control:max-age=0,no-cache,no-store,must-revalidate
Keep-Alive:timeout=15, max=99
Connection:Keep-Alive
Content-Type:application/json;charset=UTF-8
Content-Length:483
{
"_v" : "15.6",
"count" : 2,
"data" :
[
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/product_lists/cd2Id9aaabTQYaaadj9vRpVGwg",
"name" : "DC-Doe-Wedding",
"public" : false,
"title" : "DC-Doe-Wedding",
"type" : "gift_registry"
},
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/product_lists/ghjMV9aaab9d2aaafjycppVGwe",
"public" : false,
"title" : "Wish List",
"type" : "wish_list"
}
],
"total" : 2
}
Retrieves a product list by id.
Url
GET http://hostname:port/dw/shop/v15_6/product_lists/{list_id}
Formats
json, xml
Authentication
Name | Description |
---|---|
None | No authentication. |
Response Document
Path Parameters
Parameter | Type | Description | Constraints |
---|---|---|---|
list_id | String | id of the list | mandatory=true, maxLength=28, minLength=1, nullable=false |
In case of a failure Fault Document is returned.
Faults
Status | Type | Arguments | Description |
---|---|---|---|
401 |
CustomerNotAuthenticatedException
|
Indicates that the customer is not authenticated and must be logged in. | |
403 |
CustomerNotAuthorizedException
|
Indicates that the authenticated customer is not the owner of the list | |
404 |
ProductListNotFoundException
|
productListId (String) |
Indicates that this list doesn't exist |
Sample
REQUEST:
GET /dw/shop/v15_6/product_lists/cdmeh9aaabqtwaaadjcLADJaTY HTTP/1.1
Host: example.com
Cookie: dwcustomer_9727b83e8e864fa4b6902a37bc70a12d=cdT3mHBc4s8q4y1bE9qaLNQIaW;
dwsid=pATvWUO3KSdt-Kmcy-8-RsxKnoO4BMDwoec7ACVlW6tZNnhaOL7gt7mHqL-h7QYn5TyE61z0DeSMCqxngsWeHw==;
# in case of success:
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"co_registrant" :
{
"email" : "[email protected]",
"first_name" : "Jane",
"last_name" : "Doe",
"role" : "Bride"
},
"current_shipping_address_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/account/this/addresses/me?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"title" : "me, John Doe, Woburn"
},
"event" :
{
"city" : "Washington",
"country" : "US",
"date" : "2015-07-30T00:00Z",
"state" : "DC",
"type" : "Wedding"
},
"id" : "bcqg6iWbw4XEYaaadjixFLTWP0",
"items_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/product_lists/bcqg6iWbw4XEYaaadjixFLTWP0/items?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"title" : "2 items"
},
"name" : "DC-Doe-Wedding",
"owner_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/customers/[email protected]?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"title" : "John Doe"
},
"post_event_shipping_address_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/account/this/addresses/jane?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"title" : "jane, Jane Doe, Springfield"
},
"public": false,
"registrant" :
{
"email" : "[email protected]",
"first_name" : "John",
"last_name" : "Doe",
"role" : "Groom"
},
"shipping_address_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/account/this/addresses/me?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"title" : "me, John Doe, Woburn"
},
"type" : "gift_registry"
}
# in case of failure (authentication failed):
RESPONSE:
HTTP/1.1 401 Unauthorized
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthenticatedException",
"message" : "Customer must be authenticated."
}
}
# in case of failure (authorization failed):
RESPONSE:
HTTP/1.1 403 Forbidden
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthorizedException",
"message" : "Customer is not authorized for this action."
}
}
# in case of failure (list not found):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "NotFoundException",
"message" : "Productlist with id 'cdmeh9aaabqtwaaadjcLADJaTZ' not found."
}
}
Changes a product list. Changeable properties are the name, description and if the list is public.
Url
PATCH http://hostname:port/dw/shop/v15_6/product_lists/{list_id}
Formats
json, xml
Authentication
Name | Description |
---|---|
None | No authentication. |
Request Document
Response Document
Path Parameters
Parameter | Type | Description | Constraints |
---|---|---|---|
list_id | String | id of the list | mandatory=true, maxLength=28, minLength=1, nullable=false |
In case of a failure Fault Document is returned.
Faults
Status | Type | Arguments | Description |
---|---|---|---|
401 |
CustomerNotAuthenticatedException
|
Indicates that the customer is not authenticated and must be logged in. | |
403 |
CustomerNotAuthorizedException
|
Indicates that the authenticated customer is not the owner of the list | |
404 |
ProductListNotFoundException
|
productListId (String) |
Indicates that this list doesn't exist |
Sample
REQUEST:
PATCH /dw/shop/v15_6/product_lists/cdmeh9aaabqtwaaadjcLADJaTY HTTP/1.1
Host: example.com
Content-Type: application/json; charset=UTF-8
Cookie: dwcustomer_9727b83e8e864fa4b6902a37bc70a12d=cdT3mHBc4s8q4y1bE9qaLNQIaW;
dwsid=pATvWUO3KSdt-Kmcy-8-RsxKnoO4BMDwoec7ACVlW6tZNnhaOL7gt7mHqL-h7QYn5TyE61z0DeSMCqxngsWeHw==;
{
"name":"MyWedding",
"description":"wishlist for my wedding",
"public":true
}
# in case of success
RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"co_registrant" :
{
"email" : "[email protected]",
"first_name" : "Jane",
"last_name" : "Doe",
"role" : "Bride"
},
"current_shipping_address_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/account/this/addresses/me?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"title" : "me, John Doe, Woburn"
},
"event" :
{
"city" : "Washington",
"country" : "US",
"date" : "2015-07-30T00:00Z",
"state" : "DC",
"type" : "Wedding"
},
"id" : "cdmeh9aaabqtwaaadjcLADJaTY",
"items_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/product_lists/bcqg6iWbw4XEYaaadjixFLTWP0/items?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"title" : "2 items"
},
"name" : "MyWedding",
"description" : "wishlist for my wedding",
"post_event_shipping_address_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/account/this/addresses/jane?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"title" : "jane, Jane Doe, Springfield"
},
"public": true,
"registrant" :
{
"email" : "[email protected]",
"first_name" : "John",
"last_name" : "Doe",
"role" : "Groom"
},
"shipping_address_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/account/this/addresses/me?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"title" : "me, John Doe, Woburn"
},
"type" : "gift_registry"
}
# in case of failure (authentication failed):
RESPONSE:
HTTP/1.1 401 Unauthorized
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthenticatedException",
"message" : "Customer must be authenticated."
}
}
# in case of failure (authorization failed):
RESPONSE:
HTTP/1.1 403 Forbidden
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthorizedException",
"message" : "Customer is not authorized for this action."
}
}
# in case of failure (list not found):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "NotFoundException",
"message" : "Productlist with id 'cdmeh9aaabqtwaaadjcLADJaTY' not found."
}
}
Retrieves a product list's items.
Url
GET http://hostname:port/dw/shop/v15_6/product_lists/{list_id}/items
Formats
json, xml
Authentication
Name | Description |
---|---|
None | No authentication. |
Response Document
Path Parameters
Parameter | Type | Description | Constraints |
---|---|---|---|
list_id | String | id of the list | mandatory=true, maxLength=28, minLength=1, nullable=false |
In case of a failure Fault Document is returned.
Faults
Status | Type | Arguments | Description |
---|---|---|---|
401 |
CustomerNotAuthenticatedException
|
Indicates that the customer is not authenticated and must be logged in. | |
403 |
CustomerNotAuthorizedException
|
Indicates that the authenticated customer is not the owner of the list | |
404 |
ProductListNotFoundException
|
productListId (String) |
Indicates that this list doesn't exist |
Sample
REQUEST:
GET /dw/shop/v15_6/product_lists/cdmeh9aaabqtwaaadjcLADJaTY/items HTTP/1.1
Host: example.com
Content-Type: application/json; charset=UTF-8
Cookie: dwcustomer_9727b83e8e864fa4b6902a37bc70a12d=cdT3mHBc4s8q4y1bE9qaLNQIaW;
dwsid=pATvWUO3KSdt-Kmcy-8-RsxKnoO4BMDwoec7ACVlW6tZNnhaOL7gt7mHqL-h7QYn5TyE61z0DeSMCqxngsWeHw==;
# in case of success:
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"count" : 2,
"data" :
[
{
"id" : "cdPIB9aaabYFEaaadjOdBoMrMt",
"position" : -1,
"priority" : 2,
"product_details_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/products/008884303989?locale=en-US&client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"product_id" : "008884303989",
"product_name" : "Platinum Blue Stripes Easy Care Fitted Shirt",
"title" : "Platinum Blue Stripes Easy Care Fitted Shirt"
},
"public" : true,
"purchased_quantity" : 0,
"quantity" : 10,
"type" : "product"
},
{
"id" : "cdH9N9aaabYFIaaadjOdBoMrMt",
"position" : -1,
"priority" : 2,
"product_details_link" :
{
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/products/008885535488?locale=en-US&client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"product_id" : "008885535488",
"product_name" : "Must Have Washable No-Iron Georgette Blouse",
"title" : "Must Have Washable No-Iron Georgette Blouse"
},
"public" : true,
"purchased_quantity" : 0,
"quantity" : 1,
"type" : "product"
}
],
"total" : 2
}
# in case of failure (authentication failed):
RESPONSE:
HTTP/1.1 401 Unauthorized
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthenticatedException",
"message" : "Customer must be authenticated."
}
}
# in case of failure (authorization failed):
RESPONSE:
HTTP/1.1 403 Forbidden
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthorizedException",
"message" : "Customer is not authorized for this action."
}
}
# in case of failure (list not found):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "NotFoundException",
"message" : "Productlist with id 'cdmeh9aaabqtwaaadjcLADJaTZ' not found."
}
}
Adds a product to a product list.
Url
POST http://hostname:port/dw/shop/v15_6/product_lists/{list_id}/items
Formats
json, xml
Authentication
Name | Description |
---|---|
None | No authentication. |
Request Document
Response Document
Path Parameters
Parameter | Type | Description | Constraints |
---|---|---|---|
list_id | String | id of the list | mandatory=true, maxLength=28, minLength=1, nullable=false |
In case of a failure Fault Document is returned.
Faults
Status | Type | Arguments | Description |
---|---|---|---|
400 |
ProductListProductIdMissingException
|
Indicates that there was no product id given for the desired item. | |
400 |
ProductListItemTypeMissingException
|
Indicates that there was not item type given, which is required create a product item. | |
400 |
ProductListProductNotFoundException
|
productId (String) |
Indicates that there is no product existing for the given product id. |
400 |
ProductListDuplicateGiftCertificateException
|
Indicates that the given gift certificate could not be added due to an existing one (there can be only one gift certificate per product list). | |
401 |
CustomerNotAuthenticatedException
|
Indicates that the customer is not authenticated and must be logged in. | |
403 |
CustomerNotAuthorizedException
|
Indicates that the authenticated customer is not the owner of the list | |
404 |
ProductListNotFoundException
|
productListId (String) |
Indicates that this list doesn't exist |
Sample
#
# Example 1: add product
#
REQUEST:
POST /dw/shop/v15_6/product_lists/cdmeh9aaabqtwaaadjcLADJaTY/items HTTP/1.1
Host: example.com
Content-Type: application/json; charset=UTF-8
Cookie: dwcustomer_9727b83e8e864fa4b6902a37bc70a12d=cdT3mHBc4s8q4y1bE9qaLNQIaW;
dwsid=pATvWUO3KSdt-Kmcy-8-RsxKnoO4BMDwoec7ACVlW6tZNnhaOL7gt7mHqL-h7QYn5TyE61z0DeSMCqxngsWeHw==;
{
"type" : "product",
"quantity" : 5,
"priority" : 10,
"public" : false,
"product_details_link" :
{
"product_id" : "008884303989"
}
}
# in case of success:
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"_type" : "product_list_item",
"id" : "cdHYN9aaabZCEaaadj7dhW0d1L",
"position" : -1,
"priority" : 10,
"product_details_link" :
{
"_type" : "product_details_link",
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/products/008884303989?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"product_id" : "008884303989",
"product_name" : "Platinum Blue Stripes Easy Care Fitted Shirt",
"title" : "Platinum Blue Stripes Easy Care Fitted Shirt"
},
"public" : false,
"purchased_quantity" : 0,
"quantity" : 5,
"type" : "product"
}
# in case of failure (authentication failed):
RESPONSE:
HTTP/1.1 401 Unauthorized
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthenticatedException",
"message" : "Customer must be authenticated."
}
}
# in case of failure (authorization failed):
RESPONSE:
HTTP/1.1 403 Forbidden
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthorizedException",
"message" : "Customer is not authorized for this action."
}
}
# in case of failure (list not found):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "NotFoundException",
"message" : "Productlist with id 'cdmeh9aaabqtwaaadjcLADJaTZ' not found."
}
}
# in case of failure (product id missing):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "ProductListProductIdMissingException",
"message" : "Product id missing."
}
}
# in case of failure (product not found for given id):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "ProductListProductNotFoundException",
"message" : "Product with id '008884303987' not found."
}
}
# in case of failure (product item type invalid):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "ProductListInvalidItemTypeException",
"message" : "Productlist item type '999' unknown."
}
}
#
# Example 2: add gift certificate
#
REQUEST:
POST /dw/shop/v15_6/product_lists/cdmeh9aaabqtwaaadjcLADJaTY/items HTTP/1.1
Host: example.com
Content-Type: application/json; charset=UTF-8
Cookie: dwcustomer_9727b83e8e864fa4b6902a37bc70a12d=cdT3mHBc4s8q4y1bE9qaLNQIaW;
dwsid=pATvWUO3KSdt-Kmcy-8-RsxKnoO4BMDwoec7ACVlW6tZNnhaOL7gt7mHqL-h7QYn5TyE61z0DeSMCqxngsWeHw==;
{
"type" : "gift_certificate",
"priority" : 10,
"public" : false,
}
# in case of success:
RESPONSE:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"_type" : "product_list_item",
"id" : "ceOe79aaabcKgaaadjm3RW0d1T",
"position" : -1,
"priority" : 5,
"public" : false,
"purchased_quantity" : 0,
"type" : "gift_certificate"
}
# in case of failure (list already contained a gift certificate when trying to add another one):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "ProductListDuplicateGiftCertificateException",
"message" : "Productlist already contains a gift certificate."
}
}
Change an item of a product list. You can change the priority, quantity and if this item is public.
Url
PATCH http://hostname:port/dw/shop/v15_6/product_lists/{list_id}/items/{item_id}
Formats
json, xml
Authentication
Name | Description |
---|---|
None | No authentication. |
Request Document
Response Document
Path Parameters
Parameter | Type | Description | Constraints |
---|---|---|---|
item_id | String | id of the item | mandatory=true, maxLength=28, minLength=1, nullable=false |
list_id | String | id of the list | mandatory=true, maxLength=28, minLength=1, nullable=false |
In case of a failure Fault Document is returned.
Faults
Status | Type | Arguments | Description |
---|---|---|---|
401 |
CustomerNotAuthenticatedException
|
Indicates that the customer is not authenticated and must be logged in. | |
403 |
CustomerNotAuthorizedException
|
Indicates that the authenticated customer is not the owner of the list | |
404 |
ProductListNotFoundException
|
productListId (String) |
Indicates that this list doesn't exist |
404 |
ProductListItemNotFoundException
|
itemId (String) |
Indicates that this item doesn't exist |
Sample
REQUEST:
PATCH /dw/shop/v15_6/product_lists/cdmeh9aaabqtwaaadjcLADJaTY/items/egxlF9aaabd0kaaaejqgaDhv2c HTTP/1.1
Host: example.com
Content-Type: application/json; charset=UTF-8
Cookie: dwcustomer_9727b83e8e864fa4b6902a37bc70a12d=cdT3mHBc4s8q4y1bE9qaLNQIaW;
dwsid=pATvWUO3KSdt-Kmcy-8-RsxKnoO4BMDwoec7ACVlW6tZNnhaOL7gt7mHqL-h7QYn5TyE61z0DeSMCqxngsWeHw==;
{
"quantity":5,
"priority":10,
"public":false
}
# in case of success
RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"_type" : "product_list_item",
"id" : "egxlF9aaabd0kaaaejqgaDhv2c",
"position" : -1,
"priority" : 10,
"product_details_link" :
{
"_type" : "product_details_link",
"link" : "https://example.com/s/SiteGenesis/dw/shop/v15_6/products/008884303989?client_id=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"product_id" : "008884303989",
"product_name" : "Platinum Blue Stripes Easy Care Fitted Shirt",
"title" : "Platinum Blue Stripes Easy Care Fitted Shirt"
},
"public" : false,
"purchased_quantity" : 0,
"quantity" : 5,
"type" : "product"
}
# in case of failure (authentication failed):
RESPONSE:
HTTP/1.1 401 Unauthorized
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthenticatedException",
"message" : "Customer must be authenticated."
}
}
# in case of failure (authorization failed):
RESPONSE:
HTTP/1.1 403 Forbidden
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthorizedException",
"message" : "Customer is not authorized for this action."
}
}
# in case of failure (list not found):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "NotFoundException",
"message" : "Productlist with id 'cdmeh9aaabqtwaaadjcLADJaTY' not found."
}
}
# in case of failure (item not found):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "NotFoundException",
"message" : "Productlist item with id 'egxlF9aaabd0kaaaejqgaDhv2c' not found."
}
}
Deletes an item of a product list.
Url
DELETE http://hostname:port/dw/shop/v15_6/product_lists/{list_id}/items/{item_id}
Formats
json, xml
Authentication
Name | Description |
---|---|
None | No authentication. |
Path Parameters
Parameter | Type | Description | Constraints |
---|---|---|---|
item_id | String | id of the item | mandatory=true, maxLength=28, minLength=1, nullable=false |
list_id | String | id of the list | mandatory=true, maxLength=28, minLength=1, nullable=false |
In case of a failure Fault Document is returned.
Faults
Status | Type | Arguments | Description |
---|---|---|---|
401 |
CustomerNotAuthenticatedException
|
Indicates that the customer is not authenticated and must be logged in. | |
403 |
CustomerNotAuthorizedException
|
Indicates that the authenticated customer is not the owner of the list | |
404 |
ProductListNotFoundException
|
productListId (String) |
Indicates that this list doesn't exist |
404 |
ProductListItemNotFoundException
|
itemId (String) |
Indicates that this item doesn't exist |
Sample
REQUEST:
DELETE /dw/shop/v15_6/product_lists/cdmeh9aaabqtwaaadjcLADJaTY/items/cdHYN9aaabZCEaaadj7dhW0d1L HTTP/1.1
Host: example.com
Content-Type: application/json; charset=UTF-8
Cookie: dwcustomer_9727b83e8e864fa4b6902a37bc70a12d=cdT3mHBc4s8q4y1bE9qaLNQIaW;
dwsid=pATvWUO3KSdt-Kmcy-8-RsxKnoO4BMDwoec7ACVlW6tZNnhaOL7gt7mHqL-h7QYn5TyE61z0DeSMCqxngsWeHw==;
# in case of success:
RESPONSE:
HTTP/1.1 204 No Content
Content-Type : text/plain; charset=ISO-8859-1
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
# in case of failure (authentication failed):
RESPONSE:
HTTP/1.1 401 Unauthorized
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthenticatedException",
"message" : "Customer must be authenticated."
}
}
# in case of failure (authorization failed):
RESPONSE:
HTTP/1.1 403 Forbidden
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "CustomerNotAuthorizedException",
"message" : "Customer is not authorized for this action."
}
}
# in case of failure (list not found):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "NotFoundException",
"message" : "Productlist with id 'cdmeh9aaabqtwaaadjcLADJaTZ' not found."
}
}
# in case of failure (item not found):
RESPONSE:
HTTP/1.1 404 Not Found
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
"_v" : "15.6",
"fault" :
{
"type" : "NotFoundException",
"message" : "Productlist item with id 'cdHYN9aaabZCEaaadj7dhW0d1L' not found."
}
}