X-ERP Help

APIs

Developer documentation for X-ERP: quick start, cookie login, permissions, endpoints, examples and downloads - clearly structured for practical integration.

Your introduction to the X-ERP APIs

This documentation leads from the first reading call to the technically tested integration. The standard scope includes 28 operations for business partner sessions, item catalog, shopping cart, order and helpdesk. The technical API login is explained separately.

Start in this order

  1. Quick start: Prepare test access, register and read the item.
  2. authentication and permissions: Understand cookie session, company context and required rights.
  3. Endpoint reference: Look up routes, parameters and technical answers.
  4. Examples and downloads: Use OpenAPI, PowerShell Quickstart, and HTTP templates.
  5. Error handling and operation: Plan errors, repetitions and acceptance.
  6. Releases and release notes: Check standard scope, extensions and known deviations.

Technical documents

The OpenAPI file and sample templates are part of the developer package to be provided separately.

The OpenAPI file and sample templates are part of the developer package to be provided separately.

Terms briefly explained

  • API users: The X-ERP account released for technical login.
  • Company: The company database selected via databaseName during login.
  • PartnerId: The ID of an X-ERP business partner, for example a customer. It does not automatically identify the specialist dealer or developer.
  • fh: Technical name of the curated Swagger document for the standard operations.

Status and boundaries

Documentation and selected server locations were aligned on September 18, 2026. This does not replace a live test against your target installation. Before production operation, the document assignment and address transfer at checkout as well as the complete data model for helpdesk write access must be confirmed. The specific deviations can be found in the Releases and Release Notes chapter.

In this chapter