Vendor Status Resource¶
Get Vendor Status¶
HTTP Request
GET /api/vendorStatus/{id}
📋 Description: Retrieves the status of a specific vendor identified by the unique identifier {id}, providing essential insights into vendor performance and compliance.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "vendorStatusType": "string",
10 "isDefaultType": true
11}
Update Vendor Status¶
HTTP Request
PUT /api/vendorStatus/{id}
📋 Description: Updates the status of a specified vendor by ID, allowing businesses to manage vendor relationships and ensure accurate records in the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated vendor status information, including relevant attributes and metadata for the specified vendor ID. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "vendorStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{}
Response Schema
Delete Vendor Status¶
HTTP Request
DELETE /api/vendorStatus/{id}
📋 Description: Deletes the vendor status associated with the specified ID, ensuring the removal of outdated or irrelevant vendor information from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Vendor Status¶
HTTP Request
GET /api/vendorStatus
📋 Description: Retrieves the current status of vendors, providing insights into their operational performance and compliance. This operation supports informed decision-making regarding vendor management and engagement.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
isAvailable |
query |
boolean |
false |
Whether the resource is available |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
isAvailable |
|
query |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "isDefault": true,
9 "objectAvailable": true,
10 "vendorStatusType": "string",
11 "isDefaultType": true
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the status of a vendor within the supply chain, including relevant metadata to facilitate effective vendor management and performance evaluation.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» isDefault |
boolean |
false |
none |
Whether the resource is default |
» objectAvailable |
boolean |
false |
none |
Indicates whether the vendor is currently available for engagement within the system. |
» vendorStatusType |
string |
false |
none |
Type of the vendor status |
» isDefaultType |
boolean |
false |
none |
Whether the resource is default |
Create Vendor Status¶
HTTP Request
POST /api/vendorStatus
📋 Description: Submits a new vendor status update, allowing businesses to track and manage vendor performance effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the vendor status update data, including identification details and current performance metrics. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "isDefault": true,
8 "objectAvailable": true,
9 "vendorStatusType": "string",
10 "isDefaultType": true
11}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{}
Response Schema
Get All Vendor Status Type¶
HTTP Request
GET /api/vendorStatus/vendorStatusType
📋 Description: Retrieves the list of vendor status types, providing essential information to support vendor management and decision-making processes.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "PENDING_APPROVAL"
3]