Pipelet to Script Method Conversion

This section includes information on which pipelets have a script method equivalent. If the pipelet doesn't have a script method equivalent, you can still call the pipelet directly from the script. However, Salesforce recommends using the script method for easier debugging.

Note: Deprecated pipelets, job pipelets, and import/export pipelets don't currently have script equivalents. However, any pipelet can still be called directly from a controller. For more information, see Pipelets to Salesforce B2C Commerce Script Methods.

Pipelets A-Z

Pipelets by Pipelet Group

Pipelets a-Z

Pipelet

Group

Alternative JavaScript API

ABCTest

Analytics

This can be replaced with plain JavaScript

AcceptForm

Forms

dw.web.FormGroup.accept

AddBonusProductToBasket

Basket

dw.order.LineItemCtnr.createBonusProductLineItem

AddCouponToBasket

Basket

dw.order.LineItemCtnr.createCouponLineItem

AddCouponToBasket2

Basket

dw.order.LineItemCtnr.createCouponLineItem

AddGiftCertificateToBasket

Basket

dw.order.LineItemCtnr.createGiftCertificateLineItem, and also use setReceipientName, setSenderName, setMessage, and in some cases setProductList item to add the gift certificate to the basket.

AddGiftCertificateToProductList

ProductList

dw.customer.ProductList.createGiftCertificateItem

AddPaymentInstrumentToBasket

Basket

dw.order.LineItemCtnr.createPaymentInstrument

AddProductToBasket

Basket

dw.order.LineItemCtnr.createProductLineItem and setQuantityValue

AddProductToProductList

ProductList

dw.customer.ProductList.createProductItem

Assign

Common

This is replaced by assignment of variables in JavaScript

CancelOrder

Order

dw.order.OrderMgr.cancelOrder

ClearFormElement

Forms

dw.web.FormElement.clearFormElement

CreateBasketForOrderEdit

Basket

dw.order.BasketMgr.createBasketFromOrder

CreateBasketPaymentInstrument

Basket (deprecated)

dw.order.LineItemCtnr.createPaymentInstrument

CreateBillingAddress

Basket

dw.order.LineItemCtnr.createBillingAddress

CreateCustomer

Customer

dw.customer.CustomerMgr.createCustomer

CreateCustomerAddress

Customer

dw.customer.AddressBook.createAddress

CreateCustomerPaymentInstrument

Customer

dw.customer.Wallet.createPaymentInstrument

CreateCustomerProfile

Customer (deprecated)

(deprecated)

CreateCustomObject

CustomObject

dw.object.CustomObjectMgr.createCustomObject

CreateGiftCertificate

Order

dw.order.GiftCertificateMgr.createGiftCertificate, setRecipientEmail, setRecipientName, setSenderName, setMessage, and setOrderNo.

CreateOrder

Order

dw.order.OrderMgr.createOrder, dw.order.OrderMgr.placeOrder

CreateOrder2

Order

dw.order.OrderMgr.createOrder

CreateOrderNo

Order

dw.order.OrderMgr.createOrderNo

CreatePaymentTransaction

Basket (deprecated)

(deprecated)

CreateProductList

ProductList

dw.customer.ProductListMgr.createProductList

CreateProductListRegistrant

ProductList

dw.customer.ProductList.createRegistration, createCoRegistrant

CreateShipment

Basket

dw.order.LineItemCtnr.createShipment

CreateShippingAddress

Basket

dw.order.Shipping.createShippingAddress

CreateShippingOrders

Order Center

(job)

Eval

Common

This can be replaced with plain JavaScript

ExportABTests

ImpEx

 

ExportCatalog

ImpEx

 

ExportContent

ImpEx

 

ExportCouponCodes

ImpEx

 

ExportCoupons

ImpEx

 

ExportCustomerGroups

ImpEx

 

ExportCustomers

ImpEx

 

ExportCustomObjects

ImpEx

 

ExportGiftCertificates

ImpEx

 

ExportInventoryLists

ImpEx

 

ExportMetaData

ImpEx

 

ExportOrders

ImpEx

 

ExportPriceBooks

ImpEx

 

ExportProductLists

ImpEx

 

ExportPromotions

ImpEx

 

ExportShippingMethods

ImpEx

 

ExportSlots

ImpEx

 

ExportSourceCodes

ImpEx

 

ExportStores

ImpEx

 

ExportTaxTable

ImpEx

 

ExportToOrderCenter

Order

(deprecated)

FailOrder

Order

dw.order.OrderMgr.failOrder

FinalizeOAuthLogin

Customer

dw.customer.oauth.OAuthLoginFlowMgr.finalizeOAuthLogin

GenerateResetPasswordToken

Customer

dw.customer.Credentials.createResetPasswordToken

GetBasket

Basket

dw.order.BasketMgr.getBasket or dw.order.BasketMgr.getCurrentBasket()

GetBrands

Catalog

search for attribute brand using dw.catalog.ProductSearchModel

GetCategory

Catalog

dw.catalog.CatalogMgr.getCategory

GetContent

Content

dw.content.ContentMgr.getContent

GetCustomer

Customer

dw.customer.CustomerMgr.getCustomerByLogin

GetCustomerAddress

Customer

customer.addressBook.getAddress(addressID)

GetCustomerPaymentInstruments

Customer

dw.customer.Wallet.getPaymentInstruments

GetCustomerProfile

Customer (deprecated)

(deprecated)

GetGiftCertificate

Order

dw.order.GiftCertificateMgr.getGiftCertificate

GetLastVisitedProducts

Catalog

session.clickStream...

GetNearestStores

Store

dw.catalog.StoreMgr.searchStoresBy*

GetOrder

Order

dw.order.OrderMgr.getOrder

GetPaymentProcessor

Payment

dw.order.PaymentMethod.getPaymentProcessor

GetProduct

Catalog

dw.customer.ProductListMgr.getProduct and dw.catalog.Product.isOnline (isOnline is used for products being previewed on the storefront)

GetProductList

ProductList

dw.customer.ProductListMgr.getProductList

GetProductLists

ProductList

dw.customer.ProductListMgr.getProductLists

GetReplicationStatus

Replication (deprecated)

(deprecated)

GetSearchSuggestions

Search

dw.suggest.SuggestModel

ImportABTests

ImpEx

 

ImportActiveData

ImpEx

 

ImportCampaigns

ImpEx (deprecated)

 

ImportCatalog

ImpEx

 

ImportContent

ImpEx

 

ImportCoupons

ImpEx

 

ImportCustomerGroups

ImpEx

 

ImportCustomers

ImpEx

 

ImportCustomObjects

ImpEx

 

ImportGiftCertificates

ImpEx

 

ImportInventoryLists

ImpEx

 

ImportKeyValueMapping

ImpEx

 

ImportPriceBooks

ImpEx

 

ImportProductLists

ImpEx

 

ImportPromotions

ImpEx

 

ImportShippingMethods

ImpEx

 

ImportSlots

ImpEx

 

ImportSourceCodes

ImpEx

 

ImportStores

ImpEx

 

ImportTaxTable

ImpEx

 

InitiateOAuthLogin

Customer

dw.customer.oauth.OAuthLoginFlowMgr

InvalidateFormElement

Forms

dw.web.FormElement.invalidateFormElement

InvalidateWebCache

Util

 

LoginAgentUser

Customer

dw.customer.AgentUserMgr.loginAgentUser

LoginCustomer

Customer

dw.customer.CustomerMgr.loginCustomer

LoginOnBehalfCustomer

Customer

dw.customer.AgentUserMgr.loginOnBehalfCustomer

LogoutAgentUser

Customer

dw.customer.AgentUserMgr.logoutAgentUser

LogoutCustomer

Customer

dw.customer.CustomerMgr.logoutCustomer

Paging

Common

dw.web.PagingModel.*

PlaceOrder

Order

dw.order.OrderMgr.placeOrder

RedeemGiftCertificate

Order

dw.order.GiftCertificateMgr.redeemGiftCertificate

RedirectURL

Util

dw.web.URLRedirectMgr

RemoveBasketPaymentInstrument

Basket

dw.order.LineItemCtnr.removePaymentInstrument

RemoveCouponLineItem

Basket

dw.order.LineItemCtnr.removeCouponLineItem

RemoveCustomer

Customer

dw.customer.CustomerMgr.removeCustomer

RemoveCustomerAddress

Customer

dw.customer.AddressBook.removeAddress

RemoveCustomerPaymentInstrument

Customer

dw.customer.Wallet.removePaymentInstrument

RemoveCustomObject

CustomObject

dw.object.CustomObjectMgr.remove

RemoveGiftCertificateLineItem

Basket

dw.order.LineItemCtnr.removeGiftCertificateLineItem

RemoveProductLineItem

Basket

dw.order.LineItemCtnr.removeProductLineItem

RemoveProductList

ProductList

dw.customer.ProductListMgr.removeProductList

RemoveProductListItem

ProductList

dw.customer.ProductList.removeItem

ReplaceLineItemProduct

Basket

dw.order.ProductLineItem.replaceProduct

ReserveInventoryForOrder

Order

dw.product.ProductInventoryMgr.reserveInventory

ResetCustomerPassword

Customer

dw.customer.Credentials.setPasswordWithToken

ResetCustomerPasswordWithToken

Customer

dw.customer.Credentials.setPasswordWithToken

ReturnImport

Order Center

(job)

RunJobNow

Job

(job)

Script

Scripting

Use require to import the script

Search

Search

dw.catalog.ProductSearchModel.search, ContentSearchModel

SearchCustomObject

CustomObject

dw.object.CustomObjectMgr.queryCustomObjects

SearchProductLists

ProductList

dw.customer.ProductListMgr.queryProductLists

SearchRedirectURL

Search

dw.catalog.SearchModel.getRedirectURL

SearchSystemObject

Search

Basically, whatever *Mgr class you are using should have a query method you can use. If it does not, use SystemObjectMgr.* or CustomObjectMgr.* query methods

SendGoogleSiteMap

SiteMap

 

SendMail

Common

dw.net.Mail.send

SetApplicablePriceBooks

Catalog

Call the pipelet directly from the controller. See Pipelets to B2C Commerce Script Methods.

SetCustomerPassword

Customer

dw.customer.Credentials.setPassword

SetFormOptions

Forms

dw.web.FormField.setOptions

SetRequestLocale

Util

dw.system.Request.setLocale

SetSessionCurrency

Util

dw.system.Session.setCurrency

SetShippingMethod

Basket

dw.order.Shipping.setShippingMethod

SetSourceCode

SourceCode

dw.system.Session.setSourceCode

SourceCodeRedirectURL

SourceCode

session.SourceCodeInfo.Redirect.location

StartCheckout

Basket

dw.order.Basket.startCheckout

TriggerReplication

Replication (deprecated)

(deprecated)

UpdateFormWithObject

Forms

dw.web.FormGroup.copyFrom

UpdateObjectWithForm

Forms

dw.web.FormGroup.copyTo

UpdatePageMetaData

Common

dw.system.Request.getPageMetaData

UpdateProductLineItemQuantity

Basket

dw.order.ProductLineItem.updateQuantity

UpdateProductOptionSelections

Catalog

dw.catalog.ProductOptionModel.*

UpdateProductVariationSelections

Catalog

dw.catalog.ProductVariationModel.*

UpdateSearchIndex

Search

(job)

UpdateShippingOrders

Order Center

(job)

UpdateStockLevel

Order (deprecated)

(deprecated)

ValidateActiveDataFile

ImpEx

 

ValidateResetPasswordToken

Customer

dw.customer.CustomerMgr.getCustomerByToken

ValidateXMLFile

ImpEx

 

VerifyCreditCard

Basket (deprecated)

(deprecated)

VerifyCreditCardExpirationDate

Basket (deprecated)

dw.order.PaymentMgr.verifyCreditCardExpirationDate

VerifyCreditCardNumber

Basket (deprecated)

dw.order.PaymentMgr.verifyCreditCardNumber

VerifyPaymentCard

Basket

dw.order.PaymentCard.verify

VSAuthorizeCreditCard

VeriSign

(deprecated)

Pipelets by Pipelet Group

Group

Pipelet

Alternative JavaScript API

Analytics

ABCTest

This can be replaced with plain JavaScript

Basket

AddBonusProductToBasket

dw.order.LineItemCtnr.createBonusProductLineItem

 

AddCouponToBasket

dw.order.LineItemCtnr.createCouponLineItem

 

AddCouponToBasket2

dw.order.LineItemCtnr.createCouponLineItem

 

AddGiftCertificateToBasket

dw.order.LineItemCtnr.createGiftCertificateLineItem, and also use setReceipientName, setSenderName, setMessage, and in some cases setProductList item to add the gift certificate to the basket.

 

AddPaymentInstrumentToBasket

dw.order.LineItemCtnr.createPaymentInstrument

 

AddProductToBasket

dw.order.LineItemCtnr.createProductLineItem and setQuantityValue

 

CreateBasketForOrderEdit

dw.order.BasketMgr.createBasketFromOrder

 

CreateBillingAddress

dw.order.LineItemCtnr.createBillingAddress

 

CreateShipment

dw.order.LineItemCtnr.createShipment

 

CreateShippingAddress

dw.order.Shipping.createShippingAddress

 

GetBasket

dw.order.BasketMgr.getBasket or dw.order.BasketMgr.getCurrentBasket()

 

RemoveBasketPaymentInstrument

dw.order.LineItemCtnr.removePaymentInstrument

 

RemoveCouponLineItem

dw.order.LineItemCtnr.removeCouponLineItem

 

RemoveGiftCertificateLineItem

dw.order.LineItemCtnr.removeGiftCertificateLineItem

 

RemoveProductLineItem

dw.order.LineItemCtnr.removeProductLineItem

 

ReplaceLineItemProduct

dw.order.ProductLineItem.replaceProduct

 

SetShippingMethod

dw.order.Shipping.setShippingMethod

 

StartCheckout

dw.order.Basket.startCheckout

 

UpdateProductLineItemQuantity

dw.order.ProductLineItem.updateQuantity

 

VerifyPaymentCard

dw.order.PaymentCard.verify

Basket (deprecated)

CreateBasketPaymentInstrument

dw.order.LineItemCtnr.createPaymentInstrument

 

CreatePaymentTransaction

(deprecated)

 

VerifyCreditCard

(deprecated)
 

VerifyCreditCardExpirationDate

dw.order.PaymentMgr.verifyCreditCardExpirationDate

 

VerifyCreditCardNumber

dw.order.PaymentMgr.verifyCreditCardNumber

Catalog

GetBrands

search for attribute brand using dw.catalog.ProductSearchModel

 

GetCategory

dw.catalog.CatalogMgr.getCategory

 

GetLastVisitedProducts

session.clickStream...

 

GetProduct

dw.customer.ProductListMgr.getProduct and dw.catalog.Product.isOnline (isOnline is used for products being previewed on the storefront)

 

SetApplicablePriceBooks

Call the pipelet directly from the controller. See Pipelets to B2C Commerce Script Methods.
 

UpdateProductOptionSelections

dw.catalog.ProductOptionModel.*

 

UpdateProductVariationSelections

dw.catalog.ProductVariationModel.*

Common

Assign

This is replaced by assignment of variables in JavaScript

 

Eval

This can be replaced with plain JavaScript

 

Paging

dw.web.PagingModel.*

 

SendMail

dw.net.Mail.send

 

UpdatePageMetaData

dw.system.Request.getPageMetaData

Content

GetContent

dw.content.ContentMgr.getContent

Customer

CreateCustomer

dw.customer.CustomerMgr.createCustomer

 

CreateCustomerAddress

dw.customer.AddressBook.createAddress

 

CreateCustomerPaymentInstrument

dw.customer.Wallet.createPaymentInstrument

 

FinalizeOAuthLogin

dw.customer.oauth.OAuthLoginFlowMgr.finalizeOAuthLogin

 

GenerateResetPasswordToken

dw.customer.Credentials.createResetPasswordToken

 

GetCustomer

dw.customer.CustomerMgr.getCustomerByLogin

 

GetCustomerAddress

customer.addressBook.getAddress(addressID)

 

GetCustomerPaymentInstruments

dw.customer.Wallet.getPaymentInstruments

 

InitiateOAuthLogin

dw.customer.oauth.OAuthLoginFlowMgr

 

LoginAgentUser

dw.customer.AgentUserMgr.loginAgentUser

 

LoginCustomer

dw.customer.CustomerMgr.loginCustomer

 

LoginOnBehalfCustomer

dw.customer.AgentUserMgr.loginOnBehalfCustomer

 

LogoutAgentUser

dw.customer.AgentUserMgr.logoutAgentUser

 

LogoutCustomer

dw.customer.CustomerMgr.logoutCustomer

 

RemoveCustomer

dw.customer.CustomerMgr.removeCustomer

 

RemoveCustomerAddress

dw.customer.AddressBook.removeAddress

 

RemoveCustomerPaymentInstrument

dw.customer.Wallet.removePaymentInstrument

 

ResetCustomerPassword

dw.customer.Credentials.setPasswordWithToken

 

ResetCustomerPasswordWithToken

dw.customer.Credentials.setPasswordWithToken

 

SetCustomerPassword

dw.customer.Credentials.setPassword

 

ValidateResetPasswordToken

dw.customer.CustomerMgr.getCustomerByToken

Customer (deprecated)

CreateCustomerProfile

(deprecated)

 

GetCustomerProfile

(deprecated)

CustomObject

CreateCustomObject

dw.object.CustomObjectMgr.createCustomObject

 

RemoveCustomObject

dw.object.CustomObjectMgr.remove

 

SearchCustomObject

dw.object.CustomObjectMgr.queryCustomObjects

Forms

AcceptForm

dw.web.FormGroup.accept

 

ClearFormElement

dw.web.FormElement.clearFormElement

 

InvalidateFormElement

dw.web.FormElement.invalidateFormElement

 

SetFormOptions

dw.web.FormField.setOptions

 

UpdateFormWithObject

dw.web.FormGroup.copyFrom

 

UpdateObjectWithForm

dw.web.FormGroup.copyTo

ImpEx

ExportABTests

 
 

ExportCatalog

 
 

ExportContent

 
 

ExportCouponCodes

 
 

ExportCoupons

 
 

ExportCustomerGroups

 
 

ExportCustomers

 
 

ExportCustomObjects

 
 

ExportGiftCertificates

 
 

ExportInventoryLists

 
 

ExportMetaData

 
 

ExportOrders

 
 

ExportPriceBooks

 
 

ExportProductLists

 
 

ExportPromotions

 
 

ExportShippingMethods

 
 

ExportSlots

 
 

ExportSourceCodes

 
 

ExportStores

 
 

ExportTaxTable

 
 

ImportABTests

 
 

ImportActiveData

 
 

ImportCatalog

 
 

ImportContent

 
 

ImportCoupons

 
 

ImportCustomerGroups

 
 

ImportCustomers

 
 

ImportCustomObjects

 
 

ImportGiftCertificates

 
 

ImportInventoryLists

 
 

ImportKeyValueMapping

 
 

ImportPriceBooks

 
 

ImportProductLists

 
 

ImportPromotions

 
 

ImportShippingMethods

 
 

ImportSlots

 
 

ImportSourceCodes

 
 

ImportStores

 
 

ImportTaxTable

 
 

ValidateActiveDataFile

 
 

ValidateXMLFile

 

ImpEx (deprecated)

ImportCampaigns

(deprecated)

Job

RunJobNow

(job)

Order

CancelOrder

dw.order.OrderMgr.cancelOrder

 

CreateGiftCertificate

dw.order.GiftCertificateMgr.createGiftCertificate, setRecipientEmail, setRecipientName, setSenderName, setMessage, and setOrderNo.

 

CreateOrder

dw.order.OrderMgr.createOrder, dw.order.OrderMgr.placeOrder

 

CreateOrder2

dw.order.OrderMgr.createOrder

 

CreateOrderNo

dw.order.OrderMgr.createOrderNo

 

ExportToOrderCenter

(deprecated)

 

FailOrder

dw.order.OrderMgr.failOrder

 

GetGiftCertificate

dw.order.GiftCertificateMgr.getGiftCertificate

 

GetOrder

dw.order.OrderMgr.getOrder

 

PlaceOrder

dw.order.OrderMgr.placeOrder

 

RedeemGiftCertificate

dw.order.GiftCertificateMgr.redeemGiftCertificate

 

ReserveInventoryForOrder

dw.product.ProductInventoryMgr.reserveInventory

Order (deprecated)

UpdateStockLevel

(deprecated)

Order Center

CreateShippingOrders

(job)
 

ReturnImport

(job)
 

UpdateShippingOrders

(job)

Payment

GetPaymentProcessor

dw.order.PaymentMethod.getPaymentProcessor

ProductList

AddGiftCertificateToProductList

dw.customer.ProductList.createGiftCertificateItem

 

AddProductToProductList

dw.customer.ProductList.createProductItem

 

CreateProductList

dw.customer.ProductListMgr.createProductList

 

CreateProductListRegistrant

dw.customer.ProductList.createRegistration, createCoRegistrant

 

GetProductList

dw.customer.ProductListMgr.getProductList

 

GetProductLists

dw.customer.ProductListMgr.getProductLists

 

RemoveProductList

dw.customer.ProductListMgr.removeProductList

 

RemoveProductListItem

dw.customer.ProductList.removeItem

 

SearchProductLists

dw.customer.ProductListMgr.queryProductLists

Replication (deprecated)

GetReplicationStatus

(deprecated)

 

TriggerReplication

(deprecated)

Scripting

Script

Use require to import the script

Search

GetSearchSuggestions

dw.suggest.SuggestModel

 

Search

dw.catalog.ProductSearchModel.search, ContentSearchModel

 

SearchRedirectURL

dw.catalog.SearchModel.getRedirectURL

 

SearchSystemObject

dw.order.GiftCertificateMgr.query*, dw.catalog.StoreMgr.query*, dw.campaign.CampaignMgr.querySource*

 

UpdateSearchIndex

 

SiteMap

SendGoogleSiteMap

 

SourceCode

SetSourceCode

dw.system.Session.setSourceCode

 

SourceCodeRedirectURL

session.SourceCodeInfo.Redirect.location

Store

GetNearestStores

dw.catalog.StoreMgr.searchStoresBy*

Util

InvalidateWebCache

 
 

RedirectURL

dw.web.URLRedirectMgr

 

SetRequestLocale

dw.system.Request.setLocale

 

SetSessionCurrency

dw.system.Session.setCurrency

VeriSign

VSAuthorizeCreditCard

(deprecated)