Receiving request to update an item’s quantity on an active order and sending the updated order with payment terms (Java)
In this use case, the user changes the quantity of one or more items after the order has been confirmed. If the user has already made the payment, the seller sends additional payment terms that the user needs to fulfill before the quantity gets updated. In case the order is postpaid, the seller can update the total amount to be paid after the fulfillment of the order.
Code snippets
BPP receives protocol update
/*
Example Request JSON:
{
"context": {
"domain": "local_retail",
"country": "IND",
"city": "std:080",
"action": "update",
"core_version": "0.9.2",
"bap_id": "https://mock_bap.com/",
"bap_uri": "https://mock_bap.com/beckn/",
"transaction_id": "1239890342",
"message_id": "123793824",
"timestamp": "2021-06-23T07:33:02.655Z"
},
"message": {
"update_target": "items",
"order": {
"id":"298310283",
"state":"Order placed",
"provider": {
"id": "pooja-stores",
"locations": [
{
"id": "pooja-stores.koramangala"
}
]
},
"items": [
{
"id": "item_1",
"quantity": {
"count": 2
}
},
{
"id": "item_4",
"quantity": {
"count": 2
}
}
],
"billing": {
"name": "Jane Doe",
"address": {
"door": "21B",
"name": "EFG Apartments",
"locality": "Electronic City",
"city": "Bengaluru",
"state": "Karnataka",
"country": "India",
"area_code": "560104"
},
"email": "[email protected]",
"phone": "+919777543210",
"created_at": "2021-06-15T07:08:36.211Z",
"updated_at": "2021-06-15T07:08:36.211Z"
},
"fulfillment": {
"type": "home-delivery",
"tracking": false,
"start": {
"location": {
"id": "pooja-stores.koramangala",
"descriptor": {
"name": "Pooja Stores"
},
"gps": "12.9349377,77.6055586"
},
"time": {
"range": {
"start": "2021-06-15T07:09:30.000Z",
"end": "2021-06-15T07:10:30.000Z"
}
},
"instructions": {
"name": "pick up instructions",
"short_desc": "Provide the order id"
},
"contact": {
"phone": "+919999999999",
"email": "[email protected]"
}
},
"end": {
"location": {
"gps": "12.835407, 77.662524",
"address": {
"door": "21B",
"name": "EFG Apartments",
"locality": "Electronic City",
"city": "Bengaluru",
"state": "Karnataka",
"country": "India",
"area_code": "560104"
}
},
"time": {
"range": {
"start": "2021-06-15T07:11:36.212Z",
"end": "2021-06-15T07:12:36.212Z"
}
},
"instructions": {
"name": "drop off instructions",
"short_desc": "Leave at door step"
},
"contact": {
"phone": "+919777543210",
"email": "[email protected]"
}
}
},
"quote": {
"price": {
"currency": "INR",
"value": "200"
},
"breakup": [
{
"title": "Brown Bread 400 gm",
"price": {
"currency": "INR",
"value": "80"
}
},
{
"title": "Good Life Toned Milk 1L",
"price": {
"currency": "INR",
"value": "120"
}
}
],
"ttl": "P4D"
},
"payment": {
"uri": "https://api.bpp.com/pay?amt=$amount&txn_id=ksh87yriuro34iyr3p4&mode=upi&vpa=bpp@upi",
"tl_method": "http/get",
"params": {
"transaction_id": "ksh87yriuro34iyr3p4",
"amount": "160",
"mode": "upi",
"vpa": "bpp@upi"
},
"type": "ON-ORDER",
"status": "PAID"
},
"created_at": "2021-06-23T07:33:02.655Z",
"updated_at": "2021-06-23T07:33:02.655Z"
}
}
}
*/
// BPP Update Endpoint
@PostMapping("/bpp/update")
public ResponseEntity update(
@RequestHeader HttpHeaders headers,
@RequestBody UpdateRequest request) {
var response = bppApplicationService.update(request, headers);
return ResponseEntity.ok(response);
}BPP processes the update
public Response update(UpdateRequest request, HttpHeaders headers) {
var onUpdateRequest = new OnUpdateRequest();
// Validate the headers
var isHeadersValid = validateHeaders(headers);
// Construct and return error
if (!isHeadersValid) return null;
// Update the given order
var updateOrder = request.getMessage().getOrder();
// Execute business logic here
// Generate the response
onUpdateRequest = generateUpdatedOrderResponse(updateOrder);
//invoke on_update api
return invokeOnUpdate(onUpdateRequest, headers);
}
}BPP generates response
/*
Example Response JSON:
{
"context": {
"domain": "local_retail",
"country": "IND",
"city": "std:080",
"action": "on_update",
"core_version": "0.9.2",
"bap_id": "https://mock_bap.com/",
"bap_uri": "https://mock_bap.com/beckn/",
"transaction_id": "1239890342",
"message_id": "123793824",
"timestamp": "2021-06-23T07:33:02.655Z"
},
"message": {
"order": {
"id":"298310283",
"state":"Order placed",
"provider": {
"id": "pooja-stores",
"locations": [
{
"id": "pooja-stores.koramangala"
}
]
},
"items": [
{
"id": "item_1",
"quantity": {
"count": 1
}
},
{
"id": "item_4",
"quantity": {
"count": 2
}
}
],
"billing": {
"name": "Jane Doe",
"address": {
"door": "21B",
"name": "EFG Apartments",
"locality": "Electronic City",
"city": "Bengaluru",
"state": "Karnataka",
"country": "India",
"area_code": "560104"
},
"email": "[email protected]",
"phone": "+919777543210",
"created_at": "2021-06-15T07:08:36.211Z",
"updated_at": "2021-06-15T07:08:36.211Z"
},
"fulfillment": {
"type": "home-delivery",
"tracking": false,
"start": {
"location": {
"id": "pooja-stores.koramangala",
"descriptor": {
"name": "Pooja Stores"
},
"gps": "12.9349377,77.6055586"
},
"time": {
"range": {
"start": "2021-06-15T07:09:30.000Z",
"end": "2021-06-15T07:10:30.000Z"
}
},
"instructions": {
"name": "pick up instructions",
"short_desc": "Provide the order id"
},
"contact": {
"phone": "+919999999999",
"email": "[email protected]"
}
},
"end": {
"location": {
"gps": "12.835407, 77.662524",
"address": {
"door": "21B",
"name": "EFG Apartments",
"locality": "Electronic City",
"city": "Bengaluru",
"state": "Karnataka",
"country": "India",
"area_code": "560104"
}
},
"time": {
"range": {
"start": "2021-06-15T07:11:36.212Z",
"end": "2021-06-15T07:12:36.212Z"
}
},
"instructions": {
"name": "drop off instructions",
"short_desc": "Leave at door step"
},
"contact": {
"phone": "+919777543210",
"email": "[email protected]"
}
}
},
"quote": {
"price": {
"currency": "INR",
"value": "180"
},
"breakup": [
{
"title": "Brown Bread 400 gm",
"price": {
"currency": "INR",
"value": "40"
}
},
{
"title": "Good Life Toned Milk 1L",
"price": {
"currency": "INR",
"value": "120"
}
}
],
"ttl": "P4D"
},
"payment": {
"uri": "https://api.bpp.com/pay?amt=$amount&txn_id=ksh87yriuro34iyr3p4&mode=upi&vpa=bpp@upi",
"tl_method": "http/get",
"params": {
"transaction_id": "ksh87yriuro34iyr3p4",
"amount": "40",
"mode": "upi",
"vpa": "bpp@upi"
},
"type": "ON-ORDER",
"status": "NOT-PAID"
},
"created_at": "2021-06-23T07:33:02.655Z",
"updated_at": "2021-06-23T07:33:02.655Z"
}
}
}
*/
public OnUpdateRequest generateUpdatedOrderResponse(UpdatedOrderDetails updatedDetails) {
var updatedResult = UpdateResponseBuilder.builder.result(updateingDetails).build();
// Convert response into protocol object similar to example above
return updatedResult;
}
BPP calls protocol on_update
public Response invokeOnUpdate(OnUpdateRequest updateResponse, HttpHeaders headers) {
if(updateResponse.getError() == null) {
// Call BAP on_update api with the order response
// Call to look up function which returns the the public key and BAP Endpoint to be called
var url = lookUp(headers);
var response = apiClient.post(url[0] + Context.ActionEnum.on_update,
constructResponseHeaders(),
updateResponse,
OnUpdateRequest.class);
return Response.of("ACK", null);
} else {
return Response.of("NACK", null);
}
}