8.12 Support Management
These endpoints enables all customer support services to be managed.
get
Fetch a support session
Path parameters
orderIdstringRequired
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.
Responses
default
Successful closure of a chat session
application/json
get
GET /beckn/e-marketplace-bb/0.2/support/{orderId} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
default
Successful closure of a chat session
{
"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"
}
]
},
"order_id": "text",
"callback_phone": "text",
"chat": {
"url": "text",
"session_id": "text"
},
"faq": {
"url": "text",
"mime_type": "text"
},
"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-06-27",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"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"
}
}post
Generate a support request for an order
Path parameters
orderIdstringRequired
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.
Responses
default
Successful closure of a chat session
application/json
post
POST /beckn/e-marketplace-bb/0.2/support/{orderId} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
default
Successful closure of a chat session
{
"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"
}
]
},
"order_id": "text",
"callback_phone": "text",
"chat": {
"url": "text",
"session_id": "text"
},
"faq": {
"url": "text",
"mime_type": "text"
},
"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-06-27",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"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"
}
}put
Update a chat session
Path parameters
orderIdstringRequired
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.
Responses
default
Successful closure of a chat session
application/json
put
PUT /beckn/e-marketplace-bb/0.2/support/{orderId} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
default
Successful closure of a chat session
{
"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"
}
]
},
"order_id": "text",
"callback_phone": "text",
"chat": {
"url": "text",
"session_id": "text"
},
"faq": {
"url": "text",
"mime_type": "text"
},
"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-06-27",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"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"
}
}delete
Close a chat session
Path parameters
orderIdstringRequired
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.
Responses
default
Successful closure of a chat session
application/json
delete
DELETE /beckn/e-marketplace-bb/0.2/support/{orderId} HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
default
Successful closure of a chat session
{
"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"
}
]
},
"order_id": "text",
"callback_phone": "text",
"chat": {
"url": "text",
"session_id": "text"
},
"faq": {
"url": "text",
"mime_type": "text"
},
"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-06-27",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"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"
}
}get
Fetch the agent to a support session
Path parameters
orderIdstringRequired
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.
Responses
default
Successful closure of a chat session
application/json
get
GET /beckn/e-marketplace-bb/0.2/support/{orderId}/agent HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
default
Successful closure of a chat session
{
"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-06-27",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"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"
}put
Update agent for a support request
Path parameters
orderIdstringRequired
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.
Body
Details of customer support
order_idstringOptional
callback_phonestring · phoneOptional
Responses
default
Successful closure of a chat session
application/json
put
PUT /beckn/e-marketplace-bb/0.2/support/{orderId}/agent HTTP/1.1
Host: virtserver.swaggerhub.com
Content-Type: application/json
Accept: */*
Content-Length: 2099
{
"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"
}
]
},
"order_id": "text",
"callback_phone": "text",
"chat": {
"url": "text",
"session_id": "text"
},
"faq": {
"url": "text",
"mime_type": "text"
},
"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-06-27",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"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"
}
}default
Successful closure of a chat session
{
"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"
}
]
},
"order_id": "text",
"callback_phone": "text",
"chat": {
"url": "text",
"session_id": "text"
},
"faq": {
"url": "text",
"mime_type": "text"
},
"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-06-27",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"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"
}
}delete
Remove an agent from a support request
Path parameters
orderIdstringRequired
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.
Responses
default
Successful closure of a chat session
application/json
delete
DELETE /beckn/e-marketplace-bb/0.2/support/{orderId}/agent HTTP/1.1
Host: virtserver.swaggerhub.com
Accept: */*
default
Successful closure of a chat session
{
"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"
}
]
},
"order_id": "text",
"callback_phone": "text",
"chat": {
"url": "text",
"session_id": "text"
},
"faq": {
"url": "text",
"mime_type": "text"
},
"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-06-27",
"gender": "text",
"creds": [
{
"id": "text",
"type": "VerifiableCredential",
"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"
}
}Last updated
Was this helpful?