Fairmarkit Requests API
The Requests API from Fairmarkit — 23 operation(s) for requests.
The Requests API from Fairmarkit — 23 operation(s) for requests.
openapi: 3.1.1
info:
title: BUYER PUBLIC Business Units Requests API
version: '3'
description: The Fairmarkit Buyer API is a RESTful API that uses HTTP requests to allow you to access and use your Fairmarkit data. It has predictable resource-oriented URLs that use standard HTTP response codes, authentication, and verbs. See the Fairmarkit API developer portal for more information.
termsOfService: https://www.fairmarkit.com/terms-of-service
contact:
name: Fairmarkit Support
url: https://fmkt.zendesk.com/hc/en-us
email: support@fairmarkit.com
servers:
- url: https://staging.fairmarkit.com/
tags:
- name: Requests
paths:
/services/self-service/api/v4/requests/{request_id}/items/:
post:
tags:
- Requests
summary: "\uD83E\uDDEA Create Request Item"
operationId: RequestApi_create_item_services_self_service_api_v4_requests__request_id__items__post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestItemV4Create'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/RequestItemV4Retrieve'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Creates a new Request Item based on the selected schema. The Request must exist first. This endpoint is in **BETA** and may change without notice.
get:
tags:
- Requests
summary: "\uD83E\uDDEA List Request Items"
operationId: RequestApi_get_request_items_list_services_self_service_api_v4_requests__request_id__items__get
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: integer
maximum: 100
minimum: 1
title: Limit
default: 20
description: Maximum number of records to return. Defaults to 20.
name: limit
in: query
description: Maximum number of records to return. Defaults to 20.
- required: false
schema:
type: integer
minimum: 0
title: Offset
default: 0
description: Zero-based offset of the first record to return. Defaults to 0.
name: offset
in: query
description: Zero-based offset of the first record to return. Defaults to 0.
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/RequestItemV4ListRetrieve'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Returns a paginated list of Request items. This endpoint is in **BETA** and may change without notice.
/services/self-service/api/v4/requests/:
post:
tags:
- Requests
summary: "\uD83E\uDDEA Create Request"
operationId: RequestApi_create_request_services_self_service_api_v4_requests__post
parameters:
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestV4Create'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/RequestV4Retrieve'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Creates a new Request based on the selected schema. To create Request Items, use the Request Item v4 endpoint. This endpoint is in **BETA** and may change without notice.
get:
tags:
- Requests
summary: List Requests
operationId: RequestApi_list_requests_services_self_service_api_v4_requests__get
parameters:
- required: false
schema:
type: integer
maximum: 100
minimum: 1
title: Limit
default: 20
description: Maximum number of records to return. Defaults to 20.
name: limit
in: query
description: Maximum number of records to return. Defaults to 20.
- required: false
schema:
type: integer
minimum: 0
title: Offset
default: 0
description: Zero-based offset of the first record to return. Defaults to 0.
name: offset
in: query
description: Zero-based offset of the first record to return. Defaults to 0.
- description: Start of the created-at time range. Use ISO 8601 format.
required: false
schema:
type: string
format: date-time
title: Created At Min
description: Start of the created-at time range. Use ISO 8601 format.
name: created_at_min
in: query
- description: End of the created-at time range. Use ISO 8601 format.
required: false
schema:
type: string
format: date-time
title: Created At Max
description: End of the created-at time range. Use ISO 8601 format.
name: created_at_max
in: query
- required: false
schema:
items:
$ref: '#/components/schemas/GetListV5OrderingType0Item'
type: array
description: Ordering field. Prefix with '-' for descending order.
name: ordering
in: query
description: Ordering field. Prefix with '-' for descending order.
- required: false
schema:
items:
$ref: '#/components/schemas/RequestStatus'
type: array
description: Filter by status.
name: status
in: query
description: Filter by status.
- required: false
schema:
type: string
title: External Id
name: external_id
in: query
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/RequestV4ListRetrieve'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Returns a paginated list of Requests.
/services/self-service/api/v3/requests/{request_id}/pr/link/:
post:
tags:
- Requests
summary: "\uD83E\uDDEA Link External PR to Request"
description: Marks external PR creation as successful and returns the external PR details. This endpoint is in **BETA** and may change without notice.
operationId: RequestApi_link_pr_services_self_service_api_v3_requests__request_id__pr_link__post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
description: Fairmarkit API Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LinkPRRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/RequestRetrieve'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services/self-service/api/v4/requests/{request_id}/items/batch:
post:
tags:
- Requests
summary: Create Request Item Batch
operationId: RequestApi_create_request_item_batch_services_self_service_api_v4_requests__request_id__items_batch_post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
items:
$ref: '#/components/schemas/RequestItemV4Create'
type: array
title: Request
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
items:
$ref: '#/components/schemas/RequestItemV4Retrieve'
type: array
title: Response Requestapi Create Request Item Batch Services Self Service Api V4 Requests Request Id Items Batch Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Creates Request Items in batch.
/services/self-service/api/v4/requests/{request_id}/cancel:
post:
tags:
- Requests
summary: Cancel Request
operationId: RequestApi_cancel_request_services_self_service_api_v4_requests__request_id__cancel_post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/CancelRequest'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Cancels an existing Request.
/services/self-service/api/v3/requests/:
post:
tags:
- Requests
summary: ⚠ Create Request
operationId: RequestApi_create_request_services_self_service_api_v3_requests__post
parameters:
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Request'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/RequestCreate'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
deprecated: true
description: Creates a new Request. This endpoint is **DEPRECATED**. Use the v4 Requests API and Request Item endpoints instead.
/services/self-service/api/v3/requests/{request_id}/:
get:
tags:
- Requests
summary: ⚠ Get Request Details
operationId: RequestApi_get_request_services_self_service_api_v3_requests__request_id___get
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/RequestRetrieve'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
deprecated: true
description: Returns details for a specific Request. This endpoint is **DEPRECATED**. Use the v4 Requests API and Request Item endpoints instead.
/services/self-service/api/v3/requests/{request_id}/pr/mark-as-failed/:
post:
tags:
- Requests
summary: "\uD83E\uDDEA Mark External PR Creation Failed"
description: Marks external PR creation as failed. This endpoint is in **BETA** and may change without notice.
operationId: RequestApi_mark_pr_as_failed_services_self_service_api_v3_requests__request_id__pr_mark_as_failed__post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
description: Fairmarkit API Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RejectPRRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/RequestRetrieve'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services/self-service/api/v4/requests/{request_id}/items/{request_item_id}:
put:
tags:
- Requests
summary: "\uD83E\uDDEA Update Request Item"
description: Updates a Request Item while preserving attachment field values and ignoring new values. This endpoint is in **BETA** and may change without notice.
operationId: RequestApi_update_request_item_services_self_service_api_v4_requests__request_id__items__request_item_id__put
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: true
schema:
type: string
format: uuid
title: Request Item Id
name: request_item_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestItemV4Update'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/UpdateRequestItem'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services/self-service/api/v4/requests/{request_id}/:
get:
tags:
- Requests
summary: "\uD83E\uDDEA Get Request Details"
operationId: RequestApi_get_request_services_self_service_api_v4_requests__request_id___get
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/RequestV4Retrieve'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Returns a Request without its items. This endpoint is in **BETA** and may change without notice.
put:
tags:
- Requests
summary: "\uD83E\uDDEA Update Request"
description: Updates a Request while preserving attachment field values and ignoring new values. This endpoint is in **BETA** and may change without notice.
operationId: RequestApi_update_request_services_self_service_api_v4_requests__request_id___put
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestV4Update'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/UpdateRequest'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services/self-service/api/v3/requests/{request_id}/pr/status/:
post:
tags:
- Requests
summary: "\uD83E\uDDEA Update External PR Status"
description: Updates the status of an external PR linked to a Request. This endpoint is in **BETA** and may change without notice.
operationId: RequestApi_update_pr_status_services_self_service_api_v3_requests__request_id__pr_status__post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
description: Fairmarkit API Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePRStatusRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/RequestRetrieve'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services/self-service/api/v4/requests/{request_id}/event-approvals/{approval_id}/approve-step:
post:
tags:
- Requests
summary: Approve Request Event Step
description: Approves a Request event approval step.
operationId: RequestApi_approve_request_event_step_services_self_service_api_v4_requests__request_id__event_approvals__approval_id__approve_step_post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: true
schema:
type: string
format: uuid
title: Approval Id
name: approval_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApprovalStepRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ApprovalIdResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services/self-service/api/v4/requests/{request_id}/event-approvals/{approval_id}/reject-step:
post:
tags:
- Requests
summary: Reject Request Event Step
description: Rejects a Request event approval step.
operationId: RequestApi_reject_request_event_step_services_self_service_api_v4_requests__request_id__event_approvals__approval_id__reject_step_post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: true
schema:
type: string
format: uuid
title: Approval Id
name: approval_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApprovalStepRejectRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ApprovalIdResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services/self-service/api/v4/requests/{request_id}/submit:
post:
tags:
- Requests
summary: Submit Request
operationId: RequestApi_submit_request_services_self_service_api_v4_requests__request_id__submit_post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/SubmitRequest'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Submits a Request.
/services/self-service/api/v4/requests/{request_id}/approvals/{approval_id}/reject-step:
post:
tags:
- Requests
summary: "\uD83E\uDDEA Reject Request Step"
description: Rejects a Request approval step. This endpoint is in **BETA** and may change without notice.
operationId: RequestApi_reject_request_step_services_self_service_api_v3_requests__request_id__approvals__approval_id__reject_step_post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: true
schema:
type: string
format: uuid
title: Approval Id
name: approval_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApprovalStepRejectRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ApprovalIdResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services/self-service/api/v4/requests/{request_id}/approvals/{approval_id}/approve-step:
post:
tags:
- Requests
summary: "\uD83E\uDDEA Approve Request Step"
description: Approves a Request approval step. This endpoint is in **BETA** and may change without notice.
operationId: RequestApi_approve_request_step_services_self_service_api_v3_requests__request_id__approvals__approval_id__approve_step_post
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: true
schema:
type: string
format: uuid
title: Approval Id
name: approval_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApprovalStepRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ApprovalIdResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services/self-service/api/v4/requests/{request_id}/event-approvals:
get:
tags:
- Requests
summary: List Request Event Approvals
operationId: RequestApi_get_request_event_approvals_services_self_service_api_v4_requests__request_id__event_approvals_get
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
items:
$ref: '#/components/schemas/ApprovalDetail'
type: array
title: Response Requestapi Get Request Event Approvals Services Self Service Api V4 Requests Request Id Event Approvals Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Returns approval data for a Request event.
/services/self-service/api/v4/requests/{request_id}/approvals:
get:
tags:
- Requests
description: Returns approval data for a Request. This endpoint is in **BETA** and may change without notice.
summary: "\uD83E\uDDEA List Request Approvals"
operationId: RequestApi_get_request_approvals_services_self_service_api_v3_requests__request_id__approvals_get
parameters:
- required: true
schema:
type: string
format: uuid
title: Request Id
name: request_id
in: path
- required: false
schema:
type: string
title: X-Fm-Api-Key
name: X-FM-API-KEY
in: header
responses:
'200':
description: Successful Response
content:
application/json; charset=utf-8:
schema:
items:
$ref: '#/components/schemas/ApprovalDetail'
type: array
title: Response Requestapi Get Request Approvals Services Self Service Api V3 Requests Request Id Approvals Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/services/supplier-public-api/api/v1/requests/{request_id}/reject/:
post:
tags:
- Requests
summary: Reject Request
description: Creates a Response with rejection information for the Request with provided request_id
operationId: reject_request-Requests_Requests_Requests
security:
- SupplierPublicAPIHeader: []
parameters:
- name: request_id
in: path
required: true
schema:
type: string
format: uuid
description: Unique request ID.
examples:
- b61da388-b09b-4334-ae8c-d7d89722a6d8
title: Request Id
description: Unique request ID.
- name: x-fm-api-key
in: header
required: true
schema:
type: string
description: Your unique personal api key generated on https://app.fairmarkit.com/vendor/administration/api-settings
title: X-Fm-Api-Key
description: Your unique personal api key generated on https://app.fairmarkit.com/vendor/administration/api-settings
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestRejectRequest'
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError_2'
/services/supplier-public-api/api/v1/requests/{request_id}/response/:
get:
tags:
- Requests
summary: Get Request Response
description: Returns information about Response that you submit for Request by provided request id.
operationId: get_request_response-Requests_Requests_Requests
security:
- SupplierPublicAPIHeader: []
parameters:
- name: request_id
in: path
required: true
schema:
type: string
format: uuid
description: Unique request ID.
examples:
- b61da388-b09b-4334-ae8c-d7d89722a6d8
title: Request Id
description: Unique request ID.
- name: x-fm-api-key
in: header
required: true
schema:
type: string
description: Your unique personal api key generated on https://app.fairmarkit.com/vendor/administration/api-settings
title: X-Fm-Api-Key
description: Your unique personal api key generated on https://app.fairmarkit.com/vendor/administration/api-settings
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DetailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError_2'
/serv
# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fairmarkit/refs/heads/main/openapi/fairmarkit-requests-api-openapi.yml