Jump to Content

Guides API Reference Roadmap

API Reference

Guides API Reference Roadmap

Xentral API

Introduction
Authentication
Rate Limiting
Media types & variants
Versioning
Filtering, Ordering, & Pagination
Testing the APIs
Feedback?

Xentral API

Accounting Export
Collection
Credit
- Get credit informationget
Credit Note
Credit Note Tag
- List Credit Notes tagsget
Customer
Customer - Contact Person
Customer Tag
- List customers tagsget
Delivery Note
Delivery Note Tag
- List delivery notes tagsget
Delivery
Delivery Terms
- List Delivery Termsget
Documentation
- Get list of documentationget
Employee
- List employeesget
External Reference
External Reference Target
- [EARLY ACCESS] List External Reference Targetsget
Goods Receipt
- Create a new goods receipt for a purchase orderpost
- Create a new goods receipt for a returnpost
Invoice
Invoice Tag
- List Invoice tagsget
Liability
Matrixproduct
Payment Methods
- [EARLY ACCESS] Payment method listget
Payment Terms Group
Point Of Sale
Product
Product Category
Product Free Field
Product Media
Product Tag
Product Property
Product Merchandise Group
Production
- List Productionsget
- View Productionget
Project
- [EARLY ACCESS] List projectsget
- [EARLY ACCESS] List POS settings for projectget
Provisional Return
- List provisional returnsget
Purchase Order
Purchase Price
Query
Report
Report Usage
- Get report usageget
Return
Return Reason
- [EARLY ACCESS] List of return reasonsget
Sales Channels Product Settings
Sales Price
Sales Order
Shipping Methods
- List shipping methodsget
Stock Movement Types
- [EARLY ACCESS] Create a stockMovementTypepost
Supplier
Supplier Tag
- List suppliers tagsget
User
Storage Location
- [EARLY ACCESS] Storage location listget
Storage Item
Warehouse
- [EARLY ACCESS] Warehouse listget
Webhook
Tax Rate
- List tax ratesget

Events

Webhooks [BETA]

Legacy APIs

Standard API
REST API

Carrier Integration Service Contract

[ALPHA] Carrier Integration Service Contract

Xentral API

Introduction
Authentication
Rate Limiting
Media types & variants
Versioning
Filtering, Ordering, & Pagination
Testing the APIs
Feedback?

Xentral API

Accounting Export
Collection
Credit
- Get credit informationget
Credit Note
Credit Note Tag
- List Credit Notes tagsget
Customer
Customer - Contact Person
Customer Tag
- List customers tagsget
Delivery Note
Delivery Note Tag
- List delivery notes tagsget
Delivery
Delivery Terms
- List Delivery Termsget
Documentation
- Get list of documentationget
Employee
- List employeesget
External Reference
External Reference Target
- [EARLY ACCESS] List External Reference Targetsget
Goods Receipt
- Create a new goods receipt for a purchase orderpost
- Create a new goods receipt for a returnpost
Invoice
Invoice Tag
- List Invoice tagsget
Liability
Matrixproduct
Payment Methods
- [EARLY ACCESS] Payment method listget
Payment Terms Group
Point Of Sale
Product
Product Category
Product Free Field
Product Media
Product Tag
Product Property
Product Merchandise Group
Production
- List Productionsget
- View Productionget
Project
- [EARLY ACCESS] List projectsget
- [EARLY ACCESS] List POS settings for projectget
Provisional Return
- List provisional returnsget
Purchase Order
Purchase Price
Query
Report
Report Usage
- Get report usageget
Return
Return Reason
- [EARLY ACCESS] List of return reasonsget
Sales Channels Product Settings
Sales Price
Sales Order
Shipping Methods
- List shipping methodsget
Stock Movement Types
- [EARLY ACCESS] Create a stockMovementTypepost
Supplier
Supplier Tag
- List suppliers tagsget
User
Storage Location
- [EARLY ACCESS] Storage location listget
Storage Item
Warehouse
- [EARLY ACCESS] Warehouse listget
Webhook
Tax Rate
- List tax ratesget

Events

Webhooks [BETA]

Legacy APIs

Standard API
REST API

Carrier Integration Service Contract

[ALPHA] Carrier Integration Service Contract

[EARLY ACCESS] List returns

get https://{xentralId}.xentral.biz/api/v1/returns

Lists existing returns

Language

Credentials

Bearer

URL

Click Try It! to start a request and see the response here!