Supported SAP Commerce Cloud APIs

Tanisha Ray

Updated May 20, 2024 05:30

When you configure an export, import, or lookup using the form view designed for the SAP Commerce Cloud connector, the following API operations are supported:

Note: You can also create a composite endpoint for this application. For more information, see Application-specific (simple) forms.

Resource	API endpoint	Export	Import
Address	Retrieve the addresses of a customer	X
	Create a new address		X
	Verify the address		X
	Retrieve the address details of a customer	X
	Update the address of a customer		X
	Delete the address of a customer		X
	Update the address		X
B2B carts	Update the delivery address for a cart		X
	Update the quantity of the specified products in a cart		X
	Create an additional quantity of a product in the cart		X
	Get the current cart	X
	Update the cost center for the cart		X
	Update the payment type for the cart		X
B2B categories	Retrieve a list of products for a category	X
B2B cost centers	Retrieve active cost centers	X
	Create a cost center		X
	Retrieve the cost center	X
	Update the cost center		X
	Retrieve all budget and certain budgets associated with the specified cost center	X
	Create a budget for the cost center		X
	Delete the budget from a cost center		X
	Retrieve the cost centers	X
B2B miscs	Retrieve the available payment types	X
B2B orders	Create a cart from a previous order		X
	Create a B2B order		X
	Retrieve the order history for the customer's organization branch	X
	Retrieve the order from the customer's organization branch	X
	Create replenishment orders		X
B2B products	Retrieve product details	X
B2B users	Create a registration request for a B2B customer		X
B2B users	Retrieve a B2B customer profile	X
Base sites	Retrieve the base sites	X
Base stores	Retrieve a base store	X
Budget management	Retrieve the list of budget	X
	Create a new budget		X
	Retrieve the details of a budget	X
	Update the budget		X
Bundles	Create a bundle in a cart		X
Bundles	Retrieve products for an entry group	X
Cart addresses	Update the delivery address for a cart		X
	Create a delivery address for the cart		X
	Delete the delivery address		X
Cart delivery modes	Retrieve the delivery mode for the cart	X
	Update the delivery mode for the cart		X
	Delete the delivery mode from the cart		X
	Retrieve the delivery modes for the current store and delivery address	X
Cart entries	Retrieve the cart entries	X
	Assign a product to the cart		X
	Retrieve the details of a cart entry	X
	Update the details of a cart entry		X
	Delete the cart entry		X
	Update the details of a cart entry		X
Cart entry groups	Assign a product to a cart entry group		X
Cart entry groups	Delete an entry group		X
Cart payments	Set credit card payment details for the cart		X
Cart payments	Create details of a new credit card payment for the cart		X
Cart promotions	Retrieve the cart promotions	X
	Assign a promotion to the cart		X
	Retrieve information about the promotion	X
	Delete the promotion		X
	Retrieve a list of vouchers	X
	Assign a voucher to the cart		X
	Delete a voucher defined for the current cart		X
Carts	Retrieve the carts of a customer	X
	Create or restore a cart for a user		X
	Retrieve a cart	X
	Delete the cart		X
	Retrieve a list of pickup options	X
	Create a consolidated pickup location		X
	Assign an email address to the cart		X
	Retrieve the information required to create a subscription	X
	Retrieve the create subscription response from the payment provider	X
	Create the SOP payment details		X
	Delete the response from the payment provider		X
	Set the requested retrieval date for a cart		X
	Validates the cart		X
Catalogs	Retrieve a list of catalogs	X
	Retrieve a catalog	X
	Retrieve information about the catalog version	X
	Retrieve information about the category	X
Cities	Retrieve a list of districts for a city	X
Cities	Retrieve a list of cities for a region	X
Components	Retrieve the component's data	X
Components	Retrieve the component data	X
Consents	Create consent		X
	Delete the user consent		X
	Retrieve the consents	X
	Retrieve the consent	X
Consignment tracking	Retrieve consignment tracking information	X
Countries	Retrieve a list of countries	X
Countries	Retrieve a list of regions	X
Customer coupons	Retrieve the coupons of a customer	X
	Claim and remember a customer coupon		X
	Disclaim a customer coupon		X
	Create a coupon notification		X
	Delete a coupon notification		X
Customer groups	Retrieve the subgroups of a customer group	X
	Create a new customer group		X
	Retrieve a customer group	X
	Set members for a user group		X
	Assign members to a customer group		X
	Delete the customer from a customer group		X
Export	Retrieve a list of exported products	X
Feeds	Retrieve a list of orders with status Update	X
Forgotten passwords	Create a token to restore a forgotten password		X
Forgotten passwords	Reset a forgotten password		X
Future stocks	Retrieve the future availability of the products	X
Future stocks	Retrieve the future availability of a product	X
Invoices	Get invoices for an order	X
Invoices	Get binary invoice of an order	X
Login notification	Notify about successful login		X
Merchant callback	Validates the decision of the merchant		X
Merchant callback	Validates the decision of the merchant for a SOP payment related to a cart		X
Message center	Send a message		X
	Retrieve the unassigned or open conversations	X
	Retrieve the conversations	X
	Closes an open conversation		X
	Retrieve the messages of a specific conversation	X
	Pick an unassigned conversation		X
Miscs	Retrieve a list of supported payment card types	X
	Retrieve a list of available currencies	X
	Retrieve a list of available languages	X
	Retrieve the localized titles	X
Notification preference	Get all notification preferences of the current customer	X
Notification preference	Update the notification preferences of the current customer		X
Order approval permission types	Retrieve the order approval permission types	X
Order approval permissions	Retrieve the order approval permissions	X
	Create an order approval permission		X
	Retrieve the order approval permission	X
	Update the order approval permission		X
Order approvals	Retrieve the orders to approve	X
	Retrieve an order to approve	X
	Create a decision for the order approval		X
Order forms	Retrieve all order forms	X
	Create an order form		X
	Retrieve an order form	X
	Update an order form		X
	Delete an order form		X
	Add products in an order form to the current cart		X
Orders	Retrieve the order	X
	Retrieve the order history of a customer	X
	Create an order		X
	Retrieve the order	X
	Cancels an order		X
Organizational unit account summary	Retrieve the account summary	X
	Retrieve the financial organizational documents	X
	Retrieve the attachment of a document	X
Organizational unit customer management	Retrieve the list of organizational customers	X
	Create an organizational customer profile		X
	Retrieve the profile of the organizational unit customer	X
	Update the profile of the organizational unit customer		X
	Retrieve the approvers	X
	Add an approver for an organizational customer		X
	Delete an approver for an organizational customer		X
	Retrieve the organizational user groups	X
	Create an organizational user group for an organizational customer		X
	Delete an organizational user group for an organizational customer		X
	Retrieve the permissions of the customer	X
	Create permission for an organizational customer		X
	Delete permission for an organizational customer		X
Organizational unit management	Retrieve the available organizational unit nodes	X
	Create a role for an organizational customer		X
	Delete the role from the organizational customer		X
	Create a new organizational unit		X
	Retrieve the organizational unit	X
	Update the organizational unit		X
	Retrieve the addresses of an organizational unit	X
	Create an address for the organizational unit		X
	Delete the organizational unit address		X
	Update the organizational unit address		X
	Retrieve the available parent units	X
	Retrieve the users who belong to the organizational unit	X
	Add an organizational unit-dependent role to a specific organizational customer		X
	Delete an organizational, unit-dependent role from an organizational customer		X
	Retrieve the available business approval processes	X
	Retrieve the root organizational unit node	X
Organizational unit user groups	Retrieve the list of user groups in an organizational unit	X
	Create a new user group in an organizational unit		X
	Retrieve the details of the organizational unit user group	X
	Delete the organizational unit user group		X
	Update the organizational unit user group		X
	Retrieve the order approval permissions	X
	Retrieve the organizational customers	X
	Add an organizational customer as a member of an organizational unit user group		X
	Delete all organizational customers as user group members in the organizational unit		X
	Delete an organizational customer from the organizational unit group members		X
	Create an order approval permission to a user group in the organizational unit		X
	Delete the order approval permission from the organizational unit user group		X
Pages	Retrieve the page data and the CMS content slots	X
	Retrieve the page data and CMS content slots using the page identifier	X
	Retrieve the page data	X
Payment details	Retrieve all credit card payment details of the customer	X
	Retrieve detailed information for a specific credit card payment	X
	Update existing detailed information for a specific credit card payment		X
	Delete detailed information for a specific credit card payment		X
	Update existing detailed information for a specific credit card payment		X
Payment modes	Retrieve the available payment modes	X
Product configurator CCP	Get a product configuration	X
	Update a product configuration		X
	Get a product configuration overview	X
	Update the product configuration overview		X
	Get prices for a product configuration	X
	Get the default product configuration for a complex product	X
Product configurator CCP cart integration	Add a product configuration to the cart		X
	Get the configuration of a cart entry	X
	Update the configuration of a cart entry		X
Product configurator CCP order integration	Get a product configuration overview of an order entry	X
Product configurator CCP quote integration	Get a product configuration overview of a quote entry	X
Product configurator CCP saved cart integration	Get a product configuration overview of a saved cart entry	X
Product configurator CCP variant search	Get variants for a product configuration	X
Product configurator text field template	Get text field configuration	X
	Add a product to the cart		X
	Get configuration of cart entry	X
	Update configuration of cart entry		X
	Get text field configuration for order entry	X
	Get text field configuration for quote entry	X
	Get text field configuration for saved cart entry	X
Product interests	Retrieve the product interests of a customer	X
	Create product interests		X
	Delete the product interests		X
Products	Retrieve products that were added to the express update feed	X
	Retrieve a list of products	X
	Retrieve the available suggestions	X
	Retrieve product details	X
	Retrieve the product references	X
	Retrieve the reviews of a product	X
	Create a customer review as an anonymous user		X
	Retrieve the stock level of a product	X
	Retrieve the stock level of a product	X
Promotions	Retrieve the promotions	X
Promotions	Retrieve the promotion	X
Punch out	Handles a purchase order request from the punchout provider		X
	Create a punchout profile request		X
	Create a new punchout session		X
	Retrieve information about the punchout session	X
	Retrieve the order message and URL for the procurement system	X
Quotes	Retrieve all quotes for a customer	X
	Create a quote		X
	Retrieve the quote	X
	Update the quote		X
	Update the quote		X
	Create workflow actions for the quote		X
	Create a comment for a quote		X
	Create a discount for an existing quote		X
	Create a comment for a quote entry		X
Replenishment order	Retrieve the replenishment orders	X
	Retrieve the replenishment order	X
	Update the replenishment order		X
	Retrieve the history of the replenishment order	X
Return requests	Retrieve the return request history of the customer	X
	Create an order return request		X
	Retrieve the details of a return request	X
	Update the order return request using the specified code		X
Save cart	Create a clone of a saved cart		X
	Update the cart by flagging it for deletion		X
	Restore a saved cart		X
	Update a cart to save it		X
	Retrieve the saved cart	X
Site messages	Get all site messages of current customer	X
Stores	Retrieve the store locations	X
	Retrieve the store locations in a country	X
	Retrieve the store locations	X
	Retrieve store counts	X
	Retrieve a store location	X
Tickets	Retrieve the ticket categories	X
	Retrieve the object associated with a ticket	X
	Retrieve the tickets of a customer	X
	Create a ticket		X
	Retrieve a ticket	X
	Create a ticketed event		X
	Create an attachment for an event in a ticket		X
	Retrieve an attachment for an event in a ticket	X
Users	Register a customer		X
	Retrieve the customer profile	X
	Update the customer profile		X
	Delete the customer profile		X
	Update customer profile		X
	Retrieve the customer groups	X
	Change customer's login name		X
	Update the password of a customer		X
Vouchers	Retrieve the voucher	X