When you configure an export, import, or other type of flow step using the prebuilt Intershop connector, you can select any of the API operations listed below*, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Intershop API documentation. *You can also create a composite endpoint for this application in HTTP mode.
Resource |
API endpoint |
Export |
Import |
---|---|---|---|
Address |
Return the list of addresses that have been created at the selected basket |
X |
|
Add a new address to the basket |
X |
||
Return the address for the given ID |
X |
||
Delete the address with the given ID from the basket |
X |
||
Partially Update the address with the given ID |
X |
||
Return (custom) attributes for the address. |
X |
||
Create a new (custom) attribute at the basket address. |
X |
||
Delete the attribute from the basket address. |
X |
||
Update the basket address attribute. |
X |
||
Return the list of eligible addresses that can be set at the selected basket |
X |
||
Address check |
Get list of links to suggested addresses |
X |
|
Get suggested address details |
X |
||
Update address details as suggested |
X |
||
Get list of links to suggested addresses (private) |
X |
||
Get suggested address details (private) |
X |
||
Update address details as suggested (private) |
X |
||
Application |
Return a list of the channel's applications |
X |
|
Return an application by UUID or ID |
X |
||
Attachment |
Return the content of an attachment |
X |
|
Basket: General |
Return the list of active baskets for the user. |
X |
|
Create a new basket for the user. |
X |
||
Return the basket with the given ID |
X |
||
Delete the basket with the given ID |
X |
||
Partially Update the basket with the given ID |
X |
||
Return (custom) attributes for the basket |
X |
||
Create a new (custom) attribute at the basket |
X |
||
Delete the attribute from the basket |
X |
||
Update the basket attribute. |
X |
||
Merge the basket with another basket |
X |
||
Validate the basket |
X |
||
Basket: Line item |
Return the list of line items for the selected basket |
X |
|
Add one or more products to the basket |
X |
||
Delete all line items for the selected basket |
X |
||
Return the line item for the given ID |
X |
||
Delete the line item with the given ID from the basket |
X |
||
Partially Update the line item with the given ID |
X |
||
Return (custom) attributes for the line item. |
X |
||
Create a new (custom) attribute at the line item. |
X |
||
Delete the attribute from the line item. |
X |
||
Update the line item attribute. |
X |
||
Basket: Payment |
Return the list of payment methods that are eligible for the selected basket |
X |
|
Add a payment instrument to the basket |
X |
||
Delete the payment instrument with the given ID |
X |
||
Partially Update the payment instrument with the given ID |
X |
||
Return the list of payments assigned to the current basket |
X |
||
Create a new payment from a given payment instrument. |
X |
||
Create (or replace) the payment with the given ID |
X |
||
Delete the payment with the given ID |
X |
||
Update the payment. |
X |
||
Basket: Quote |
Return the list of quotes that have been added at the selected basket |
X |
|
Add a quote to the basket |
X |
||
Remove the quote with the given string from the basket |
X |
||
Batch processes (imports) |
Return links denoting batch process and import types |
X |
|
Return catalog import process information |
X |
||
Create a catalog import process |
X |
||
Return information about a catalog import process |
X |
||
Return customer import process information |
X |
||
Create a customer import process |
X |
||
Return information about a customer import process |
X |
||
Return order import process information |
X |
||
Create an order import process |
X |
||
Return information about an order import process |
X |
||
Return price list import process information |
X |
||
Create a price list import process |
X |
||
Return information about a price list import process |
X |
||
Return product import process information |
X |
||
Create a product import process |
X |
||
Return information about a product import process |
X |
||
Return scaled price import process information |
X |
||
Create a scaled price import process |
X |
||
Return information about a scaled price import process |
X |
||
Return user import process information |
X |
||
Create a user import process |
X |
||
Return information about a user import process |
X |
||
Return variation type import process information |
X |
||
Create a variation-type import process |
X |
||
Return information about a variation type import process |
X |
||
Cache management |
Return the statuses of the given cache name for all server nodes. |
X |
|
Requests to clear a given cache on all server nodes. |
X |
||
Return the statuses for all cache for all server nodes. |
X |
||
Categories |
Return categories of a product |
X |
|
Return categories of a product (categories) |
X |
||
Return top-level categories or category tree |
X |
||
Return category info |
X |
||
Return category links of a category |
X |
||
Channel |
Return a list of the organization's channels |
X |
|
Return details of a channel |
X |
||
CMS: General |
Return a list of CMS sub-resources |
X |
|
Co-browse |
Return a new co-browse authentication token |
X |
|
Configuration |
Return the configuration details for given application. |
X |
|
Confirmation |
Confirm GDPR request |
X |
|
Contact |
Get subjects for "contact us" |
X |
|
Send "contact us" e-mail |
X |
||
Contact center customer: Address |
Return the customer's addresses (customers) |
X |
|
Create a new customer address |
X |
||
Get customer address details |
X |
||
Update customer address |
X |
||
Delete customer address |
X |
||
Return the customer's addresses (private) |
X |
||
Create a new customer address (private) |
X |
||
Get customer address details (private) |
X |
||
Update customer address (private) |
X |
||
Delete customer address (private) |
X |
||
Contact center: User |
Redirects to the currently logged-in user's details |
X |
|
Return details of the currently authenticated user |
X |
||
Contract |
Return customer contracts |
X |
|
Return customer contract details |
X |
||
Return customer contract orders |
X |
||
Cost center |
Return all cost centers |
X |
|
Create a new cost center |
X |
||
Return cost center details |
X |
||
Remove the cost center |
X |
||
Update the cost center |
X |
||
Return all buyers to the cost center |
X |
||
Add a new cost center buyer |
X |
||
Return information about a buyer of the cost center |
X |
||
Remove the buyer from the cost center |
X |
||
Update the budget for a buyer of the cost center |
X |
||
Return a list of cost centers of a business user |
X |
||
Return business user cost center details |
X |
||
Country |
Return the available countries for the channel. |
X |
|
Return the country details for the given country code. |
X |
||
Return the available maindivisions for a given country code. |
X |
||
Customer |
Return customers based on given search parameters |
X |
|
Return details of a customer |
X |
||
Return the customer's addresses |
X |
||
Return details of a customer address |
X |
||
Create a new customer authentication token |
X |
||
Customer: General |
Register a new SMB customer |
X |
|
Get customer profile of currently logged-in user |
X |
||
Update customer profile of currently logged-in user |
X |
||
Create individual customer |
X |
||
Create customer |
X |
||
Get current customer profile details |
X |
||
Update a customer |
X |
||
Customer: Payment |
Get list of customer profile payments |
X |
|
Add a payment to customer profile |
X |
||
Get details of a customer profile payment |
X |
||
Update payment from customer profile |
X |
||
Remove a payment from customer profile |
X |
||
Get list of customer profile payments (private) |
X |
||
Add a payment to customer profile (private) |
X |
||
Get details of a customer profile payment (private) |
X |
||
Update payment from customer profile (private) |
X |
||
Remove a payment from customer profile (private) |
X |
||
cXML: General |
Return details for cXML punchout |
X |
|
Return information on a specific cXML punchout session |
X |
||
Create a cXML punchout session |
X |
||
Trigger the cXML punchout basket transfer |
X |
||
cXML: User management |
Return cXML punchout users |
X |
|
Create a cXML punchout user |
X |
||
Return information on the given cXML punchout user |
X |
||
Update cXML punchout user data |
X |
||
Delete a cXML punchout user of a customer |
X |
||
Dispatch |
Create an order dispatch message |
X |
|
Filter |
Return product filters |
X |
|
Return product filters (categories) |
X |
||
GDPR: shop |
Get GDPR-relevant customer data |
X |
|
Delete GDPR-relevant customer data |
X |
||
Gift card and certificate |
Return gift cards and certificates |
X |
|
Return gift card or certificate details |
X |
||
Return gift cards and certificates (private) |
X |
||
Return gift card or certificate details (private) |
X |
||
Include |
Return a specific include |
X |
|
Return a list of all the includes |
X |
||
Inventory |
Get the currently available quantity of a product. |
X |
|
IOM: Application monitoring |
Return the status of all app servers of a cluster. |
X |
|
Check if the app server is alive. |
X |
||
Localizations |
Return localized texts |
X |
|
Return localized text for a given key |
X |
||
Notifications |
Return notifications endpoints |
X |
|
Return notifications endpoints (private) |
X |
||
OCI: Configuration |
Return customer-specific OCI punchout configurations |
X |
|
Update an existing OCI punchout configuration |
X |
||
OCI: General |
Return details for the OCI punchout. if basket ID is provided, it Return the basket line item data according to OCI punchout configuration |
X |
|
Searches for products |
X |
||
Trigger the OCI punchout basket transfer |
X |
||
Validate a product with the given ID and quantity |
X |
||
OCI: User management |
Return OCI punchout users |
X |
|
Create an OCI punchout user |
X |
||
Return information on the given OCI punchout user |
X |
||
Update OCI punchout user data |
X |
||
Delete an OCI punchout specific user of a customer |
X |
||
Order |
Create an order |
X |
|
Order state |
Return order states by search criteria |
X |
|
Order: General |
Return the list of orders for the user. |
X |
|
Create a new order for the user from a given basket |
X |
||
Return the order with the given ID |
X |
||
Update the order with the given ID |
X |
||
Return (custom) attributes for the order. |
X |
||
Create a new (custom) attribute at the order. |
X |
||
Order: Line item |
Return the list of line items for the selected order. |
X |
|
Return the line item for the given ID |
X |
||
Return (custom) attributes for the line item. |
X |
||
Create a new (custom) attribute at the line item. |
X |
||
Order: Payment |
Return the list of payments assigned to the order. |
X |
|
Update the payment. |
X |
||
Order: Shipping bucket |
Return the list of shipping buckets for the selected order. |
X |
|
Return the shipping bucket with the given ID |
X |
||
Page |
Return a specific page hierarchy |
X |
|
Return all pages with their tree hierarchy |
X |
||
Return a specific page |
X |
||
Return a list of all pages |
X |
||
Pagelet |
Return a list of all published pagelets of the domain |
X |
|
Return a specific slot of a pagelet |
X |
||
Return a specific pagelet of the domain |
X |
||
Price notifications |
Return price notifications |
X |
|
Create price notification |
X |
||
Return price notification details |
X |
||
Update price notification |
X |
||
Delete a price notification |
X |
||
Return price notifications (private) |
X |
||
Create price notification (private) |
X |
||
Return price notification details (private) |
X |
||
Update price notification (private) |
X |
||
Delete a price notification (private) |
X |
||
Product |
Return details of a product |
X |
|
Return a variation of a product by search |
X |
||
Return product links of a product (categories) |
X |
||
Return variations of a product (categories) |
X |
||
Return product cross-sells (categories) |
X |
||
Return bundled products |
X |
||
Return details of a product (categories) |
X |
||
Return a variation of a product by search (categories) |
X |
||
Return bundled products (categories) |
X |
||
Return products of retail set |
X |
||
Return variations of a product |
X |
||
Return products by search |
X |
||
Return product links of a product |
X |
||
Return products by search (categories) |
X |
||
Return product cross-sells |
X |
||
Return products of retail set (categories) |
X |
||
Product prices |
Return prices for one or more products |
X |
|
Promotion |
Return available contact center promotions |
X |
|
Return details of a promotion |
X |
||
Create a promotion code for the promotion |
X |
||
Send a promotion code to a customer |
X |
||
Promotion code |
Return the list of promotion codes that have been applied at the selected basket |
X |
|
Add a promotion code to the basket |
X |
||
Return data for a given promotion code |
X |
||
Remove a promotion code from the basket |
X |
||
Return (custom) attributes for a promotion code applied to a basket |
X |
||
Promotion: General |
Return details for a promotion |
X |
|
Return a personalized list of promotions |
X |
||
Promotion: Product |
Return applicable promotions for a product |
X |
|
Return applicable promotions for product categories |
X |
||
Public wishlists |
Public wishlists |
X |
|
Get public wishlist details |
X |
||
Punchout: General |
Return supported punchout standards |
X |
|
Quote |
Retrieve a list of quotes |
X |
|
Submit a quote request |
X |
||
Return details of a quote |
X |
||
Reject a quote |
X |
||
Delete a quote |
X |
||
Quote request |
Return a list of quote requests |
X |
|
Create a quote request |
X |
||
Return a quote request by given ID |
X |
||
Update data of a quote request |
X |
||
Delete a quote request |
X |
||
Return line items of a quote request |
X |
||
Set the list of quote line items |
X |
||
Create line item for the quote request |
X |
||
Return a line item of a quote request |
X |
||
Update the line item of a quote request (quantity) |
X |
||
Delete a line item of a quote request |
X |
||
Rating and review |
Create a review for product |
X |
|
Delete product review by ID (categories) |
X |
||
Create review for a product |
X |
||
Delete product review by ID |
X |
||
Return product review by ID (categories) |
X |
||
Return reviews of a product |
X |
||
Return product review by ID |
X |
||
Return reviews of a product (categories) |
X |
||
Recommendation |
Create a new recommendation context |
X |
|
Recommendation event |
Send an event to the recommendation engine |
X |
|
Recommendation request |
Get recommended products for the basket with the given basket ID |
X |
|
Get recommended products for the given product (SKU) |
X |
||
Get recommended products for the given search term |
X |
||
Get recommended global top-seller products |
X |
||
Get recommended products for the assigned user |
X |
||
Response |
Create an order response message |
X |
|
Return |
Create an order return message |
X |
|
RMA: Shop |
List the configured return reasons for a given shop |
X |
|
Create an approval |
X |
||
List the return request contact persons |
X |
||
Get a return request |
X |
||
List the returnable order positions to prepare the creation of a return request |
X |
||
List the return requests |
X |
||
Create a return request |
X |
||
List the return request pickup addresses |
X |
||
List the return request custom attributes |
X |
||
List the return request position items |
X |
||
Get a return request position |
X |
||
List the return request positions |
X |
||
Schedule configs |
Get schedules by search criteria |
X |
|
Get a schedule by ID |
X |
||
Schedule states |
Get the schedules current states by search criteria |
X |
|
Get the schedule state by ID |
X |
||
Set the runtime configuration of a schedule. |
X |
||
Schedules and jobs |
Return links denoting job information |
X |
|
Return the job by name. |
X |
||
Update a job using the transmitted fields. |
X |
||
Return links denoting job information |
X |
||
Search |
Retrieve suggestions for a search term |
X |
|
Search index |
Return details of a search index |
X |
|
Search indexes |
Return details of a search filter |
X |
|
Shipping bucket |
Return the list of shipping buckets for the selected basket |
X |
|
Return the shipping bucket with the given ID |
X |
||
Update the shipping bucket with the given ID |
X |
||
Shipping method |
Return the list of shipping methods that are eligible for the selected shipping bucket |
X |
|
Return the list of shipping methods that are eligible for the selected basket |
X |
||
Return the list of shipping methods that are eligible for the selected line item |
X |
||
Stock notifications |
Return stock notifications |
X |
|
Create stock notification |
X |
||
Return stock notification details |
X |
||
Update stock notification |
X |
||
Delete a stock notification |
X |
||
Return stock notifications (private) |
X |
||
Create stock notification (private) |
X |
||
Return stock notification details (private) |
X |
||
Update stock notification (private) |
X |
||
Delete a stock notification (private) |
X |
||
Store locator |
Store locator |
X |
|
Subscription (e-mail marketing) |
Subscribe a recipient |
X |
|
Return subscription status for given recipient |
X |
||
Unsubscribe recipient from e-mail provider |
X |
||
Subscription: General |
Return a list of recurring orders of the given individual customer |
X |
|
Return details about a customer's recurring order |
X |
||
Update a recurring order |
X |
||
Return a list of recurring orders of the given individual customer (users) |
X |
||
Return details about a customer's recurring order (users) |
X |
||
Update a recurring order (users) |
X |
||
Return a list of recurring orders of the given individual customer (private) |
X |
||
Return details about a customer's recurring order (private) |
X |
||
Update a recurring order (private) |
X |
||
Subscription: Payment |
Return payments of recurring order |
X |
|
Add payment to a recurring order |
X |
||
Return payment details of recurring order payments (customers) |
X |
||
Remove payment from recurring order (customers) |
X |
||
Create URL for redirect to the payment provider |
X |
||
Send transaction details after redirect to the shop system |
X |
||
Return payments of recurring order (users) |
X |
||
Add payment to recurring order (users) |
X |
||
Return payment details of recurring order payments |
X |
||
Remove payment from recurring order |
X |
||
Get return URLs from rest client for payment provider redirect |
X |
||
Get transaction details after redirect before checkout |
X |
||
Return payments of recurring order (private) |
X |
||
Add payment to recurring order (private) |
X |
||
Return payment details of recurring order payments (private) |
X |
||
Remove payment from recurring order (private) |
X |
||
Get return URLs from rest client for payment provider redirect (private) |
X |
||
Get transaction details after redirect before checkout (private) |
X |
||
Transmission |
Get transmissions by type + additional filter criteria. |
X |
|
Get a transmission by ID |
X |
||
Get a list of transmission types supported by the API |
X |
||
Transmission update |
Bulk create processes to update statuses of transmissions(by id) |
X |
|
Bulk create processes to update statuses of transmissions(by filter) |
X |
||
User |
Get users of SMB customer |
X |
|
Register new users of SMB customer |
X |
||
Get user profile data of selected user |
X |
||
Update the profile of selected user of SMB customer |
X |
||
Delete user of SMB customer |
X |
||
View context |
Return all view contexts of the domain |
X |
|
Return a specific view context of the domain |
X |
||
Resolve a page for a view context |
X |
||
Wishlist |
Get list of wishlists of customer |
X |
|
Create new customer wishlist |
X |
||
Get wishlist settings of customer |
X |
||
Update customer wishlist settings |
X |
||
Get customer wishlist details |
X |
||
Update customer wishlist |
X |
||
Delete customer wishlist |
X |
||
Add product to specific or preferred wishlist |
X |
||
Remove product from specific or preferred wishlist |
X |
||
Share wishlist of customer with given recipient |
X |
||
Unshare wishlist |
X |
||
Add wishlist item to basket |
X |
||
Get list of wishlists of customer (private) |
X |
||
Create new customer wishlist (private) |
X |
||
Get wishlist settings of customer (private) |
X |
||
Update customer wishlist settings (private) |
X |
||
Get customer wishlist details (private) |
X |
||
Update customer wishlist (private) |
X |
||
Delete customer wishlist (private) |
X |
||
Add product to specific or preferred wishlist (private) |
X |
||
Remove product from specific or preferred wishlist (private) |
X |
||
Share wishlist of customer with given recipient (private) |
X |
||
Unshare wishlist (private) |
X |
||
Add wishlist item to basket (private) |
X |
Comments
Article is closed for comments.