jDID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!
この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
Shop API 23.1 の OCAPI フック
OCAPI のバージョン 23.1 では以下のフックを使用できます。
Auth
Shop API の Auth フック。
dw.ocapi.shop.auth.afterPOST
POST /customers/auth
メソッドの詳細
afterPOST (customer : dw.customer.Customer, authRequestType : dw.value.EnumValue) : dw.system.Status
この関数は、顧客が認証された後に呼び出されます。
- パラメーター:
- customer - 認証された顧客
- authRequestType - リクエストがゲスト、ログイン、または認証の更新を指定するか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.auth.beforePOST
POST /customers/auth
メソッドの詳細
beforePOST (authorizationHeader : String, authRequestType : dw.value.EnumValue) : dw.system.Status
この関数は、顧客が認証される前に呼び出されます。
- パラメーター:
- authorizationHeader - 認証ヘッダー。 タイプによって異なります。
- guest - 認証に関連するコンテンツなし。
- credentials - Base64 でエンコードされたユーザー名とパスワード。例: Authorization:Basic dXNlcm5hbWU6cGFzc3dvcmQ=。ユーザー名またはパスワードを抽出できます:
var credentials = authHeader.substr(6); // cut out Basic var base64decoded : String = StringUtils.decodeBase64(credentials, "UTF-8"); var userName : String = base64decoded.split(":")[0]; var password : String = base64decoded.split(":")[1]; - refresh - 更新トークン。例: Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX
- session - 認証に関連するコンテンツなし。クッキーに基づく認証。
- authRequestType - リクエストがゲスト、ログイン、または認証の更新を指定するか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.auth.modifyPOSTResponse
POST /customers/auth
メソッドの詳細
modifyPOSTResponse (customer : dw.customer.Customer, customerResponse : Customer, authRequestType : dw.value.EnumValue) : dw.system.Status
- パラメーター:
- customer - 認証の顧客
- customerResponse - 顧客のレスポンスオブジェクト
- authRequestType - 認証リクエストタイプの列挙
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
買い物カゴ
Shop API の Basket (買い物カゴ) フック。
dw.ocapi.shop.basket.afterDELETE
DELETE /baskets/{basket_id}
メソッドの詳細
afterDELETE (basketId : String) : dw.system.Status
この関数は、買い物カゴが削除された後に呼び出されます。
- パラメーター:
- basketId - 削除された買い物カゴの ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.afterPATCH
PATCH /baskets/{basket_id}
メソッドの詳細
afterPATCH (basket : dw.order.Basket, basketInput : Basket) : dw.system.Status
この関数は、買い物カゴが更新された後に呼び出されます。
- パラメーター:
- basket - the basket that was updated
- basketInput - 必要な変更を含む買い物カゴの差分
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.afterPOST
POST /baskets
メソッドの詳細
afterPOST (basket : dw.order.Basket) : dw.system.Status
この関数は、買い物カゴが作成された後に呼び出されます。
- パラメーター:
- basket - 作成された買い物カゴ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.agent.afterPUT
PUT /baskets/{basket_id}/agent
メソッドの詳細
afterPUT (basket : dw.order.Basket) : dw.system.Status
この関数は、買い物カゴのエージェント買い物カゴとしての送信の後に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.agent.beforePUT
PUT /baskets/{basket_id}/agent
メソッドの詳細
beforePUT (basketId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- basketId - 買い物カゴ ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.agent.modifyPUTResponse
PUT /baskets/{basket_id}/agent
メソッドの詳細
modifyPUTResponse (basket : dw.order.Basket, basketResponse : Basket) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.approaching_discounts.beforeGET
GET /baskets/{basket_id}/approaching_discounts
メソッドの詳細
beforeGET (basketId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- basketId - 買い物カゴ ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.approaching_discounts.modifyGETResponse
GET /baskets/{basket_id}/approaching_discounts
メソッドの詳細
modifyGETResponse (approachingDiscountResultResponse : ApproachingDiscountResult) : dw.system.Status
- パラメーター:
- approachingDiscountResultResponse - 近づいている割引の結果のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.beforeDELETE
DELETE /baskets/{basket_id}
メソッドの詳細
beforeDELETE (basket : dw.order.Basket) : dw.system.Status
この関数は、買い物カゴが削除される前に呼び出されます。
- パラメーター:
- basket - 削除される買い物カゴ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.beforeGET
GET /baskets/{basket_id}
メソッドの詳細
beforeGET (basketId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- basketId - 買い物カゴ ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.beforePATCH
PATCH /baskets/{basket_id}
メソッドの詳細
beforePATCH (basket : dw.order.Basket, basketInput : Basket) : dw.system.Status
この関数は、買い物カゴが更新される前に呼び出されます。
- パラメーター:
- basket - 更新される買い物カゴ
- basketInput - 必要な変更を含む買い物カゴの差分
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.beforePOST_v2
POST /baskets
メソッドの詳細
beforePOST_v2 (basketRequest : Basket) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- basketRequest - 買い物カゴリクエスト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.billing_address.afterPUT
PUT /baskets/{basket_id}/billing_address
メソッドの詳細
afterPUT (basket : dw.order.Basket, billingAddress : OrderAddress) : dw.system.Status
この関数は、買い物カゴに請求先住所が設定された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- billingAddress - 買い物カゴに設定された請求先住所
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.billing_address.beforePUT
PUT /baskets/{basket_id}/billing_address
メソッドの詳細
beforePUT (basket : dw.order.Basket, billingAddress : OrderAddress) : dw.system.Status
この関数は、買い物カゴに請求先住所が設定される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- billingAddress - 買い物カゴに設定される請求先住所
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.billing_address.modifyPUTResponse
PUT /baskets/{basket_id}/billing_address
メソッドの詳細
modifyPUTResponse (basket : dw.order.Basket, basketResponse : Basket, addressRequest : OrderAddress) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- addressRequest - 住所のリクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.coupon.afterDELETE
DELETE /baskets/{basket_id}/coupons/{coupon_item_id}
メソッドの詳細
afterDELETE (basket : dw.order.Basket, couponItemID : String) : dw.system.Status
この関数は、買い物カゴからクーポンが削除された後に呼び出されます。
- パラメーター:
- basket - クーポンが削除される買い物カゴ
- couponItemID - クーポン情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.coupon.afterPOST
POST /baskets/{basket_id}/coupons
メソッドの詳細
afterPOST (basket : dw.order.Basket, couponItem : CouponItem) : dw.system.Status
この関数は、買い物カゴにクーポンが追加された後に呼び出されます。
- パラメーター:
- basket - クーポンが追加される買い物カゴ
- couponItem - クーポン情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.coupon.beforeDELETE
DELETE /baskets/{basket_id}/coupons/{coupon_item_id}
メソッドの詳細
beforeDELETE (basket : dw.order.Basket, couponItemID : String) : dw.system.Status
この関数は、買い物カゴからクーポンが削除される前に呼び出されます。
- パラメーター:
- basket - クーポンが削除される買い物カゴ
- couponItemID - クーポン情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.coupon.beforePOST
POST /baskets/{basket_id}/coupons
メソッドの詳細
beforePOST (basket : dw.order.Basket, couponItem : CouponItem) : dw.system.Status
この関数は、買い物カゴにクーポンが追加される前に呼び出されます。
- パラメーター:
- basket - クーポンが追加される買い物カゴ
- couponItem - クーポン情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.coupon.modifyDELETEResponse
DELETE /baskets/{basket_id}/coupons/{coupon_item_id}
メソッドの詳細
modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, couponItemId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- couponItemId - クーポン品目 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.coupon.modifyPOSTResponse
POST /baskets/{basket_id}/coupons
メソッドの詳細
modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, couponRequest : CouponItem) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- couponRequest - クーポンリクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.customer.afterPUT
PUT /baskets/{basket_id}/customer
メソッドの詳細
afterPUT (basket : dw.order.Basket, customerInfo : CustomerInfo) : dw.system.Status
この関数は、買い物カゴの顧客情報が設定された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- customerInfo - 買い物カゴに設定された顧客情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.customer.beforePUT
PUT /baskets/{basket_id}/customer
メソッドの詳細
beforePUT (basket : dw.order.Basket, customerInfo : CustomerInfo) : dw.system.Status
この関数は、買い物カゴの顧客情報が設定される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- customerInfo - 買い物カゴに設定される顧客情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.customer.modifyPUTResponse
PUT /baskets/{basket_id}/customer
メソッドの詳細
modifyPUTResponse (basket : dw.order.Basket, basketResponse : Basket, customerRequest : CustomerInfo) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- customerRequest - 顧客リクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.gift_certificate_item.afterDELETE
DELETE /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id}
メソッドの詳細
afterDELETE (basket : dw.order.Basket, giftCertificateItemId : String) : dw.system.Status
この関数は、買い物カゴからギフト券品目が削除された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- giftCertificateItemId - 削除されたギフト券品目の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.gift_certificate_item.afterPATCH
PATCH /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id}
メソッドの詳細
afterPATCH (basket : dw.order.Basket, giftCertificateItemId : String, item : GiftCertificateItem) : dw.system.Status
この関数は、買い物カゴのギフト券品目が更新された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- giftCertificateItemId - 更新されたギフト券品目の ID
- item - 新しいギフト券品目データ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.gift_certificate_item.afterPOST
POST /baskets/{basket_id}/gift_certificate_items
メソッドの詳細
afterPOST (basket : dw.order.Basket, item : GiftCertificateItem) : dw.system.Status
この関数は、買い物カゴにギフト券品目が追加された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- item - 追加するギフト券品目
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.gift_certificate_item.beforeDELETE
DELETE /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id}
メソッドの詳細
beforeDELETE (basket : dw.order.Basket, giftCertificateItemId : String) : dw.system.Status
この関数は、買い物カゴからギフト券品目が削除される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- giftCertificateItemId - 削除されるギフト券品目の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.gift_certificate_item.beforePATCH
PATCH /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id}
メソッドの詳細
beforePATCH (basket : dw.order.Basket, giftCertificateItemId : String, item : GiftCertificateItem) : dw.system.Status
この関数は、買い物カゴのギフト券品目が更新される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- giftCertificateItemId - 更新されるギフト券品目の ID
- item - 新しいギフト券品目データ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.gift_certificate_item.beforePOST
POST /baskets/{basket_id}/gift_certificate_items
メソッドの詳細
beforePOST (basket : dw.order.Basket, item : GiftCertificateItem) : dw.system.Status
この関数は、買い物カゴにギフト券品目が追加される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- item - 追加するギフト券品目
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.gift_certificate_item.modifyDELETEResponse
DELETE /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id}
メソッドの詳細
modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, giftCertificateItemId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- giftCertificateItemId - 削除されたギフト券品目の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.gift_certificate_item.modifyPATCHResponse
PATCH /baskets/{basket_id}/gift_certificate_items/{gift_certificate_item_id}
メソッドの詳細
modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket, giftCertificateItemId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- giftCertificateItemId - 更新されたギフト券品目の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.gift_certificate_item.modifyPOSTResponse
POST /baskets/{basket_id}/gift_certificate_items
メソッドの詳細
modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, certificateItemRequest : GiftCertificateItem) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- certificateItemRequest - certificateItem リクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.item.afterDELETE
DELETE /baskets/{basket_id}/items/{item_id}
メソッドの詳細
afterDELETE (basket : dw.order.Basket, productItemId : String) : dw.system.Status
この関数は、買い物カゴ項目が削除された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- productItemId - 削除された商品品目の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.item.afterPATCH
PATCH /baskets/{basket_id}/items/{item_id}
メソッドの詳細
afterPATCH (basket : dw.order.Basket, item : ProductItem) : dw.system.Status
この関数は、買い物カゴの品目が更新された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- item - 商品品目への必要な変更を含む商品品目の差分
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.item.beforeDELETE
DELETE /baskets/{basket_id}/items/{item_id}
メソッドの詳細
beforeDELETE (basket : dw.order.Basket, productItemId : String) : dw.system.Status
この関数は、買い物カゴ項目が削除される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- productItemId - 削除される商品品目の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.item.beforePATCH
PATCH /baskets/{basket_id}/items/{item_id}
メソッドの詳細
beforePATCH (basket : dw.order.Basket, item : ProductItem) : dw.system.Status
この関数は、買い物カゴの品目が更新される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- item - 商品品目への必要な変更を含む商品品目の差分
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.item.modifyDELETEResponse
DELETE /baskets/{basket_id}/items/{item_id}
メソッドの詳細
modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, productItemId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- productItemId - productItemId リクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.item.modifyPATCHResponse
PATCH /baskets/{basket_id}/items/{item_id}
メソッドの詳細
modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket, productItemId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- productItemId - productItemId リクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.items.afterPOST
POST /baskets/{basket_id}/items
メソッドの詳細
afterPOST (basket : dw.order.Basket, items : ProductItem) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- items - 商品品目の productItems 配列
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.items.beforePOST
POST /baskets/{basket_id}/items
メソッドの詳細
beforePOST (basket : dw.order.Basket, items : ProductItem) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- items - 商品品目の productItems 配列
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.items.modifyPOSTResponse
POST /baskets/{basket_id}/items
メソッドの詳細
modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, productItems : ProductItem) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- productItems - 商品品目の productItems 配列
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.modifyGETResponse
GET /baskets/{basket_id}
メソッドの詳細
modifyGETResponse (basket : dw.order.Basket, basketResponse : Basket) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.modifyPATCHResponse
PATCH /baskets/{basket_id}
メソッドの詳細
modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.modifyPOSTResponse
POST /baskets
メソッドの詳細
modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket) : dw.system.Status
- パラメーター:
- basket - 作成された買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.note.afterDELETE
DELETE /baskets/{basket_id}/notes/{note_id}
メソッドの詳細
afterDELETE (basket : dw.order.Basket, note : dw.object.Note) : dw.system.Status
この関数は、メモが削除された後に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- note - 削除されるメモ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.note.afterPOST
POST /baskets/{basket_id}/notes
メソッドの詳細
afterPOST (basketId : String, note : Note) : dw.system.Status
この関数は、メモが追加された後に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- note - 追加されるメモ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.note.beforeDELETE
DELETE /baskets/{basket_id}/notes/{note_id}
メソッドの詳細
beforeDELETE (basket : dw.order.Basket, note : dw.object.Note) : dw.system.Status
この関数は、メモが削除される前に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- note - 削除されるメモ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.note.beforePOST
POST /baskets/{basket_id}/notes
メソッドの詳細
beforePOST (basketId : String, note : Note) : dw.system.Status
この関数は、メモが追加される前に呼び出されます。
- パラメーター:
- basketId - 買い物カゴ
- note - 追加されるメモ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.note.modifyDELETEResponse
DELETE /baskets/{basket_id}/notes/{note_id}
メソッドの詳細
modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, noteId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- noteId - 削除済みのメモの ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.note.modifyPOSTResponse
POST /baskets/{basket_id}/notes
メソッドの詳細
modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, noteRequest : Note) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- noteRequest - メモのリクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.notes.beforeGET
GET /baskets/{basket_id}/notes
メソッドの詳細
beforeGET (basketId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- basketId - メモの結果が取得される買い物カゴ ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.notes.modifyGETResponse_v2
GET /baskets/{basket_id}/notes
メソッドの詳細
modifyGETResponse_v2 (basket : dw.order.Basket, notesResponse : NotesResult) : dw.system.Status
- パラメーター:
- basket - メモの結果が取得される買い物カゴ ID
- notesResponse - メモレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_instrument.afterDELETE
DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
afterDELETE (basket : dw.order.Basket) : dw.system.Status
注文の支払手段 が買い物カゴから削除された後に呼び出されます。
- パラメーター:
- basket - 支払手段が削除された買い物カゴ
- paymentInstrument - 削除される支払手段
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_instrument.afterPATCH
PATCH /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
afterPATCH (basket : dw.order.Basket, paymentInstrument : dw.order.OrderPaymentInstrument, paymentInstrumentRequest : BasketPaymentInstrumentRequest) : dw.system.Status
この関数は、買い物カゴの支払手段が更新された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- paymentInstrument - 更新された支払手段
- paymentInstrumentRequest - 新しい支払手段データ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_instrument.afterPOST
POST /baskets/{basket_id}/payment_instruments
メソッドの詳細
afterPOST (basket : dw.order.Basket, paymentInstrument : BasketPaymentInstrumentRequest) : dw.system.Status
この関数は、買い物カゴに支払手段が追加された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- paymentInstrument - 買い物カゴに追加された支払手段
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_instrument.beforeDELETE
DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
beforeDELETE (basket : dw.order.Basket, delete : dw.order.OrderPaymentInstrument) : dw.system.Status
注文の支払手段 が買い物カゴから削除される前に呼び出されます。
- パラメーター:
- basket - 支払手段を削除する買い物カゴ
- delete - 注文の支払手段ドキュメント。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_instrument.beforePATCH
PATCH /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
beforePATCH (basket : dw.order.Basket, paymentInstrument : dw.order.OrderPaymentInstrument, newPaymentInstrument : BasketPaymentInstrumentRequest) : dw.system.Status
この関数は、買い物カゴの支払手段が更新される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- paymentInstrument - 更新される支払手段
- newPaymentInstrument - 新しい支払手段データ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_instrument.beforePOST
POST /baskets/{basket_id}/payment_instruments
メソッドの詳細
beforePOST (basket : dw.order.Basket, paymentInstrument : BasketPaymentInstrumentRequest) : dw.system.Status
この関数は、買い物カゴに支払手段が追加される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- paymentInstrument - 買い物カゴに追加される支払手段
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_instrument.modifyDELETEResponse
DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, paymentInstrumentId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- paymentInstrumentRequest - 支払手段 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_instrument.modifyPATCHResponse
PATCH /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket, paymentInstrumentId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- paymentInstrumentRequest - 支払手段 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_instrument.modifyPOSTResponse
POST /baskets/{basket_id}/payment_instruments
メソッドの詳細
modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, paymentInstrumentRequest : BasketPaymentInstrumentRequest) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- paymentInstrumentRequest - 支払手段リクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_methods.afterGET
GET /baskets/{basket_id}/payment_methods
メソッドの詳細
afterGET (basket : dw.order.Basket, paymentMethods : PaymentMethodResult) : dw.system.Status
使用可能な支払方法のリストを顧客に返す前に呼び出されます。結果を編集することができます。
- パラメーター:
- basket - 買い物カゴ
- paymentMethods - 利用可能な支払方法
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_methods.beforeGET
GET /baskets/{basket_id}/payment_methods
メソッドの詳細
beforeGET (basketId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- basketId - 買い物カゴ ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.payment_methods.modifyGETResponse_v2
GET /baskets/{basket_id}/payment_methods
メソッドの詳細
modifyGETResponse_v2 (basket : dw.order.Basket, paymentMethodResultResponse : PaymentMethodResult) : dw.system.Status
- パラメーター:
- basket - 支払方法の結果を取得する対象の買い物カゴ
- paymentMethodResultResponse - paymentMethodResult レスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.price_adjustment.afterDELETE
DELETE /baskets/{basket_id}/price_adjustments/{price_adjustment_id}
メソッドの詳細
afterDELETE (basket : dw.order.Basket, priceAdjustmentId : String) : dw.system.Status
この関数は、カスタムの価格調整が削除された後に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- priceAdjustmentId - 削除された価格調整の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.price_adjustment.afterPATCH
PATCH /baskets/{basket_id}/price_adjustments/{price_adjustment_id}
メソッドの詳細
afterPATCH (basket : dw.order.Basket, priceAdjustmentId : String, priceAdjustmentWO : PriceAdjustment) : dw.system.Status
この関数は、カスタムの価格調整が更新された後に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- priceAdjustmentId - 更新された価格調整の ID
- priceAdjustmentWO - 新しい価格調整データ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.price_adjustment.afterPOST
POST /baskets/{basket_id}/price_adjustments
メソッドの詳細
afterPOST (basket : dw.order.Basket, request : PriceAdjustmentRequest) : dw.system.Status
この関数は、カスタムの価格調整が追加された後に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- request - 価格調整のリクエスト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.price_adjustment.beforeDELETE
DELETE /baskets/{basket_id}/price_adjustments/{price_adjustment_id}
メソッドの詳細
beforeDELETE (basket : dw.order.Basket, priceAdjustmentId : String) : dw.system.Status
この関数は、カスタムの価格調整が削除される前に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- priceAdjustmentId - 削除される価格調整の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.price_adjustment.beforePATCH
PATCH /baskets/{basket_id}/price_adjustments/{price_adjustment_id}
メソッドの詳細
beforePATCH (basket : dw.order.Basket, priceAdjustmentId : String, priceAdjustmentWO : PriceAdjustment) : dw.system.Status
この関数は、カスタムの価格調整が更新される前に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- priceAdjustmentId - 更新される価格調整の ID
- priceAdjustmentWO - 新しい価格調整データ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.price_adjustment.beforePOST
POST /baskets/{basket_id}/price_adjustments
メソッドの詳細
beforePOST (basket : dw.order.Basket, request : PriceAdjustmentRequest) : dw.system.Status
この関数は、カスタムの価格調整が追加される前に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- request - 価格調整のリクエスト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.price_adjustment.modifyDELETEResponse
DELETE /baskets/{basket_id}/price_adjustments/{price_adjustment_id}
メソッドの詳細
modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, priceAdjustmentId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- priceAdjustmentId - 価格調整 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.price_adjustment.modifyPATCHResponse
PATCH /baskets/{basket_id}/price_adjustments/{price_adjustment_id}
メソッドの詳細
modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket, priceAdjustmentId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- priceAdjustmentId - 価格調整 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.price_adjustment.modifyPOSTResponse
POST /baskets/{basket_id}/price_adjustments
メソッドの詳細
modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, priceAdjustmentRequest : PriceAdjustmentRequest) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- priceAdjustmentRequest - 価格調整リクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.reference.afterPOST
POST /baskets/reference
メソッドの詳細
afterPOST (sourceBasket : dw.order.Basket, basket : dw.order.Basket, request : BasketReference) : dw.system.Status
- パラメーター:
- sourceBasket - データのコピー元となる買い物カゴ
- basket - 作成された買い物カゴ
- basketReferenceRequest - 買い物カゴ参照の入力ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.reference.beforePOST
POST /baskets/reference
メソッドの詳細
beforePOST (sourceBasket : dw.order.Basket, request : BasketReference) : dw.system.Status
- パラメーター:
- sourceBasket - データのコピー元となる買い物カゴ
- basketReferenceRequest - 買い物カゴ参照の入力ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.reference.modifyPOSTResponse
POST /baskets/reference
メソッドの詳細
modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, basketReferenceRequest : BasketReference) : dw.system.Status
- パラメーター:
- basket - 作成された買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- basketReferenceRequest - 買い物カゴ参照の入力ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.afterDELETE
DELETE /baskets/{basket_id}/shipments/{shipment_id}
メソッドの詳細
afterDELETE (basket : dw.order.Basket, shipmentId : String) : dw.system.Status
買い物カゴの配送が削除された後に呼び出されます。
- パラメーター:
- basket - the basket that was updated
- shipmentId - 削除された配送の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.afterPATCH
PATCH /baskets/{basket_id}/shipments/{shipment_id}
メソッドの詳細
afterPATCH (basket : dw.order.Basket, shipment : dw.order.Shipment, shipmentInfo : Shipment) : dw.system.Status
この関数は、買い物カゴの配送がパッチされた後に呼び出されます。
- パラメーター:
- basket - 配送が変更された買い物カゴ
- shipment - 更新された配送
- shipmentInfo - 配送更新のための配送情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.afterPOST
POST /baskets/{basket_id}/shipments
メソッドの詳細
afterPOST (basket : dw.order.Basket, shipment : Shipment) : dw.system.Status
この関数は、買い物カゴから配送が作成された後に呼び出されます。
- パラメーター:
- basket - 配送が作成された買い物カゴ
- shipment - 配送作成のための配送情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.beforeDELETE
DELETE /baskets/{basket_id}/shipments/{shipment_id}
メソッドの詳細
beforeDELETE (basket : dw.order.Basket, shipment : dw.order.Shipment) : dw.system.Status
買い物カゴの配送が削除される前に呼び出されます。
- パラメーター:
- basket - 更新される買い物カゴ
- shipment - 削除される配送
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.beforePATCH
PATCH /baskets/{basket_id}/shipments/{shipment_id}
メソッドの詳細
beforePATCH (basket : dw.order.Basket, shipment : dw.order.Shipment, shipmentInfo : Shipment) : dw.system.Status
この関数は、買い物カゴの配送が変更される前に呼び出されます。
- パラメーター:
- basket - 配送が更新される買い物カゴ
- shipment - 更新される現在の配送
- shipmentInfo - 配送更新のための配送情報 (更新データ)
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.beforePOST
POST /baskets/{basket_id}/shipments
メソッドの詳細
beforePOST (basket : dw.order.Basket, shipment : Shipment) : dw.system.Status
この関数は、買い物カゴの配送が作成される前に呼び出されます。
- パラメーター:
- basket - 配送が作成される買い物カゴ
- shipment - 配送作成のための配送情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.modifyDELETEResponse
DELETE /baskets/{basket_id}/shipments/{shipment_id}
メソッドの詳細
modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, shipmentId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- shipmentId - 配送 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.modifyPATCHResponse
PATCH /baskets/{basket_id}/shipments/{shipment_id}
メソッドの詳細
modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket, shipmentId : String) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- shipmentId - 配送 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.modifyPOSTResponse
POST /baskets/{basket_id}/shipments
メソッドの詳細
modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, shipmentRequest : Shipment) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- shipmentRequest - 配送リクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.shipping_address.afterPUT
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_address
メソッドの詳細
afterPUT (basket : dw.order.Basket, shipment : dw.order.Shipment, shippingAddress : OrderAddress) : dw.system.Status
この関数は、配送先住所が買い物カゴの特定の配送に設定された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- shipment - 配送作成のための配送情報
- shippingAddress - 配送に設定された配送先住所
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.shipping_address.beforePUT
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_address
メソッドの詳細
beforePUT (basket : dw.order.Basket, shipment : dw.order.Shipment, shippingAddress : OrderAddress) : dw.system.Status
この関数は、配送先住所が買い物カゴの特定の配送に設定される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- shipment - 配送作成のための配送情報
- shippingAddress - 配送に設定される配送先住所
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.shipping_address.modifyPUTResponse
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_address
メソッドの詳細
modifyPUTResponse (basket : dw.order.Basket, basketResponse : Basket, orderAddressRequest : OrderAddress) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- orderAddressRequest - 注文の住所のリクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.shipping_method.afterPUT
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_method
メソッドの詳細
afterPUT (basket : dw.order.Basket, shipment : dw.order.Shipment, shippingMethod : ShippingMethod) : dw.system.Status
この関数は、配送方法が買い物カゴの特定の配送に設定された後に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- shipment - 配送作成のための配送情報
- shippingMethod - 配送に設定された配送方法
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.shipping_method.beforePUT
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_method
メソッドの詳細
beforePUT (basket : dw.order.Basket, shipment : dw.order.Shipment, shippingMethod : ShippingMethod) : dw.system.Status
この関数は、配送方法が買い物カゴの特定の配送に設定される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- shipment - 配送作成のための配送情報
- shippingMethod - 配送に設定される配送方法
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipment.shipping_method.modifyPUTResponse
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_method
メソッドの詳細
modifyPUTResponse (basket : dw.order.Basket, basketResponse : Basket, shippingMethodRequest : ShippingMethod) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- shippingMethodRequest - 配送方法リクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipments.shipping_methods.beforeGET
GET /baskets/{basket_id}/shipments/{shipment_id}/shipping_methods
メソッドの詳細
beforeGET (basketId : String, shipmentId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- basketId - ターゲットの買い物カゴの ID
- shipmentId - 配送 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.shipments.shipping_methods.modifyGETResponse_v2
GET /baskets/{basket_id}/shipments/{shipment_id}/shipping_methods
メソッドの詳細
modifyGETResponse_v2 (shipment : dw.order.Shipment, shippingMethodResult : ShippingMethodResult) : dw.system.Status
- パラメーター:
- shipment - 配送方法の結果を取得する配送。
- shippingMethodResult - 配送方法結果オブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.storefront.afterPUT
PUT /baskets/{basket_id}/storefront
メソッドの詳細
afterPUT (basket : dw.order.Basket) : dw.system.Status
この関数は、買い物カゴのストアフロント買い物カゴとしての送信の後に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.storefront.beforePUT
PUT /baskets/{basket_id}/storefront
メソッドの詳細
beforePUT (basketId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- basket - 買い物カゴ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.storefront.modifyPUTResponse
PUT /baskets/{basket_id}/storefront
メソッドの詳細
modifyPUTResponse (basket : dw.order.Basket, basketResponse : Basket) : dw.system.Status
- パラメーター:
- basket - ターゲットの買い物カゴ
- basketResponse - 買い物カゴのレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/coupons/{coupon_item_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/items/{item_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/notes/{note_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/price_adjustments/{price_adjustment_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
DELETE /baskets/{basket_id}/shipments/{shipment_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
GET /baskets/{basket_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
PATCH /baskets/{basket_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
PATCH /baskets/{basket_id}/items/{item_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
PATCH /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
PATCH /baskets/{basket_id}/shipments/{shipment_id}
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
POST /baskets
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/coupons
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/gift_certificate_items
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/items
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/notes
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/payment_instruments
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/price_adjustments
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
POST /baskets/{basket_id}/shipments
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
POST /orders
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
PUT /baskets/{basket_id}/billing_address
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
PUT /baskets/{basket_id}/customer
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_address
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.basket.validateBasket
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_method
メソッドの詳細
validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status
カスタム flash の追加、または内部 flash の削除を許可します。flash の存在は、買い物カゴをまだ送信できないことを意味します。パラメーター duringSubmit は、現在の呼び出しが買い物カゴ送信処理中であることを示します。duringSubmit および flash が存在すると、デフォルトの実装によって ERROR が返されます。
flash の追加、リスト、削除の例:
1exports.validateBasket = function(basketResponse, duringSubmit) {
2 basketResponse.addFlash({
3 type: "MyType",
4 message: "My message",
5 path: "my_path",
6 details: {
7 "k1": "v1",
8 "k2": "v2"
9 }
10 });
11 var flashToRemove;
12 for each(f in basketResponse.flashes) {
13 if (f.type == "SomeOtherType") {
14 flashToRemove = f;
15 }
16 }
17 if (flashToRemove != null) {
18 basketResponse.removeFlash(flashToRemove);
19 }
20};- パラメーター:
- basketResponse - 選択された OCAPI プロパティが適用される前に検証される買い物カゴのレスポンス
- duringSubmit - 買い物カゴの送信を確認する必要があるかどうか
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
Category
Shop API の Category (カテゴリ) フック。
dw.ocapi.shop.category.beforeGET
GET /categories/({id},...,{id})
メソッドの詳細
beforeGET (categoryId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- categoryId - カテゴリの ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.category.beforeGET
GET /categories/{id}
メソッドの詳細
beforeGET (categoryId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- categoryId - カテゴリの ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.category.modifyGETResponse
GET /categories/({id},...,{id})
メソッドの詳細
modifyGETResponse (scriptCategory : dw.catalog.Category, doc : Category) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptCategory - dw.catalog.Category のインスタンス
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.category.modifyGETResponse
GET /categories/{id}
メソッドの詳細
modifyGETResponse (scriptCategory : dw.catalog.Category, doc : Category) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptCategory - dw.catalog.Category のインスタンス
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
コンテンツ
Shop API の Content (コンテンツ) フック。
dw.ocapi.shop.content.beforeGET
GET /content/({id},...,{id})
メソッドの詳細
beforeGET (contentId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- contentId - コンテンツアセットの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.content.beforeGET
GET /content/{id}
メソッドの詳細
beforeGET (contentId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- contentId - コンテンツアセットの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.content.modifyGETResponse
GET /content/({id},...,{id})
メソッドの詳細
modifyGETResponse (scriptContent : dw.content.Content, doc : Content) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptContent - dw.content.Content のインスタンス
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.content.modifyGETResponse
GET /content/{id}
メソッドの詳細
modifyGETResponse (scriptContent : dw.content.Content, doc : Content) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptContent - dw.content.Content のインスタンス
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
コンテンツの検索
Shop API の Content Search (コンテンツ検索) フック。
dw.ocapi.shop.content_search.beforeGET
GET /content_search
メソッドの詳細
beforeGET () : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.content_search.modifyGETResponse
GET /content_search
メソッドの詳細
modifyGETResponse (doc : ContentSearchResult) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
カスタムオブジェクト
Shop API の Custom Object (カスタムオブジェクト) フック。
dw.ocapi.shop.custom_object.beforeGET
GET /custom_objects/{object_type}/{key}
メソッドの詳細
beforeGET (objectType : String, key : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- bjectType - オブジェクトタイプの ID
- key - カスタムオブジェクトの主キー属性の値
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.custom_object.modifyGETResponse
GET /custom_objects/{object_type}/{key}
メソッドの詳細
modifyGETResponse (scriptCustomObject : dw.object.CustomObject, doc : CustomObject) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptCustomObject - dw.object.CustomObject のインスタンス
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
顧客
Shop API の Customer (顧客) フック。
dw.ocapi.shop.customer.afterPATCH
PATCH /customers/{customer_id}
メソッドの詳細
afterPATCH (customer : dw.customer.Customer, customerInput : Customer) : dw.system.Status
この関数は、顧客が更新された後に呼び出されます。
- パラメーター:
- customer - 更新する顧客
- customerInput - パッチの変更を含む入力顧客
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.afterPOST
POST /customers
メソッドの詳細
afterPOST (customer : dw.customer.Customer, registration : CustomerRegistration) : dw.system.Status
この関数は、新規顧客が登録された後に呼び出されます。
- パラメーター:
- customer - 登録済み顧客
- registration - 顧客の登録情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.auth.afterPOST
POST /customers/{customer_id}/auth
メソッドの詳細
afterPOST (customer : dw.customer.Customer) : dw.system.Status
この関数は、顧客が認証された後に呼び出されます。
- パラメーター:
- customer - 認証する顧客
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.auth.beforePOST
POST /customers/{customer_id}/auth
メソッドの詳細
beforePOST (customer : dw.customer.Customer) : dw.system.Status
この関数は、顧客が認証される前に呼び出されます。
- パラメーター:
- customer - 認証する顧客
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.auth.modifyPOSTResponse
POST /customers/{customer_id}/auth
メソッドの詳細
modifyPOSTResponse (customer : dw.customer.Customer, customerResponse : Customer) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- customerResponse - 顧客のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.baskets.beforeGET
GET /customers/{customer_id}/baskets
メソッドの詳細
beforeGET (customerId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - 買い物カゴの結果を取得する顧客の ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.baskets.modifyGETResponse_v2
GET /customers/{customer_id}/baskets
メソッドの詳細
modifyGETResponse_v2 (customer : dw.customer.Customer, customerBasketsResultResponse : BasketsResult) : dw.system.Status
- パラメーター:
- customer - 買い物カゴの結果を取得する顧客。
- customerBasketsResultResponse - 顧客の買い物カゴの結果のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.beforeGET
GET /customers/{customer_id}
メソッドの詳細
beforeGET (customerId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - 顧客 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.beforePATCH
PATCH /customers/{customer_id}
メソッドの詳細
beforePATCH (customer : dw.customer.Customer, customerInput : Customer) : dw.system.Status
この関数は、顧客が更新される前に呼び出されます。
- パラメーター:
- customer - 更新する顧客
- customerInput - パッチの変更を含む入力顧客
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.beforePOST
POST /customers
メソッドの詳細
beforePOST (registration : CustomerRegistration) : dw.system.Status
この関数は、新規顧客が登録される前に呼び出されます。
- パラメーター:
- registration - 顧客の登録情報
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.modifyGETResponse
GET /customers/{customer_id}
メソッドの詳細
modifyGETResponse (customer : dw.customer.Customer, customerResponse : Customer) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- customerResponse - 顧客のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.modifyPATCHResponse
PATCH /customers/{customer_id}
メソッドの詳細
modifyPATCHResponse (customer : dw.customer.Customer, customerResponse : Customer) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- customerResponse - 顧客のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.modifyPOSTResponse
POST /customers
メソッドの詳細
modifyPOSTResponse (customer : dw.customer.Customer, customerResponse : Customer) : dw.system.Status
- パラメーター:
- customer - 作成された顧客
- customerResponse - 顧客のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.orders.beforeGET
GET /customers/{customer_id}/orders
メソッドの詳細
beforeGET (customerId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - 注文を取得する顧客の ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.orders.modifyGETResponse_v2
GET /customers/{customer_id}/orders
メソッドの詳細
modifyGETResponse_v2 (customer : dw.customer.Customer, customerOrderResultResponse : CustomerOrderResult) : dw.system.Status
- パラメーター:
- customer - 注文を取得する顧客。
- customerOrderResultResponse - 顧客の注文の結果のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.password_reset.afterPOST
POST /customers/{customer_id}/password_reset
メソッドの詳細
afterPOST (customer : dw.customer.Customer, resetToken : String) : dw.system.Status
顧客のパスワードのリセットを許可します。以下の、パスワードリセットのリンクを記載した Eメールの送信の例を参照してください。
1var variables: Map = new dw.util.HashMap();
2variables.put("Customer", customer);
3variables.put("ResetPasswordToken", token);
4var template: Template = new dw.util.Template("mail/resetpasswordemail.isml");
5var content: MimeEncodedText = template.render(variables);
6var mail: Mail = new Mail()
7 .setSubject("Password Reset")
8 .setContent(content)
9 .setFrom("noreply@salesforce.com")
10 .addTo(customer.profile.email);
11mail.send();- パラメーター:
- customer - パスワードをリセットする顧客
- resetToken - リセットに使用するためにシステムによって生成されたトークン
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.password_reset.beforePOST
POST /customers/{customer_id}/password_reset
メソッドの詳細
beforePOST (customer : dw.customer.Customer) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customer - パスワードをリセットする顧客
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.payment_instrument.afterDELETE
DELETE /customers/{customer_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
afterDELETE (customer : dw.customer.Customer, paymentInstrumentId : String) : dw.system.Status
この関数は、顧客の支払手段が削除された後に呼び出されます。
- パラメーター:
- customer - 支払手段を削除する顧客
- paymentInstrumentId - the id of the payment instrument that was deleted
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.payment_instrument.afterPOST
POST /customers/{customer_id}/payment_instruments
メソッドの詳細
afterPOST (customer : dw.customer.Customer, paymentInstrument : CustomerPaymentInstrumentRequest) : dw.system.Status
この関数は、支払手段が顧客に追加された後に呼び出されます。
- パラメーター:
- customer - 支払手段を追加する顧客
- paymentInstrument - the payment instrument that was added
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.payment_instrument.beforeDELETE
DELETE /customers/{customer_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
beforeDELETE (customer : dw.customer.Customer, paymentInstrumentId : String) : dw.system.Status
この関数は、顧客の支払手段が削除された後に呼び出されます。
- パラメーター:
- customer - 支払手段を削除する顧客
- paymentInstrumentId - 削除される支払手段の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.payment_instrument.beforeGET
GET /customers/{customer_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
beforeGET (customerId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - ターゲット顧客の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.payment_instrument.beforePOST
POST /customers/{customer_id}/payment_instruments
メソッドの詳細
beforePOST (customer : dw.customer.Customer, paymentInstrument : CustomerPaymentInstrumentRequest) : dw.system.Status
この関数は、支払手段が顧客に追加される前に呼び出されます。
- パラメーター:
- customer - 支払手段を追加する顧客
- paymentInstrument - 追加される支払手段
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.payment_instrument.modifyGETResponse
GET /customers/{customer_id}/payment_instruments/{payment_instrument_id}
メソッドの詳細
modifyGETResponse (customer : dw.customer.Customer, customerPaymentInstrument : dw.customer.CustomerPaymentInstrument, customerPaymentInstrumentResponse : CustomerPaymentInstrument) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- customerPaymentInstrument - 支払手段
- customerPaymentInstrumentResponse - 顧客の支払手段のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.payment_instrument.modifyPOSTResponse
POST /customers/{customer_id}/payment_instruments
メソッドの詳細
modifyPOSTResponse (customer : dw.customer.Customer, customerPaymentInstrument : dw.customer.CustomerPaymentInstrument, customerPaymentInstrumentResponse : CustomerPaymentInstrument) : dw.system.Status
- パラメーター:
- Customer - ターゲット顧客
- customerPaymentInstrument - 支払手段
- customerPaymentInstrumentResponse - 顧客の支払手段のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.payment_instruments.beforeGET
GET /customers/{customer_id}/payment_instruments
メソッドの詳細
beforeGET (customerId : String, paymentMethodId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - 顧客の支払手段の結果を取得する顧客の ID。
- paymentMethodId - 支払方法の ID。null の場合は、すべての支払手段が取得されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.payment_instruments.modifyGETResponse_v2
GET /customers/{customer_id}/payment_instruments
メソッドの詳細
modifyGETResponse_v2 (customer : dw.customer.Customer, customerPaymentInstrumentResultResponse : CustomerPaymentInstrumentResult) : dw.system.Status
- パラメーター:
- customer - 顧客の支払手段の結果を取得する顧客。
- customerPaymentInstrumentResultResponse - 顧客の支払手段の結果のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.afterDELETE
DELETE /customers/{customer_id}/product_lists/{list_id}
メソッドの詳細
afterDELETE (customer : dw.customer.Customer, productListId : String) : dw.system.Status
この関数は、顧客商品リストが削除された後に呼び出されます。
- パラメーター:
- customer - 顧客
- productListId - 商品リスト ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.afterPATCH
PATCH /customers/{customer_id}/product_lists/{list_id}
メソッドの詳細
afterPATCH (customer : dw.customer.Customer, productList : CustomerProductList) : dw.system.Status
この関数は、顧客商品リストが変更された後に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.beforeDELETE
DELETE /customers/{customer_id}/product_lists/{list_id}
メソッドの詳細
beforeDELETE (customer : dw.customer.Customer, productList : dw.customer.ProductList) : dw.system.Status
この関数は、顧客商品リストが削除される前に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.beforeGET
GET /customers/{customer_id}/product_lists/{list_id}
メソッドの詳細
beforeGET (customerId : String, productListId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - 顧客 ID。
- productListId - 商品リスト ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.beforePATCH
PATCH /customers/{customer_id}/product_lists/{list_id}
メソッドの詳細
beforePATCH (customer : dw.customer.Customer, productList : CustomerProductList) : dw.system.Status
この関数は、顧客商品リストが変更される前に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.afterDELETE
DELETE /customers/{customer_id}/product_lists/{list_id}/items/{item_id}
メソッドの詳細
afterDELETE (customer : dw.customer.Customer, productList : dw.customer.ProductList, itemId : String) : dw.system.Status
この関数は、顧客商品リストから品目が削除された後に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- itemId - 削除された品目の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.afterPATCH
PATCH /customers/{customer_id}/product_lists/{list_id}/items/{item_id}
メソッドの詳細
afterPATCH (customer : dw.customer.Customer, productList : dw.customer.ProductList, item : CustomerProductListItem) : dw.system.Status
この関数は、顧客商品リストの品目が更新された後に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- item - 更新された品目
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.beforeDELETE
DELETE /customers/{customer_id}/product_lists/{list_id}/items/{item_id}
メソッドの詳細
beforeDELETE (customer : dw.customer.Customer, productList : dw.customer.ProductList, item : dw.customer.ProductListItem) : dw.system.Status
この関数は、顧客商品リストから品目が削除される前に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- item - 削除する商品リスト品目
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.beforeGET
GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}
メソッドの詳細
beforeGET (customerId : String, productListId : String, productListItemId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - ターゲット顧客の ID
- productListId - 商品リスト品目の購入の結果を取得する、顧客商品リストの ID。
- productListItemId - 商品リスト品目の購入の結果を取得する、商品リストの ID の品目。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.beforePATCH
PATCH /customers/{customer_id}/product_lists/{list_id}/items/{item_id}
メソッドの詳細
beforePATCH (customer : dw.customer.Customer, productList : dw.customer.ProductList, item : CustomerProductListItem) : dw.system.Status
この関数は、顧客商品リストの品目が更新される前に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- item - 更新する商品リスト品目
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.modifyGETResponse
GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}
メソッドの詳細
modifyGETResponse (customer : dw.customer.Customer, productListItem : dw.customer.ProductListItem, customerProductListItemResponse : CustomerProductListItem) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- productListItem - ターゲットの商品リスト品目
- customerProductListItemResponse - 顧客の商品リスト品目のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.modifyPATCHResponse
PATCH /customers/{customer_id}/product_lists/{list_id}/items/{item_id}
メソッドの詳細
modifyPATCHResponse (customer : dw.customer.Customer, productList : dw.customer.ProductList, customerProductListItemResponse : CustomerProductListItem, customerProductListItemRequest : CustomerProductListItem) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- productList - ターゲット商品リスト
- customerProductListItemRequest - 顧客の商品リスト品目のリクエストオブジェクト
- customerProductListItemResponse - 顧客の商品リスト品目のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.modifyPOSTResponse
POST /customers/{customer_id}/product_lists/{list_id}/items
メソッドの詳細
modifyPOSTResponse (customer : dw.customer.Customer, productList : dw.customer.ProductList, customerProductListItemResponse : CustomerProductListItem, customerProductListItemRequest : CustomerProductListItem) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- productList - ターゲット商品リスト
- customerProductListItemResponse - 顧客の商品リスト品目のレスポンスオブジェクト
- customerProductListItemRequest - 顧客の商品リスト品目のリクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.purchase.afterPATCH
PATCH /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases/{purchase_id}
メソッドの詳細
afterPATCH (customer : dw.customer.Customer, productList : dw.customer.ProductList, productListItem : dw.customer.ProductListItem, purchase : CustomerProductListItemPurchase) : dw.system.Status
この関数は、顧客商品リスト品目の購入が更新された後に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- productListItem - 商品リスト品目
- purchase - 更新された購入
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.purchase.beforeGET
GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases/{purchase_id}
メソッドの詳細
beforeGET (customerId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - ターゲット顧客の ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.purchase.beforePATCH
PATCH /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases/{purchase_id}
メソッドの詳細
beforePATCH (customer : dw.customer.Customer, productList : dw.customer.ProductList, productListItem : dw.customer.ProductListItem, purchase : CustomerProductListItemPurchase) : dw.system.Status
この関数は、顧客商品リスト品目の購入が更新される前に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- productListItem - 商品リスト品目
- purchase - 更新する商品リスト品目の購入
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.purchase.modifyGETResponse
GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases/{purchase_id}
メソッドの詳細
modifyGETResponse (customer : dw.customer.Customer, productListItemPurchase : dw.customer.ProductListItemPurchase, customerProductListItemPurchaseResponse : CustomerProductListItemPurchase) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- productListItemPurchase - ターゲットの商品リスト品目の購入
- customerProductListItemPurchaseResponse - 顧客の商品リスト品目購入のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.purchase.modifyPATCHResponse
PATCH /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases/{purchase_id}
メソッドの詳細
modifyPATCHResponse (customer : dw.customer.Customer, productList : dw.customer.ProductList, productListItem : dw.customer.ProductListItem, customerProductListItemPurchaseResponse : CustomerProductListItemPurchase, customerProductListItemPurchaseRequest : CustomerProductListItemPurchase) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- productList - ターゲット商品リスト
- productListItem - ターゲットの商品リスト品目
- customerProductListItemPurchaseRequest - 顧客の商品リスト品目購入のリクエストオブジェクト
- customerProductListItemPurchaseResponse - 顧客の商品リスト品目購入のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.purchases.afterPOST
POST /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases
メソッドの詳細
afterPOST (customer : dw.customer.Customer, productList : dw.customer.ProductList, productListItem : dw.customer.ProductListItem, purchase : CustomerProductListItemPurchase) : dw.system.Status
この関数は、顧客商品リスト品目に購入が追加された後に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- productListItem - 商品リスト品目
- purchase - 顧客商品リストに追加された品目
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.purchases.beforeGET
GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases
メソッドの詳細
beforeGET (customerId : String, listId : String, itemId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - 商品リスト品目の購入の結果を取得する、顧客の ID。
- listId - 商品リスト品目の購入の結果を取得する、顧客商品リストの ID。
- itemId - 商品リスト品目の購入の結果を取得する、商品リストの ID の品目。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.purchases.beforePOST
POST /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases
メソッドの詳細
beforePOST (customer : dw.customer.Customer, productList : dw.customer.ProductList, productListItem : dw.customer.ProductListItem, purchase : CustomerProductListItemPurchase) : dw.system.Status
この関数は、顧客商品リスト品目に購入が追加される前に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- productListItem - 商品リスト品目
- purchase - 顧客商品リスト品目に追加する購入
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.purchases.modifyGETResponse_v2
GET /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases
メソッドの詳細
modifyGETResponse_v2 (customer : dw.customer.Customer, productList : dw.customer.ProductList, productListItem : dw.customer.ProductListItem, customerProductListItemPurchaseResultResponse : CustomerProductListItemPurchaseResult) : dw.system.Status
- パラメーター:
- customer - 商品リスト品目の購入の結果を取得する顧客。
- productList - 商品リスト品目の購入の結果を取得する、顧客商品リストの ID。
- productListItem - 商品リスト品目の購入の結果を取得する、商品リスト品目。
- customerProductListItemPurchaseResultResponse - 顧客の商品リスト品目購入の結果のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.item.purchases.modifyPOSTResponse
POST /customers/{customer_id}/product_lists/{list_id}/items/{item_id}/purchases
メソッドの詳細
modifyPOSTResponse (customer : dw.customer.Customer, productList : dw.customer.ProductList, productListItem : dw.customer.ProductListItem, customerProductListItemPurchaseResponse : CustomerProductListItemPurchase, customerProductListItemPurchaseRequest : CustomerProductListItemPurchase) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- productList - ターゲット商品リスト
- productListItem - ターゲットの商品リスト品目
- customerProductListItemPurchaseResponse - 顧客の商品リスト品目購入のレスポンスオブジェクト
- customerProductListItemPurchaseRequest - 顧客の商品リスト品目購入のリクエストオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.items.afterPOST
POST /customers/{customer_id}/product_lists/{list_id}/items
メソッドの詳細
afterPOST (customer : dw.customer.Customer, productList : dw.customer.ProductList, item : CustomerProductListItem) : dw.system.Status
この関数は、顧客商品リストに品目が追加された後に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- item - 顧客商品リストに追加された品目
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.items.beforeGET
GET /customers/{customer_id}/product_lists/{list_id}/items
メソッドの詳細
beforeGET (customerId : String, productListId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - 顧客商品リスト品目の結果を取得する顧客の ID。
- productListId - 顧客商品リスト品目の結果を取得する商品リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.items.beforePOST
POST /customers/{customer_id}/product_lists/{list_id}/items
メソッドの詳細
beforePOST (customer : dw.customer.Customer, productList : dw.customer.ProductList, item : CustomerProductListItem) : dw.system.Status
この関数は、顧客商品リストに品目が追加される前に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 商品リスト
- item - 顧客商品リストに追加する品目
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.items.modifyGETResponse_v2
GET /customers/{customer_id}/product_lists/{list_id}/items
メソッドの詳細
modifyGETResponse_v2 (customer : dw.customer.Customer, productList : dw.customer.ProductList, customerProductListItemResultResponse : CustomerProductListItemResult) : dw.system.Status
- パラメーター:
- customer - 顧客商品リスト品目の結果を取得する顧客。
- productList - 顧客商品リスト品目の結果を取得する商品リスト。
- customerProductListItemResultResponse - 顧客商品リスト品目の結果のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.modifyGETResponse
GET /customers/{customer_id}/product_lists/{list_id}
メソッドの詳細
modifyGETResponse (customer : dw.customer.Customer, productList : dw.customer.ProductList, customerProductListResponse : CustomerProductList) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- productList - ターゲット商品リスト
- customerProductListResponse - 顧客の商品リストのレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.modifyPATCHResponse
PATCH /customers/{customer_id}/product_lists/{list_id}
メソッドの詳細
modifyPATCHResponse (customer : dw.customer.Customer, productList : dw.customer.ProductList, customerProductListResponse : CustomerProductList) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- productList - ターゲット商品リスト
- customerProductListResponse - 顧客の商品リストのレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_list.modifyPOSTResponse
POST /customers/{customer_id}/product_lists
メソッドの詳細
modifyPOSTResponse (customer : dw.customer.Customer, productList : dw.customer.ProductList, customerProductListResponse : CustomerProductList) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- productList - 商品リスト
- customerProductListResponse - 顧客の商品リストのレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_lists.afterPOST
POST /customers/{customer_id}/product_lists
メソッドの詳細
afterPOST (customer : dw.customer.Customer, productList : CustomerProductList) : dw.system.Status
この関数は、指定した顧客に新規商品リストが作成された後に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 作成された商品リスト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_lists.beforeGET
GET /customers/{customer_id}/product_lists
メソッドの詳細
beforeGET (customerId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - 顧客商品リストの結果を取得する顧客の ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_lists.beforePOST
POST /customers/{customer_id}/product_lists
メソッドの詳細
beforePOST (customer : dw.customer.Customer, productList : CustomerProductList) : dw.system.Status
この関数は、指定した顧客に新規商品リストが作成される前に呼び出されます。
- パラメーター:
- customer - 顧客
- productList - 作成する商品リスト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.product_lists.modifyGETResponse_v3
GET /customers/{customer_id}/product_lists
メソッドの詳細
modifyGETResponse_v3 (customer : dw.customer.Customer, customerProductListResultResponse : CustomerProductListResult) : dw.system.Status
- パラメーター:
- customer - 顧客商品リストの結果を取得する顧客。
- customerProductListResultResponse - 顧客商品リストのページング可能結果レスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
顧客
Shop API の Customers (顧客) フック。
dw.ocapi.shop.customers.password_reset.afterPOST
POST /customers/password_reset
メソッドの詳細
afterPOST (customer : dw.customer.Customer, resetToken : String) : dw.system.Status
顧客のパスワードのリセットを許可します。以下の、パスワードリセットのリンクを記載した Eメールの送信の例を参照してください。
1var variables: Map = new dw.util.HashMap();
2variables.put("Customer", customer);
3variables.put("ResetPasswordToken", token);
4var template: Template = new dw.util.Template("mail/resetpasswordemail.isml");
5var content: MimeEncodedText = template.render(variables);
6var mail: Mail = new Mail()
7 .setSubject("Password Reset")
8 .setContent(content)
9 .setFrom("noreply@salesforce.com")
10 .addTo(customer.profile.email);
11mail.send();- パラメーター:
- customer - パスワードをリセットする顧客
- resetToken - リセットに使用するためにシステムによって生成されたトークン
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customers.password_reset.beforePOST
POST /customers/password_reset
メソッドの詳細
beforePOST (passwordReset : PasswordReset) : dw.system.Status
顧客のパスワードのリセットを許可します。パスワードリセットドキュメントに指定されている顧客情報の検証は、このフックの呼び出し後に行われます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
Customer Address (顧客の住所)
Shop API の Customer Address (顧客の住所) フック。
dw.ocapi.shop.customer.address.afterDELETE
DELETE /customers/{customer_id}/addresses/{address_name}
メソッドの詳細
afterDELETE (customer : dw.customer.Customer, addressName : String) : dw.system.Status
この関数は、顧客の住所が削除された後に呼び出されます。
- パラメーター:
- customer - 住所が削除された顧客
- addressName - the name of the address that was deleted
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.address.afterPATCH
PATCH /customers/{customer_id}/addresses/{address_name}
メソッドの詳細
afterPATCH (customer : dw.customer.Customer, addressName : String, customerAddress : CustomerAddress) : dw.system.Status
この関数は、顧客の住所が更新された後に呼び出されます。
- パラメーター:
- customer - 住所が更新された顧客
- addressName - the name of the address that was updated
- customerAddress - 顧客の住所のリクエストデータ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.address.beforeDELETE
DELETE /customers/{customer_id}/addresses/{address_name}
メソッドの詳細
beforeDELETE (customer : dw.customer.Customer, addressName : String) : dw.system.Status
この関数は、顧客の住所が削除される前に呼び出されます。
- パラメーター:
- customer - 住所を削除する顧客
- addressName - 削除する住所の名前
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.address.beforeGET
GET /customers/{customer_id}/addresses/{address_name}
メソッドの詳細
beforeGET (customerId : String, addressName : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customer - ターゲット顧客
- customerAddress - ターゲット顧客の住所
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.address.beforePATCH
PATCH /customers/{customer_id}/addresses/{address_name}
メソッドの詳細
beforePATCH (customer : dw.customer.Customer, addressName : String, customerAddress : CustomerAddress) : dw.system.Status
この関数は、顧客の住所が更新される前に呼び出されます。
- パラメーター:
- customer - 住所を更新する顧客
- addressName - 更新する住所の名前
- customerAddress - 顧客の住所のリクエストデータ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.address.modifyGETResponse
GET /customers/{customer_id}/addresses/{address_name}
メソッドの詳細
modifyGETResponse (customer : dw.customer.Customer, customerAddress : dw.customer.CustomerAddress, customerAddressResponse : CustomerAddress) : dw.system.Status
- パラメーター:
- customer - ターゲット顧客
- customerAddress - ターゲット顧客の住所
- customerAddressResponse - 顧客の住所のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.address.modifyPATCHResponse
PATCH /customers/{customer_id}/addresses/{address_name}
メソッドの詳細
modifyPATCHResponse (customer : dw.customer.Customer, customerAddress : dw.customer.CustomerAddress, customerAddressResponse : CustomerAddress, customerAddressRequest : CustomerAddress) : dw.system.Status
- パラメーター:
- customerAddress - ターゲット顧客の住所
- customerAddressResponse - 顧客の住所のレスポンスオブジェクト
- customerAddressRequest - 顧客の住所のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.address.modifyPOSTResponse
POST /customers/{customer_id}/addresses
メソッドの詳細
modifyPOSTResponse (customer : dw.customer.Customer, customerAddress : dw.customer.CustomerAddress, customerAddressResponse : CustomerAddress, customerAddressRequest : CustomerAddress) : dw.system.Status
この関数は、レスポンスが返される前に呼び出されます。
- パラメーター:
- customer - 住所が追加された顧客。
- customerAddress - 作成された顧客の住所
- customerAddressResponse - 顧客の住所のレスポンスオブジェクト。
- customerAddressRequest - 顧客の住所のリクエストオブジェクト。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
顧客の住所
Shop API の Customer Addresses (顧客の住所) フック。
dw.ocapi.shop.customer.addresses.afterPOST
POST /customers/{customer_id}/addresses
メソッドの詳細
afterPOST (customer : dw.customer.Customer, addressName : String, customerAddress : CustomerAddress) : dw.system.Status
この関数は、顧客に住所が追加された後に呼び出されます。
- パラメーター:
- customer - 住所が追加された顧客
- addressName - the name of the address that was added
- customerAddress - 顧客の住所のリクエストデータ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.addresses.beforeGET
GET /customers/{customer_id}/addresses
メソッドの詳細
beforeGET (customerId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- customerId - 顧客 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.addresses.beforePOST
POST /customers/{customer_id}/addresses
メソッドの詳細
beforePOST (customer : dw.customer.Customer, addressName : String, customerAddress : CustomerAddress) : dw.system.Status
この関数は、顧客に住所が追加される前に呼び出されます。
- パラメーター:
- customer - 住所を追加する顧客
- addressName - 追加する住所の名前
- customerAddress - 顧客の住所のリクエストデータ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.customer.addresses.modifyGETResponse
GET /customers/{customer_id}/addresses
メソッドの詳細
modifyGETResponse (customerAddressResultResponse : CustomerAddressResult) : dw.system.Status
- パラメーター:
- customerAddressResultResponse - 顧客の住所の結果のレスポンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
フォルダー
Shop API の Folder (フォルダー) フック。
dw.ocapi.shop.folder.beforeGET
GET /folders/({id},...,{id})
メソッドの詳細
beforeGET (id : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- id - リクエストされたコンテンツフォルダーの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.folder.beforeGET
GET /folders/{id}
メソッドの詳細
beforeGET (id : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- id - リクエストされたコンテンツフォルダーの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.folder.modifyGETResponse
GET /folders/({id},...,{id})
メソッドの詳細
modifyGETResponse (scriptFolder : dw.content.Folder, doc : ContentFolder) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptFolder - dw.content.Folder のインスタンス
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.folder.modifyGETResponse
GET /folders/{id}
メソッドの詳細
modifyGETResponse (scriptFolder : dw.content.Folder, doc : ContentFolder) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptFolder - dw.content.Folder のインスタンス
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
ギフト券
バージョン 23.1 の Gift Certificate (ギフト券) フック
dw.ocapi.shop.gift_certificate.beforePOST
POST /gift_certificate
メソッドの詳細
beforePOST (giftCertificateRequest : GiftCertificateRequest) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- giftCertificateRequest - ギフト券コードを含むリクエスト。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.gift_certificate.modifyPOSTResponse
POST /gift_certificate
メソッドの詳細
modifyPOSTResponse (giftCertificate : dw.order.GiftCertificate, giftCertificateResponse : GiftCertificate) : dw.system.Status
- パラメーター:
- giftCertificate - ターゲットのギフト券
- giftCertificateResponse - ギフト券レスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
注文
Shop API の Order (注文) フック。
dw.ocapi.shop.order.afterPATCH
PATCH /orders/{order_no}
メソッドの詳細
afterPATCH (order : dw.order.Order, orderInput : Order) : dw.system.Status
この関数は、注文が変更された後に呼び出されます。
- パラメーター:
- order - 変更された注文
- orderInput - REST 呼び出しからの入力データ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.afterPOST
POST /orders
メソッドの詳細
afterPOST (order : dw.order.Order) : dw.system.Status
この関数は、買い物カゴから注文が作成された後に呼び出されます。
- パラメーター:
- order - 買い物カゴから作成された注文
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.afterPUT
PUT /orders/{order_no}
メソッドの詳細
afterPUT (order : dw.order.Order) : dw.system.Status
この関数は、呼び出しで注文番号が指定されて、買い物カゴから注文が作成された後に呼び出されます。
- パラメーター:
- order - 買い物カゴから作成された注文
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.beforeGET
GET /orders/{order_no}
メソッドの詳細
beforeGET (orderNo : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- orderNo - 注文番号
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.beforePATCH
PATCH /orders/{order_no}
メソッドの詳細
beforePATCH (order : dw.order.Order, orderInput : Order) : dw.system.Status
この関数は、注文が変更される前に呼び出されます。
- パラメーター:
- order - 変更される注文
- orderInput - REST 呼び出しからの入力データ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.beforePOST
POST /orders
メソッドの詳細
beforePOST (basket : dw.order.Basket) : dw.system.Status
この関数は、買い物カゴから注文が作成される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.beforePUT
PUT /orders/{order_no}
メソッドの詳細
beforePUT (ctor : dw.order.Basket) : dw.system.Status
この関数は、呼び出しで注文番号が指定されて、買い物カゴから注文が作成される前に呼び出されます。
- パラメーター:
- basket - 注文が作成される買い物カゴ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.modifyGETResponse
GET /orders/{order_no}
メソッドの詳細
modifyGETResponse (order : dw.order.Order, orderResponse : Order) : dw.system.Status
- パラメーター:
- order - ターゲットの注文
- orderResponse - 注文のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.modifyPATCHResponse
PATCH /orders/{order_no}
メソッドの詳細
modifyPATCHResponse (order : dw.order.Order, orderResponse : Order) : dw.system.Status
- パラメーター:
- order - ターゲットの注文
- orderResponse - 注文のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.modifyPOSTResponse
POST /orders
メソッドの詳細
modifyPOSTResponse (order : dw.order.Order, orderResponse : Order) : dw.system.Status
- パラメーター:
- order - ターゲットの注文
- orderResponse - 注文のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.modifyPUTResponse
PUT /orders/{order_no}
メソッドの詳細
modifyPUTResponse (order : dw.order.Order, orderResponse : Order) : dw.system.Status
- パラメーター:
- order - ターゲットの注文
- orderResponse - 注文のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
注文支払
Shop API の Order Payment (注文支払) フック。
dw.order.payment.authorize
PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id}
メソッドの詳細
authorize (order : dw.order.Order, paymentDetails : dw.order.OrderPaymentInstrument) : dw.system.Status
カスタム支払承認 - 注文を必要に応じて変更します。
- 前提条件: データ API を使用して、またはストアフロントを通じて、注文が作成されました。
- Status.OK が返された場合: 対応する支払トランザクションは、承認済みとしてマークされます (通常、このためにカスタムプロパティが使用されます)。
- Status.ERROR が返された場合: 注文は保留になり、承認を繰り返す必要があります。
- パラメーター:
- order - 注文
- paymentDetails - 指定された支払の詳細
- 返品数:
-
- Status.OK 承認に成功。
- Status.ERROR 承認に失敗。
dw.order.payment.authorize
POST /orders/{order_no}/payment_instruments
メソッドの詳細
authorize (order : dw.order.Order, paymentDetails : dw.order.OrderPaymentInstrument) : dw.system.Status
カスタム支払承認 - 注文を必要に応じて変更します。
- 前提条件: データ API を使用して、またはストアフロントを通じて、注文が作成されました。
- Status.OK が返された場合: 対応する支払トランザクションは、承認済みとしてマークされます (通常、このためにカスタムプロパティが使用されます)。
- Status.ERROR が返された場合: 注文は保留になり、承認を繰り返す必要があります。
- パラメーター:
- order - 注文
- paymentDetails - 指定された支払の詳細
- 返品数:
-
- Status.OK 承認に成功。
- Status.ERROR 承認に失敗。
dw.order.payment.authorizeCreditCard
PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id}
メソッドの詳細
authorizeCreditCard (order : dw.order.Order, paymentDetails : dw.order.OrderPaymentInstrument, cvn : String) : dw.system.Status
クレジットカードのカスタム支払承認 - 注文を必要に応じて変更します。
- 前提条件: データ API を使用して、またはストアフロントを通じて、注文が作成されました。
- Status.OK が返された場合: 対応する支払トランザクションは、承認済みとしてマークされます (通常、このためにカスタムプロパティが使用されます)。
- Status.ERROR が返された場合: 注文は保留になり、承認を繰り返す必要があります。
- パラメーター:
- order - 注文
- paymentDetails - 指定された支払の詳細
- cvn - クレジットカードの検証番号
- 返品数:
-
- Status.OK 承認に成功。
- Status.ERROR 承認に失敗。
dw.order.payment.authorizeCreditCard
POST /orders/{order_no}/payment_instruments
メソッドの詳細
authorizeCreditCard (order : dw.order.Order, paymentDetails : dw.order.OrderPaymentInstrument, cvn : String) : dw.system.Status
クレジットカードのカスタム支払承認 - 注文を必要に応じて変更します。
- 前提条件: データ API を使用して、またはストアフロントを通じて、注文が作成されました。
- Status.OK が返された場合: 対応する支払トランザクションは、承認済みとしてマークされます (通常、このためにカスタムプロパティが使用されます)。
- Status.ERROR が返された場合: 注文は保留になり、承認を繰り返す必要があります。
- パラメーター:
- order - 注文
- paymentDetails - 指定された支払の詳細
- cvn - クレジットカードの検証番号
- 返品数:
-
- Status.OK 承認に成功。
- Status.ERROR 承認に失敗。
dw.ocapi.shop.order.validateOrder
DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id}
メソッドの詳細
validateOrder (order : Order) : dw.system.Status
注文の更新後に注文を検証します。データベーストランザクション外でフックが呼び出されるため、注文の変更はできません。クライアントに情報を伝えるために、カスタムフラッシュの追加を許可します。flash の追加の例:
1exports.validateBasket = function() {
2 order.addFlash({
3 type: "PaymentAuthorizationFailure",
4 message: "Order was not successfully authorized.",
5 path: "authorizations",
6 details: {
7 "result": "reject",
8 "reason": "invalid_credit_card"
9 }
10 });
11}- パラメーター:
- order - 変更された注文
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.validateOrder
PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id}
メソッドの詳細
validateOrder (order : Order) : dw.system.Status
注文の更新後に注文を検証します。データベーストランザクション外でフックが呼び出されるため、注文の変更はできません。クライアントに情報を伝えるために、カスタムフラッシュの追加を許可します。flash の追加の例:
1exports.validateBasket = function () {
2 order.addFlash({
3 type: "PaymentAuthorizationFailure",
4 message: "Order was not successfully authorized.",
5 path: "authorizations",
6 details: {
7 result: "reject",
8 reason: "invalid_credit_card",
9 },
10 });
11};- パラメーター:
- order - 変更された注文
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.validateOrder
POST /orders/{order_no}/payment_instruments
メソッドの詳細
validateOrder (order : Order) : dw.system.Status
注文の更新後に注文を検証します。データベーストランザクション外でフックが呼び出されるため、注文の変更はできません。クライアントに情報を伝えるために、カスタムフラッシュの追加を許可します。flash の追加の例:
1exports.validateBasket = function () {
2 order.addFlash({
3 type: "PaymentAuthorizationFailure",
4 message: "Order was not successfully authorized.",
5 path: "authorizations",
6 details: {
7 result: "reject",
8 reason: "invalid_credit_card",
9 },
10 });
11};- パラメーター:
- order - 変更された注文
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
注文メモ
Shop API の Note (メモ) フック。
dw.ocapi.shop.order.note.afterDELETE
DELETE /orders/{order_no}/notes/{note_id}
メソッドの詳細
afterDELETE (order : dw.order.Order, note : dw.object.Note) : dw.system.Status
この関数は、メモが削除された後に呼び出されます。
- パラメーター:
- order - 注文
- note - 削除されるメモ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.note.beforeDELETE
DELETE /orders/{order_no}/notes/{note_id}
メソッドの詳細
beforeDELETE (order : dw.order.Order, note : dw.object.Note) : dw.system.Status
この関数は、メモが削除される前に呼び出されます。
- パラメーター:
- order - 注文
- note - 削除されるメモ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.note.beforePOST
POST /orders/{order_no}/notes
メソッドの詳細
beforePOST (orderNo : String, note : Note) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- orderNo - メモを取得する注文の ID。
- note - 追加されるメモ。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.note.modifyDELETEResponse
DELETE /orders/{order_no}/notes/{note_id}
メソッドの詳細
modifyDELETEResponse (order : dw.order.Order, orderResponse : Order, noteId : String) : dw.system.Status
- パラメーター:
- order - ターゲットの注文
- orderResponse - 注文のレスポンスオブジェクト
- noteId - 削除するメモの ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.note.modifyPOSTResponse
POST /orders/{order_no}/notes
メソッドの詳細
modifyPOSTResponse (order : dw.order.Order, orderResponse : Order) : dw.system.Status
- パラメーター:
- order - ターゲットの注文
- orderResponse - 注文のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
注文メモ
Shop API の Notes (メモ) フック。
dw.ocapi.shop.order.notes.beforeGET
GET /orders/{order_no}/notes
メソッドの詳細
beforeGET (orderNo : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- orderNo - メモを取得する注文の ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.notes.modifyGETResponse_v2
GET /orders/{order_no}/notes
メソッドの詳細
modifyGETResponse_v2 (order : dw.order.Order, notesResultResponse : NotesResult) : dw.system.Status
- パラメーター:
- order - メモの結果を取得する注文。
- notesResultResponse - メモの結果のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
注文の支払手段
Shop API の Order Payment Instruments (注文支払手段) フック。
dw.ocapi.shop.order.payment_instrument.afterDELETE
DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id}
メソッドの詳細
afterDELETE (order : dw.order.Order, paymentInstrument : dw.order.OrderPaymentInstrument) : dw.system.Status
この関数は、注文の支払手段が削除された後に呼び出されます。
- パラメーター:
- order - 変更された注文
- paymentInstrument - 削除された支払手段
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.payment_instrument.afterPATCH
PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id}
メソッドの詳細
afterPATCH (order : dw.order.Order, paymentInstrument : dw.order.OrderPaymentInstrument, newPaymentInstrument : OrderPaymentInstrumentRequest, successfullyAuthorized : boolean) : dw.system.Status
この関数は、注文の支払手段が更新された後に呼び出されます。
- パラメーター:
- order - 変更された注文
- paymentInstrument - 更新された支払手段
- newPaymentInstrument - 新しい支払手段データ
- successfullyAuthorized - 支払手段の承認が完了。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.payment_instrument.afterPOST
POST /orders/{order_no}/payment_instruments
メソッドの詳細
afterPOST (order : dw.order.Order, paymentInstrument : OrderPaymentInstrumentRequest, successfullyAuthorized : boolean) : dw.system.Status
この関数は、支払手段が注文に追加された後に呼び出されます。
- パラメーター:
- order - 変更された注文
- paymentInstrument - 注文に追加された支払手段
- successfullyAuthorized - 支払手段の承認が完了。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.payment_instrument.beforeDELETE
DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id}
メソッドの詳細
beforeDELETE (order : dw.order.Order, paymentInstrument : dw.order.OrderPaymentInstrument) : dw.system.Status
この関数は、注文の支払手段が削除される前に呼び出されます。
- パラメーター:
- order - 変更された注文
- paymentInstrument - 削除される支払手段
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.payment_instrument.beforePATCH
PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id}
メソッドの詳細
beforePATCH (order : dw.order.Order, paymentInstrument : dw.order.OrderPaymentInstrument, newPaymentInstrument : OrderPaymentInstrumentRequest) : dw.system.Status
この関数は、注文の支払手段が更新される前に呼び出されます。
- パラメーター:
- order - 変更された注文
- paymentInstrument - 更新される支払手段
- newPaymentInstrument - 新しい支払手段データ
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.payment_instrument.beforePOST
POST /orders/{order_no}/payment_instruments
メソッドの詳細
beforePOST (order : dw.order.Order, paymentInstrument : OrderPaymentInstrumentRequest) : dw.system.Status
この関数は、支払手段が注文に追加される前に呼び出されます。
- パラメーター:
- order - 変更された注文
- paymentInstrument - 注文に追加される支払手段
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.payment_instrument.modifyDELETEResponse
DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id}
メソッドの詳細
modifyDELETEResponse (order : dw.order.Order, orderResponse : Order, paymentInstrumentId : String) : dw.system.Status
- パラメーター:
- order - ターゲットの注文
- orderResponse - 注文のレスポンスオブジェクト
- paymentInstrumentId - 支払手段 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.payment_instrument.modifyPATCHResponse
PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id}
メソッドの詳細
modifyPATCHResponse (order : dw.order.Order, orderResponse : Order, paymentInstrumentId : String) : dw.system.Status
- パラメーター:
- order - ターゲットの注文
- orderResponse - 注文のレスポンスオブジェクト
- paymentInstrumentId - 支払手段 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.payment_instrument.modifyPOSTResponse
POST /orders/{order_no}/payment_instruments
メソッドの詳細
modifyPOSTResponse (order : dw.order.Order, orderResponse : Order) : dw.system.Status
- パラメーター:
- order - ターゲットの注文
- orderResponse - 注文のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
注文の支払方法
Shop API の Order Payment Methods (注文支払方法) フック。
dw.ocapi.shop.order.payment_methods.beforeGET
GET /orders/{order_no}/payment_methods
メソッドの詳細
beforeGET (orderNumber : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- orderNumber - 注文番号
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.order.payment_methods.modifyGETResponse_v2
GET /orders/{order_no}/payment_methods
メソッドの詳細
modifyGETResponse_v2 (order : dw.order.Order, paymentMethodResultResponse : PaymentMethodResult) : dw.system.Status
- パラメーター:
- order - 支払方法の結果を取得する対象の注文
- paymentMethodResultResponse - 支払方法の結果のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
注文検索
Shop API の Order Search (注文検索) フック。
dw.ocapi.shop.order_search.modifyPOSTResponse
POST /order_search
メソッドの詳細
modifyPOSTResponse (orderSearchResultResponse : OrderSearchResult) : dw.system.Status
- パラメーター:
- orderSearchResultResponse - 注文の検索結果のレスポンスオブジェクト。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
Price Adjustment Limits (価格調整の制限) フック
Shop API の Price Adjustment Limits (価格調整の制限) フック。
dw.ocapi.shop.price_adjustment_limits.beforeGET
GET /price_adjustment_limits
メソッドの詳細
beforeGET () : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.price_adjustment_limits.modifyGETResponse
GET /price_adjustment_limits
メソッドの詳細
modifyGETResponse (priceAdjLimitResponse : PriceAdjustmentLimits) : dw.system.Status
- パラメーター:
- priceAdjLimitResponse - PriceAdjustmentLimit レスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
商品
Shop API の Product (商品) フック。
dw.ocapi.shop.product.beforeGET
GET /products/({id},...,{id})
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}/availability
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}/bundled_products
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}/images
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}/links
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}/options
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}/prices
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}/promotions
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}/recommendations
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}/set_products
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.beforeGET
GET /products/{id}/variations
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - URL からの受信商品 ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/({id},...,{id})
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/availability
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/bundled_products
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/images
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/links
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/options
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/prices
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/promotions
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/recommendations
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/set_products
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.modifyGETResponse
GET /products/{id}/variations
メソッドの詳細
modifyGETResponse (scriptProduct : dw.catalog.Product, doc : Product) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- scriptProduct - dw.catalog.Product のインスタンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
商品配送
Shop API の Product Shipping (商品配送) フック。
dw.ocapi.shop.product.shipping_methods.beforeGET
GET /products/{id}/shipping_methods
メソッドの詳細
beforeGET (productId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- productId - リクエストされた商品 ID
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product.shipping_methods.modifyGETResponse_v2
GET /products/{id}/shipping_methods
メソッドの詳細
modifyGETResponse_v2 (product : dw.catalog.Product, shippingMethodResultResponse : ShippingMethodResult) : dw.system.Status
- パラメーター:
- product - 配送方法の結果を取得する商品。
- shippingMethodResultResponse - 配送方法の結果のレスポンス
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
商品リスト
Shop API の Product List (商品リスト) フック。
dw.ocapi.shop.product_list.beforeGET
GET /product_lists/{list_id}
メソッドの詳細
beforeGET (listId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- listId - リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_list.item.beforeGET
GET /product_lists/{list_id}/items/{item_id}
メソッドの詳細
beforeGET (listId : String, itemId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- listId - リストの ID。
- itemId - 品目の ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_list.item.modifyGETResponse
GET /product_lists/{list_id}/items/{item_id}
メソッドの詳細
modifyGETResponse (productList : dw.customer.ProductList, productListItem : dw.customer.ProductListItem, publicProductListItemResponse : PublicProductListItem) : dw.system.Status
- パラメーター:
- productList - 商品リスト。
- productListItem - 商品リスト品目。
- publicProductListItemResponse - 公開商品リスト品目のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_list.items.beforeGET
GET /product_lists/{list_id}/items
メソッドの詳細
beforeGET (listId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- listId - リストの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_list.items.modifyGETResponse
GET /product_lists/{list_id}/items
メソッドの詳細
modifyGETResponse_v2 (productList : dw.customer.ProductList, publicProductListItemResultResponse : PublicProductListItemResult) : dw.system.Status
- パラメーター:
- productList - 品目を取得する対象の商品リスト
- publicProductListItemResultResponse - 公開商品リスト品目の結果のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_list.modifyGETResponse
GET /product_lists/{list_id}
メソッドの詳細
modifyGETResponse (productList : dw.customer.ProductList, publicProductListResponse : PublicProductList) : dw.system.Status
- パラメーター:
- productList - 商品リスト。
- publicProductListResponse - 公開商品リストのレスポンスオブジェクト。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
商品リスト
Shop API の Product Lists (商品リスト) フック。
dw.ocapi.shop.product_lists.beforeGET
GET /product_lists
メソッドの詳細
beforeGET (email : String , firstName : String , lastName : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- email - 顧客の Eメールアドレス、商品リストの所属先
- firstName - 顧客の名、商品リストの所属先
- lastName - 顧客の姓、商品リストの所属先
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_lists.modifyGETResponse
GET /product_lists
メソッドの詳細
modifyGETResponse (publicProductListResultResponse : PublicProductListResult) : dw.system.Status
- パラメーター:
- publicProductListResultResponse - 公開商品リストの結果のレスポンスオブジェクト
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
商品検索
Shop API の Product Search (商品検索) フック。
dw.ocapi.shop.product_search.beforeGET
GET /product_search
メソッドの詳細
beforeGET () : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.beforeGET
GET /product_search/availability
メソッドの詳細
beforeGET () : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.beforeGET
GET /product_search/images
メソッドの詳細
beforeGET () : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.beforeGET
GET /product_search/prices
メソッドの詳細
beforeGET () : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.beforeGET
GET /product_search/represented_products
メソッドの詳細
beforeGET () : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.beforeGET
GET /product_search/variations
メソッドの詳細
beforeGET () : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search
メソッドの詳細
modifyGETResponse (doc : ProductSearchResult) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search/availability
メソッドの詳細
modifyGETResponse (doc : ProductSearchResult) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search/images
メソッドの詳細
modifyGETResponse (doc : ProductSearchResult) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search/prices
メソッドの詳細
modifyGETResponse (doc : ProductSearchResult) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search/represented_products
メソッドの詳細
modifyGETResponse (doc : ProductSearchResult) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.product_search.modifyGETResponse
GET /product_search/variations
メソッドの詳細
modifyGETResponse (doc : ProductSearchResult) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
プロモーション
Shop API の Promotion (プロモーション) フック。
dw.ocapi.shop.promotion.beforeGET
GET /promotions/({id},...,{id})
メソッドの詳細
beforeGET (id : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- id - リクエストされたプロモーションの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.promotion.beforeGET
GET /promotions/{id}
メソッドの詳細
beforeGET (id : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- id - リクエストされたプロモーションの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.promotion.modifyGETResponse
GET /promotions/({id},...,{id})
メソッドの詳細
modifyGETResponse (scriptPromotion : dw.campaign.Promotion, doc : Promotion) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptPromotion - dw.campaign.Promotion のインスタンス
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.promotion.modifyGETResponse
GET /promotions/{id}
メソッドの詳細
modifyGETResponse (scriptPromotion : dw.campaign.Promotion, doc : Promotion) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptPromotion - dw.campaign.Promotion のインスタンス
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
プロモーション
Shop API の Promotions (プロモーション) フック。
dw.ocapi.shop.promotions.beforeGET
GET /promotions
メソッドの詳細
beforeGET (campaignId : String , startDate : String , endDate : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- campaignId - このキャンペーンに割り当てられているプロモーションを検索します (必須)。
- startDate - ISO8601 日付時刻形式 (yyyy-MM-dd'T'HH:mmZ) によるプロモーションの開始日
- endDate - ISO8601 日付時刻形式 (yyyy-MM-dd'T'HH:mmZ) によるプロモーションの終了日。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.promotions.modifyGETResponse
GET /promotions
メソッドの詳細
modifyGETResponse (doc : PromotionResult) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
検索の提案
Shop API の Search Suggestions (検索の提案) フック。
dw.ocapi.shop.search_suggestion.beforeGET
GET /search_suggestion
メソッドの詳細
beforeGET () : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.search_suggestion.modifyGETResponse
GET /search_suggestion
メソッドの詳細
modifyGETResponse (doc : SuggestionResult) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
サイト
Shop API の Site (サイト) フック。
dw.ocapi.shop.site.beforeGET
GET /site
メソッドの詳細
beforeGET (siteId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.site.modifyGETResponse
GET /site
メソッドの詳細
modifyGETResponse (doc : Site) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
店舗
Shop API の Store (店舗) フック。
dw.ocapi.shop.store.beforeGET
GET /stores/{id}
メソッドの詳細
beforeGET (id : String , siteId : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- id - リクエストされた店舗の ID。
- siteID - 店舗の取得元サイトの ID。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.store.modifyGETResponse
GET /stores/({id},...,{id})
メソッドの詳細
modifyGETResponse (scriptStore : dw.catalog.Store, doc :Store) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptStore - an instance of dw.catalog.Store
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.store.modifyGETResponse
GET /stores/{id}
メソッドの詳細
modifyGETResponse (scriptStore : dw.catalog.Store, doc :Store) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- scriptStore - an instance of dw.catalog.Store
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
店舗
Shop API の Stores (店舗) フック。
dw.ocapi.shop.stores.beforeGET
GET /stores
メソッドの詳細
beforeGET (latitude : Double , longitude : Double , countryCode : String , postalCode : String) : dw.system.Status
この関数は、リクエストが処理される前に呼び出されます。
- パラメーター:
- latitude - 店舗を検索するための地理座標の緯度 (値の範囲は -90.00 ～ 90.00)。
- longitude - 店舗を検索するための地理座標の経度 (値の範囲は -180.00 ～ 180.00)。
- countryCode - 2 文字の ISO 国コード (例: "US")。
- postalCode - 郵便番号 (例: "01801")。
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
dw.ocapi.shop.stores.modifyGETResponse
GET /stores
メソッドの詳細
modifyGETResponse (doc : StoreResult) : dw.system.Status
この関数は、リクエストが処理された後に呼び出されます。
- パラメーター:
- doc - ドキュメント
- 返品数:
- null 以外の Status (ステータス) によってフックの実行が終了します
j