Available Commercetools APIs

Tanisha Ray

Updated November 22, 2024 11:04

When you configure an export, import, other type of flow step using the prebuilt Commercetools 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 Commercetools API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
API clients	Query API clients	X
	Create API client		X
	Get API client	X
	Delete API client		X
Associate roles	Query associate roles	X
	Create associate role		X
	Get associate role by key	X
	Update associate role by key		X
	Delete associate role by key		X
	Get associate role by ID	X
	Update associate role by ID		X
	Delete associate role by ID		X
Attribute groups	Query attribute groups	X
	Create attribute groups		X
	Get attribute group by key	X
	Update attribute groups by key		X
	Delete attribute group by key		X
	Get attribute groups by ID	X
	Update attribute groups by ID		X
	Delete attribute group by ID		X
Business unit associates	Query business units by associate ID	X
	Create business unit as associate		X
	Check if business unit exists by key	X
	Update business unit by key		X
	Get business unit by ID	X
	Update business unit by ID		X
	Query approval flow in business unit	X
	Get approval flow in business unit by ID	X
	Update approval flow in business unit by ID		X
	Query approval rule in business unit	X
	Create approval rule in business unit		X
	Get approval rule in business unit by key	X
	Update approval rule in business unit by key		X
	Get approval rule in business unit by ID	X
	Update approval rule in business unit by ID		X
	Query carts in business unit	X
	Create cart in business unit		X
	Get cart in a business unit by key	X
	Update cart in business unit by key		X
	Delete cart in business unit by key		X
	Replicate cart in business unit		X
	Get cart in business unit by ID	X
	Update cart in business unit by ID		X
	Delete cart in business unit by ID		X
	Query orders in business unit	X
	Create order from cart in business unit		X
	Get order in business unit by order number	X
	Update order in business unit by order number		X
	Create order from quote in business unit		X
	Get order in business unit by ID	X
	Update order in business unit by ID		X
	Query quote requests in business unit	X
	Create quote request in business unit		X
	Get quote request in business unit by key	X
	Update quote request in business unit by key		X
	Get quote request in business unit by ID	X
	Update quote request in business unit by ID		X
	Query quotes in business unit	X
	Get quote in business unit by key	X
	Update quote in business unit by key		X
	Get quote in business unit by ID	X
	Update quote in business unit by ID		X
Business units	Query business units	X
	Create business unit		X
	Get business unit by key	X
	Update business unit by key		X
	Delete business unit by key		X
	Get business unit by ID	X
	Update business unit by ID		X
	Delete business unit by ID		X
Cart discounts	Query cart discounts	X
	Create cart discount		X
	Get cart discount by key	X
	Update cart discount by key		X
	Delete cart discount by key		X
	Get cart discount by ID	X
	Update cart discount by ID		X
	Delete cart discount by ID		X
Carts	Query carts	X
	Create cart		X
	Get cart by customer ID	X
	Get cart by key	X
	Update cart by key		X
	Delete cart by key		X
	Replicate cart		X
	Get cart by ID	X
	Update cart by ID		X
	Delete cart by ID		X
Categories	Query catagories	X
	Create category		X
	Get category by key	X
	Update category by key		X
	Delete category by key		X
	Get category by ID	X
	Update category by ID		X
	Delete category by ID		X
Channels	Query channels	X
	Create channel		X
	Get channel	X
	Update channel		X
	Delete channel		X
Custom objects	Query custom objects	X
	Create or update custom object		X
	Get custom object by container and key	X
	Delete custom object by container and key		X
Customer groups	Query customer groups	X
	Create customer group		X
	Get customer group by key	X
	Update customer group by key		X
	Delete customer group by key		X
	Get customer group by ID	X
	Update customer group by ID		X
	Delete customer group by ID		X
Customers	Query customers	X
	Create customer		X
	Create email token for customer		X
	Get customer by email token	X
	Verify email of customer		X
	Get customer by key	X
	Update customer by key		X
	Delete customer by key		X
	Change password of customer		X
	Create password reset token for customer		X
	Get customer by password token	X
	Reset password of customer		X
	Get customer by ID	X
	Update customer by ID		X
	Delete customer by ID		X
Discount codes	Query discount codes	X
	Create discount code		X
	Get discount code by key	X
	Update discount code by key		X
	Delete discount code by key		X
	Get discount code by ID	X
	Update discount code by ID		X
	Delete discount code by ID		X
Extensions	Query extensions	X
	Create extension		X
	Get extension by key	X
	Update extension by key		X
	Delete extension by key		X
	Get extension by ID	X
	Update extension by ID		X
	Delete extension by ID		X
In business unit	Create associate for a business unit by key		X
In store	Query cart discounts in store	X
	Create cart discount in store		X
	Get cart discount by key	X
	Update cart discount by key		X
	Delete cart discount by key		X
	Get cart discount by ID	X
	Update cart discount by ID		X
	Delete cart discount by ID		X
	Quer carts in store	X
	Create cart in store		X
	Get cart by customer ID	X
	Get cart by key	X
	Update cart by key		X
	Delete cart by key		X
	Replicate cart		X
	Get cart by ID	X
	Update cart by ID		X
	Delete cart by ID		X
	Query customer in store	X
	Create customer in store		X
	Create email token for customer in store		X
	Get customer in store by email token	X
	Verify email of customer in store		X
	Get customer in store by key	X
	Update customer in store by key		X
	Delete customer in store by key		X
	Change password customer in store		X
	Create password reset token for customer in store		X
	Get customer in store by password token	X
	Reset password of customer in store		X
	Get customer in store by ID	X
	Update customer in store by ID		X
	Delete customer in store by ID		X
	Authenticate (sign in) customer		X
	Get customer in store	X
	Update customer in store		X
	Delete customer in store		X
	Get active cart in store	X
	Query cart in store	X
	Create cart in store		X
	Get cart in store by ID	X
	Update cart in store by ID		X
	Delete cart in store by ID		X
	Verify email of customer in store		X
	Authenticate (sign in) customer in store		X
	Query order in store	X
	Create order in store from cart		X
	Get order in store	X
	Change password of customer in store		X
	Reset password of customer in store		X
	Query shopping lists in store	X
	Create shopping lists in store		X
	Get shopping lists in store by key	X
	Update shopping lists in store by key		X
	Delete shopping lists in store by key		X
	Get shopping lists in store by ID	X
	Update shopping lists in store by ID		X
	Delete shopping lists in store by ID		X
	Create (sign up) customer in store		X
	Query orders in store	X
	Create order in store		X
	Get order in store by ordernumber	X
	Update order by ordernumber		X
	Delete order by ordernumber		X
Get order in store by ID	X
Update order in store by ID		X
Delete order in store by ID		X
Get product projection in store by ID	X
Get product projection in store by ID	X
Query products assigned to active product selections in a store	X
Query product tailoring in store	X
Create product tailoring in store		X
Get product tailoring in store by product key	X
Update product tailoring in store by product key		X
Delete product tailoring in store by product key		X
Get product tailoring in store by product ID	X
Update product tailoring in store by product ID		X
Delete product tailoring in store by product ID		X
Retrieve all the shipping methods for a cart in store	X
Query shopping lists in store	X
Create shopping list in store		X
Get shopping list in store by key	X
Update shopping list in store by key		X
Delete shopping list in store by key		X
Get shopping list in store by ID	X
Update shopping list in store by ID		X
Delete shopping list in store by ID		X
Inventory	Query inventory	X
	Create inventory entry		X
	Get inventory by key	X
	Update inventory by key		X
	Delete inventory by key		X
	Get inventory by ID	X
	Update inventory by ID		X
	Delete inventory by ID		X
Login	Authenticate (sign in) customer		X
Me	Get customer	X
	Update customer		X
	Delete customer		X
	Get active cart	X
	Query business units	X
	Create business unit		X
	Get business unit by key	X
	Update business unit by key		X
	Delete business unit by key		X
	Get business unit by ID	X
	Update business unit by ID		X
	Delete business unit by ID		X
	Query carts	X
	Create cart		X
	Get cart by key	X
	Update cart by key		X
	Delete cart by key		X
	Replicate cart		X
	Get cart by ID	X
	Update cart by ID		X
	Delete cart by ID		X
	Verify email of customer		X
	Authenticate (sign in) customer		X
	Query orders	X
	Create order		X
	Create order from quote		X
	Get order by ID	X
	Change password of customer		X
	Reset password of customer		X
	Query payments	X
	Create payment		X
	Get payment by ID	X
	Update payment by ID		X
	Delete payment by ID		X
	Query quote requests	X
	Create quote request		X
	Get quote request by key	X
	Update quote request by key		X
	Delete quote request by key		X
	Get quote request by ID	X
	Update quote request by ID		X
	Delete quote request by ID		X
	Query quotes	X
	Get quote by key	X
	Update quote by key		X
	Get quote by ID	X
	Update quote by ID		X
	Query shopping lists	X
	Create shopping list		X
	Get shopping list by key	X
	Update shopping list by key		X
	Delete shopping list by key		X
	Get shopping list by ID	X
	Update shopping list by ID		X
	Delete shopping list by ID		X
	Create (sign up) customer		X
Messages	Query messages	X
Messages	Get message	X
Orders	Query orders	X
	Create order from cart		X
	Query order edits	X
	Create order edit		X
	Get order edit by key	X
	Update order edit by key		X
	Delete order edit by key		X
	Get order edit by ID	X
	Update order edit by ID		X
	Delete order edit by ID		X
	Apply order edit		X
	Create order by import		X
	Get order by order number	X
	Update order by order number		X
	Delete order by order number		X
	Create order from quote		X
	Search orders	X
	Get order by ID	X
	Update order by ID		X
	Delete order by ID		X
Payments	Query payments	X
	Create payments		X
	Get payment by key	X
	Update payment by key		X
	Delete payment by key		X
	Get payment by ID	X
	Update payment by ID		X
	Delete payment by ID		X
Product discounts	Query product discounts	X
	Create product discount		X
	Get product discount by key	X
	Update product discount by key		X
	Delete product discount by key		X
	Get matching product discount		X
	Get product discount by ID	X
	Update product discount by ID		X
	Delete product discount by ID		X
Product projections	Query product projections	X
	Get product projection by key	X
	Product projection search	X
	Product projection search using query parameters	X
	Suggest query	X
	Gets the current or staged representation of a product projection	X
Product selections	Query product selections	X
	Create product selection		X
	Get product selection by key	X
	Update product selection by key		X
	Delete product selection by key		X
	Query products assigned to a product selections by key	X
	Get product selections by ID	X
	Update product selections by ID		X
	Delete product selections by ID		X
	Query products assigned to a product selections by key	X
Product tailoring	Query product tailoring	X
	Create product tailoring		X
	Get product tailoring by key	X
	Update product tailoring by key		X
	Delete product tailoring by key		X
	Get product tailoring by ID	X
	Update product tailoring by ID		X
	Delete product tailoring by ID		X
Product types	Query product types	X
	Create product type		X
	Get product type by key	X
	Update product type by key		X
	Delete product type by key		X
	Get product type by ID	X
	Update product type by ID		X
	Delete product type by ID		X
Products	Query products	X
	Create product		X
	Get product by key	X
	Update product by key		X
	Delete product by key		X
	Query product selections for product by ID	X
	Get product by ID	X
	Update product by ID		X
	Delete product by ID		X
	Upload product image		X
	Query product selections for product	X
Project	Get project	X
Project	Update project		X
Quote requests	Query quote requests	X
	Create quote request		X
	Get quote request by key	X
	Update quote request by key		X
	Delete quote request by key		X
	Get quote request by ID	X
	Update quote request by ID		X
	Delete quote request by ID		X
Quotes	Query quotes	X
	Create quote		X
	Get quote by key	X
	Update quote by key		X
	Delete quote by key		X
	Get quote by ID	X
	Update quote by ID		X
	Delete quote by ID		X
Reviews	Query reviews	X
	Create review		X
	Get review by key	X
	Update review by key		X
	Delete review by key		X
	Get review by ID	X
	Update review by ID		X
	Delete review by ID		X
Shipping methods	Query shipping methods	X
	Create shipping method		X
	Get shipping method by key	X
	Update shipping method by key		X
	Delete shipping method by key		X
	Get matching shipping methods	X
	Retrieve all the shipping methods for a cart and location	X
	Retrieve all the shipping methods for a location	X
	Retrieve all the shipping methods for an order edit	X
	Get shipping method by ID	X
	Update shipping method by ID		X
	Delete shipping method by ID		X
Shopping lists	Query shipping lists	X
	Create shipping list		X
	Get shipping list by key	X
	Update shipping list by keys		X
	Delete shipping list by key		X
	Get shipping list by ID	X
	Update shipping list by ID		X
	Delete shipping list by ID		X
Staged quotes	Query stated quotes	X
	Create stated quote		X
	Get stated quote by key	X
	Update stated quote by key		X
	Delete stated quote by key		X
	Get stated quote by ID	X
	Update stated quote by ID		X
	Delete stated quote by ID		X
Standalone prices	Query standlone prices	X
	Create standlone price		X
	Get standlone price by key	X
	Update standlone price by key		X
	Delete standlone price by key		X
	Get standlone price by ID	X
	Update standlone price by key		X
	Delete standlone price by key		X
States	Query states	X
	Create state		X
	Get state by key	X
	Update state by key		X
	Delete state by key		X
	Get state by ID	X
	Update state by ID		X
	Delete state by ID		X
Stores	Query stores	X
	Create store		X
	Get store by key	X
	Update store by key		X
	Delete store by key		X
	Get store by ID	X
	Update store by ID		X
	Delete store by ID		X
Subscriptions	Query subscriptions	X
	Create subscription		X
	Get subscription by key	X
	Update subscription by key		X
	Delete subscription by key		X
	Get subscription by ID	X
	Update subscription by ID		X
	Delete subscription by ID		X
	Get health status of subscription by ID	X
Tax categories	Query tax categories	X
	Create tax category		X
	Get tax category by key	X
	Update tax category by key		X
	Delete tax category by key		X
	Get tax category by ID	X
	Update tax category by ID		X
	Delete tax category by ID		X
Types	Query types	X
	Create type		X
	Get type by key	X
	Update type by key		X
	Delete type by key		X
	Get type by ID	X
	Update type by ID		X
	Delete type by ID		X
Zones	Query zones	X
	Create zone		X
	Get zone by key	X
	Update zone by key		X
	Delete zone by key		X
	Get zone by ID	X
	Update zone by ID		X
	Delete zone by ID		X