Service URL: PATCH /baskets/{basketReference}/description
Tokens:
basketReference – The basket reference of the basket to add the items to, or can be ‘PRIMARY’ to add to the PRIMARY basket.
Request:
UpdateBasketDescriptionRequest – extends BasketRetrievalRequest
- description – String – the new description of the wishlist – max length 20
Parameters:
- returnBasket – Boolean – Should the basket be returned in the request. (Optional, defaults to false)
Response:
BasketResponse
basket – IBasket – The basket associated with the given reference
basketReference – String – the reference of the basket
basketType – String – the type of the basket
basketDescription – String – the description of the basket
basketResponseCode – String – A specific basket code to indict whether the basket was implicitly created by the server.
basketStatus – String – the status of the basket. Fresh baskets have the status NEW. Baskets in progress have the status of IN_PROGRESS. Baskets will have been submitted to retail processing have the status SUBMITTED.
Remarks:
- Updates an existing baskets description. The basket must already exist, otherwise, the service will return a 404 not found. If the description is empty in the request, the service should return 400 bad request. If the service call is successful, a 200 OK response is returned. However, if the returnBasket parameter is true, the basket is also returned in the response.
All Scenarios start with: Basket manager service receives an associate basket customer request with the merge Rule of DISCARD.
| Scenario | Outcome | Expected behaviour | Status Code | Response | |
|---|---|---|---|---|---|
| 1 | The Update Basket Service has received a valid request for a basket reference that exists. | Success | The baskets description is updated | 200 | 200 OK Success |
| 2 | The Update Basket Service has received a valid request for a basket reference that exists with the flag returnBasket set to true | Success | The baskets description is updated. | 200 | BasketResponse |
| 3 | The Update Basket Service has received a valid request for a basket that does not exist. | NotFound | The baskets description is not updated. An error message is returned with a 404 response. | 404 | ErrorMessage: Failed to update baskets description, outcome: NotFound |
Example Request
PATCH /WebRestApi/rest/baskets/PRIMARY/description
Content-Type: application/json
{
"description": "New Description"
}