Supplier Label

The Supplier label endpoint allows you to add the review label to the supplier via our API. This is the same as reviewing a supplier in the Ravelin dashboard. This is an optional integration. You may manage reviews entirely within the Ravelin dashboard.

Field Status Definitions
Required Required fields must be sent. If the data is not sent Ravelin will return an error.
Important Important fields are crucial for performance where that data is relevant for your business.
Optional Optional fields are additional data points that can be shared with Ravelin.
These fields are unlikely to impact performance but may be visible in the Ravelin dashboard.

POST api.ravelin.com/v2/supplier/:supplierid:/labels

Show all
category string optional

The category of label being applied to the supplier.

Only: SUPPLIER_FRAUD.

review string optional

The review label to apply to the supplier.

One of: SUPPLIER_FRAUD, NOT_SUPPLIER_FRAUD, or UNREVIEWED.

reviewer object optional

The individual who is reviewing the supplier.

Their details will appear in the supplier profile on the Ravelin dashboard so you are able to see who did this review.

Show definition
POST https://api.ravelin.com/v2/supplier/supplier-123/labels HTTP/1.1
Authorization: token ...
Content-Type: application/json

{
  "category": "SUPPLIER_FRAUD",
  "review": "NOT_SUPPLIER_FRAUD",
  "reviewer": {
    "name": "Bilbo Baggins",
    "email": "bilbo.b@shiremail.com"
  }
}

Example response:

{
    "eventTime": "2020-01-23T16:33:02Z"
}

Feedback