Jump to Content
API Reference
Home
Guides
API Reference
Roadmap
v25.33
v25.34
v25.35
v25.36
API Reference
API Reference
Moon (Dark Mode)
Sun (Light Mode)
25.35.3
Home
Guides
API Reference
Roadmap
Create Print Job
Search
JUMP TO
Xentral API
Introduction
Authentication
Rate Limiting
Media types & variants
PDF Documents
Versioning
Filtering, Ordering, & Pagination
Testing the APIs
Feedback?
Xentral API
Accounting
Accounting Export
Check the export status
get
Download a generated export file
get
Execute the accounting CSV export for invoices and credit notes
post
Execute the accounting CSV export for liabilities
post
Execute the accounting CSV export for account transactions
post
Execute the accounting XML export for invoices
post
Execute the accounting XML export for credit notes
post
Execute the accounting XML export for liabilities
post
Payment Service Provider
Create Payment Service Provider Transactions
post
List Payment Service Provider Transactions
get
Collective Bill
Create collective bill
post
Credit Note
Create credit note
post
List credit notes
get
View credit note
get
Update single credit note
patch
Delete single credit note
del
View Credit Note Balance
get
View related documents for credit note
get
Invoice
Create invoice
post
Create Positions for Invoice
post
List invoices
get
View invoice
get
Update single invoice
patch
Update status for single invoice
patch
Delete single invoice
del
Send invoice
patch
View Invoice Balance
get
View related documents for invoice
get
Liability
Create liability
post
Create recurring liability
post
List Liabilities
get
View liability
get
Releases a liability
patch
Add a liability document to an existing liability
post
Payment Methods
Payment method list
get
Payment Terms Group
Create a new paymentTermsGroup
post
Get a list of paymentTermsGroups
get
Get a single paymentTermsGroup
get
Payment Transaction
View a single payment transaction
get
[EARLY ACCESS] Update status for single Payment Transaction
patch
Point Of Sale
Cashier PIN check
post
Add journal entry
post
Add cash count entry
post
Add qr code data to a document
post
Cashier list
get
Journals list
get
Cash Register balance
get
Tax Rate
List tax rates
get
Analytics
Collection
Create collection
post
Get list of collections
get
Get a collection
get
Update a collection
patch
Delete a collection
del
Credit
Get credit information
get
Documentation
Get list of documentation
get
Query
Create query export
post
List recent query exports
get
List query export by ID
get
Execute a query synchronously
post
Report
Create report
post
Get list of reports.
get
Get report by ID
get
Update a report
patch
Delete a report
del
Create report export
post
List all recent report exports
get
Execute a query synchronously
post
Get report export by ID
get
Create permalink for report
post
List permalink for report
get
Invalidate permalink for report
del
Download report via permalink
get
Create schedule for report
post
List schedules for report
get
Update schedule for report
patch
Delete schedule for report
del
Report Usage
Get report usage
get
Reporting Settings
Get settings
get
Update settings
patch
CRM
Customer
Create customer
post
List customers
get
View customer
get
Update customer
patch
Delete customer
del
Customer Address
Create address
post
List addresses
get
View address
get
Update address
patch
Delete address
del
Customer - Contact Person
Create contact person
post
List contact persons
get
View contact person
get
Update contact person
patch
Delete contact person
del
Employee
List employees
get
Supplier
List suppliers
get
View supplier
get
Delete supplier
del
Fulfillment
Delivery Note
Delivery note list
get
View delivery note
get
Update delivery note positions customs data.
patch
Delivery
List deliveries
get
View delivery aka shipment
get
View delivery note deliveries aka shipments
get
Delivery Terms
List Delivery Terms
get
Goods Receipt
Create a new goods receipt for a purchase order
post
Create a new goods receipt for a return
post
Production
List Productions
get
View Production
get
Releases a production
patch
Cancel a production
patch
Provisional Return
List provisional returns
get
Purchase Order
Create new purchase order
post
Lists available purchase orders
get
View a single purchase order
get
Update existing purchase order
patch
Cancels a purchase order
patch
Releases a purchase order
patch
Return
Create a return
post
List returns
get
View return
get
Release a return
post
Create return document
post
View return document list
get
View return document
get
Update multiple return documents
patch
Delete multiple return documents
del
List of return reasons
get
Sales Order
Import sales order
post
List sales orders
get
View sales order
get
Update existing sales order
patch
Delete draft sales order
del
Cancel a sales order
post
Dispatch a released sales order
post
Create a partial SalesOrder
patch
Create sales order document
post
View sales order document list
get
View sales order document
get
Update multiple sales order documents
patch
Delete multiple sales order documents
del
Shipping Methods
Create Shipping Method
post
List shipping methods
get
View Shipping Method
get
Update Shipping Method
put
Stock Movement Types
Create a stockMovementType
post
Storage Location
Storage location list
get
Set total stock on storage location(s)
patch
Storage Item
Storage item list
get
Add item to Storage Location
post
Retrieves item from Storage Location
patch
Warehouse
Create a Warehouse
post
Warehouse list
get
Update warehouse
patch
Delete warehouse
del
Products
Cross Sellings
Create new cross selling for a product
post
List cross selling of a product
get
Update cross selling of a product
patch
Delete cross selling of a product
del
Parts
Create new parts for product
post
View parts
get
Update parts of a product
patch
Deletes parts of a product
del
Reservations
View reservations
get
Texts
List product texts
get
External Reference
Create new external references for a given Product
post
List external references for given Product
get
List External Reference Targets
get
Update external references for a given Product
patch
Delete external references of a given Product
del
Matrixproduct
Creates variants for a matrix product
post
Creates new option for a product
post
View options of a product
get
Updates a single option of a matrix product.
patch
Update multiple options of a product
patch
Deletes multiple options of a product
del
Creates multiple values for an option of a matrix product.
post
Lists all values from an option of a matrix product.
get
View a single value from an option of a matrix product.
get
Updates a single value from an option of a matrix product.
patch
Deletes a single value from an option of a matrix product.
del
Deletes multiple values from an option of a matrix product.
del
Product
Create new product V2
post
List products V2
get
View product V2
get
Update product v2
patch
Update multiple products V2
patch
Delete product
del
Delete multiple products
del
View sales prices
get
View purchase orders positions
get
View sales orders positions
get
View productions positions
get
View storage locations
get
View purchase prices
get
Product Category
Create new product category
post
Lists available products categories
get
View a single product category
get
Update a single product category
patch
Delete a single product category
del
Product Free Field
list of information about product free fields from company settings
get
view information about a single product free field from company settings
get
update information about a single product free field from company settings
patch
update information of multiple product free fields from company settings
patch
Product Media
Create product media
post
List product media
get
View product media
get
Update multiple product media
patch
Delete multiple product media
del
Create product media version
post
View product media version
get
Updates product media version
patch
Delete product media version
del
Product Property
Create products properties
post
List products properties
get
Update multiple products properties
patch
Delete multiple products properties
del
View properties
get
Update properties
patch
Product Merchandise Group
Create new product merchandise group
post
Lists available products merchandise groups
get
View a single product merchandise group
get
Update a single product merchandise group
patch
Delete a single product merchandise group
del
Purchase Price
Create purchase price
post
List purchase prices V2
get
View purchase price
get
Update purchase price V2
patch
Update multiple purchase prices V2
patch
Delete purchase price
del
Sales Channels Product Settings
Creates sales channel settings for a single product.
post
Updates sales channel settings for a single product.
patch
Deletes sales channel settings for a single product.
del
Sales Price
Create sales price
post
List sales prices
get
View sales price
get
Update sales price
patch
Update multiple sales prices
patch
Delete sales price
del
Product Label
Print product label
post
Download product label as pdf
get
Deprecated
Create new product V1
post
Create new product tag
post
List products tags
get
Update a single product tag
patch
List products V1
get
View delivery note shipments aka deliveries
get
List delivery notes tags
get
View shipment aka delivery
get
Update multiple products V1
patch
List purchase prices V1
get
Update purchase price V1
patch
Update product v1
patch
List suppliers tags
get
Update single Supplier tags
patch
Update multiple purchase prices V1
patch
Update multiple suppliers tags
patch
View media
get
Identify product
get
List Credit Notes tags
get
List Invoice tags
get
View product v1
get
Setting
Address Free Fields
Create address custom field configuration
post
List address custom fields
get
Text Templates
View text template settings
get
/api/v2/settings/text-templates
patch
AuthPlatform
Exchange a subject token for a platform access token
post
Print Jobs
Create Print Job
post
Project
List projects
get
List POS settings for project
get
Sales Channel
List all sales channels
get
User
Create user
post
List users
get
View user
get
Update user
patch
Delete single user
del
View user's permissions
get
Request reset password email
post
Webhook
Create a webhook
post
List webhooks
get
View a webhook
get
Update a webhook
patch
Delete a webhook.
del
List webhook event types
get
Tag
List all tags
get
Update multiple tags
patch
Delete tags
del
Bulk assign tags to multiple resources
post
Bulk remove tags from multiple resources
del
Events
Webhooks
Legacy APIs
Standard API
REST API
Carrier Integration Service Contract
Carrier Integration Service Contract
Check the liveness of the service
get
Get available carriers
get
Create shipment
post
Get shipment
get
Cancel shipment
del
Create Print Job
post
https://{xentralId}.xentral.biz/api/v1/printJobs
Create a new print job.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
Bearer
URL
Base URL
https://
xentral
.xentral.biz
/api/v1/printJobs
RESPONSE
Click
Try It!
to start a request and see the response here!