8.12 Support Management

These endpoints enables all customer support services to be managed.

Fetch a support session

GEThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}

Path parameters

orderId*string

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.

Response

default

Successful closure of a chat session

Body

application/json

descriptorobject

Physical description of something.

order_idstring

callback_phonestring (phone)

chatobject

faqobject

Link to the FAQ document

agentobject

Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

{
  "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": {},
      "dob": "2025-01-30",
      "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": false
            }
          ]
        }
      ]
    },
    "contact": {
      "phone": "text",
      "email": "text"
    },
    "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": {},
      "state": {
        "name": "text",
        "code": "text"
      },
      "city": {
        "name": "text",
        "code": "text"
      },
      "contact": {
        "phone": "text",
        "email": "text"
      }
    },
    "rating": "text"
  }
}

Generate a support request for an order

POSThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}

Path parameters

orderId*string

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.

Response

default

Successful closure of a chat session

Body

application/json

descriptorobject

Physical description of something.

order_idstring

callback_phonestring (phone)

chatobject

faqobject

Link to the FAQ document

agentobject

Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

default

{
  "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": {},
      "dob": "2025-01-30",
      "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": false
            }
          ]
        }
      ]
    },
    "contact": {
      "phone": "text",
      "email": "text"
    },
    "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": {},
      "state": {
        "name": "text",
        "code": "text"
      },
      "city": {
        "name": "text",
        "code": "text"
      },
      "contact": {
        "phone": "text",
        "email": "text"
      }
    },
    "rating": "text"
  }
}

Update a chat session

PUThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}

Path parameters

orderId*string

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.

Response

default

Successful closure of a chat session

Body

application/json

descriptorobject

Physical description of something.

order_idstring

callback_phonestring (phone)

chatobject

faqobject

Link to the FAQ document

agentobject

Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

default

{
  "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": {},
      "dob": "2025-01-30",
      "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": false
            }
          ]
        }
      ]
    },
    "contact": {
      "phone": "text",
      "email": "text"
    },
    "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": {},
      "state": {
        "name": "text",
        "code": "text"
      },
      "city": {
        "name": "text",
        "code": "text"
      },
      "contact": {
        "phone": "text",
        "email": "text"
      }
    },
    "rating": "text"
  }
}

Close a chat session

DELETEhttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}

Path parameters

orderId*string

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.

Response

default

Successful closure of a chat session

Body

application/json

descriptorobject

Physical description of something.

order_idstring

callback_phonestring (phone)

chatobject

faqobject

Link to the FAQ document

agentobject

Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

default

{
  "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": {},
      "dob": "2025-01-30",
      "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": false
            }
          ]
        }
      ]
    },
    "contact": {
      "phone": "text",
      "email": "text"
    },
    "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": {},
      "state": {
        "name": "text",
        "code": "text"
      },
      "city": {
        "name": "text",
        "code": "text"
      },
      "contact": {
        "phone": "text",
        "email": "text"
      }
    },
    "rating": "text"
  }
}

Fetch the agent to a support session

GEThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}/agent

Path parameters

orderId*string

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.

Response

default

Successful closure of a chat session

Body

application/json

idstring

personobject

Describes a person as any individual

contactobject

Describes the contact information of an entity

organizationobject

An organization. Usually a recognized business entity.

ratingstring

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 ||.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}/agent', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

{
  "id": "text",
  "person": {
    "id": "text",
    "url": "https://example.com",
    "name": "text",
    "image": {
      "url": "https://example.com",
      "size_type": "xs",
      "width": "text",
      "height": "text"
    },
    "age": {},
    "dob": "2025-01-30",
    "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": false
          }
        ]
      }
    ]
  },
  "contact": {
    "phone": "text",
    "email": "text"
  },
  "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": {},
    "state": {
      "name": "text",
      "code": "text"
    },
    "city": {
      "name": "text",
      "code": "text"
    },
    "contact": {
      "phone": "text",
      "email": "text"
    }
  },
  "rating": "text"
}

Update agent for a support request

PUThttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}/agent

Path parameters

orderId*string

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

application/json

descriptorobject

Physical description of something.

order_idstring

callback_phonestring (phone)

chatobject

faqobject

Link to the FAQ document

agentobject

Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.

Response

default

Successful closure of a chat session

Body

application/json

descriptorobject

Physical description of something.

order_idstring

callback_phonestring (phone)

chatobject

faqobject

Link to the FAQ document

agentobject

Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}/agent', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

default

{
  "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": {},
      "dob": "2025-01-30",
      "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": false
            }
          ]
        }
      ]
    },
    "contact": {
      "phone": "text",
      "email": "text"
    },
    "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": {},
      "state": {
        "name": "text",
        "code": "text"
      },
      "city": {
        "name": "text",
        "code": "text"
      },
      "contact": {
        "phone": "text",
        "email": "text"
      }
    },
    "rating": "text"
  }
}

Remove an agent from a support request

DELETEhttps://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}/agent

Path parameters

orderId*string

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.

Response

default

Successful closure of a chat session

Body

application/json

descriptorobject

Physical description of something.

order_idstring

callback_phonestring (phone)

chatobject

faqobject

Link to the FAQ document

agentobject

Describes the direct performer, driver or executor that fulfills an order. It is usually a person. But in some rare cases, it could be a non-living entity like a drone, or a bot. Some examples of agents are Doctor in the healthcare sector, a driver in the mobility sector, or a delivery person in the logistics sector. This object can be set at any stage of the order lifecycle. This can be set at the discovery stage when the Provider Platform wants to provide details on the agent fulfilling the order, like in healthcare, where the doctor's name appears during search. This object can also used to search for a particular person that the customer wants fulfilling an order. Sometimes, this object gets instantiated after the order is confirmed, like in the case of on-demand taxis, where the driver is assigned after the user confirms the ride.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}/agent', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

default

{
  "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": {},
      "dob": "2025-01-30",
      "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": false
            }
          ]
        }
      ]
    },
    "contact": {
      "phone": "text",
      "email": "text"
    },
    "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": {},
      "state": {
        "name": "text",
        "code": "text"
      },
      "city": {
        "name": "text",
        "code": "text"
      },
      "contact": {
        "phone": "text",
        "email": "text"
      }
    },
    "rating": "text"
  }
}