8.9 Rating and Feedback Management
Last updated
Was this helpful?
Last updated
Was this helpful?
BPP provides the list of entities that can be rated in its system to the BAP
/forms
Describes a form
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
curl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/forms' \
--header 'Content-Type: application/json' \
--data '{
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
}'{
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
}Form object
create a form
/forms/{formId}
ID of the form
curl -L \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/forms/{formId}'{
"id": "text",
"type": "text",
"rateable": true,
"tracking": false,
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"vehicle": {
"category": "text",
"capacity": 1,
"make": "text",
"model": "text",
"size": "text",
"variant": "text",
"color": "text",
"energy_type": "text",
"registration": "text",
"wheels_count": "text",
"cargo_volumne": "text",
"wheelchair_access": "text",
"code": "text",
"emission_standard": "text"
},
"path": "text",
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"type": "text",
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-03-03T17:15:43.074Z",
"valid_to": "2025-03-03T17:15:43.074Z",
"status": "text"
},
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
},
"time": {
"label": "text",
"timestamp": "2025-03-03T17:15:43.074Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T17:15:43.074Z"
],
"times": [
"2025-03-03T17:15:43.074Z"
]
},
"range": {
"start": "2025-03-03T17:15:43.074Z",
"end": "2025-03-03T17:15:43.074Z"
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T17:15:43.074Z",
"updated_by": "text"
},
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"rating": "text"
}
}Successful closure of a chat session
Update fulfillment state for an order
/forms/{formId}
Unique reference ID to the fulfillment of an order
Physical description of something.
ID of entity which changed the state
curl -L \
--request PUT \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/forms/{formId}' \
--header 'Content-Type: application/json' \
--data '{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T17:15:43.074Z",
"updated_by": "text"
}'{
"id": "text",
"type": "text",
"rateable": true,
"tracking": false,
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"vehicle": {
"category": "text",
"capacity": 1,
"make": "text",
"model": "text",
"size": "text",
"variant": "text",
"color": "text",
"energy_type": "text",
"registration": "text",
"wheels_count": "text",
"cargo_volumne": "text",
"wheelchair_access": "text",
"code": "text",
"emission_standard": "text"
},
"path": "text",
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"type": "text",
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-03-03T17:15:43.074Z",
"valid_to": "2025-03-03T17:15:43.074Z",
"status": "text"
},
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
},
"time": {
"label": "text",
"timestamp": "2025-03-03T17:15:43.074Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T17:15:43.074Z"
],
"times": [
"2025-03-03T17:15:43.074Z"
]
},
"range": {
"start": "2025-03-03T17:15:43.074Z",
"end": "2025-03-03T17:15:43.074Z"
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T17:15:43.074Z",
"updated_by": "text"
},
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"rating": "text"
}
}Successful closure of a chat session
Cancel the fulfillment for an order
/forms/{formId}
Human-readable ID of the order. This is generated at the Provider Platform layer. The Provider Platform can either generate order id within its system or forward the order ID created at the provider level.
curl -L \
--request DELETE \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/forms/{formId}'{
"id": "text",
"type": "text",
"rateable": true,
"tracking": false,
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"vehicle": {
"category": "text",
"capacity": 1,
"make": "text",
"model": "text",
"size": "text",
"variant": "text",
"color": "text",
"energy_type": "text",
"registration": "text",
"wheels_count": "text",
"cargo_volumne": "text",
"wheelchair_access": "text",
"code": "text",
"emission_standard": "text"
},
"path": "text",
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"type": "text",
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-03-03T17:15:43.074Z",
"valid_to": "2025-03-03T17:15:43.074Z",
"status": "text"
},
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"map_url": "https://example.com",
"district": "text",
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"unit": "text",
"type": "CONSTANT",
"range": {
"min": "text",
"max": "text"
}
}
},
"polygon": "text",
"3dspace": "text",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"rating": "text"
},
"time": {
"label": "text",
"timestamp": "2025-03-03T17:15:43.074Z",
"duration": "text",
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-03-03T17:15:43.074Z"
],
"times": [
"2025-03-03T17:15:43.074Z"
]
},
"range": {
"start": "2025-03-03T17:15:43.074Z",
"end": "2025-03-03T17:15:43.074Z"
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
}
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"updated_at": "2025-03-03T17:15:43.074Z",
"updated_by": "text"
},
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
},
"dob": "2025-03-03",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"url": "https://example.com"
}
],
"tags": [
{
"display": true,
"list": [
{
"value": "text",
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
}
}
],
"age": "text",
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"width": "text",
"height": "text",
"size_type": "xs"
}
],
"additional_desc": {
"url": "text",
"content_type": "text/plain"
}
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
}
},
"rating": "text"
}
}Successful closure of a chat session
BPP provides the list of entities that can be rated in its system to the BAP
/generateFeedbackForRating
Id of the object being rated
Rating value given to the object. This can be a single value or can also contain an inequality operator like gt, gte, lt, lte. This can also contain an inequality expression containing logical operators like && and ||.
Category of the entity being rated
Item, Order, Fulfillment, Provider, Agent, Supportcurl -L \
--request POST \
--url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/generateFeedbackForRating' \
--header 'Content-Type: application/json' \
--data '{
"id": "text",
"value": "text",
"rating_category": "Item"
}'{
"id": "text",
"form": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"required": true,
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"submission_id": "123e4567-e89b-12d3-a456-426614174000",
"mime_type": "text/html",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"headings": [
"text"
],
"index": {
"cur": 1,
"max": 1,
"min": 1
}
}
}Form object