Apache OFBiz · Schema

ServiceResponse

Standard API response from an OFBiz service invocation.

ERPCRME-CommerceBusiness ApplicationsApacheJavaOpen SourceSupply Chain

Properties

Name	Type	Description
statusCode	integer	HTTP status code.
statusDescription	string	Human-readable status description.
successMessage	string	Success message if applicable.
data	object	Service output data. Structure varies by service.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-ofbiz/refs/heads/main/json-schema/apache-ofbiz-service-response-schema.json",
  "title": "ServiceResponse",
  "description": "Standard API response from an OFBiz service invocation.",
  "type": "object",
  "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."
    }
  }
}