The Supplier Scorecard Criteria object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

criteria_name string required
max_score number

Default: 100

formula string required
weight number
The Supplier Scorecard Criteria object 
{
  "id": "supplier-scorecard-criteria_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "criteria_name": "criteria_name_example",
  "max_score": 100,
  "formula": "formula_example",
  "weight": 0
}
GET /api/buying/supplier-scorecard-criteria/{id}

Retrieve a supplier scorecard criteria

Retrieves the details of an existing supplier scorecard criteria. Supply the unique supplier scorecard criteria ID that was returned from a previous request.

Path parameters

id string required

The identifier of the supplier scorecard criteria to retrieve.

Returns

Returns the supplier scorecard criteria object if a valid identifier was provided.

GET /api/buying/supplier-scorecard-criteria/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-criteria/supplier-scorecard-criteria_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "supplier-scorecard-criteria_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "criteria_name": "criteria_name_example",
  "max_score": 100,
  "formula": "formula_example",
  "weight": 0
}
GET /api/buying/supplier-scorecard-criteria

List all supplier scorecard criterias

Returns a list of supplier scorecard criterias. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of supplier scorecard criteria objects.

GET /api/buying/supplier-scorecard-criteria 
curl https://api.overplane.dev/api/buying/supplier-scorecard-criteria \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "supplier-scorecard-criteria_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "criteria_name": "criteria_name_example",
      "max_score": 100,
      "formula": "formula_example",
      "weight": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/buying/supplier-scorecard-criteria

Create a supplier scorecard criteria

Creates a new supplier scorecard criteria object.

Body parameters

criteria_name string required
max_score number

Default: 100

formula string required
weight number

Returns

Returns the newly created supplier scorecard criteria object if the call succeeded.

POST /api/buying/supplier-scorecard-criteria 
curl https://api.overplane.dev/api/buying/supplier-scorecard-criteria \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"criteria_name":"criteria_name_example","formula":"formula_example"}'
Response 
{
  "id": "supplier-scorecard-criteria_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "criteria_name": "criteria_name_example",
  "max_score": 100,
  "formula": "formula_example",
  "weight": 0
}
PATCH /api/buying/supplier-scorecard-criteria/{id}

Update a supplier scorecard criteria

Updates the specified supplier scorecard criteria by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the supplier scorecard criteria to update.

Body parameters

criteria_name string
max_score number

Default: 100

formula string
weight number

Returns

Returns the updated supplier scorecard criteria object.

PATCH /api/buying/supplier-scorecard-criteria/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-criteria/supplier-scorecard-criteria_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"criteria_name":"criteria_name_example","max_score":100}'
Response 
{
  "id": "supplier-scorecard-criteria_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "criteria_name": "criteria_name_example",
  "max_score": 100,
  "formula": "formula_example",
  "weight": 0
}
DELETE /api/buying/supplier-scorecard-criteria/{id}

Delete a supplier scorecard criteria

Permanently deletes a supplier scorecard criteria. This cannot be undone.

Path parameters

id string required

The identifier of the supplier scorecard criteria to delete.

Returns

Returns a confirmation that the supplier scorecard criteria has been deleted.

DELETE /api/buying/supplier-scorecard-criteria/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-criteria/supplier-scorecard-criteria_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "supplier-scorecard-criteria_abc123",
  "deleted": true
}