Introduction

About

The autoX API enables you to interact with your data programmatically. Use this API to build integrations, automate operations, or develop custom applications on top of your autoX instance on SAP Cloud ERP. This page documents the REST resources available in autoX, including HTTP response codes and example requests and responses.

The autoX API is built on open standards and exposed via SAP's services layer, enabling programmatic access to your automotive dealer data across sales, service, parts, and fleet operations. It supports both real-time REST API integration for on-demand data access and scheduled SFTP flat file delivery for batch integration use cases.

Standard SAP APIs

All standard SAP APIs for your S/4HANA landscape – including business partners, materials, sales orders, and more – are documented on the SAP Business Accelerator Hub.

The APIs documented in this reference are specific to autoX and extend or complement the standard SAP APIs available on the hub.

Integration Patterns

The autoX API supports the following integration patterns. Each endpoint is delivered through one of the following – refer to the endpoint's documentation to identify which applies.

1. SAP Cloud ERP

Endpoints under this pattern follow the Open Data Protocol (OData) conventions, exposed via SAP S/4HANA's OData services layer. All resources are addressed as HTTP endpoints following OData conventions for querying, inserting, updating, and deleting data.

Requests are made directly to your SAP S/4HANA instance. The service root follows this structure:

https://<your-sap-instance>/sap/opu/odata/sap/<SERVICE_NAME>/

If you are accessing autoX within your corporate network or through VNet peering on SAP RISE, refer to this SAP Community guide to locate your SAP instance URL.

If your SAP instance is exposed publicly through API Management in SAP Integration Suite, the base URL follows this structure instead:

https://<your-integration-suite-tenant>/sap/opu/odata/sap/<SERVICE_NAME>/

To discover all available entity sets for a given service, append $metadata to the service root:

GET https://<your-sap-instance>/sap/opu/odata/sap/API_BUSINESS_PARTNER/$metadata

2. SAP Integration Suite

Some endpoints are exposed through SAP Integration Suite (Cloud Platform Integration). In this scenario, the base URL is your CPI tenant URL and the path is specific to the integration flow:

https://<your-integration-suite-tenant>/http/api/<endpoint>

3. Scheduled Batch (SFTP)

Some data sets support scheduled batch extraction via SFTP. In this pattern, autoX generates a flat file (CSV) on a defined schedule and delivers it to a pre-configured SFTP server. This is suitable for downstream systems that consume bulk data rather than making real-time API requests.

Batch delivery schedules, file formats, and SFTP connection details are configured during onboarding. Contact your IntelliSoft account team for setup and configuration.

Authentication

The autoX API uses HTTP Basic Authentication. Include an Authorization header with your SAP credentials encoded in Base64 on every request.

Authorization: Basic <base64(username:password)>

Example using cURL:

curl -X GET \
"https://<your-sap-instance>/sap/opu/odata/sap/API_BUSINESS_PARTNER/A_BusinessPartner" \
-H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
-H "Accept: application/json"

Keep credentials secure. Never expose your SAP username or password in client-side code or public repositories. Use environment variables or a secrets manager instead.

Authorization

Authorization is role-based and managed within SAP. Users must be assigned the appropriate SAP roles for the modules they need to access. Contact your SAP system administrator to manage role assignments.

Outbound Webhooks

autoX supports outbound webhook callbacks for event-driven integrations. Based on a configurable trigger or manual push, autoX will POST a structured payload to a partner-provided API. The partner is responsible for implementing and hosting the endpoint that receives these events. autoX expects the endpoint to return an appropriate HTTP status code to acknowledge receipt.

Endpoints that function as outbound webhooks are marked with a ⬩ symbol in the API Reference.

Refer to the relevant module's webhook documentation for the payload structure and event triggers applicable to your integration.

OData Endpoints

The following conventions apply to OData endpoints exposed directly from SAP S/4HANA.

1. Query options

OData provides a set of reserved $-prefixed System Query Options that control which data is returned and how it is shaped. These are appended to the resource URI as query string parameters.

Parameter	Description	Example
`$select`	Return only the specified Properties.	`$select=BusinessPartner,FirstName,LastName`
`$filter`	Filter Entries by a condition.	`$filter=BusinessPartnerCategory eq '1'`
`$orderby`	Order Entries by one or more Properties.	`$orderby=CreationDate desc`
`$top`	Return only the first N Entries.	`$top=20`
`$skip`	Skip the first N Entries.	`$skip=40`
`$expand`	Expand a Navigation Property inline in the response.	`$expand=to_BusinessPartnerAddress`
`$inlinecount`	Include a count of Entries in the Collection alongside results.	`$inlinecount=allpages`
`$format`	Request the response format. Prefer the `Accept` header instead.	`$format=json`

System Query Options can be combined freely. For example, to retrieve the first 10 Entries from the A_BusinessPartner Collection filtered by category, returning only key Properties:

GET https://<your-sap-instance>/sap/opu/odata/sap/API_BUSINESS_PARTNER/A_BusinessPartner?$filter=BusinessPartnerCategory eq '1'&$top=10&$select=BusinessPartner,FirstName,LastName

2. Pagination

Use $top and $skip together to page through a Collection. $top sets the page size; $skip offsets the starting Entry.

Page 1: GET .../A_BusinessPartner?$top=25&$skip=0
Page 2: GET .../A_BusinessPartner?$top=25&$skip=25
Page 3: GET .../A_BusinessPartner?$top=25&$skip=50

To retrieve the total count of Entries in a Collection, include $inlinecount=allpages in your request. The response will contain a __count field alongside the results.

3. Ordering and filtering

The $orderby System Query Option accepts one or more comma-separated Property names, each optionally followed by asc (default) or desc.

$orderby=CreationDate desc, LastName asc

The $filter System Query Option supports standard OData comparison and logical operators:

Operator	Description	Example
`eq`	Equal	`$filter=BusinessPartnerCategory eq '1'`
`ne`	Not equal	`$filter=BusinessPartnerCategory ne '2'`
`gt` / `ge`	Greater than / or equal	`$filter=CreationDate ge datetime'2024-01-01T00:00:00'`
`lt` / `le`	Less than / or equal	`$filter=CreationDate le datetime'2024-12-31T00:00:00'`
`and` / `or`	Logical operators	`$filter=BusinessPartnerCategory eq '1' and IsMarkedForArchiving eq false`
`substringof`	String contains	`$filter=substringof('John', FirstName)`
`startswith`	String starts with	`$filter=startswith(LastName, 'Smi')`

String values must be wrapped in single quotes. Numeric and boolean values are passed unquoted. Date values use the OData datetime literal format as shown above.

Status Codes

The autoX API uses standard HTTP status codes. Successful responses return 2xx; client errors return 4xx; server errors return 5xx.

Code	Description
`200 OK`	The request succeeded and the response body contains the requested data.
`201 Created`	A new resource was successfully created.
`204 No Content`	The request succeeded but there is no response body (e.g. after a delete or update).
`400 Bad Request`	The request was malformed, contained invalid query options, or was missing required fields.
`401 Unauthorized`	Authentication credentials are missing or invalid. Check your `Authorization` header.
`403 Forbidden`	The authenticated user does not have the required SAP role to perform this operation.
`404 Not Found`	The requested resource or Entry does not exist.
`405 Method Not Allowed`	The HTTP method is not supported on this endpoint.
`406 Not Acceptable`	The requested response format is not supported. Check your `Accept` header.
`500 Internal Server Error`	An unexpected error occurred. Contact your SAP system administrator if the issue persists.

OData error responses include a structured error body with a code and message field:

{
  "error": {
    "code": "ABC/123",
    "message": {
      "lang": "en",
      "value": "Entity not found."
    }
  }
}

SAP Integration Suite endpoints: CPI integration flows return standard HTTP status codes where explicitly configured. If no custom error handling is defined in the integration flow, CPI defaults to returning 500 for any processing failure regardless of the underlying cause. Refer to each endpoint's documentation for its specific error behaviour.

About#

Standard SAP APIs#

Integration Patterns#

1. SAP Cloud ERP#

2. SAP Integration Suite#

3. Scheduled Batch (SFTP)#

Authentication#

Authorization#

Outbound Webhooks#

OData Endpoints#

1. Query options#

2. Pagination#

3. Ordering and filtering#

Status Codes#