23Q4

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

Successful closure of a chat session

Body

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

order_idstring

callback_phonestring (phone)

chatobject

urlstring

Chat URL

session_idstring

Chat session ID

faqobject

Link to the FAQ document

urlstring

mime_typestring

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.

idstring

personobject

Describes a person as any individual

idstring

Describes the identity of the person

urlstring (uri)

Profile url of the person

namestring

the name of the person

imageobject

Describes an image

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

ageall of

Age of the person

string

Describes duration as per ISO8601 format

dobstring (date)

Date of birth of the person

genderstring

Gender of something, typically a Person, but possibly also fictional characters, animals, etc. While Male and Female may be used, text strings are also acceptable for people who do not identify as a binary gender.Allowed values for this field can be published in the network policy

credsarray of object

idstring

typestring

urlstring (uri)

URL of the credential

languagesarray of object

codestring

namestring

skillsarray of object

codestring

namestring

tagsarray of object

displayboolean

Indicates the display properties of the tag group. If display is set to false, then the group will not be displayed. If it is set to true, it should be displayed. However, group-level display properties can be overriden by individual tag-level display property. As this schema is purely for catalog display purposes, it is not recommended to send this value during search.

descriptorall of

Description of the TagGroup, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

listarray of object

An array of Tag objects listed under this group. This property can be set by Consumer Interfaces during search to narrow the search and achieve more relevant results. When received during on_search, Consumer Interfaces must render this list under the heading described by the name property of this schema.

descriptorall of

Description of the Tag, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

valuestring

The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.

displayboolean

This value indicates if the tag is intended for display purposes. If set to true, then this tag must be displayed. If it is set to false, it should not be displayed. This value can override the group display value.

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

organizationobject

An organization. Usually a recognized business entity.

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

addressall of

The postal address of the organization

string

Describes a postal address.

stateall of

The state where the organization's address is registered

namestring

Name of the state

codestring

State code as per country or international standards

cityall of

The city where the the organization's address is registered

namestring

Name of the city

codestring

City code

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

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

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

{
  "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-31",
      "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

Response

Successful closure of a chat session

Body

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

order_idstring

callback_phonestring (phone)

chatobject

urlstring

Chat URL

session_idstring

Chat session ID

faqobject

Link to the FAQ document

urlstring

mime_typestring

agentobject

idstring

personobject

Describes a person as any individual

idstring

Describes the identity of the person

urlstring (uri)

Profile url of the person

namestring

the name of the person

imageobject

Describes an image

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

ageall of

Age of the person

string

Describes duration as per ISO8601 format

dobstring (date)

Date of birth of the person

genderstring

credsarray of object

idstring

typestring

urlstring (uri)

URL of the credential

languagesarray of object

codestring

namestring

skillsarray of object

codestring

namestring

tagsarray of object

displayboolean

descriptorall of

Description of the TagGroup, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

listarray of object

descriptorall of

Description of the Tag, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

valuestring

The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.

displayboolean

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

organizationobject

An organization. Usually a recognized business entity.

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

addressall of

The postal address of the organization

string

Describes a postal address.

stateall of

The state where the organization's address is registered

namestring

Name of the state

codestring

State code as per country or international standards

cityall of

The city where the the organization's address is registered

namestring

Name of the city

codestring

City code

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

ratingstring

Request

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

{
  "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-31",
      "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

Response

Successful closure of a chat session

Body

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

order_idstring

callback_phonestring (phone)

chatobject

urlstring

Chat URL

session_idstring

Chat session ID

faqobject

Link to the FAQ document

urlstring

mime_typestring

agentobject

idstring

personobject

Describes a person as any individual

idstring

Describes the identity of the person

urlstring (uri)

Profile url of the person

namestring

the name of the person

imageobject

Describes an image

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

ageall of

Age of the person

string

Describes duration as per ISO8601 format

dobstring (date)

Date of birth of the person

genderstring

credsarray of object

idstring

typestring

urlstring (uri)

URL of the credential

languagesarray of object

codestring

namestring

skillsarray of object

codestring

namestring

tagsarray of object

displayboolean

descriptorall of

Description of the TagGroup, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

listarray of object

descriptorall of

Description of the Tag, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

valuestring

The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.

displayboolean

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

organizationobject

An organization. Usually a recognized business entity.

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

addressall of

The postal address of the organization

string

Describes a postal address.

stateall of

The state where the organization's address is registered

namestring

Name of the state

codestring

State code as per country or international standards

cityall of

The city where the the organization's address is registered

namestring

Name of the city

codestring

City code

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

ratingstring

Request

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

{
  "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-31",
      "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

Response

Successful closure of a chat session

Body

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

order_idstring

callback_phonestring (phone)

chatobject

urlstring

Chat URL

session_idstring

Chat session ID

faqobject

Link to the FAQ document

urlstring

mime_typestring

agentobject

idstring

personobject

Describes a person as any individual

idstring

Describes the identity of the person

urlstring (uri)

Profile url of the person

namestring

the name of the person

imageobject

Describes an image

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

ageall of

Age of the person

string

Describes duration as per ISO8601 format

dobstring (date)

Date of birth of the person

genderstring

credsarray of object

idstring

typestring

urlstring (uri)

URL of the credential

languagesarray of object

codestring

namestring

skillsarray of object

codestring

namestring

tagsarray of object

displayboolean

descriptorall of

Description of the TagGroup, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

listarray of object

descriptorall of

Description of the Tag, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

valuestring

The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.

displayboolean

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

organizationobject

An organization. Usually a recognized business entity.

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

addressall of

The postal address of the organization

string

Describes a postal address.

stateall of

The state where the organization's address is registered

namestring

Name of the state

codestring

State code as per country or international standards

cityall of

The city where the the organization's address is registered

namestring

Name of the city

codestring

City code

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

ratingstring

Request

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

{
  "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-31",
      "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

Response

Successful closure of a chat session

Body

idstring

personobject

Describes a person as any individual

idstring

Describes the identity of the person

urlstring (uri)

Profile url of the person

namestring

the name of the person

imageobject

Describes an image

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

ageall of

Age of the person

string

Describes duration as per ISO8601 format

dobstring (date)

Date of birth of the person

genderstring

credsarray of object

idstring

typestring

urlstring (uri)

URL of the credential

languagesarray of object

codestring

namestring

skillsarray of object

codestring

namestring

tagsarray of object

displayboolean

descriptorall of

Description of the TagGroup, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

listarray of object

descriptorall of

Description of the Tag, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

valuestring

The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.

displayboolean

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

organizationobject

An organization. Usually a recognized business entity.

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

addressall of

The postal address of the organization

string

Describes a postal address.

stateall of

The state where the organization's address is registered

namestring

Name of the state

codestring

State code as per country or international standards

cityall of

The city where the the organization's address is registered

namestring

Name of the city

codestring

City code

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

ratingstring

Request

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

{
  "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-31",
    "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

Body

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

order_idstring

callback_phonestring (phone)

chatobject

urlstring

Chat URL

session_idstring

Chat session ID

faqobject

Link to the FAQ document

urlstring

mime_typestring

agentobject

idstring

personobject

Describes a person as any individual

idstring

Describes the identity of the person

urlstring (uri)

Profile url of the person

namestring

the name of the person

imageobject

Describes an image

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

ageall of

Age of the person

string

Describes duration as per ISO8601 format

dobstring (date)

Date of birth of the person

genderstring

credsarray of object

idstring

typestring

urlstring (uri)

URL of the credential

languagesarray of object

codestring

namestring

skillsarray of object

codestring

namestring

tagsarray of object

displayboolean

descriptorall of

Description of the TagGroup, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

listarray of object

descriptorall of

Description of the Tag, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

valuestring

The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.

displayboolean

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

organizationobject

An organization. Usually a recognized business entity.

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

addressall of

The postal address of the organization

string

Describes a postal address.

stateall of

The state where the organization's address is registered

namestring

Name of the state

codestring

State code as per country or international standards

cityall of

The city where the the organization's address is registered

namestring

Name of the city

codestring

City code

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

ratingstring

Response

Successful closure of a chat session

Body

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

order_idstring

callback_phonestring (phone)

chatobject

urlstring

Chat URL

session_idstring

Chat session ID

faqobject

Link to the FAQ document

urlstring

mime_typestring

agentobject

idstring

personobject

Describes a person as any individual

idstring

Describes the identity of the person

urlstring (uri)

Profile url of the person

namestring

the name of the person

imageobject

Describes an image

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

ageall of

Age of the person

string

Describes duration as per ISO8601 format

dobstring (date)

Date of birth of the person

genderstring

credsarray of object

idstring

typestring

urlstring (uri)

URL of the credential

languagesarray of object

codestring

namestring

skillsarray of object

codestring

namestring

tagsarray of object

displayboolean

descriptorall of

Description of the TagGroup, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

listarray of object

descriptorall of

Description of the Tag, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

valuestring

The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.

displayboolean

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

organizationobject

An organization. Usually a recognized business entity.

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

addressall of

The postal address of the organization

string

Describes a postal address.

stateall of

The state where the organization's address is registered

namestring

Name of the state

codestring

State code as per country or international standards

cityall of

The city where the the organization's address is registered

namestring

Name of the city

codestring

City code

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

ratingstring

Request

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

{
  "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-31",
      "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

Response

Successful closure of a chat session

Body

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

order_idstring

callback_phonestring (phone)

chatobject

urlstring

Chat URL

session_idstring

Chat session ID

faqobject

Link to the FAQ document

urlstring

mime_typestring

agentobject

idstring

personobject

Describes a person as any individual

idstring

Describes the identity of the person

urlstring (uri)

Profile url of the person

namestring

the name of the person

imageobject

Describes an image

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

ageall of

Age of the person

string

Describes duration as per ISO8601 format

dobstring (date)

Date of birth of the person

genderstring

credsarray of object

idstring

typestring

urlstring (uri)

URL of the credential

languagesarray of object

codestring

namestring

skillsarray of object

codestring

namestring

tagsarray of object

displayboolean

descriptorall of

Description of the TagGroup, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

listarray of object

descriptorall of

Description of the Tag, can be used to store detailed information.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

valuestring

The value of the tag. This set by the Provider Platform and rendered as-is by the Consumer Interface.

displayboolean

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

organizationobject

An organization. Usually a recognized business entity.

descriptorobject

Physical description of something.

namestring

codestring

short_descstring

long_descstring

additional_descobject

urlstring

content_typeenum

text/plaintext/htmlapplication/json

mediaarray of object

mimetypestring

indicates the nature and format of the document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838

urlstring (uri)

The URL of the file

signaturestring

The digital signature of the file signed by the sender

dsastring

The signing algorithm used by the sender

imagesarray of object

urlstring (uri)

URL to the image. This can be a data url or an remote url

size_typeenum

The size of the image. The network policy can define the default dimensions of each type

xssmmdlgxlcustom

widthstring

Width of the image in pixels

heightstring

Height of the image in pixels

addressall of

The postal address of the organization

string

Describes a postal address.

stateall of

The state where the organization's address is registered

namestring

Name of the state

codestring

State code as per country or international standards

cityall of

The city where the the organization's address is registered

namestring

Name of the city

codestring

City code

contactobject

Describes the contact information of an entity

phonestring

emailstring

jcardobject

A Jcard object as per draft-ietf-jcardcal-jcard-03 specification

ratingstring

Request

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

{
  "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-31",
      "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"
  }
}

8.12 Support Management

8.12 Support Management