Reference
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Open Commerce API
OCAPI Data API
OCAPI Shop API
Summary
Endpoints
Create basket
POST
Create a basket from a reference
POST
Remove a basket
DELE
Get basket
GET
Update the customer of a basket
PATC
Put a basket as agent basket
PUT
Get approaching discounts of a basket
GET
Set billing address of a basket
PUT
Update basket with coupon
POST
Remove coupon from basket
DELE
Update customer of basket
PUT
Add a gift certificate item to a basket
POST
Delete a gift certificate item from a basket
DELE
Updates a gift certificate item of a basket
PATC
Add items to a basket
POST
Remove product item from basket
DELE
Update an item of a basket
PATC
Get notes from a basket
GET
Add a note to a basket
POST
Remove a note from a basket
DELE
Add payment instrument to basket
POST
Removes a payment instrument from a basket
DELE
Updates payment instrument of basket
PATC
Get applicable payment methods for basket
GET
Add price adjustment to basket
POST
Remove price adjustment from basket
DELE
Updates a price adjustment on a basket
PATC
Create shipment for a basket
POST
Remove shipment from basket
DELE
Update shipment for a basket
PATC
Sets the shipping address of a shipment
PUT
Set shipping method to shipment
PUT
Get applicable shipping methods for certain shipment of basket
GET
Put a basket as storefront basket
PUT
Get multiple categories
GET
Get category
GET
Get multiple content
GET
Get content
GET
Search content
GET
Read custom object
GET
Register customer
POST
Invalidate an existing customer jwt json web token
DELE
Get or refresh customer jwt json web token
POST
Authorize trusted system client
POST
Get customer ext profile
GET
Register customer ext profile
POST
Reset password token
POST
Reset customer password
POST
Starts a password reset process
POST
Get a customer
GET
Update a customer
PATC
Get all customer addresses
GET
Create customer address
POST
Delete customer address
DELE
Get customer address
GET
Update customer address
PATC
Get an agent on behalf of customer token
POST
Get customer basket
GET
Get orders of customer
GET
Update a customer s password
PUT
Starts a password reset process for given customer
POST
Get customer payment instruments
GET
Add payment instrument for customer
POST
Delete customer payment instrument
DELE
Get customer payment instrument
GET
Get customer product lists
GET
Create customer product list
POST
Delete customer product list
DELE
Get customer product list
GET
Change customer product list
PATC
Get items of customer s product list
GET
Add item to customer s product list
POST
Remove item from customer s product list
DELE
Get an item of a customer product list
GET
Update customer s product list item
PATC
Get the purchases of a customer product list item
GET
Add a purchase to an item on a customer product list
POST
Get a purchase of a customer product list item
GET
Update a purchase of a customer product list item
PATC
Get multiple content folders
GET
Get content folder
GET
Get gift certificate
POST
Search orders
POST
Submit basket
POST
Get order
GET
Update order
PATC
Submit basket with given order number
PUT
Get notes from an order
GET
Add a note to an order
POST
Remove a note from an order
DELE
Add payment instrument to order
POST
Removes a payment instrument of an order
DELE
Updates payment instrument of order
PATC
Get applicable payment methods for an order
GET
Get price adjustment limits
GET
Get list of product lists
GET
Get product list
GET
Get product list items
GET
Get product list item
GET
Search products
GET
Search products availability
GET
Search products images
GET
Search products prices
GET
Search products represented products
GET
Search products variations
GET
Get multiple products
GET
Get single product
GET
Get product availability
GET
Get bundled products
GET
Get product images
GET
Get product links
GET
Get product options
GET
Get product prices
GET
Get product promotions
GET
Get product recommendations
GET
Get set products
GET
Get applicable shipping methods for certain product
GET
Get product variations
GET
Get multiple promotions by filter criteria
GET
Get multiple promotions by id
GET
Get promotion
GET
Get search suggestions
GET
Exchange jwt
POST
Get site
GET
Get nearest stores
GET
Get multiple stores
GET
Get store
GET
Types
approaching_discount
approaching_discount_result
auth_request
basket
basket_payment_instrument_request
basket_reference
baskets_result
bonus_discount_line_item
bool_filter
bool_query
bundled_product
category
category_result
cause
content
content_folder
content_folder_result
content_result
content_search_refinement
content_search_refinement_value
content_search_result
coupon_item
custom_object
customer
customer_address
customer_address_link
customer_address_result
customer_info
customer_order_result
customer_payment_card_request
customer_payment_instrument
customer_payment_instrument_request
customer_payment_instrument_result
customer_product_list
customer_product_list_item
customer_product_list_item_link
customer_product_list_item_purchase
customer_product_list_item_purchase_result
customer_product_list_item_result
customer_product_list_registrant
customer_product_list_result
customer_registration
customers_ext_profile
discount
discount_request
fault
filter
filtered_query
gift_certificate
gift_certificate_item
gift_certificate_request
grouped_tax
image
image_group
inventory
locale
master
match_all_query
nested_query
note
notes_result
option
option_item
option_value
order
order_address
order_payment_card_request
order_payment_instrument
order_payment_instrument_request
order_search_hit
order_search_request
order_search_result
password_change_request
password_reset
path_record
payment_bank_account
payment_bank_account_request
payment_card
payment_card_spec
payment_method
payment_method_result
price_adjustment
price_adjustment_limit
price_adjustment_limits
price_adjustment_request
product
product_details_link
product_item
product_link
product_list_event
product_list_item_reference
product_list_link
product_list_registrant
product_list_shipping_address
product_promotion
product_ref
product_result
product_search_hit
product_search_refinement
product_search_refinement_value
product_search_result
product_search_sorting_option
product_simple_link
product_type
promotion
promotion_link
promotion_result
public_product_list
public_product_list_item
public_product_list_item_result
public_product_list_link
public_product_list_result
query
query_filter
range2_filter
range_filter
recommendation
recommendation_type
reset_password_request
reset_password_token_request
reset_password_token_result
result_page
shipment
shipping_item
shipping_method
shipping_method_result
shipping_promotion
simple_link
site
sort
status
store
store_result
suggested_category
suggested_content
suggested_phrase
suggested_product
suggested_term
suggested_terms
suggestion
suggestion_result
term_filter
term_query
text_query
trusted_system_auth_request
variant
variation_attribute
variation_attribute_value
variation_group
Security
client_id - Api Key
customers_auth - Basic Authentication
oauth2_application - OAuth 2.0
External Reference Content
B2C Commerce Developer Sandbox REST API
Shop API
24.1
The Shop API endpoints enable developers to build full shopper-experience applications such as storefronts. They are designed for high-scale usage, and include a number of areas such as Baskets & Orders, Customers, Products and Pricing. Shop API endpoints are typically read-only APIs, with the exception of baskets and orders.
https://{host}/s/{siteId}/dw/shop/v24_1
https