Home
API Catalog
About
Back to System
Sage X3 API
1.0.0
OAS 3.0
Comprehensive API for managing Sage X3 business objects and operations.
Servers
https://api.sagex3.com/v1
Authorize
default
GET
/users
Retrieves a list of users.
POST
/users
Creates a new user.
GET
/health
Checks the health status of the API.
GET
/invoices
Retrieves a list of invoices.
POST
/invoices
Creates a new invoice.
GET
/products
Retrieves a list of products.
POST
/products
Creates a new product.
GET
/settings
Retrieves application settings.
PUT
/settings
Updates application settings.
GET
/webhooks
Retrieves a list of registered webhooks.
POST
/webhooks
Registers a new webhook.
GET
/customers
Retrieves a list of customers.
POST
/customers
Creates a new customer.
GET
/inventory
Retrieves current inventory levels.
GET
/suppliers
Retrieves a list of suppliers.
POST
/suppliers
Creates a new supplier.
POST
/auth
/login
Authenticates a user and returns a token.
GET
/warehouses
Retrieves a list of warehouses.
POST
/warehouses
Creates a new warehouse.
GET
/salesorders
Retrieves a list of sales orders.
POST
/salesorders
Creates a new sales order.
POST
/bulk
/products
Bulk creates or updates products.
GET
/purchaseorders
Retrieves a list of purchase orders.
POST
/purchaseorders
Creates a new purchase order.
GET
/users
/{userId}
Retrieves a user by ID.
PUT
/users
/{userId}
Updates an existing user.
DELETE
/users
/{userId}
Deletes a user.
GET
/invoices
/{invoiceId}
Retrieves an invoice by ID.
PUT
/invoices
/{invoiceId}
Updates an existing invoice.
DELETE
/invoices
/{invoiceId}
Deletes an invoice.
GET
/products
/{productId}
Retrieves a product by ID.
PUT
/products
/{productId}
Updates an existing product.
DELETE
/products
/{productId}
Deletes a product.
DELETE
/webhooks
/{webhookId}
Deletes a registered webhook.
POST
/inventory
/adjustments
Creates an inventory adjustment.
GET
/salesorders
/{orderId}
Retrieves a sales order by ID.
PUT
/salesorders
/{orderId}
Updates an existing sales order.
DELETE
/salesorders
/{orderId}
Deletes a sales order.
GET
/customers
/{customerId}
Retrieves a customer by ID.
PUT
/customers
/{customerId}
Updates an existing customer.
DELETE
/customers
/{customerId}
Deletes a customer.
GET
/suppliers
/{supplierId}
Retrieves a supplier by ID.
PUT
/suppliers
/{supplierId}
Updates an existing supplier.
DELETE
/suppliers
/{supplierId}
Deletes a supplier.
GET
/warehouses
/{warehouseId}
Retrieves a warehouse by ID.
PUT
/warehouses
/{warehouseId}
Updates an existing warehouse.
DELETE
/warehouses
/{warehouseId}
Deletes a warehouse.
GET
/purchaseorders
/{purchaseOrderId}
Retrieves a purchase order by ID.
PUT
/purchaseorders
/{purchaseOrderId}
Updates an existing purchase order.
DELETE
/purchaseorders
/{purchaseOrderId}
Deletes a purchase order.
Schemas
User
Error
Address
Invoice
Product
Webhook
Customer
Supplier
AuthToken
Inventory
Warehouse
SalesOrder
UserCreate
UserUpdate
AppSettings
HealthStatus
LoginRequest
InvoiceCreate
InvoiceUpdate
ProductCreate
ProductUpdate
PurchaseOrder
WebhookCreate
CustomerCreate
CustomerUpdate
SalesOrderLine
SupplierCreate
SupplierUpdate
WarehouseCreate
WarehouseUpdate
SalesOrderCreate
SalesOrderUpdate
AppSettingsUpdate
PurchaseOrderLine
BulkOperationResult
InventoryAdjustment
PurchaseOrderCreate
PurchaseOrderUpdate
