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 Customer Address API

Represents the address associated with a specific customer, including details such as location, contact information, and address type.

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

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

This API exposes 5 operations across 2 paths. 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}.

5 operations 2 paths 0 schemas 1 DELETE2 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 Customer Address 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 5

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

Customer Address 5

Represents the address associated with a specific customer, including details such as location, contact information, and address type.

POST
/api/v2/customers/{customerId}/addresses
Create address
customer.address.create.v2 1 param body → 201400401403404409415429
GET
/api/v2/customers/{customerId}/addresses
List addresses
customer.address.list.v2 3 params → 200400401403404406
GET
/api/v2/customers/{customerId}/addresses/{id}
View address
customer.address.view.v2 2 params → 200400401403404406429
PATCH
/api/v2/customers/{customerId}/addresses/{id}
Update address
customer.address.update.v2 2 params body → 204400401403404406
DELETE
/api/v2/customers/{customerId}/addresses/{id}
Delete address
customer.address.delete.v2 2 params → 204401403404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xentral-customer-address-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 API
Xentral Customer - Contact Person API
Xentral Customer Delivery Address API