8.9 Rating and Feedback Management
Last updated
Was this helpful?
Development
Last updated
Was this helpful?
Cancel the fulfillment for an order
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.
DELETE /beckn/e-marketplace-bb/0.2/forms/{formId} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
Successful closure of a chat session
{
"id": "text",
"type": "text",
"rateable": true,
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-05-11T14:52:32.803Z",
"updated_by": "text"
},
"tracking": true,
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-05-11",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-05-11",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"rating": "text"
},
"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"
},
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"type": "text",
"time": {
"label": "text",
"timestamp": "2025-05-11T14:52:32.803Z",
"duration": "text",
"range": {
"start": "2025-05-11T14:52:32.803Z",
"end": "2025-05-11T14:52:32.803Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-05-11T14:52:32.803Z"
],
"times": [
"2025-05-11T14:52:32.803Z"
]
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-05-11",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-05-11T14:52:32.803Z",
"valid_to": "2025-05-11T14:52:32.803Z",
"status": "text"
}
}
],
"path": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}create a form
ID of the form
GET /beckn/e-marketplace-bb/0.2/forms/{formId} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
Successful closure of a chat session
{
"id": "text",
"type": "text",
"rateable": true,
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-05-11T14:52:32.803Z",
"updated_by": "text"
},
"tracking": true,
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-05-11",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-05-11",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"rating": "text"
},
"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"
},
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"type": "text",
"time": {
"label": "text",
"timestamp": "2025-05-11T14:52:32.803Z",
"duration": "text",
"range": {
"start": "2025-05-11T14:52:32.803Z",
"end": "2025-05-11T14:52:32.803Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-05-11T14:52:32.803Z"
],
"times": [
"2025-05-11T14:52:32.803Z"
]
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-05-11",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-05-11T14:52:32.803Z",
"valid_to": "2025-05-11T14:52:32.803Z",
"status": "text"
}
}
],
"path": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}BPP provides the list of entities that can be rated in its system to the BAP
Contains any additional or extended inputs required to confirm an order. This is typically a Form Input. Sometimes, selection of catalog elements is not enough for the Provider Platform to confirm an order. For example, to confirm a flight ticket, the airline requires details of the passengers along with information on baggage, identity, in addition to the class of ticket. Similarly, a logistics company may require details on the nature of shipment in order to confirm the shipping. A recruiting firm may require additional details on the applicant in order to confirm a job application. For all such purposes, the can choose to send this object attached to any object in the catalog that is required to be sent while placing the order. This object can typically be sent at an item level or at the order level. The item level XInput will override the Order level XInput as it indicates a special requirement of information for that particular item. Hence the Consumer Interface must render a separate form for the Item and another form at the Order level before confirmation.
Indicates whether the form data is mandatorily required by the Provider Platform to confirm the order.
POST /beckn/e-marketplace-bb/0.2/forms HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 438
{
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
}Form object
{
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
}Update fulfillment state for an order
Unique reference ID to the fulfillment of an order
Describes the state of fulfillment
ID of entity which changed the state
PUT /beckn/e-marketplace-bb/0.2/forms/{formId} HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 383
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-05-11T14:52:32.803Z",
"updated_by": "text"
}Successful closure of a chat session
{
"id": "text",
"type": "text",
"rateable": true,
"rating": "text",
"state": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"updated_at": "2025-05-11T14:52:32.803Z",
"updated_by": "text"
},
"tracking": true,
"customer": {
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-05-11",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"agent": {
"id": "text",
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-05-11",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"organization": {
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"address": "text",
"state": {
"name": "text",
"code": "text"
},
"city": {
"name": "text",
"code": "text"
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
}
},
"rating": "text"
},
"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"
},
"stops": [
{
"id": "text",
"parent_stop_id": "text",
"location": {
"id": "text",
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"map_url": "https://example.com",
"gps": "text",
"address": "text",
"city": {
"name": "text",
"code": "text"
},
"district": "text",
"state": {
"name": "text",
"code": "text"
},
"country": {
"name": "text",
"code": "text"
},
"area_code": "text",
"circle": {
"gps": "text",
"radius": {
"type": "CONSTANT",
"value": "text",
"estimated_value": "text",
"computed_value": "text",
"range": {
"min": "text",
"max": "text"
},
"unit": "text"
}
},
"polygon": "text",
"3dspace": "text",
"rating": "text"
},
"type": "text",
"time": {
"label": "text",
"timestamp": "2025-05-11T14:52:32.803Z",
"duration": "text",
"range": {
"start": "2025-05-11T14:52:32.803Z",
"end": "2025-05-11T14:52:32.803Z"
},
"days": "text",
"schedule": {
"frequency": "text",
"holidays": [
"2025-05-11T14:52:32.803Z"
],
"times": [
"2025-05-11T14:52:32.803Z"
]
}
},
"instructions": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"contact": {
"phone": "text",
"email": "text",
"jcard": {}
},
"person": {
"id": "text",
"url": "https://example.com",
"name": "text",
"image": {
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
},
"age": "text",
"dob": "2025-05-11",
"gender": "text",
"creds": [
{
"id": "text",
"type": "text",
"url": "https://example.com"
}
],
"languages": [
{
"code": "text",
"name": "text"
}
],
"skills": [
{
"code": "text",
"name": "text"
}
],
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
},
"authorization": {
"type": "text",
"token": "text",
"valid_from": "2025-05-11T14:52:32.803Z",
"valid_to": "2025-05-11T14:52:32.803Z",
"status": "text"
}
}
],
"path": "text",
"tags": [
{
"display": true,
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"list": [
{
"descriptor": {
"name": "text",
"code": "text",
"short_desc": "text",
"long_desc": "text",
"additional_desc": {
"url": "text",
"content_type": "text/plain"
},
"media": [
{
"mimetype": "text",
"url": "https://example.com",
"signature": "text",
"dsa": "text"
}
],
"images": [
{
"url": "https://example.com",
"size_type": "xs",
"width": "text",
"height": "text"
}
]
},
"value": "text",
"display": true
}
]
}
]
}BPP provides the list of entities that can be rated in its system to the BAP
Describes the rating of an entity
Category of the entity being rated
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 ||.
POST /beckn/e-marketplace-bb/0.2/generateFeedbackForRating HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"rating_category": "Item",
"id": "text",
"value": "text"
}Form object
{
"id": "text",
"head": {
"descriptor": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"index": {
"cur": 1,
"max": 1,
"min": 1
},
"headings": [
"text"
]
},
"form": {
"id": "text",
"url": "https://example.com",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"mime_type": "text/html",
"submission_id": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true
}