Vendor Managemment

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/vendor/vendor/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "name": "text",
    "vendor_id": "text",
    "organization": "text",
    "vendor_name": "text",
    "status": 1,
    "type": 1,
    "web_url": "text",
    "location": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "contact_person": "text",
    "email": "text",
    "phone_number": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "description": "text",
    "created_by": 1,
    "modified_by": 1,
    "creation_time": "2025-06-07T11:51:30.905Z",
    "last_update_time": "2025-06-07T11:51:30.905Z",
    "is_deleted": true
  }
]

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRequired

namestringRequired

vendor_idstring · max: 25Required

organizationstring · max: 25Required

vendor_namestringOptional

statusintegerOptional

typeintegerOptional

web_urlstringOptional

contact_personstringOptional

emailstringOptional

descriptionstringOptional

created_byintegerOptional

modified_byintegerOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/common/vendor/vendor/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 428

{
  "id": "text",
  "name": "text",
  "vendor_id": "text",
  "organization": "text",
  "vendor_name": "text",
  "status": 1,
  "type": 1,
  "web_url": "text",
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "contact_person": "text",
  "email": "text",
  "phone_number": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T11:51:30.905Z",
  "last_update_time": "2025-06-07T11:51:30.905Z",
  "is_deleted": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": "text",
  "name": "text",
  "vendor_id": "text",
  "organization": "text",
  "vendor_name": "text",
  "status": 1,
  "type": 1,
  "web_url": "text",
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "contact_person": "text",
  "email": "text",
  "phone_number": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T11:51:30.905Z",
  "last_update_time": "2025-06-07T11:51:30.905Z",
  "is_deleted": true
}

Gets a vendor with the given id

get

This endpoint is used to fetch a vendor details in the current organization

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/vendor/vendor/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "name": "text",
  "vendor_id": "text",
  "organization": "text",
  "vendor_name": "text",
  "status": 1,
  "type": 1,
  "web_url": "text",
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "contact_person": "text",
  "email": "text",
  "phone_number": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T11:51:30.905Z",
  "last_update_time": "2025-06-07T11:51:30.905Z",
  "is_deleted": true
}

put

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRequired

namestringRequired

vendor_idstring · max: 25Required

organizationstring · max: 25Required

vendor_namestringOptional

statusintegerOptional

typeintegerOptional

web_urlstringOptional

contact_personstringOptional

emailstringOptional

descriptionstringOptional

created_byintegerOptional

modified_byintegerOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

PUT /ux/common/vendor/vendor/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 428

{
  "id": "text",
  "name": "text",
  "vendor_id": "text",
  "organization": "text",
  "vendor_name": "text",
  "status": 1,
  "type": 1,
  "web_url": "text",
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "contact_person": "text",
  "email": "text",
  "phone_number": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T11:51:30.905Z",
  "last_update_time": "2025-06-07T11:51:30.905Z",
  "is_deleted": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "name": "text",
  "vendor_id": "text",
  "organization": "text",
  "vendor_name": "text",
  "status": 1,
  "type": 1,
  "web_url": "text",
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "contact_person": "text",
  "email": "text",
  "phone_number": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T11:51:30.905Z",
  "last_update_time": "2025-06-07T11:51:30.905Z",
  "is_deleted": true
}

Deletes the vendor with given id

delete

This endpoint is used to delete an existing vendor for the current organization

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

DELETE /ux/common/vendor/vendor/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/vendor/vendor/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "name": "text",
  "vendor_id": "text",
  "organization": "text",
  "vendor_name": "text",
  "status": 1,
  "type": 1,
  "web_url": "text",
  "location": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "contact_person": "text",
  "email": "text",
  "phone_number": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "created_by": 1,
  "modified_by": 1,
  "creation_time": "2025-06-07T11:51:30.905Z",
  "last_update_time": "2025-06-07T11:51:30.905Z",
  "is_deleted": true
}