Retrieve all open baskets for the logged in customer including the temporary baskets.
Restricted to agent scenario use cases: The returned list contains all agent baskets created with
createAgentBasket() and the current storefront basket which can also be retrieved with
getCurrentBasket(). This method will result in an exception if called by a user without permission
Create_Order_On_Behalf_Of or if no customer is logged in the session.
Please notice that baskets are invalidated after a certain amount of time and may not be returned anymore.
This method returns the current valid basket of the session customer or null if no current valid
basket exists.
The methods getCurrentBasket() and getCurrentOrNewBasket() work based on the selected basket
persistence, which can be configured in the Business Manager site preferences / baskets section. A basket is
valid for the configured basket lifetime.
In hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also
utilizing PWA Kit or other custom headless solution for another part of the same site), this method must
NOT be used. Instead, retrieve baskets via GET baskets/{basketId} or
GET customers/{customerId}/baskets. Do not use getCurrentOrNewBasket() for basket creation
in any scenario.
The current basket, if one exists, is usually updated by the method. In particular the last-modified date is
updated. No update is done when method getCurrentBasket() is used within a read-only hook
implementation (such as a beforeGet or a modifyResponse hook). The lifetime of a basket can be extended
in 2 ways:
The basket is modified in some way, e.g. a product is added resulting in the basket total being newly calculated. This results in the basket lifetime being reset.
The basket has not been modified for 60 minutes, then using this method to access the basket will also reset the basket lifetime.
What happens when a customer logs in? Personal data held inside the basket such as addresses, email addresses and
payment settings is associated with the customer to whom the basket belongs. If the basket being updated belongs
to a different customer this data is removed. This happens when a guest customer that has a basket logs in and
hence identifies as a registered customer. In this case the basket which was previously created by the guest
customer gets transferred to the (now logged in) registered customer. Should the registered customer already have
a basket, this basket is effectively invalidated, but made available using getStoredBasket() allowing
the script to merge content from it if desired.
What happens when a customer logs out or when the customer session times out? After the customer logs out, a
basket belonging to the registered customer (now logged out) is stored (where applicable) and this method
returns null. Personal data is also cleared when the session times out for a guest customer.
The following personal data is cleared:
product line items that were added from a wish list
shipping method
coupon line items
gift certificate line items
billing and shipping addresses
payment instruments
buyer email
If the session currency no longer matches the basket currency, the basket currency should be updated with
Basket.updateCurrency().
Typical usage:
1var basket : Basket = BasketMgr.getCurrentBasket();2if (basket) {3 // do something with basket4}
Constraints:
The method only accesses the basket for the session customer, an exception is thrown when the session customer is null.
This method returns the current valid basket of the session customer or creates a new one if no current valid
basket exists. See getCurrentBasket() for more details.
In hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also
utilizing PWA Kit or other custom headless solution for another part of the same site), this method must
NOT be used. For these scenarios, create baskets via POST baskets REST calls.
This method returns the stored basket of the session customer or null if none is found. A stored
basket is returned in the following situation:
During one visit, a customer-Q logs in and creates a basket-A by adding products to it.
During a subsequent visit, a second basket-B is created for a guest customer who then logs in as customer-Q.
In this case, basket-B is reassigned to customer-Q and basket-A is accessible as the stored basket using this
method. It is now possible to merge the information from the stored basket (basket-A) to the active basket
(basket-B). If this method returns null in the previous scenario, verify that:
The session handling between the two visits is correct - the first visit and second visit must be in different sessions. Furthermore, the second session must contain both basket creations: as guest and the customer login.
The stored basket is not expired.
Basket persistence settings are configured correctly in the Business Manager.
A stored basket exists only if the corresponding setting is selected in Business Manager. preferences' baskets
section. A basket is valid for the configured basket lifetime.
Typical usage:
1var currentBasket : Basket = BasketMgr.getCurrentOrNewBasket();2var storedBasket : Basket = BasketMgr.getStoredBasket();3if (storedBasket) {4 // transfer all the data needed from the stored to the active basket5}
Creates a Basket from an existing Order for the purposes of changing an Order. When an Order is later created
from the Basket, the original Order is changed to status Order.ORDER_STATUS_REPLACED. Restricted
to agent scenario use cases.
In case a storefront customer is using it the created storefront basket cannot be retrieved via
Basket-related CSC Operations from BM (these also use OCAPI REST API).
Baskets containing an "orderNumberBeingEdited" are explicitly excluded from the list of baskets that can be
retrieved. Responsible for this behavior (this kind of basket cannot be used as general purpose shopping baskets)
In case a Business Manager user is logged in into the session the basket will be marked as an agent basket. See
Basket.isAgentBasket()</>.
Any inventory reservation associated with the order will be canceled either early when
Basket.reserveInventory() is called for the new basket or (later) when a new replacement order
is created from the basket. Consider reserving the basket following its creation.
The method only succeeds for an Order
without gift certificates,
status is not cancelled,
was not previously replaced and
was not previously exported.
Failures are indicated by throwing an APIException of type CreateBasketFromOrderException which provides one of
these errorCodes:
Creates a new temporary basket for the current session customer. Temporary baskets are separate from shopper
storefront and agent baskets, and are intended for use to perform calculations or create an order without
disturbing a shopper's open storefront basket. Temporary baskets are automatically deleted after a time duration
of 15 minutes.
This method returns a valid basket of the session customer or null if none is found. This method can
also be used to get a temporary basket for the session customer.
If the basket does not belong to the session customer, the method returns null.
If the registered customer is not logged in, the method returns null.
Restricted to agent scenario use cases: This method will result in an exception if called by a user without
permission Create_Order_On_Behalf_Of or if no customer is logged in the session.
The basket, if accessible, is usually updated in the same way as getCurrentBasket().
If the session currency no longer matches the basket currency, the basket currency should be updated with
Basket.updateCurrency().
Retrieve all open baskets for the logged in customer including the temporary baskets.
Restricted to agent scenario use cases: The returned list contains all agent baskets created with
createAgentBasket() and the current storefront basket which can also be retrieved with
getCurrentBasket(). This method will result in an exception if called by a user without permission
Create_Order_On_Behalf_Of or if no customer is logged in the session.
Please notice that baskets are invalidated after a certain amount of time and may not be returned anymore.
This method returns the current valid basket of the session customer or null if no current valid
basket exists.
The methods getCurrentBasket() and getCurrentOrNewBasket() work based on the selected basket
persistence, which can be configured in the Business Manager site preferences / baskets section. A basket is
valid for the configured basket lifetime.
In hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also
utilizing PWA Kit or other custom headless solution for another part of the same site), this method must
NOT be used. Instead, retrieve baskets via GET baskets/{basketId} or
GET customers/{customerId}/baskets. Do not use getCurrentOrNewBasket() for basket creation
in any scenario.
The current basket, if one exists, is usually updated by the method. In particular the last-modified date is
updated. No update is done when method getCurrentBasket() is used within a read-only hook
implementation (such as a beforeGet or a modifyResponse hook). The lifetime of a basket can be extended
in 2 ways:
The basket is modified in some way, e.g. a product is added resulting in the basket total being newly calculated. This results in the basket lifetime being reset.
The basket has not been modified for 60 minutes, then using this method to access the basket will also reset the basket lifetime.
What happens when a customer logs in? Personal data held inside the basket such as addresses, email addresses and
payment settings is associated with the customer to whom the basket belongs. If the basket being updated belongs
to a different customer this data is removed. This happens when a guest customer that has a basket logs in and
hence identifies as a registered customer. In this case the basket which was previously created by the guest
customer gets transferred to the (now logged in) registered customer. Should the registered customer already have
a basket, this basket is effectively invalidated, but made available using getStoredBasket() allowing
the script to merge content from it if desired.
What happens when a customer logs out or when the customer session times out? After the customer logs out, a
basket belonging to the registered customer (now logged out) is stored (where applicable) and this method
returns null. Personal data is also cleared when the session times out for a guest customer.
The following personal data is cleared:
product line items that were added from a wish list
shipping method
coupon line items
gift certificate line items
billing and shipping addresses
payment instruments
buyer email
If the session currency no longer matches the basket currency, the basket currency should be updated with
Basket.updateCurrency().
Typical usage:
1var basket : Basket = BasketMgr.getCurrentBasket();2if (basket) {3 // do something with basket4}
Constraints:
The method only accesses the basket for the session customer, an exception is thrown when the session customer is null.
This method returns the current valid basket of the session customer or creates a new one if no current valid
basket exists. See getCurrentBasket() for more details.
In hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also
utilizing PWA Kit or other custom headless solution for another part of the same site), this method must
NOT be used. For these scenarios, create baskets via POST baskets REST calls.
This method returns the stored basket of the session customer or null if none is found. A stored
basket is returned in the following situation:
During one visit, a customer-Q logs in and creates a basket-A by adding products to it.
During a subsequent visit, a second basket-B is created for a guest customer who then logs in as customer-Q.
In this case, basket-B is reassigned to customer-Q and basket-A is accessible as the stored basket using this
method. It is now possible to merge the information from the stored basket (basket-A) to the active basket
(basket-B). If this method returns null in the previous scenario, verify that:
The session handling between the two visits is correct - the first visit and second visit must be in different sessions. Furthermore, the second session must contain both basket creations: as guest and the customer login.
The stored basket is not expired.
Basket persistence settings are configured correctly in the Business Manager.
A stored basket exists only if the corresponding setting is selected in Business Manager. preferences' baskets
section. A basket is valid for the configured basket lifetime.
Typical usage:
1var currentBasket : Basket = BasketMgr.getCurrentOrNewBasket();2var storedBasket : Basket = BasketMgr.getStoredBasket();3if (storedBasket) {4 // transfer all the data needed from the stored to the active basket5}
j