8.12 Support Management

These endpoints enables all customer support services to be managed.

Fetch a support session

get

/support/{orderId}

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}'

default

default

{
  "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"
    }
  },
  "order_id": "text",
  "callback_phone": "text",
  "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"
  },
  "chat": {
    "url": "text",
    "session_id": "text"
  },
  "faq": {
    "url": "text",
    "mime_type": "text"
  }
}

Successful closure of a chat session

Generate a support request for an order

post

/support/{orderId}

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}'

default

default

{
  "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"
    }
  },
  "order_id": "text",
  "callback_phone": "text",
  "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"
  },
  "chat": {
    "url": "text",
    "session_id": "text"
  },
  "faq": {
    "url": "text",
    "mime_type": "text"
  }
}

Successful closure of a chat session

Update a chat session

put

/support/{orderId}

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}'

default

default

{
  "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"
    }
  },
  "order_id": "text",
  "callback_phone": "text",
  "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"
  },
  "chat": {
    "url": "text",
    "session_id": "text"
  },
  "faq": {
    "url": "text",
    "mime_type": "text"
  }
}

Successful closure of a chat session

Close a chat session

delete

/support/{orderId}

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}'

default

default

{
  "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"
    }
  },
  "order_id": "text",
  "callback_phone": "text",
  "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"
  },
  "chat": {
    "url": "text",
    "session_id": "text"
  },
  "faq": {
    "url": "text",
    "mime_type": "text"
  }
}

Successful closure of a chat session

Fetch the agent to a support session

get

/support/{orderId}/agent

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}/agent'

default

default

{
  "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 agent for a support request

put

/support/{orderId}/agent

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

descriptorobject

Physical description of something.

order_idstring

callback_phonestring · phone

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.

chatobject

faqobject

Link to the FAQ document

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}/agent' \
  --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"
      }
    },
    "order_id": "text",
    "callback_phone": "text",
    "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"
    },
    "chat": {
      "url": "text",
      "session_id": "text"
    },
    "faq": {
      "url": "text",
      "mime_type": "text"
    }
  }'

default

default

{
  "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"
    }
  },
  "order_id": "text",
  "callback_phone": "text",
  "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"
  },
  "chat": {
    "url": "text",
    "session_id": "text"
  },
  "faq": {
    "url": "text",
    "mime_type": "text"
  }
}

Successful closure of a chat session

Remove an agent from a support request

delete

/support/{orderId}/agent

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://virtserver.swaggerhub.com/beckn/e-marketplace-bb/0.2/support/{orderId}/agent'

default

default

{
  "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"
    }
  },
  "order_id": "text",
  "callback_phone": "text",
  "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"
  },
  "chat": {
    "url": "text",
    "session_id": "text"
  },
  "faq": {
    "url": "text",
    "mime_type": "text"
  }
}

Successful closure of a chat session