Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > OCAPI Usage 23.2

OCAPI Hooks

The following hooks exist in version 23.2:

Shop API

Request Method Request Path Extension Points
POST /baskets
  • dw.ocapi.shop.basket.beforePOST_v2
  • dw.ocapi.shop.basket.afterPOST
  • dw.ocapi.shop.basket.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
POST /baskets/reference
  • dw.ocapi.shop.basket.reference.beforePOST
  • dw.ocapi.shop.basket.reference.afterPOST
  • dw.ocapi.shop.basket.reference.modifyPOSTResponse
GET /baskets/{basket_id}
  • dw.ocapi.shop.basket.beforeGET
  • dw.ocapi.shop.basket.modifyGETResponse
  • dw.ocapi.shop.basket.validateBasket
PATCH /baskets/{basket_id}
  • dw.ocapi.shop.basket.beforePATCH
  • dw.ocapi.shop.basket.afterPATCH
  • dw.ocapi.shop.basket.modifyPATCHResponse
  • dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}
  • dw.ocapi.shop.basket.beforeDELETE
  • dw.ocapi.shop.basket.afterDELETE
PUT /baskets/{basket_id}/agent
  • dw.ocapi.shop.basket.agent.beforePUT
  • dw.ocapi.shop.basket.agent.afterPUT
  • dw.ocapi.shop.basket.agent.modifyPUTResponse
GET /baskets/{basket_id}/approaching_discounts
  • dw.ocapi.shop.basket.approaching_discounts.beforeGET
  • dw.ocapi.shop.basket.approaching_discounts.modifyGETResponse
PUT /baskets/{basket_id}/billing_address
  • dw.ocapi.shop.basket.billing_address.beforePUT
  • dw.ocapi.shop.basket.billing_address.afterPUT
  • dw.ocapi.shop.basket.billing_address.modifyPUTResponse
  • dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/coupons
  • dw.ocapi.shop.basket.coupon.beforePOST
  • dw.ocapi.shop.basket.coupon.afterPOST
  • dw.ocapi.shop.basket.coupon.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/coupons/{coupon_item_id}
  • dw.ocapi.shop.basket.coupon.beforeDELETE
  • dw.ocapi.shop.basket.coupon.afterDELETE
  • dw.ocapi.shop.basket.coupon.modifyDELETEResponse
  • dw.ocapi.shop.basket.validateBasket
PUT /baskets/{basket_id}/customer
  • dw.ocapi.shop.basket.customer.beforePUT
  • dw.ocapi.shop.basket.customer.afterPUT
  • dw.ocapi.shop.basket.customer.modifyPUTResponse
  • dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/gift_certificate_items
  • dw.ocapi.shop.basket.gift_certificate_item.beforePOST
  • dw.ocapi.shop.basket.gift_certificate_item.afterPOST
  • dw.ocapi.shop.basket.gift_certificate_item.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id}
  • dw.ocapi.shop.basket.gift_certificate_item.beforeDELETE
  • dw.ocapi.shop.basket.gift_certificate_item.afterDELETE
  • dw.ocapi.shop.basket.gift_certificate_item.modifyDELETEResponse
PATCH /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id}
  • dw.ocapi.shop.basket.gift_certificate_item.beforePATCH
  • dw.ocapi.shop.basket.gift_certificate_item.afterPATCH
  • dw.ocapi.shop.basket.gift_certificate_item.modifyPATCHResponse
POST /baskets/{basket_id}/items
  • dw.ocapi.shop.basket.items.beforePOST
  • dw.ocapi.shop.basket.items.afterPOST
  • dw.ocapi.shop.basket.items.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
PATCH /baskets/{basket_id}/items/{item_id}
  • dw.ocapi.shop.basket.item.beforePATCH
  • dw.ocapi.shop.basket.item.afterPATCH
  • dw.ocapi.shop.basket.item.modifyPATCHResponse
  • dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/items/{item_id}
  • dw.ocapi.shop.basket.item.beforeDELETE
  • dw.ocapi.shop.basket.item.afterDELETE
  • dw.ocapi.shop.basket.item.modifyDELETEResponse
  • dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/notes
  • dw.ocapi.shop.basket.note.beforePOST
  • dw.ocapi.shop.basket.note.afterPOST
  • dw.ocapi.shop.basket.note.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
GET /baskets/{basket_id}/notes
  • dw.ocapi.shop.basket.notes.beforeGET
  • dw.ocapi.shop.basket.notes.modifyGETResponse_v2
DELETE /baskets/{basket_id}/notes/{note_id}
  • dw.ocapi.shop.basket.note.beforeDELETE
  • dw.ocapi.shop.basket.note.afterDELETE
  • dw.ocapi.shop.basket.note.modifyDELETEResponse
  • dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/payment_instruments
  • dw.ocapi.shop.basket.payment_instrument.beforePOST
  • dw.ocapi.shop.basket.payment_instrument.afterPOST
  • dw.ocapi.shop.basket.payment_instrument.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
PATCH /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
  • dw.ocapi.shop.basket.payment_instrument.beforePATCH
  • dw.ocapi.shop.basket.payment_instrument.afterPATCH
  • dw.ocapi.shop.basket.payment_instrument.modifyPATCHResponse
  • dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
  • dw.ocapi.shop.basket.payment_instrument.beforeDELETE
  • dw.ocapi.shop.basket.payment_instrument.afterDELETE
  • dw.ocapi.shop.basket.payment_instrument.modifyDELETEResponse
  • dw.ocapi.shop.basket.validateBasket
GET /baskets/{basket_id}/payment_methods
  • dw.ocapi.shop.basket.payment_methods.beforeGET
  • dw.ocapi.shop.basket.payment_methods.afterGET
  • dw.ocapi.shop.basket.payment_methods.modifyGETResponse_v2
POST /baskets/{basket_id}/price_adjustments
  • dw.ocapi.shop.basket.price_adjustment.beforePOST
  • dw.ocapi.shop.basket.price_adjustment.afterPOST
  • dw.ocapi.shop.basket.price_adjustment.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/price_adjustments/{price_adjustment_id}
  • dw.ocapi.shop.basket.price_adjustment.beforeDELETE
  • dw.ocapi.shop.basket.price_adjustment.afterDELETE
  • dw.ocapi.shop.basket.price_adjustment.modifyDELETEResponse
  • dw.ocapi.shop.basket.validateBasket
PATCH /baskets/{basket_id}/price_adjustments/{price_adjustment_id}
  • dw.ocapi.shop.basket.price_adjustment.beforePATCH
  • dw.ocapi.shop.basket.price_adjustment.afterPATCH
  • dw.ocapi.shop.basket.price_adjustment.modifyPATCHResponse
POST /baskets/{basket_id}/shipments
  • dw.ocapi.shop.basket.shipment.beforePOST
  • dw.ocapi.shop.basket.shipment.afterPOST
  • dw.ocapi.shop.basket.shipment.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
PATCH /baskets/{basket_id}/shipments/{shipment_id}
  • dw.ocapi.shop.basket.shipment.beforePATCH
  • dw.ocapi.shop.basket.shipment.afterPATCH
  • dw.ocapi.shop.basket.shipment.modifyPATCHResponse
  • dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/shipments/{shipment_id}
  • dw.ocapi.shop.basket.shipment.beforeDELETE
  • dw.ocapi.shop.basket.shipment.afterDELETE
  • dw.ocapi.shop.basket.shipment.modifyDELETEResponse
  • dw.ocapi.shop.basket.validateBasket
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_address
  • dw.ocapi.shop.basket.shipment.shipping_address.beforePUT
  • dw.ocapi.shop.basket.shipment.shipping_address.afterPUT
  • dw.ocapi.shop.basket.shipment.shipping_address.modifyPUTResponse
  • dw.ocapi.shop.basket.validateBasket
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_method
  • dw.ocapi.shop.basket.shipment.shipping_method.beforePUT
  • dw.ocapi.shop.basket.shipment.shipping_method.afterPUT
  • dw.ocapi.shop.basket.shipment.shipping_method.modifyPUTResponse
  • dw.ocapi.shop.basket.validateBasket
GET /baskets/{basket_id}/shipments/{shipment_id}/shipping_methods
  • dw.ocapi.shop.basket.shipments.shipping_methods.beforeGET
  • dw.ocapi.shop.basket.shipments.shipping_methods.modifyGETResponse_v2
PUT /baskets/{basket_id}/storefront
  • dw.ocapi.shop.basket.storefront.beforePUT
  • dw.ocapi.shop.basket.storefront.afterPUT
  • dw.ocapi.shop.basket.storefront.modifyPUTResponse
GET /categories/({id},...,{id})
  • dw.ocapi.shop.category.beforeGET
  • dw.ocapi.shop.category.modifyGETResponse
GET /categories/{id}
  • dw.ocapi.shop.category.beforeGET
  • dw.ocapi.shop.category.modifyGETResponse
GET /content/({id},...,{id})
  • dw.ocapi.shop.content.beforeGET
  • dw.ocapi.shop.content.modifyGETResponse
GET /content/{id}
  • dw.ocapi.shop.content.beforeGET
  • dw.ocapi.shop.content.modifyGETResponse
GET /content_search
  • dw.ocapi.shop.content_search.beforeGET
  • dw.ocapi.shop.content_search.modifyGETResponse
GET /custom_objects/{object_type}/{key}
  • dw.ocapi.shop.custom_object.beforeGET
  • dw.ocapi.shop.custom_object.modifyGETResponse
POST /customers
  • dw.ocapi.shop.customer.beforePOST
  • dw.ocapi.shop.customer.afterPOST
  • dw.ocapi.shop.customer.modifyPOSTResponse
POST /customers/auth
  • dw.ocapi.shop.auth.beforePOST
  • dw.ocapi.shop.auth.afterPOST
  • dw.ocapi.shop.auth.modifyPOSTResponse
POST /customers/password_reset
  • dw.ocapi.shop.customers.password_reset.beforePOST
  • dw.ocapi.shop.customers.password_reset.afterPOST
GET /customers/{customer_id}
  • dw.ocapi.shop.customer.beforeGET
  • dw.ocapi.shop.customer.modifyGETResponse
PATCH /customers/{customer_id}
  • dw.ocapi.shop.customer.beforePATCH
  • dw.ocapi.shop.customer.afterPATCH
  • dw.ocapi.shop.customer.modifyPATCHResponse
GET /customers/{customer_id}/addresses
  • dw.ocapi.shop.customer.addresses.beforeGET
  • dw.ocapi.shop.customer.addresses.modifyGETResponse
POST /customers/{customer_id}/addresses
  • dw.ocapi.shop.customer.addresses.beforePOST
  • dw.ocapi.shop.customer.addresses.afterPOST
  • dw.ocapi.shop.customer.address.modifyPOSTResponse
GET /customers/{customer_id}/addresses/{address_name}
  • dw.ocapi.shop.customer.address.beforeGET
  • dw.ocapi.shop.customer.address.modifyGETResponse
DELETE /customers/{customer_id}/addresses/{address_name}
  • dw.ocapi.shop.customer.address.beforeDELETE
  • dw.ocapi.shop.customer.address.afterDELETE
PATCH /customers/{customer_id}/addresses/{address_name}
  • dw.ocapi.shop.customer.address.beforePATCH
  • dw.ocapi.shop.customer.address.afterPATCH
  • dw.ocapi.shop.customer.address.modifyPATCHResponse
POST /customers/{customer_id}/auth
  • dw.ocapi.shop.customer.auth.beforePOST
  • dw.ocapi.shop.customer.auth.afterPOST
  • dw.ocapi.shop.customer.auth.modifyPOSTResponse
GET /customers/{customer_id}/baskets
  • dw.ocapi.shop.customer.baskets.beforeGET
  • dw.ocapi.shop.customer.baskets.modifyGETResponse_v2
GET /customers/{customer_id}/orders
  • dw.ocapi.shop.customer.orders.beforeGET
  • dw.ocapi.shop.customer.orders.modifyGETResponse_v2
POST /customers/{customer_id}/password_reset
  • dw.ocapi.shop.customer.password_reset.beforePOST
  • dw.ocapi.shop.customer.password_reset.afterPOST
GET /customers/{customer_id}/payment_instruments
  • dw.ocapi.shop.customer.payment_instruments.beforeGET
  • dw.ocapi.shop.customer.payment_instruments.modifyGETResponse_v2
POST /customers/{customer_id}/payment_instruments
  • dw.ocapi.shop.customer.payment_instrument.beforePOST
  • dw.ocapi.shop.customer.payment_instrument.afterPOST
  • dw.ocapi.shop.customer.payment_instrument.modifyPOSTResponse
GET /customers/{customer_id}/payment_instruments/{payment_instrument_id}
  • dw.ocapi.shop.customer.payment_instrument.beforeGET
  • dw.ocapi.shop.customer.payment_instrument.modifyGETResponse
DELETE /customers/{customer_id}/payment_instruments/{payment_instrument_id}
  • dw.ocapi.shop.customer.payment_instrument.beforeDELETE
  • dw.ocapi.shop.customer.payment_instrument.afterDELETE
GET /customers/{customer_id}/product_lists
  • dw.ocapi.shop.customer.product_lists.beforeGET
  • dw.ocapi.shop.customer.product_lists.modifyGETResponse_v3
POST /customers/{customer_id}/product_lists
  • dw.ocapi.shop.customer.product_lists.beforePOST
  • dw.ocapi.shop.customer.product_lists.afterPOST
  • dw.ocapi.shop.customer.product_list.modifyPOSTResponse
GET /customers/{customer_id}/product_lists/{list_id}
  • dw.ocapi.shop.customer.product_list.beforeGET
  • dw.ocapi.shop.customer.product_list.modifyGETResponse
PATCH /customers/{customer_id}/product_lists/{list_id}
  • dw.ocapi.shop.customer.product_list.beforePATCH
  • dw.ocapi.shop.customer.product_list.afterPATCH
  • dw.ocapi.shop.customer.product_list.modifyPATCHResponse
DELETE /customers/{customer_id}/product_lists/{list_id}
  • dw.ocapi.shop.customer.product_list.beforeDELETE
  • dw.ocapi.shop.customer.product_list.afterDELETE
GET /customers/{customer_id}/product_lists/{list_id}/items
  • dw.ocapi.shop.customer.product_list.items.beforeGET
  • dw.ocapi.shop.customer.product_list.items.modifyGETResponse_v2
POST /customers/{customer_id}/product_lists/{list_id}/items
  • dw.ocapi.shop.customer.product_list.items.beforePOST
  • dw.ocapi.shop.customer.product_list.items.afterPOST
  • dw.ocapi.shop.customer.product_list.item.modifyPOSTResponse
GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}
  • dw.ocapi.shop.customer.product_list.item.beforeGET
  • dw.ocapi.shop.customer.product_list.item.modifyGETResponse
DELETE /customers/{customer_id}/product_lists/{list_id}/items/{item_id}
  • dw.ocapi.shop.customer.product_list.item.beforeDELETE
  • dw.ocapi.shop.customer.product_list.item.afterDELETE
PATCH /customers/{customer_id}/product_lists/{list_id}/items/{item_id}
  • dw.ocapi.shop.customer.product_list.item.beforePATCH
  • dw.ocapi.shop.customer.product_list.item.afterPATCH
  • dw.ocapi.shop.customer.product_list.item.modifyPATCHResponse
GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases
  • dw.ocapi.shop.customer.product_list.item.purchases.beforeGET
  • dw.ocapi.shop.customer.product_list.item.purchases.modifyGETResponse_v2
POST /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases
  • dw.ocapi.shop.customer.product_list.item.purchases.beforePOST
  • dw.ocapi.shop.customer.product_list.item.purchases.afterPOST
  • dw.ocapi.shop.customer.product_list.item.purchases.modifyPOSTResponse
GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases/{purchase_id}
  • dw.ocapi.shop.customer.product_list.item.purchase.beforeGET
  • dw.ocapi.shop.customer.product_list.item.purchase.modifyGETResponse
PATCH /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases/{purchase_id}
  • dw.ocapi.shop.customer.product_list.item.purchase.beforePATCH
  • dw.ocapi.shop.customer.product_list.item.purchase.afterPATCH
  • dw.ocapi.shop.customer.product_list.item.purchase.modifyPATCHResponse
GET /folders/({id},...,{id})
  • dw.ocapi.shop.folder.beforeGET
  • dw.ocapi.shop.folder.modifyGETResponse
GET /folders/{id}
  • dw.ocapi.shop.folder.beforeGET
  • dw.ocapi.shop.folder.modifyGETResponse
POST /gift_certificate
  • dw.ocapi.shop.gift_certificate.beforePOST
  • dw.ocapi.shop.gift_certificate.modifyPOSTResponse
POST /order_search
  • dw.ocapi.shop.order_search.modifyPOSTResponse
POST /orders
  • dw.ocapi.shop.order.beforePOST
  • dw.ocapi.shop.order.afterPOST
  • dw.ocapi.shop.order.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
PUT /orders/{order_no}
  • dw.ocapi.shop.order.beforePUT
  • dw.ocapi.shop.order.afterPUT
  • dw.ocapi.shop.order.modifyPUTResponse
GET /orders/{order_no}
  • dw.ocapi.shop.order.beforeGET
  • dw.ocapi.shop.order.modifyGETResponse
PATCH /orders/{order_no}
  • dw.ocapi.shop.order.beforePATCH
  • dw.ocapi.shop.order.afterPATCH
  • dw.ocapi.shop.order.modifyPATCHResponse
POST /orders/{order_no}/notes
  • dw.ocapi.shop.order.note.beforePOST
  • dw.ocapi.shop.order.note.modifyPOSTResponse
GET /orders/{order_no}/notes
  • dw.ocapi.shop.order.notes.beforeGET
  • dw.ocapi.shop.order.notes.modifyGETResponse_v2
DELETE /orders/{order_no}/notes/{note_id}
  • dw.ocapi.shop.order.note.beforeDELETE
  • dw.ocapi.shop.order.note.afterDELETE
  • dw.ocapi.shop.order.note.modifyDELETEResponse
POST /orders/{order_no}/payment_instruments
  • dw.ocapi.shop.order.validateOrder
  • dw.ocapi.shop.order.payment_instrument.modifyPOSTResponse
  • dw.order.payment.authorize
  • dw.ocapi.shop.order.payment_instrument.beforePOST
  • dw.order.payment.authorizeCreditCard
  • dw.ocapi.shop.order.payment_instrument.afterPOST
PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id}
  • dw.ocapi.shop.order.payment_instrument.afterPATCH
  • dw.ocapi.shop.order.payment_instrument.modifyPATCHResponse
  • dw.ocapi.shop.order.payment_instrument.beforePATCH
  • dw.ocapi.shop.order.validateOrder
  • dw.order.payment.authorize
  • dw.order.payment.authorizeCreditCard
DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id}
  • dw.ocapi.shop.order.validateOrder
  • dw.ocapi.shop.order.payment_instrument.beforeDELETE
  • dw.ocapi.shop.order.payment_instrument.afterDELETE
  • dw.ocapi.shop.order.payment_instrument.modifyDELETEResponse
GET /orders/{order_no}/payment_methods
  • dw.ocapi.shop.order.payment_methods.beforeGET
  • dw.ocapi.shop.order.payment_methods.modifyGETResponse_v2
GET /price_adjustment_limits
  • dw.ocapi.shop.price_adjustment_limits.beforeGET
  • dw.ocapi.shop.price_adjustment_limits.modifyGETResponse
GET /product_lists
  • dw.ocapi.shop.product_lists.beforeGET
  • dw.ocapi.shop.product_lists.modifyGETResponse
GET /product_lists/{list_id}
  • dw.ocapi.shop.product_list.beforeGET
  • dw.ocapi.shop.product_list.modifyGETResponse
GET /product_lists/{list_id}/items
  • dw.ocapi.shop.product_list.items.beforeGET
  • dw.ocapi.shop.product_list.items.modifyGETResponse
GET /product_lists/{list_id}/items/{item_id}
  • dw.ocapi.shop.product_list.item.beforeGET
  • dw.ocapi.shop.product_list.item.modifyGETResponse
GET /product_search
  • dw.ocapi.shop.product_search.beforeGET
  • dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search/availability
  • dw.ocapi.shop.product_search.beforeGET
  • dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search/images
  • dw.ocapi.shop.product_search.beforeGET
  • dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search/prices
  • dw.ocapi.shop.product_search.beforeGET
  • dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search/represented_products
  • dw.ocapi.shop.product_search.beforeGET
  • dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search/variations
  • dw.ocapi.shop.product_search.beforeGET
  • dw.ocapi.shop.product_search.modifyGETResponse
GET /products/({id},...,{id})
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/availability
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/bundled_products
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/images
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/links
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/options
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/prices
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/promotions
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/recommendations
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/set_products
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/shipping_methods
  • dw.ocapi.shop.product.shipping_methods.beforeGET
  • dw.ocapi.shop.product.shipping_methods.modifyGETResponse_v2
GET /products/{id}/variations
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET /promotions
  • dw.ocapi.shop.promotions.beforeGET
  • dw.ocapi.shop.promotions.modifyGETResponse
GET /promotions/({id},...,{id})
  • dw.ocapi.shop.promotion.beforeGET
  • dw.ocapi.shop.promotion.modifyGETResponse
GET /promotions/{id}
  • dw.ocapi.shop.promotion.beforeGET
  • dw.ocapi.shop.promotion.modifyGETResponse
GET /search_suggestion
  • dw.ocapi.shop.search_suggestion.beforeGET
  • dw.ocapi.shop.search_suggestion.modifyGETResponse
GET /site
  • dw.ocapi.shop.site.beforeGET
  • dw.ocapi.shop.site.modifyGETResponse
GET /stores
  • dw.ocapi.shop.stores.modifyGETResponse
  • dw.ocapi.shop.stores.beforeGET
GET /stores/({id},...,{id})
  • dw.ocapi.shop.store.modifyGETResponse
GET /stores/{id}
  • dw.ocapi.shop.store.modifyGETResponse
  • dw.ocapi.shop.store.beforeGET

Data API

Request Method Request Path Extension Points
PUT /custom_objects/{object_type}/{key}
  • dw.ocapi.data.object.beforePut
  • dw.ocapi.data.object.afterPut
DELETE /custom_objects/{object_type}/{key}
  • dw.ocapi.data.object.beforeDelete
  • dw.ocapi.data.object.afterDelete
PATCH /custom_objects/{object_type}/{key}
  • dw.ocapi.data.object.beforePatch
  • dw.ocapi.data.object.afterPatch
POST /customer_lists/{list_id}/customers
  • dw.ocapi.data.customer_list.customers.beforePOST
  • dw.ocapi.data.customer_list.customers.afterPOST
PATCH /customer_lists/{list_id}/customers/{customer_no}
  • dw.ocapi.data.customer_list.customer.beforePATCH
  • dw.ocapi.data.customer_list.customer.afterPATCH
DELETE /customer_lists/{list_id}/customers/{customer_no}
  • dw.ocapi.data.customer_list.customer.beforeDELETE
  • dw.ocapi.data.customer_list.customer.afterDELETE
PUT /customer_lists/{list_id}/customers/{customer_no}
  • dw.ocapi.data.customer_list.customers.beforePUT
  • dw.ocapi.data.customer_list.customers.afterPUT
POST /customer_lists/{list_id}/customers/{customer_no}/addresses
  • dw.ocapi.data.customer_list.customer.addresses.beforePOST
  • dw.ocapi.data.customer_list.customer.addresses.afterPOST
PATCH /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id}
  • dw.ocapi.data.customer_list.customer.address.beforePATCH
  • dw.ocapi.data.customer_list.customer.address.afterPATCH
DELETE /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id}
  • dw.ocapi.data.customer_list.customer.address.beforeDELETE
  • dw.ocapi.data.customer_list.customer.address.afterDELETE
PUT /libraries/{library_id}/content/{content_id}
  • dw.ocapi.data.content.content.beforeCreate
  • dw.ocapi.data.content.content.afterCreate
DELETE /libraries/{library_id}/content/{content_id}
  • dw.ocapi.data.content.content.beforeDelete
  • dw.ocapi.data.content.content.afterDelete
PATCH /libraries/{library_id}/content/{content_id}
  • dw.ocapi.data.content.content.beforeUpdate
  • dw.ocapi.data.content.content.afterUpdate
PUT /libraries/{library_id}/folders/{folder_id}
  • dw.ocapi.data.content.folder.beforeCreate
  • dw.ocapi.data.content.folder.afterCreate
DELETE /libraries/{library_id}/folders/{folder_id}
  • dw.ocapi.data.content.folder.beforeDelete
  • dw.ocapi.data.content.folder.afterDelete
PATCH /libraries/{library_id}/folders/{folder_id}
  • dw.ocapi.data.content.folder.beforeUpdate
  • dw.ocapi.data.content.folder.afterUpdate
PUT /sites/{site_id}/custom_objects/{object_type}/{key}
  • dw.ocapi.data.object.beforePut
  • dw.ocapi.data.object.afterPut
DELETE /sites/{site_id}/custom_objects/{object_type}/{key}
  • dw.ocapi.data.object.beforeDelete
  • dw.ocapi.data.object.afterDelete
PATCH /sites/{site_id}/custom_objects/{object_type}/{key}
  • dw.ocapi.data.object.beforePatch
  • dw.ocapi.data.object.afterPatch
PATCH /users/this/password
  • dw.ocapi.data.users.afterPATCH
Related concepts
Using Hooks Securely

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.