REST API Version

11.11

11.10

11.9

11.7

11.6

11.5

11.4

11.3

11.2

11.1

11.0

Address Check

Validate and update customer addresses in real time with suggestions using external address validation services.

Attachment
Retrieve attachment content.

Authentication
Authenticate API requests using tokens or identity providers. Manage tokens, credentials, passwords, security questions, access public keys, retrieve CAPTCHA challenges, and more.

Basket
Manage baskets as part of the checkout process with endpoints to create, update, and delete baskets; handle line items, payments, addresses, shipping, promotions, and more.

Batch Processes
Use this API to manage batch and import processes for catalogs, customers, orders, and more. In addition, this REST API supports file uploads required for these import processes, allowing users to upload, retrieve, and delete import files.

CMS
Retrieve information about CMS objects such as pagelets, pages, includes, and view contexts. Access resources that represent the core features of the content management system.

Configuration
Use this API to retrieve configuration details for an application.

Contact
Trigger "Contact Us" e-mails directly through the API and retrieve a list of subjects for these e-mails.

Contact Center
Retrieve information for customer interaction, including co-browse tokens, and create or send promotion codes.

Contract
Retrieve contract information for business customers, including contract details and contract-specific orders.

Cost Center
Manage cost centers, buyers and their budgets, and retrieve lists of cost centers and associated users.

Customer
Perform a range of customer-related operations, including registration, managing address and payment information, interacting with user profiles associated with B2B customers, and more.

GDPR
Handle personal data requests in compliance with GDPR. Use the provided endpoint to confirm data requests via hash verification.

Internationalization
Retrieve country details, main divisions, and localized texts for different locales.

Inventory
Retrieve inventory information for one or more products.

Jobs
Retrieve job information and update or start jobs and schedules.

Media Asset Management
Access files in the shared file system of Intershop Commerce Management that were uploaded via content upload.

Newsletter
Manage e-mail marketing by subscribing or unsubscribing recipients and retrieving their subscription status.

Notification
Notify users when a product drops below a set price or is back in stock.

Order
Manage orders as part of the checkout process with endpoints to create, retrieve, and update orders. Access order details, line items, shipping buckets, and payments, and extend orders with custom attributes for advanced order handling.

Organization
This REST API is deprecated. The described cost object feature is no longer supported.

Pricing
Retrieve prices for one or more products, including scaled and customer-specific prices, and filter the results.

Product and Category
Retrieve detailed product and category information, including personalized content and product filters. Access customer-segment-specific data, filter products by search terms and attributes, and navigate categories with flexible filtering options.

Promotion
Retrieve promotion details, personalized lists of promotions as well as applicable promotions for a specific product, also for those promotions assigned to certain customer segments.

Punchout
Manage Punchout processes, configurations, and users with endpoints supporting both cXML and OCI standards.

Quoting
Manage the entire quoting process: create, update and remove quote requests and quotes.

Rating and Review
Retrieve, create and delete ratings and reviews for products.

Recommendation
Provide customers with personalized product suggestions based on user behavior and product relationships.

Requisition Approval
Retrieve and update user budgets, review and approve or reject requisitions, and manage user roles and permissions throughout the requisition approval process.

Search
Retrieve search suggestions from the installed search engine for a search term.

Search Index
Retrieve information about search indexes and search filters from Intershop Commerce Management and their assigned categories and subcategories.

Shop**

Store
Use this API to leverage the store locator functionality.

Subscription (Recurring Order)
Retrieve, update, and delete recurring orders for private customers and B2B users.

Wish List
Manage wishlists and the included products. Note that this API also serves as the basis for implementing order templates in the Intershop Progressive Web App (PWA).