Hook List

The following table organizes the available hooks by category.

MethodSCAPI EndpointHook Name
DELETE.../baskets/{basketId}/coupons/{couponItemId}
  • dw.ocapi.shop.basket.coupon.beforeDELETE
  • dw.ocapi.shop.basket.coupon.afterDELETE
  • dw.ocapi.shop.basket.coupon.modifyDELETEResponse
  • dw.ocapi.shop.basket.validateBasket
GET.../baskets/{basketId}
  • dw.ocapi.shop.basket.beforeGET
  • dw.ocapi.shop.basket.modifyGETResponse
  • dw.ocapi.shop.basket.validateBasket
DELETE.../baskets/{basketId}
  • dw.ocapi.shop.basket.beforeDELETE
  • dw.ocapi.shop.basket.afterDELETE
PATCH.../baskets/{basketId}
  • dw.ocapi.shop.basket.beforePATCH
  • dw.ocapi.shop.basket.afterPATCH
  • dw.ocapi.shop.basket.modifyPATCHResponse
  • dw.ocapi.shop.basket.validateBasket
DELETE.../baskets/{basketId}/gift-certificate-items/{giftCertificateItemId}
  • 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/{basketId}/gift-certificate-items/{giftCertificateItemId}
  • dw.ocapi.shop.basket.gift_certificate_item.beforePATCH
  • dw.ocapi.shop.basket.gift_certificate_item.afterPATCH
  • dw.ocapi.shop.basket.gift_certificate_item.modifyPATCHResponse
DELETE.../baskets/{basketId}/items/{itemId}
  • dw.ocapi.shop.basket.item.beforeDELETE
  • dw.ocapi.shop.basket.item.afterDELETE
  • dw.ocapi.shop.basket.item.modifyDELETEResponse
  • dw.ocapi.shop.basket.validateBasket
PATCH.../baskets/{basketId}/items/{itemId}
  • 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/{basketId}/payment-instruments/{paymentInstrumentId}
  • 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
PATCH.../baskets/{basketId}/payment-instruments/{paymentInstrumentId}
  • 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/{basketId}/shipments/{shipmentId}
  • dw.ocapi.shop.basket.shipment.beforeDELETE
  • dw.ocapi.shop.basket.shipment.afterDELETE
  • dw.ocapi.shop.basket.shipment.modifyDELETEResponse
  • dw.ocapi.shop.basket.validateBasket
PATCH.../baskets/{basketId}/shipments/{shipmentId}
  • dw.ocapi.shop.basket.shipment.beforePATCH
  • dw.ocapi.shop.basket.shipment.afterPATCH
  • dw.ocapi.shop.basket.shipment.modifyPATCHResponse
  • dw.ocapi.shop.basket.validateBasket
DELETE.../orders/{orderNo}/payment-instruments/{paymentInstrumentId}
  • dw.ocapi.shop.order.payment_instrument.afterDELETE
  • dw.ocapi.shop.order.payment_instrument.modifyDELETEResponse
  • dw.ocapi.shop.order.payment_instrument.beforeDELETE
  • dw.ocapi.shop.order.validateOrder
PATCH.../orders/{orderNo}/payment-instruments/{paymentInstrumentId}
  • 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
GET.../baskets/{basketId}/payment-methods
  • dw.ocapi.shop.basket.payment_methods.beforeGET
  • dw.ocapi.shop.basket.payment_methods.afterGET
  • dw.ocapi.shop.basket.payment_methods.modifyGETResponse_v2
GET.../baskets/{basketId}/shipments/{shipmentId}/shipping-methods
  • dw.ocapi.shop.basket.shipments.shipping_methods.beforeGET
  • dw.ocapi.shop.basket.shipments.shipping_methods.modifyGETResponse_v2
GET.../orders/{orderNo}
  • dw.ocapi.shop.order.beforeGET
  • dw.ocapi.shop.order.modifyGETResponse
GET.../orders/{orderNo}/payment-methods
  • dw.ocapi.shop.order.payment_methods.beforeGET
  • dw.ocapi.shop.order.payment_methods.modifyGETResponse_v2
N/A.../baskets/{basketId}/price-books
  • N/A
N/A.../orders/{orderNo}/taxes
  • N/A
N/A.../baskets/{basketId}/taxes
  • N/A
POST.../baskets/{basketId}/coupons
  • dw.ocapi.shop.basket.coupon.beforePOST
  • dw.ocapi.shop.basket.coupon.afterPOST
  • dw.ocapi.shop.basket.coupon.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
POST.../baskets/{basketId}/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
POST.../baskets/{basketId}/items
  • dw.ocapi.shop.basket.items.beforePOST
  • dw.ocapi.shop.basket.items.afterPOST
  • dw.ocapi.shop.basket.items.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
POST.../baskets/{basketId}/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
POST.../baskets/{basketId}/shipments
  • dw.ocapi.shop.basket.shipment.beforePOST
  • dw.ocapi.shop.basket.shipment.afterPOST
  • dw.ocapi.shop.basket.shipment.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
POST.../baskets
  • dw.ocapi.shop.basket.beforePOST
  • dw.ocapi.shop.basket.afterPOST
  • dw.ocapi.shop.basket.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
POST.../baskets/actions/merge
  • dw.ocapi.baskets.actions.afterMerge
POST.../baskets/actions/transfer
  • dw.ocapi.baskets.actions.afterTransfer
POST.../orders
  • dw.ocapi.shop.order.beforePOST
  • dw.ocapi.shop.order.afterPOST
  • dw.ocapi.shop.order.modifyPOSTResponse
  • dw.ocapi.shop.basket.validateBasket
POST.../orders/{orderNo}/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
PUT.../baskets/{basketId}/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
PUT.../baskets/{basketId}/customer
  • dw.ocapi.shop.basket.customer.beforePUT
  • dw.ocapi.shop.basket.customer.afterPUT
  • dw.ocapi.shop.basket.customer.modifyPUTResponse
  • dw.ocapi.shop.basket.validateBasket
PUT.../baskets/{basketId}/shipments/{shipmentId}/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/{basketId}/shipments/{shipmentId}/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
N/A.../baskets/{basketId}/items/{itemId}/taxes
  • N/A
POST.../organizations/{organizationId}/orders
  • dw.scapi.orders.beforePOST
  • dw.scapi.orders.afterPOST
MethodSCAPI - EndpointHook Name
POST.../gift-certificate
  • dw.ocapi.shop.gift_certificate.beforePOST
  • dw.ocapi.shop.gift_certificate.modifyPOSTResponse
GET.../promotions/campaigns/{campaignId}
  • dw.ocapi.shop.promotions.beforeGET
  • dw.ocapi.shop.promotions.modifyGETResponse
GET.../promotions
  • dw.ocapi.shop.promotion.beforeGET
  • dw.ocapi.shop.promotion.modifyGETResponse
MethodSCAPI - EndpointHook Name
DELETE../customers/(customerId)/addresses/(addressName)
  • dw.ocapi.shop.customer.address.beforeDELETE
  • dw.ocapi.shop.customer.address.afterDELETE
DELETE../customers/(customerId)/payment-instruments/(paymentInstrumentId)
  • dw.ocapi.shop.customer.payment_instrument.beforeDELETE
  • dw.ocapi.shop.customer.payment_instrument.afterDELETE
DELETE../customers/(customerId)/product-lists/(listId)
  • dw.ocapi.shop.customer.product_list.beforeDELETE
  • dw.ocapi.shop.customer.product_list.afterDELETE
DELETE../customers/(customerId)/product-lists/(listId)/items/(itemId)
  • dw.ocapi.shop.customer.product_list.item.beforeDELETE
  • dw.ocapi.shop.customer.product_list.item.afterDELETE
DELETE../customers/actions/logout
  • dw.ocapi.shop.auth.beforePOST
  • dw.ocapi.shop.auth.afterPOST
  • dw.ocapi.shop.auth.modifyPOSTResponse
GET../customers/(customerId)
  • dw.ocapi.shop.customer.beforeGET
  • dw.ocapi.shop.customer.modifyGETResponse
GET../customers/(customerId)/addresses/(addressName)
  • dw.ocapi.shop.customer.addresses.beforeGET
  • dw.ocapi.shop.customer.addresses.modifyGETResponse
GET../customers/(customerId)/baskets
  • dw.ocapi.shop.customer.baskets.beforeGET
  • dw.ocapi.shop.customer.baskets.modifyGETResponse_v2
GET../customers/(customerId)/orders
  • dw.ocapi.shop.customer.orders.beforeGET
  • dw.ocapi.shop.customer.orders.modifyGETResponse_v2
GET../customers/(customerId)/payment-instruments/(paymentInstrumentId)
  • dw.ocapi.shop.customer.payment_instruments.beforeGET
  • dw.ocapi.shop.customer.payment_instruments.modifyGETResponse_v2
GET../customers/(customerId)/product-lists
  • dw.ocapi.shop.customer.product_lists.beforeGET
  • dw.ocapi.shop.customer.product_lists.modifyGETResponse_v3
GET../customers/(customerId)/product-lists/(listId)
  • dw.ocapi.shop.customer.product_list.beforeGET
  • dw.ocapi.shop.customer.product_list.modifyGETResponse
GET../customers/(customerId)/product-lists/(listId)/items/(itemId)
  • dw.ocapi.shop.customer.product_list.item.beforeGET
  • dw.ocapi.shop.customer.product_list.item.modifyGETResponse
GET../customers/external-profile
  • N/A
GET../product-lists
  • dw.ocapi.shop.customer.product_lists.beforeGET
  • dw.ocapi.shop.customer.product_lists.modifyGETResponse_v3
GET../product-lists/(listId)
  • dw.ocapi.shop.customer.product_list.beforeGET
  • dw.ocapi.shop.customer.product_list.modifyGETResponse
GET../product-lists/(listId)/items/(itemId)
  • dw.ocapi.shop.customer.product_list.item.beforeGET
  • dw.ocapi.shop.customer.product_list.item.modifyGETResponse
PATCH../customers/(customerId)
  • dw.ocapi.shop.customer.beforePATCH
  • dw.ocapi.shop.customer.afterPATCH
  • dw.ocapi.shop.customer.modifyGETResponse
PATCH../customers/(customerId)/addresses/(addressName)
  • dw.ocapi.shop.customer.address.beforePATCH
  • dw.ocapi.shop.customer.address.afterPATCH
  • dw.ocapi.shop.customer.address.modifyPATCHResponse
PATCH../customers/(customerId)/product-lists/(listId)
  • dw.ocapi.shop.customer.product_list.beforePATCH
  • dw.ocapi.shop.customer.product_list.afterPATCH
  • dw.ocapi.shop.customer.product_list.modifyPATCHResponse
PATCH../customers/(customerId)/product-lists/(listId)/items/(itemId)
  • dw.ocapi.shop.customer.product_list.item.beforePATCH
  • dw.ocapi.shop.customer.product_list.item.afterPATCH
  • dw.ocapi.shop.customer.product_list.item.modifyPATCHResponse
POST../customers
  • dw.ocapi.shop.customer.beforePOST
  • dw.ocapi.shop.customer.afterPOST
  • dw.ocapi.shop.customer.modifyPOSTResponse
POST../customers/(customerId)/addresses
  • dw.ocapi.shop.customer.addresses.beforePOST
  • dw.ocapi.shop.customer.addresses.afterPOST
  • dw.ocapi.shop.customer.addresses.modifyGETResponse
POST../customers/(customerId)/payment-instruments
  • dw.ocapi.shop.customer.payment_instrument.beforePOST
  • dw.ocapi.shop.customer.payment_instrument.afterPOST
  • dw.ocapi.shop.customer.payment_instrument.modifyPOSTResponse
POST../customers/(customerId)/product-lists
  • dw.ocapi.shop.customer.product_lists.beforePOST
  • dw.ocapi.shop.customer.product_lists.afterPOST
  • dw.ocapi.shop.customer.product_list.modifyPOSTResponse
POST../customers/(customerId)/product-lists/(listId)/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
POST../customers/actions/login
  • dw.ocapi.shop.customer.auth.beforePOST
  • dw.ocapi.shop.customer.auth.afterPOST
  • dw.ocapi.shop.customer.auth.modifyPOSTResponse
POST../customers/external-profile
  • N/A
POST../customers/password/actions/create-reset-token
  • N/A
POST../customers/password/actions/reset
  • N/A
POST../customers/trusted-system/actions/login
  • N/A
PUT../customers/(customerId)/password
  • N/A
MethodSCAPI - EndpointHook Name
GET../categories/(id)
  • dw.ocapi.shop.category.beforeGET
  • dw.ocapi.shop.category.modifyGETResponse
GET../categories
  • dw.ocapi.shop.category.beforeGET
  • dw.ocapi.shop.category.modifyGETResponse
GET../products
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET../products/(id)
  • dw.ocapi.shop.product.beforeGET
  • dw.ocapi.shop.product.modifyGETResponse
GET../product-search
  • dw.ocapi.shop.product_search.beforeGET
  • dw.ocapi.shop.product_search.modifyGETResponse
GET../search-suggestions
  • dw.ocapi.shop.search_suggestion.beforeGET
  • dw.ocapi.shop.search_suggestion.modifyGETResponse
MethodSCAPI - EndpointHook Name
GET/url-mapping
  • dw.shop.seo.url_mapping.beforeGET
  • dw.shop.seo.url_mapping.modifyGETResponse

For information about using the getUrlMapping endpoint, see the URL Resolution guide.