Xara Business API
API reference

Products

Create products and retrieve your business catalog.

Products describe the goods and services your business can sell. Create a product first, then use its returned id when requesting an invoice.

Create a product

POST /CatalogItem/create creates a product, service, or subscription in the authenticated business catalog.

Request body

FieldTypeRequiredDescription
namestringYesCustomer-facing item name.
pricenumberYesSelling price. Must be greater than zero.
quantitynumberNoStarting inventory quantity. Defaults to 0.
descriptionstringNoA short description of the item.
min_stocknumberNoInventory level at which the item is considered low in stock.
cost_pricenumberNoInternal cost price. Must be zero or greater.
picturestringNoFile name of an image uploaded beforehand.
parent_idIDNoID of the parent product when creating a variant.
typestringNoproduct, service, or subscription. Defaults to product.
subscription_interval_daysnumberConditionalBilling interval in days when type is subscription.

The request and response panel shows a complete product example. Store the returned data.id; it becomes the product_id in invoice line items.

Validation and errors

Xara checks the required fields and number values before creating the item. Invalid product data returns 422. A missing or invalid API token returns an authentication error.

Retrieve products

GET /CatalogItem/getAll retrieves catalog items for the authenticated business.

Pass type=product to retrieve products only:

curl --request GET \
  --url 'https://graph.usexara.ai/rest/CatalogItem/getAll?type=product' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

The optional type filter accepts product, service, ticket, or subscription. When omitted, Xara returns all active catalog items except tickets, ordered from newest to oldest.

Copyright © 2026