List and invoke exported OFBiz services
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/apache-ofbiz:apache-ofbiz-services-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Apache OFBiz REST Services API
description: 'REST API for Apache OFBiz, exposing OFBiz services via a RESTful interface. The API allows clients to list and invoke any OFBiz service that has been exported via the REST plugin. Authentication is JWT-based: clients first obtain a token via HTTP Basic Auth, then use Bearer authentication for subsequent calls. An OpenAPI/Swagger UI is available at /docs/swagger-ui.html.'
version: '18.12'
license:
name: Apache 2.0
identifier: Apache-2.0
contact:
name: Apache OFBiz
url: https://ofbiz.apache.org
servers:
- url: https://localhost:8443/rest
description: Apache OFBiz REST API server (default HTTPS port)
security:
- bearerAuth: []
tags:
- name: Services
description: List and invoke exported OFBiz services
paths:
/services:
get:
tags:
- Services
summary: Apache OFBiz List All Exported Services
description: Returns a list of all OFBiz services that have been exported via the REST plugin (export="true" with verb="get" or verb="post").
operationId: getServices
responses:
'200':
description: List of exported services retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceListResponse'
examples:
GetServices200Example:
summary: Default getServices 200 response
x-microcks-default: true
value:
statusCode: 200
statusDescription: OK
successMessage: OK
data:
- name: findProductById
description: Finds productId(s) corresponding to a product reference, productId or a GoodIdentification idValue
link:
href: https://localhost:8443/rest/services/findProductById
rel: self
type: get
- name: searchProductsByGoodIdentificationValue
description: Search Products by Good Identification Value
link:
href: https://localhost:8443/rest/services/searchProductsByGoodIdentificationValue
rel: self
type: post
'401':
$ref: '#/components/responses/Unauthorized'
'500':
$ref: '#/components/responses/InternalServerError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/services/{serviceName}:
get:
tags:
- Services
summary: Apache OFBiz Invoke Service via GET
description: Invoke an exported OFBiz service using HTTP GET. Input parameters must be passed as a URL-encoded JSON string in the inParams query parameter. Only services exported with verb="get" support this method.
operationId: invokeServiceGet
parameters:
- name: serviceName
in: path
required: true
description: The name of the OFBiz service to invoke.
schema:
type: string
example: findProductById
- name: inParams
in: query
required: false
description: URL-encoded JSON string of service input parameters.
schema:
type: string
example: '%7B%22idToFind%22%3A%22GZ-1001%22%7D'
responses:
'200':
description: Service invoked successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
InvokeServiceGet200Example:
summary: Default invokeServiceGet 200 response
x-microcks-default: true
value:
statusCode: 200
statusDescription: OK
data:
product:
productId: GZ-1001
productName: Nan Gizmo
internalName: Nan Gizmo
productTypeId: FINISHED_GOOD
isVirtual: N
isVariant: N
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Services
summary: Apache OFBiz Invoke Service via POST
description: Invoke an exported OFBiz service using HTTP POST. Input parameters are passed as a JSON request body. Only services exported with verb="post" support this method.
operationId: invokeServicePost
parameters:
- name: serviceName
in: path
required: true
description: The name of the OFBiz service to invoke.
schema:
type: string
example: searchProductsByGoodIdentificationValue
requestBody:
required: true
description: Service input parameters as a JSON object.
content:
application/json:
schema:
type: object
additionalProperties: true
examples:
InvokeServicePostRequestExample:
summary: Default invokeServicePost request
x-microcks-default: true
value:
idFragment: '2644'
responses:
'200':
description: Service invoked successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
examples:
InvokeServicePost200Example:
summary: Default invokeServicePost 200 response
x-microcks-default: true
value:
statusCode: 200
statusDescription: OK
data:
products:
- productId: GZ-2644
internalName: Round Gizmo
isVariant: N
isVirtual: N
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
responses:
InternalServerError:
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
Unauthorized:
description: Unauthorized - missing or invalid authentication token.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
BadRequest:
description: Bad request - invalid input parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
NotFound:
description: Service not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
schemas:
ServiceListResponse:
type: object
description: API response containing a list of exported services.
properties:
statusCode:
type: integer
description: HTTP status code.
example: 200
statusDescription:
type: string
description: Human-readable status description.
example: OK
successMessage:
type: string
description: Success message.
example: OK
data:
type: array
description: Array of exported service entries.
items:
$ref: '#/components/schemas/ServiceEntry'
ServiceResponse:
type: object
description: Standard API response from an OFBiz service invocation.
properties:
statusCode:
type: integer
description: HTTP status code.
example: 200
statusDescription:
type: string
description: Human-readable status description.
example: OK
successMessage:
type: string
description: Success message if applicable.
example: OK
data:
type: object
additionalProperties: true
description: Service output data. Structure varies by service.
ErrorResponse:
type: object
description: Standard error response.
properties:
statusCode:
type: integer
description: HTTP status code.
example: 400
statusDescription:
type: string
description: Human-readable status description.
example: Bad Request
errorMessage:
type: string
description: Detailed error message.
example: Invalid input parameters.
ServiceLink:
type: object
description: Hypermedia link to a service endpoint.
properties:
href:
type: string
format: uri
description: URL to invoke the service.
example: https://localhost:8443/rest/services/findProductById
rel:
type: string
description: Relationship type.
example: self
type:
type: string
description: HTTP method for accessing the service.
example: get
ServiceEntry:
type: object
description: A single exported OFBiz service with its metadata and invocation link.
properties:
name:
type: string
description: The service name.
example: findProductById
description:
type: string
description: Human-readable description of the service.
example: Finds productId(s) corresponding to a product reference.
link:
$ref: '#/components/schemas/ServiceLink'
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic Auth used only for token acquisition at /auth/token.
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT Bearer token obtained from /auth/token. Required for all service endpoints.