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 Sales Order API

SalesOrders are an outbound orders, meaning that someone has bought from you.

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

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

This API exposes 13 operations across 8 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}.

13 operations 8 paths 0 schemas 2 DELETE4 GET3 PATCH4 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 Sales Order 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 13

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

Sales Order 13

SalesOrders are an outbound orders, meaning that someone has bought from you.

GET
/api/v1/salesOrders
List sales orders
salesOrder.list 3 params → 200403406429
POST
/api/v1/salesOrders/actions/import
Import sales order
salesOrder.import body → 201400403406
POST
/api/v1/salesOrders/{id}/actions/dispatch
Dispatch sales order
salesOrder.actions.dispatch 1 param → 204400401403404406429
POST
/api/v1/salesOrders/{id}/actions/cancel
Cancel sales order
salesOrder.actions.cancel 1 param body → 204401403404409429
PATCH
/api/v1/salesOrders/{id}/actions/createPartialSalesOrder
Create partial sales order
salesOrder.actions.createPartialSalesOrder 1 param → 201400401403404409429
GET
/api/v1/salesOrders/{id}
View sales order
salesOrder.view 1 param → 200401403404406429
PATCH
/api/v1/salesOrders/{id}
Update sales order
salesOrder.update 1 param body → 204400403404406
DELETE
/api/v1/salesOrders/{id}
Delete sales order
salesOrder.delete 1 param → 204401403404409429
POST
/api/v1/salesOrders/{id}/documents
Create sales order document
salesOrder.createDocument 1 param body → 201400403404415429
PATCH
/api/v1/salesOrders/{id}/documents
Update multiple sales order documents
salesOrder.updateMultiple 1 param body → 204400403404415429
DELETE
/api/v1/salesOrders/{id}/documents
Delete multiple sales order documents
salesOrder.deleteMultiple 1 param body → 204400403404415429
GET
/api/v1/salesOrders/{id}/documentsdeprecated
List sales order documents
salesOrder.listDocument 3 params → 200403404406415429
GET
/api/v1/salesOrders/{id}/documents/{documentId}deprecated
View sales order document
salesOrder.viewDocument 3 params → 200403404406429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xentral-sales-order-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