Reference
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Open Commerce API
OCAPI Data API
Summary
Endpoints
Get alert descriptors
GET
Get alert descriptors for application context
GET
Get alert descriptor
GET
Trigger rule validation
PATC
Get alerts
GET
Get alerts for application context
GET
Delete alert
DELE
Get alert
GET
Get alert settings
GET
Change alert settings
PATC
Search catalogs
POST
Get catalogs
GET
Get catalog
GET
Update catalog
PATC
Get categories
GET
Delete category
DELE
Get category
GET
Update category
PATC
Create category
PUT
Get category links
GET
Delete category link
DELE
Get category link
GET
Update category link
PATC
Create category link
PUT
Search category product assignment
POST
Delete category product assignment
DELE
Get category product assignment
GET
Update category product assignment
PATC
Create category product assignment
PUT
Search categories within a catalog
POST
Get shared product options
GET
Delete shared product option
DELE
Get product option
GET
Update shared product option
PATC
Create shared product option
PUT
Get shared product option values
GET
Delete shared product option value
DELE
Get shared product option value
GET
Update shared product option value
PATC
Create shared product option value
PUT
Get shared variation attributes
GET
Get shared variation attribute values
GET
Delete shared variation attribute value
DELE
Get shared variation attribute value
GET
Update shared variation attribute value
PATC
Put shared variation attribute value
PUT
Delete shared variation attribute
DELE
Get shared variation attribute
GET
Update shared variation attribute
PATC
Create shared variation attribute
PUT
Search categories
POST
Get all code versions
GET
Delete a code version
DELE
Get a code version
GET
Update a code version
PATC
Create code version
PUT
Search attribute definitions for custom object
POST
Get attribute definitions for custom object
GET
Delete attribute definition for custom object
DELE
Get attribute definition for custom object
GET
Update attribute definition for custom object
PATC
Create attribute definition for custom object
PUT
Search attribute groups for custom object
POST
Get attribute groups for custom object
GET
Un assign custom object attribute definition from attribute group
DELE
Assign custom object attribute definition to attribute group
PUT
Delete attribute groups for custom object
DELE
Get attribute group for custom object
GET
Update attribute group for custom object
PATC
Create attribute group for custom object
PUT
Delete global custom object
DELE
Read global custom object
GET
Update global custom object
PATC
Create global custom object
PUT
Search custom objects
POST
Search for customers in a customer list
POST
Get customer list
GET
Create customer
POST
Delete customer
DELE
Get customer
GET
Update customer
PATC
Create customer with given customer number
PUT
Get all customer addresses
GET
Create customer address
POST
Delete customer address
DELE
Get customer address
GET
Update customer address
PATC
Get custom preferences
GET
Update custom preferences
PATC
Search inventory lists
POST
Get inventory lists
GET
Delete inventory list
DELE
Get inventory list
GET
Update inventory list
PATC
Create inventory list
PUT
Get product inventory records
GET
Delete product inventory record
DELE
Get product inventory record
GET
Update product inventory record
PATC
Create product inventory record
PUT
Search job executions
POST
Create job execution
POST
Delete job execution
DELE
Read job execution
GET
Delete content asset
DELE
Get content asset
GET
Update content asset
PATC
Create content asset
PUT
Get assigned folders list
GET
Unassign content asset from folder
DELE
Get content folder assignment
GET
Update content folder assignment
PATC
Assign content asset to folder
PUT
Delete a folder
DELE
Get folder
GET
Update folder
PATC
Create folder
PUT
Get assigned content assets list
GET
Get sub folders
GET
Get locales
GET
Request log file
POST
Read logfetching execution status
GET
Api metrics
GET
Delete a client
DELE
Get all allowed resources for the client
GET
Add a client to existing ocapi configurations return errors when client already exists
POST
Add a client to existing ocapi configurations overwrite config if the client already exists
PUT
Get application permissions
GET
Get business manager permissions
GET
Get functional permissions
GET
Get locale permissions
GET
Get business manager module permissions
GET
Get web dav permissions
GET
Get permissions
GET
Get csc module permissions
GET
Search products
POST
Delete product
DELE
Get product
GET
Update product
PATC
Create product
PUT
Search variants
POST
Get variation groups
GET
Unassign variation group
DELE
Get variation group
GET
Update variation group
PATC
Assign variation group
PUT
Get variations
GET
Unassign variation product
DELE
Get variation
GET
Update variation
PATC
Assign variation
PUT
Get local and shared product options
GET
Delete local product option unbind shared product option
DELE
Get local or shared product option
GET
Update product option
PATC
Create local product option bind shared product option
PUT
Get local product option values
GET
Delete local product option value
DELE
Get local product option value
GET
Update local product option value
PATC
Create local product option value
PUT
Get variation attributes
GET
Get product variation attribute values
GET
Delete product variation attribute value
DELE
Get product variation attribute value
GET
Update product variation attribute value
PATC
Put product variation attribute value
PUT
Delete variation attribute
DELE
Get variation attribute
GET
Update variation attribute
PATC
Create variation attribute
PUT
Search public access roles
POST
Get public access roles
GET
Delete access role
DELE
Get access role
GET
Create access role
PUT
Get role permissions
GET
Set role permissions
PUT
Search for users on a public access role
POST
Get users assigned to an access role
GET
Unassign user to access role
DELE
Assign user to access role
PUT
Get custom log settings
GET
Update custom log settings
PATC
Search preferences
POST
Get preference
GET
Search sites
POST
Get sites
GET
Get site
GET
A b test search
POST
Get ab tests
GET
Unbind promotions
DELE
Bind promotion to a b test
PUT
Unbind slot configuration
DELE
Bind slot configuration
PUT
Unbind sorting rule
DELE
Bind sorting rule to a b test
PUT
Delete a b test
DELE
Get an a b test
GET
Update an a b test
PATC
Creates an a b test
PUT
Delete a b test segment
DELE
Get a b test segment
GET
Update a b test segment
PATC
Creates an a b test segment
PUT
Get recommenders
GET
Search campaigns
POST
Delete campaign
DELE
Get campaign
GET
Update campaign
PATC
Create campaign
PUT
Unbind coupon
DELE
Bind coupon
PUT
Unbind customer group
DELE
Bind customer group
PUT
Unbind promotion
DELE
Update promotion campaign assignment
PATC
Bind promotion to campaign
PUT
Unbind slot configuration
DELE
Update slot configuration campaign assignment
PATC
Bind slot configuration to campaign
PUT
Un bind sorting rule
DELE
Bind sorting rule to campaign
PUT
Unbind source code group
DELE
Bind source code group
PUT
Add a cartridge to cartridge path
POST
Overwrite cartridge path
PUT
Remove a cartridge from cartridge path
DELE
Search coupon redemptions
POST
Search coupons
POST
Get coupons
GET
Delete coupon
DELE
Get coupon
GET
Update coupon
PATC
Create coupon
PUT
Get campaigns
GET
Get promotions for campaign
GET
Get coupon codes
GET
Modify multiple codes
POST
Get promotions
GET
Delete site specific custom object
DELE
Read site specific custom object
GET
Update site specific custom object
PATC
Create site specific custom object
PUT
Search customer groups
POST
Get customer groups
GET
Delete customer group
DELE
Get customer group
GET
Update customer group
PATC
Create customer group
PUT
Search customer group members
POST
Get customer group members
GET
Put customer group member
DELE
Get customer group member
GET
Assign customer group member to group
PUT
Search gift certificates
POST
Get gift certificates
GET
Create gift certificate
POST
Delete gift certificates
DELE
Get gift certificate
GET
Update gift certificate
PATC
Get locales for given site
GET
Updates the order
PATC
Updates the order confirmation status
PUT
Updates the order export status
PUT
Updates the order external status
PUT
Updates the payment instrument of an order
PATC
Updates the transaction of an order payment instrument
PATC
Updates the order payment status
PUT
Updates create or replace the order shipment address
PUT
Updates the order shipping status
PUT
Updates the order status
PUT
Search promotion campaign assignments
POST
Search promotions
POST
Delete promotion
DELE
Get promotion
GET
Update promotion
PATC
Create promotion
PUT
Get custom site preferences
GET
Update custom site preferences
PATC
Search slot configuration campaign assignments
POST
Search slot configurations
POST
Get slot configurations
GET
Search slots
POST
Get slots
GET
Delete slot configuration
DELE
Get slot configuration
GET
Update slot configuration
PATC
Create slot configuration
PUT
Get slot
GET
Search product sorting rules
POST
Search source code groups
POST
Get source code groups
GET
Delete source code group
DELE
Get source code group
GET
Update source code group
PATC
Create source code group
PUT
Search stores
POST
Get stores
GET
Delete stores
DELE
Get store
GET
Update store
PATC
Create store
PUT
Search system objects
POST
Get system objects
GET
Get system object
GET
Search attribute definitions for system object
POST
Get attribute definitions for system object
GET
Delete attribute definition for system object
DELE
Get attribute definition for system object
GET
Update attribute definition for system object
PATC
Create attribute definition for system object
PUT
Search attribute groups for system object
POST
Get attribute groups for system object
GET
Un assign system object attribute definition from attribute group
DELE
Assign system object attribute definition to attribute group
PUT
Delete attribute groups for system object
DELE
Get attribute group for system object
GET
Update attribute group for system object
PATC
Create attribute group for system object
PUT
Search users
POST
Get users
GET
Get user password expiration information
GET
Change a local user password
PATC
Delete user
DELE
Get user
GET
Update user
PATC
Create user
PUT
Delete access key
DELE
Get access key
GET
Enable disable access key
PATC
Creates access key
PUT
Types
ab_test
ab_test_group
ab_test_search_result
ab_test_segment
ab_test_segment_stats
ab_test_trigger
ab_tests
access_key_details
access_key_update_request
account_transaction
alert_descriptor
alert_descriptor_settings
alert_descriptors
alert_descriptors_revalidation_request
alert_item
alert_items
alert_settings
application_permissions
bmpermissions
bool_filter
bool_query
campaign
campaign_search_result
campaigns
cartridge_path_add_request
cartridge_path_api_response
cartridge_path_create_request
catalog
catalog_category_id
catalog_search_result
catalogs
categories
category
category_link
category_links
category_product_assignment
category_product_assignment_search_request
category_product_assignment_search_result
category_search_result
cause
code_version
code_version_result
content_asset
content_asset_result
content_folder
content_folder_assignment
content_folder_result
content_sub_folder_result
coupon
coupon_code
coupon_codes
coupon_multi_codes_request
coupon_redemption
coupon_redemption_search_result
coupon_search_result
coupon_system_code_config
coupons
credentials
cscpermissions
custom_log_settings
custom_object
custom_object_search_result
customer
customer_address
customer_address_result
customer_group
customer_group_member
customer_group_member_search_result
customer_group_members
customer_group_search_result
customer_groups
customer_list
customer_list_link
customer_search_hit
customer_search_result
ecdn_log_fetch_request
ecdn_log_fetch_response
empty_body
fault
filter
filtered_query
functional_permission
functional_permissions
gift_certificate
gift_certificate_search_result
gift_certificates
image_group
inventory_list
inventory_list_search_result
inventory_lists
job_execution
job_execution_continue_information
job_execution_parameter
job_execution_request
job_execution_retry_information
job_execution_search_result
job_step_execution
locale
locale_permission
locale_permissions
locale_result
log_category
markup_text
master
match_all_query
media_file
menu_action
menu_item
metric_response
module_permissions
money
nested_query
object_attribute_definition
object_attribute_definition_search_result
object_attribute_definitions
object_attribute_group
object_attribute_group_search_result
object_attribute_groups
object_attribute_value_definition
object_type_definition
object_type_definition_search_result
object_type_definitions
ocapi_configs_api_request
ocapi_configs_api_response
order_confirmation_status_update_request
order_export_status_update_request
order_external_status_update_request
order_payment_status_update_request
order_shipping_status_update_request
order_status_update_request
order_update_request
organization_preferences
password_change_request
path_record
payment_instrument_update_request
payment_transaction_update_request
preference_value
preference_value_search_result
product
product_inventory_record
product_inventory_record_allocation
product_inventory_records
product_option
product_option_value
product_option_values
product_options
product_search_result
product_type
promotion
promotion_abtest_group_assignment
promotion_assignment_information
promotion_campaign_assignment
promotion_campaign_assignment_search_result
promotion_search_result
promotions
query
query_filter
range2_filter
range_filter
recommender
recommenders_result
recurrence
redemption_limit_per_period
redemption_limits
resource_info
resource_object
result_page
role
role_functional_permission
role_functional_permissions
role_locale_permission
role_locale_permissions
role_module_permission
role_module_permissions
role_permissions
role_search_request
role_search_result
role_webdav_permission
role_webdav_permissions
roles
rule
schedule
search_request
shipping_address_update_request
site
site_preferences
site_resource_info
site_search_result
sites
slot
slot_configuration
slot_configuration_abtest_group_assignment
slot_configuration_assignment_information
slot_configuration_campaign_assignment
slot_configuration_campaign_assignment_search_result
slot_configuration_search_result
slot_configurations
slot_content
slot_search_result
slots
sort
sorting_rule
sorting_rule_search_result
sorting_rule_step
source_code_group
source_code_group_search_result
source_code_groups
source_code_redirect_info
source_code_specification
status
status_metadata
store
store_search_result
stores
tag
term_filter
term_query
text_query
time_of_day
user
user_search_result
users
variant
variant_search_result
variants
variation_attribute
variation_attribute_value
variation_attribute_values
variation_attributes
variation_group
variation_groups
version_range_object
webdav_permission
webdav_permissions
Security
client_id - Api Key
oauth2_application - OAuth 2.0
OCAPI Shop API
External Reference Content
B2C Commerce Developer Sandbox REST API
Data API
24.1
Data API endpoints enable developers to build applications for merchants: Create, update, delete business objects, like products, customers, pricing and promotions or assignments. They typically provide read and write access and are designed for moderate usage.
https://{host}/s/-/dw/data/v24_1
https