The Fairmarkit API is a RESTful API that uses HTTP requests to allow you to programmatically add, update, access, and use your Fairmarkit data. The public API has predictable resource-oriented URLs that use standard HTTP response codes, authentication, and verbs to allow you to create, retrieve, and update data. With the API, you can define a communications link between Fairmarkit and your applications and provided a more seamless and effective purchasing process.
Important: For information on configuration settings in Fairmarkit needed to use the Fairmarkit API and webhooks, see Fairmarkit API settings.
Available Actions
Using the Fairmarkit API, you can share data between Fairmarkit and your purchasing application.
Business units
- Pull a list of business units
- Create a business unit
- Pull data about a business unit
- Update an existing business unit
- Delete an existing business unit
Categories
- Pull a list of categories
ERP System
- Pull a list of ERP systems
Purchase orders
- Pull a list of all purchase orders
- Create a new purchase order
Requests
- Create a request
- Pull data about a specific request
Requests for quote
- Pull a list of events
- Create an event
- Pull data about a specific event
- Update an existing event
- Delete an existing event
- Update the purchase order information for an awarded event.
- Pull a list of responses (quotes) for an event
- Pull a list if internal notes
- Add an internal note
- Add attachments to the event and line item level
- Pull a list of attachments
Requests for proposal
- Create a new request for proposal event based on a template
- Pull a list of templates
- Pull data about a specific supplier response
Schema
- Pull data about current schema
- Pull data about specific schema
Suppliers
- Pull a list of suppliers
- Create a new supplier
- Bulk create new suppliers
- Pull data about a specific supplier
- Update an existing supplier
- Delete an existing supplier
Fairmarkit Webhooks
Fairmarkit webhooks allow you to get notifications from Fairmarkit about changes to your data as they are happening. Instead of having to pull information using the Fairmarkit API, the webhook will automatically push information to your endpoint as events happen. When the event happens, a one-way data share is automatically sent to your application. For example, when an RFQ is awarded, the RFQ_AWARDED webhook can send updated RFQ data to your application.
Available webhooks:
A notification is sent for the following actions when the webhook URL is configured.
- RFP_AWARDED: Sends a notification when a request for proposal (RFP) event is awarded.
- RFP_CLOSED: Sends a notification when a request for proposal (RFP) event is closed.
- RFP_OPENED: Sends a notification when a request for proposal (RFP) event is opened.
- RFQ_OPEN: Sends a notification when an request for quote (RFQ) event is opened.
- RFQ_CLOSED: Sends a notification when an request for quote (RFQ) event is closed.
- RFQ_AWARDED: Sends a notification when an request for quote (RFQ) event is awarded.
- RFQ_ARCHIVED: Sends a notification when an request for quote (RFQ) event is archived.
- RFQ_CANCELED: Sends a notification when an request for quote (RFQ) event is canceled.
- SUPPLIER_CREATED: Sends a notification when a new supplier is created.
- BID_SUBMITTED: Sends a notification when a supplier responds to a request for quote (RFQ) event.
Developer portal
The Developer portal provides an API reference and guides to help you use the Fairmarkit API.