API Overview
Connect your commerce platform to QixolPromo to evaluate baskets, validate coupon codes and exchange the information your integration needs. Explore the operations below to find request details, response structures and practical examples.
Explore the APIs
Use Basket Evaluation to calculate promotional outcomes, Configuration to work with supported configuration information, Import to submit data for processing and Export to retrieve data for your own systems. Each operation documents its supported request and response formats. Where both JSON and XML are available, follow the examples and schemas for your chosen format; their structures may differ.
Browse the API Reference or begin with Getting Started.
Loyalty and gift card scope
This release documents Basket, Configuration, Import and Export operations. Dedicated Loyalty and Gift Card operations are outside this release’s scope. Shared schemas may include fields or values related to these features.
If your integration does not use Loyalty or Gift Card features, omit optional fields for those features from your requests. Your integration should accept responses that contain these fields and can skip processing their values if it has no use for them. If you pass the full response to another system, preserve those fields in the data you pass through.
WCF services
QixolPromo also exposes WCF services for the operations covered in this documentation. Each operation in the API Reference and its XML guide lists the WCF method and service addresses.
Basket
Evaluation/Developmenthttps://evaluation.qixolpromo.com/BasketService.svc
Productionhttps://basketmanager.qixolpromo.com/BasketService.svc
Configuration
Evaluation/Developmenthttps://evaluation.qixolpromo.com/ConfigurationService.svc
Productionhttps://datamanager.qixolpromo.com/ConfigurationService.svc
Import
Evaluation/Developmenthttps://evaluation.qixolpromo.com/ImportService.svc
Productionhttps://datamanager.qixolpromo.com/ImportService.svc
Export
Evaluation/Developmenthttps://evaluation.qixolpromo.com/ExportService.svc
Productionhttps://datamanager.qixolpromo.com/ExportService.svc
Configure your WCF client for the relevant service contract and environment. Use the service metadata and the method signature shown in the XML guide to determine parameter names, types and message wrapping. Some methods accept an XML document as a string; others accept separate parameters, including company keys, identifiers or coupon codes. Follow the contract for the operation you call.
The XML request and response examples describe business payloads. The interactive Test Request tool sends REST requests. Use a WCF client to call the listed service methods.
Environment access and security
Use HTTPS, the correct environment host and the confidential company Services Interaction Key as companyKey. Evaluation keys can be obtained through the Portal; production keys are provided by Qixol. Production IP restrictions are enabled by default; Evaluation/Development companies are exempt. Configure separate Basket Service Access and Data Management Service Access allowlists in Portal → Configuration → Permitted IP Addresses. Changes may take up to 24 hours. See Integration Best Practices.
Responses and asynchronous operations
HTTP 200 does not guarantee application success: inspect summary.result and summary.messages and consult Response Codes & Messages. Use the same unique basket ID throughout evaluations, changes and confirmation. Confirmed processing can have persistent coupon/voucher effects; duplicate prevention applies to previously utilised coupons and issued vouchers for the same basket ID, but is not full idempotency. Prior effects are not automatically reversed when an amended basket ceases to qualify.
All five Import operations enqueue asynchronous work; an acknowledgement is not completion. Monitor the Portal Import Log; no Import status API is documented. See the implementation guide.
XML reference material
For XML requests, consult XML Reference Guides and the operation-specific Request and Response XSD links. Some mixed text/attribute structures cannot be fully expressed by standard OpenAPI XML schema metadata.
Request limits
In Evaluation/Development, Validate Basket (10300) and Validate Coupon Code (10200) share a default limit of 10 requests per second. The limit can be configured for your company. These application-level limits do not apply to Production Basket requests. Export requests are limited to 5 calls per second. This limit applies to all companies. Pace requests and use a controlled retry after throttling. Import requests are queued for asynchronous processing and are not throttled. See Integration Best Practices for guidance.