← Developer documentation home

XML Reference Guides

Working with XML? Choose an operation below to see its XML request and response examples, endpoint details and schema links. Use the examples together with the API Reference to build and validate your integration.

Each operation guide also lists its WCF method, service addresses and contract signature. See WCF integration guidance for details.

Test an XML request

1. Open Validate Basket (10300) and select application/xml in the request body.
2. Choose Test Request. Use the evaluation server and enter your evaluation Services Interaction Key in companyKey.
3. In the XML request, use a test basket ID and the sale date and time. Replace the sample product code with one configured in your evaluation company and keep confirmed="false". Send the request with Content-Type and Accept set to application/xml.
4. In the response body, check the result attribute on <summary> and review any <message> entries. The viewer indents nested elements. Select Download to save the original XML.

For your own HTTP client, copy the literal request from the operation’s XML guide and use the same headers.

For the JSON equivalent, see Test a JSON request in Getting Started.

Basket

• 10200 — Validate Coupon Code
• 10300 — Validate Basket

Configuration

• 40100 — Promotion List
• 40110 — Promotion Get
• 40120 — Promotion Add
• 40130 — Promotion Edit
• 40140 — Promotion Delete
• 40150 — Promotion Publish
• 40160 — Promotion Lock/Unlock
• 40200 — Promotion Group List
• 40210 — Promotion Group Get
• 40220 — Promotion Group Add
• 40230 — Promotion Group Edit
• 40240 — Promotion Group Delete
• 40300 — Reporting Code List
• 40310 — Reporting Code Get
• 40320 — Reporting Code Add
• 40330 — Reporting Code Edit
• 40340 — Reporting Code Delete

Import

• 20100 — Import coupon codes
• 20200 — Attribute Value Import
• 20300 — Product Import
• 20500 — Generate Voucher Codes
• 20600 — Reassign Customer Reference

Export

• 30100 — Export Promotion Usage Summary by Day
• 30200 — Export Transaction Summary by Day
• 30300 — Export Settings
• 30400 — Export Attributes
• 30500 — Export Products
• 30600 — Export Reporting Codes
• 30700 — Export Coupon/Campaigns
• 30800 — Export Promotion Groups
• 30900 — Export Promotions
• 31000 — Export Voucher Number Series
• 31100 — Export Coupon/Campaign Codes
• 31200 — Export Available Promotions (Basket)
• 31300 — Export Available Promotions (Products)
• 31400 — Export Coupon/Campaign Code Uses
• 31500 — Export Attribute Values
• 31600 — Export Product Attribute Values
• 31700 — Export Log Entries
• 31800 — Export Coupon Usage Summary by Day
• 31900 — Export Matched Products for Promotion