Customer Service Center Hooks
Use the Shop API hooks to customize Customer Service Center.
The Shop API hooks use OCAPI version 17.8 except for dw.ocapi.shop.customer.modifyGETResponse, which uses OCAPI version 18.3.
| CSC Function | Resource | Shop API Hooks |
|---|
| Search orders | POST /order_search- The Created On (From) and Created On (To) search filter criteria are consolidated into one search filter criteria, Created On, which can define a date range.
- Previously, the two separate search filter criteria were required to filter a date range.
| dw.ocapi.shop.order_search.modifyPOSTResponse |
| Open an order | GET /orders/{order_no} | dw.ocapi.shop.order.modifyGETResponse |
| Add a note | POST /orders/{order_no}/notes | dw.ocapi.shop.order.note.modifyPOSTResponse |
| Customer Service Center Function | Resource | Shop API Hooks |
|---|
| New order | POST /baskets GET /baskets/{basket_id} | - dw.ocapi.shop.basket.modifyPOSTResponse
- dw.ocapi.shop.basket.modifyGETResponse
|
| Set Customer | PUT /baskets/{basket_id}/customer | - dw.ocapi.shop.basket.customer.beforePUT
- dw.ocapi.shop.basket.customer.afterPUT
- dw.ocapi.shop.basket.customer.modifyPUTResponse
|
| Set Billing Address | 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
|
| Set Shipping Address | 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
|
| Add Product | POST /baskets/{basket_id}/items | - dw.ocapi.shop.basket.items.beforePOST
- dw.ocapi.shop.basket.items.afterPOST
- dw.ocapi.shop.basket.items.modifyPOSTResponse
|
| Update Product Item (such as quantity and custom properties | PATCH /baskets/{basket_id}/items/{item_id} | - dw.ocapi.shop.basket.beforePATCHItem
- dw.ocapi.shop.basket.item.afterPATCHItem
- dw.ocapi.shop.basket.item.modifyPATCHResponse
|
| Remove a product item | 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
|
| Set shipping method | PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_method | - dw.ocapi.shop.basket.beforePUTShippingAddress
- dw.ocapi.shop.basket.afterPUTShippingAddress
- dw.ocapi.shop.basket.shipment.shipping_method.modifyPUTResponse
|
| Add Coupon | POST /baskets/{basket_id}/coupons | - dw.ocapi.shop.basket.coupon.beforePOST
- dw.ocapi.shop.basket.coupon.afterPOST
- dw.ocapi.shop.basket.coupon.modifyPOSTResponse
|
| Remove Coupon | 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
|
| Add Price Adjustment | 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
|
| Delete Price Adjustment | 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
|
| Submit Basket | POST /orders | - dw.ocapi.shop.order.beforePOST
- dw.ocapi.shop.order.afterPOST
- dw.ocapi.shop.order.modifyPOSTResponse
|
| Get Payment Methods | GET /baskets/{basket_id}/payment_methods (first payment selection) GET /orders/{order_no}/payment_methods | - dw.ocapi.shop.basket.payment_methods.modifyGETResponse
- dw.ocapi.shop.order.payment_methods.modifyGETResponse
|
| Add Payment Instrument | POST /orders/{order_no}/payment_instruments | - dw.ocapi.shop.order.payment_instrument.beforePOST
- dw.ocapi.shop.order.payment_instrument.afterPOST
- dw.ocapi.shop.order.payment_instrument.modifyPOSTResponse
- For payment integrations, use dw.order.hooks.PaymentHooks.
- dw.order.payment.authorize
- dw.order.payment.authorizeCreditCard
- dw.ocapi.shop.order.validateOrder
|
| Delete Payment Instrument | DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id} | - dw.ocapi.shop.order.payment_instrument.modifyDELETEResponse
- dw.ocapi.shop.order.validateOrder
|
| Guide | all basket resources | - dw.ocapi.shop.basket.validateBasket
|
| Customer Service Center Function | Resource | Shop API Hooks |
|---|
| View Customer | GET /customers/{customer_id} | - dw.ocapi.shop.customer.modifyGETResponse
- dw.ocapi.shop.customer.modifyGETResponse uses OCAPI version 18.3.
|
| Edit Customer | PATCH /customers/{customer_id} | - dw.ocapi.shop.customer.beforePATCHCustomer
- dw.ocapi.shop.customer.afterPATCHCustomer
- dw.ocapi.shop.customer.modifyPATCHResponse
|
| Create a Customer | POST /customers | - dw.ocapi.shop.customer.beforePost
- dw.ocapi.shop.customer.afterPost
- dw.ocapi.shop.customer.modifyPOSTResponse
|
| Reset Password | POST /customers/password_reset POST /customers/{customer_id}/password_reset | - dw.ocapi.shop.customers.password_reset.afterPOST
- dw.ocapi.shop.customer.password_reset.afterPOST The AfterPost hook triggers a customer password reset email.
|
| Create an Address | POST /customers/{customer_id}/addresses | - dw.ocapi.shop.customer.addresses.beforePOST
- dw.ocapi.shop.customer.addresses.afterPOST
- dw.ocapi.shop.customer.addresses.modifyPOSTResponse
|
| Edit Address | 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
|
| Delete Address | DELETE /customers/{customer_id}/addresses/{address_name} | - dw.ocapi.shop.customer.address.beforeDELETE
- dw.ocapi.shop.customer.address.afterDELETE
|