API Endpoints
API Endpoints
An overview of all available resources in the xoPort REST API.
Available Endpoints
Select a resource for detailed documentation:
Products
Product data with images, prices, categories, videos, suppliers, and ContentEditor.
Products →Customer Groups
List and manage customer groups—including category blacklists (restricted_categories_ids). Export + Import, scopes: customer_groups:read/:write.
Contracts
Contracts/Subscriptions with attributes, domains, status history, and order links.
Contracts →Newsletter Subscribers
Newsletter subscribers with DOI support, provider sync, and GDPR privacy logging.
Newsletter Subscribers →Newsletter Campaigns
Newsletter campaigns with multi-language support, locked status checks, and sent safety checks.
Newsletter Campaigns →Slider NEW v2.22.0
Promotional Slides (table slider + slider_description) — Export, Import, Update, and Delete. Filters: status, type, categories_id, content_id, language.
Projects & Tasks NEW v2.35.0
xoCRM Projects and Project Tasks — Export, Import, Update, and Delete, including multilingual descriptions, project managers, assignees, and status history. Deleting a project cascades across all tasks.
Projects & Tasks →Tickets v2.118.0
Support tickets with status history, assignments, file attachments, and linked CRM appointments. Export, import, update, delete. New in v2.25.0: Public replies to customers, including email delivery and automatic admin signature (with opt-in flag, defensive defaults). New in v2.60.0: File attachments can now be written using ` attachments[] `—previously, they were read-only. New in v2.118.0: An editing claim shows who is currently working on a ticket (PUT /Import/JSON/ticket_claims, export fields claim and edit_lock).
Media v2.19.0
Product image library with multi-source upload (URL/Base64/Multipart), multilingual titles, and automatic thumbnails. New in v2.19.0: Static asset uploads (entity_type=static) for marketplace logos and interface branding.
Orders v2.21.0
Orders with multi-item support, attributes, totals, status history, and tracking. Export and import (POST/PUT) via the generic OrderBuilder service. New in v2.21.0: Totals modes (auto/recalc/verbatim),tax_flag/language_id auto-derivation from customer group, expected_total drift check, tracking + status_history sub-resources.
Products Options v2.96.0
Attributes and option values as separate entities: read, create, and update, including cost price and MSRP per value.
Export API →Shipping Profiles v2.94.0
Shipping time profiles with tiers, shipping time ranges, and customer texts for each language.
Export API →Product Filters v2.100.0
Which filters a category page offers, including display options.
Export API →Coupons v2.102.0
Vouchers and coupons with restrictions, redemption limits, and validity periods.
Export API →Ticket Departments v2.103.0
View, create, edit, and delete ticket departments in multiple languages.
Export API →Configuration v2.108.0
Read and modify approved settings—only keys that the administrator has explicitly approved.
Export API →Porters v2.109.0
Read CSV/XLS porters with column mapping and enable or disable the import path.
Export API →Reviews v2.122.6
Product reviews with text and the store’s response for each language, without customer data.
Export API →