Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xentral External Reference API

External shop references that are linked to a product.

Xentral External Reference API is one of 90 APIs that Xentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External Reference. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 1 path. It is described by OpenAPI 3.0.0, at version v0.1.

Requests are made against 2 base URLs: https://{xentralId}.xentral.biz, https://{domain}.

4 operations 1 paths 0 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v0.1
Base URL
https://xentral.xentral.biz
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Xentral External Reference API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token obtained in POST /tokens endpoint or pregenerated in the system.

Paths & Operations 4

Across 1 path, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

External Reference 4

External shop references that are linked to a product.

GET
/api/v1/products/{id}/externalReferences
List external references
externalReference.list 1 param → 200400401403406429
POST
/api/v1/products/{id}/externalReferences
Create external reference
externalReference.create 1 param body → 201400401403429
PATCH
/api/v1/products/{id}/externalReferences
Update external reference
externalReference.updateMultiple 1 param body → 204400401403429
DELETE
/api/v1/products/{id}/externalReferences
Delete external reference
externalReference.deleteMultiple 1 param body → 204400401403429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xentral-external-reference-api-openapi.yml Raw ↑

Other APIs Xentral publishes across the network.

Xentral Account API
Xentral Accounting Export API
Xentral AuthPlatform API
Xentral Collection API
Xentral Collective Bill API
Xentral Credit API
Xentral Credit Note API
Xentral Credit Note Tag API
Xentral CreditNote API
Xentral Customer Address API
Xentral Customer API
Xentral Customer - Contact Person API