v1
latestOpenAPI 3.0.32026-07-173196215.4 KBGet a basket
Fetch the content of an existing basket.
Baskets are created on demand when the first variant is added to it. Fetching a non existent basket will not return an error but instead just return an empty basket.
Using the with parameter, it is possible to retrieve extra information in the response (see parameters below).
Path parameters
The ID of the Basket
Query parameters
Adjust prices based on the specified campaignKey. If results are not having a matching campaign, the default price is returned.
Please note, that campaign prices are stored in advance and available earlier than the campaign starts.
If includeItemsWithoutProductData is set to true, basket items will be included even if there is no product information available (items.product and items.variant might be empty).
This parameter allows disabling the availability check when adding an item into the wishlist or basket. This is needed to make sure that sold out products can be reserved via Click & Reserve in retail stores (where they are still available). Important – Check if this resource is available for your shop.
The with parameter can be applied to include related resources, for example, the attributes of a product can be attached using with=items.product.attributes. It is also possible to filter attributes by key with=items.product.attributes:key(plusSize) or by type with=items.product.attributes:type(material_care). The with=applicablePromotions parameter can also be applied to include all promotions applicable for the current basket. In the following table, there is more information about possible includes.
| Include | Nested Includes | Available Filters |
|---|---|---|
| items.product | See available includes for products | Check the filters available for products |
| items.variant | See available includes for variants | Check the filters available for variants |
| applicablePromotions |
In case you are operating multiple shops (for example, for different domain names or different languages), each shop is identified by its specific shopId
Headers
Base64-encoded data for custom order information. Should be in the format of map[string]any.
A JWT token containing the customer ID used to validate promotions in the promotion engine.
Response
Successful Operation