Spryker

https://github.com/spryker/spryker-docs
Admin
Spryker is a composable commerce platform that provides a flexible and scalable foundation for...
Tokens:3,813,065
Snippets:22,062
Trust Score:9.3
Update:3 weeks ago
Show doc for...
Tokens:
Raw
================
LIBRARY RULES
================
- Always share in the begining of answer firstly links to documentation pages relevant for user request.
- Share link to documentation replacing https://github.com/spryker/spryker-docs/blob/master with https://docs.spryker.com/
- Remove from links .md ending
- Example to share links [AI IDE assistants](https://docs.spryker.com/docs/dg/dev/ai/ai-assistants/ai-ide-assistants)

================
CODE SNIPPETS
================
### Bootstrap and start Docker setup

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/sdks/the-docker-sdk/docker-sdk-quick-start-guide.md

Bootstraps the Docker setup, builds, and starts the instance. Run these commands in sequence from the project root.

```bash
docker/sdk boot deploy.*.yml
docker/sdk up
```

--------------------------------

### Example output of queue:task:start

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/backend-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md

Shows the expected output when running the queue:task:start command, including the store, environment, and a message from the publisher.

```bash
{vagrant@spryker-vagrant ➜  current git:(master) ✗  console queue:task:start publish.hello_world
Store: DE | Environment: development
Hello World Writer!
```

--------------------------------

### Run queue:setup in production install recipe

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/guidelines/performance-guidelines/general-performance-guidelines.md

Adds the queue:setup command to config/install/production.yml, run after configuration:sync and before the scheduler starts. Ensures queues and exchanges are created once per deployment when runtime setup is disabled.

```yaml
sections:
    configuration:
        configuration-sync:
            command: 'vendor/bin/console configuration:sync -vvv --no-ansi'

    scheduler-start:
        queue-setup:
            command: 'vendor/bin/console queue:setup'
        scheduler-setup:
            command: 'vendor/bin/console scheduler:setup -vvv --no-ansi'
```

--------------------------------

### Debug Kernel::boot() application setup

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/architecture/dependency-injection/troubleshooting.md

Debug example for Kernel::boot() to inspect application setup. Add a breakpoint to check container compilation, ApplicationPlugins, and ContainerDelegator attachments.

```php
// Add breakpoint in Kernel::boot()
public function boot(): void
{
    // Check if container is already compiled
    // See which ApplicationPlugins are being booted
    // Inspect ContainerDelegator attachments
}
```

--------------------------------

### Run queue:setup per store in development install recipe

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/guidelines/performance-guidelines/general-performance-guidelines.md

Adds the queue:setup command to config/install/development.yml with stores: true so it runs for each store. Use this to create queues after changing queue configuration or installing a module that adds a queue.

```yaml
queue-setup:
    command: 'vendor/bin/console queue:setup'
    stores: true
```

--------------------------------

### Install or update application with setup:install

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/backend-development/console-commands/console-commands.md

Runs a set of commands necessary for installing or updating the application. The steps include deleting cache, removing generated files, creating/migrating the database, generating transfer classes, initializing the database, generating IDE auto-completion files, building project resources, and building the navigation tree. Each command can also be executed individually.

```bash
setup:install
```

```bash
cache:delete-all
```

```bash
setup:remove-generated-directory
```

```bash
setup:propel
```

```bash
transfer:generate
```

```bash
setup:init-db
```

```bash
dev:ide:generate-auto-completion
```

```bash
application:build-navigation-tree
```

--------------------------------

### Set up and start Docker instance

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/set-up-spryker-locally/install-spryker/install/install-in-development-mode-on-windows.md

Commands to set up and start the Docker-based Spryker instance on Windows. First, add the current user to the docker group, then bootstrap the local Docker setup with the deploy.dev.yml file, and finally build and start the instance. The bootstrap command only needs to be run after updating the Docker SDK or changing the deploy file.

```bash
sudo usermod -aG docker $USER
```

```bash
docker/sdk bootstrap deploy.dev.yml
```

```bash
docker/sdk up
```

--------------------------------

### Insert demo data with setup:install:demo-data

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/backend-development/console-commands/console-commands.md

Inserts demo data into the database for testing reasons.

```bash
setup:install:demo-data
```

--------------------------------

### Add DE and AT stores to installation recipe

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/internationalization-and-multi-store/set-up-multiple-stores.md

Example of adding the AT and DE stores to an installation recipe in config/install/*.

```yaml
...

stores:
    ...
    - DE
    - AT
...    
```

--------------------------------

### Bootstrap and Start Spryker Demo Instance

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/set-up-spryker-locally/install-spryker/install/install-in-demo-mode-on-macos-and-linux.md

Bootstrap the local Docker setup for demo mode, then build and start the instance. Bootstrap is only needed after updating the Docker SDK or changing the deploy file; the first launch can take up to 20 minutes.

```shell
docker/sdk bootstrap
```

```shell
docker/sdk up
```

--------------------------------

### Initialize database setup

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/payment-service-provider/latest/base-shop/third-party-integrations/stripe/install-and-configure-stripe-prerequisites.md

Run this command only when initially setting up the database in an environment, for example right after `docker/sdk boot deploy.dev.yml` on a fresh local setup. Do not run it as part of routine deployments to an already-initialized environment.

```bash
vendor/bin/console setup:init-db
```

--------------------------------

### Run the ai-dev-setup skill

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/ai/ai-dev/ai-dev-installation.md

Invoke the setup skill at the Claude Code prompt. It installs the module if needed, generates rules and context, and registers the MCP server.

```text
/spryker-ai-dev-sdk:ai-dev-setup
```

--------------------------------

### Run code generation and database migration

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/payment-service-provider/latest/base-shop/third-party-integrations/stripe/migrate-from-acp-to-stripe.md

Run these commands to generate code and migrate the database. `setup:init-db` is only for initial database setup, and `acl-entity:synchronize` is only for projects with `spryker/acl-merchant-portal` installed.

```bash
vendor/bin/console transfer:generate
vendor/bin/console propel:install
vendor/bin/console setup:init-db
vendor/bin/console acl-entity:synchronize
```

--------------------------------

### Bootstrap, build, and update hosts file

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/set-up-spryker-locally/configure-after-installing/configure-spryker-after-installing.md

Commands to bootstrap the local Docker setup, build and start the instance, and update the hosts file after editing deploy files.

```shell
docker/sdk boot
```

```shell
docker/sdk up
```

```shell
echo "127.0.0.1 {endpointName}" | sudo tee -a /etc/hosts
```

--------------------------------

### package.json dependencies after React install

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/frontend-development/latest/yves/atomic-frontend/integrate-react-into-atomic-frontend.md

Shows the updated dependencies section in package.json after installing React and its types. The versions shown are examples from the guide.

```php
"dependencies": {
  ...
  "@types/react": "~16.7.18",
  "@types/react-dom": "~16.0.11",
  "react": "~16.7.0",
  "react-dom": "~16.7.0"
  ...
}
```

--------------------------------

### Minimal recipe for adding a store (setup-store.yml)

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/internationalization-and-multi-store/adding-stores-in-a-multi-database-setup.md

Example deployment recipe for adding a store. Create this file under config/install/EU/setup-store.yml. It defines environment settings, stores, and sections like search setup and propel migrate. Placeholder stores like {STORE-1} and {STORE-2} should be replaced.

```json
env:
  NEW_RELIC_ENABLED: 0
command-timeout: 7200
stores:
  - { STORE-1 }
  - { STORE-2 }
  ...
sections:
  init-storage:
    setup-search-create-sources:
      command: "vendor/bin/console search:setup:sources -vvv --no-ansi"
      stores: true
  init-storages-per-store:
    propel-migrate:
      command: "vendor/bin/console propel:migrate -vvv --no-ansi"
      stores: true
  ...
```

--------------------------------

### Install Twig v3

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/upgrade-and-migrate/migrating-from-twig-v1-to-twig-v3.md

Install the required version of Twig, for example 3.0.0.

```bash
composer require twig/twig:"^3.0.0"
```

--------------------------------

### Retrieve a product offer - request examples

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/offer-management/latest/marketplace/glue-api-retrieve-product-offers.md

Example requests to retrieve a product offer using the GET /product-offers/{offerId} endpoint. Includes examples with query parameters for product-offer-prices, product-offer-availabilities, and merchants.

```http
GET https://glue.mysprykershop.com/product-offers/offer56
```

```http
GET https://glue.mysprykershop.com/product-offers/offer78?product-offer-prices
```

```http
GET https://glue.mysprykershop.com/product-offers/offer101?product-offer-availabilities
```

```http
GET https://glue.mysprykershop.com/product-offers/offer101?merchants
```

--------------------------------

### Clean data, boot deploy file, and start instance

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/sdks/the-docker-sdk/reset-docker-environments.md

In the project root directory, cleans data, boots the deploy file, and starts the instance. Replace {deploy_file_name} with the actual deploy file name.

```bash
docker/sdk clean-data && docker/sdk boot {deploy_file_name} && docker/sdk up
```

--------------------------------

### GET abstract-products response

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/search/latest/marketplace/glue-api-search-the-product-catalog.md

Example response for a GET request to the abstract-products endpoint, showing a single abstract product with its attributes, prices, and images.

```json
{
    "data": [
        {
            "type": "abstract-products",
            "id": "068",
            "attributes": {
                "sku": "068",
                "name": "Samsung Galaxy S5",
                "description": "Samsung Galaxy S5 is a high-end smartphone...",
                "rating": {
                    "averageRating": 4.5,
                    "reviewCount": 12
                },
                "price": 8005,
                "prices": [
                    {
                        "priceTypeName": "DEFAULT",
                        "currency": {
                            "code": "EUR",
                            "symbol": "€",
                            "name": "Euro"
                        },
                        "grossAmount": 8005,
                        "DEFAULT": 8005
                    },
                    {
                        "priceTypeName": "ORIGINAL",
                        "currency": {
                            "code": "EUR",
                            "symbol": "€",
                            "name": "Euro"
                        },
                        "grossAmount": 9000,
                        "ORIGINAL": 9000
                    }
                ],
                "images": [
                    {
                        "externalUrlSmall": "https://images.icecat.biz/img/norm/medium/21927453-1632.jpg",
                        "externalUrlLarge": "https://images.icecat.biz/img/norm/high/21927453-1632.jpg"
                    }
                ]
            },
            "links": {
                "self": "https://glue.mysprykershop.com/abstract-products/068"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/abstract-products"
    }
}
```

--------------------------------

### Build and start the instance

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/identity-access-management/latest/configure-basic-htaccess-authentication.md

Builds and starts the Docker instance.

```bash
docker/sdk up
```

--------------------------------

### Example: file name import with parameters

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/sdks/the-docker-sdk/deploy-file/deploy-file-reference.md

Example of importing deploy.base.template.yml with parameters env_name and locale.

```yaml
version: 1.0
imports:
    deploy.base.template.yml:
      parameters:
        env_name: 'dev'
        locale: 'en'
```

--------------------------------

### Actions HTTP usage example

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/frontend-development/latest/marketplace/ui-components-library/actions/actions-http.md

Example usage of the Actions HTTP service. The action type is 'http', the URL is '/html-request', and the method is 'GET' (the default).

```html
<spy-button-action
    [action]="{
        type: 'http',
        url: '/html-request',
        method: 'GET',
    }"
>
</spy-button-action>
```

--------------------------------

### Remove propel:config:convert from install recipes

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/integrate-and-configure/integrate-dynamic-propel-configuration.md

Example of the command entry to delete from all install recipes (e.g., config/install/developing.yml, config/install/testing.yml). The ConvertConfigConsole is deprecated.

```yml
propel-config:
    command: "vendor/bin/console propel:config:convert"
```

--------------------------------

### Install facade method runInstall

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/backend-development/extend-spryker/spryker-os-module-customisation/install-module-structure-and-configuration.md

Defines the single method of the Install module's Business layer facade. It starts the installation process and expects Symfony's console input and output objects as arguments.

```php
  /**
  * @param \Symfony\Component\Console\Input\InputInterface $input
  * @param \Symfony\Component\Console\Output\OutputInterface $output
  *
  * @return void
  */
public function runInstall(InputInterface $input, OutputInterface $output): void;
```

--------------------------------

### Start queue:task:start for publish.hello_world

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/backend-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md

Starts processing messages from the publish.hello_world queue. The output shows the store and environment context.

```bash
{vagrant@spryker-vagrant ➜  current git:(master) ✗  console queue:task:start publish.hello_world
Store: DE | Environment: development
```

--------------------------------

### Update Ubuntu packages

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-windows-with-wsl2.md

Run this command in Ubuntu to update the package list and upgrade all installed packages. This is part of the initial setup after installing Ubuntu 20.04.

```bash
sudo apt update && sudo apt dist-upgrade
```

--------------------------------

### Describe your project to the wizard

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/ai/ai-dev/ai-dev-project-starter-wizard.md

Example prompt describing a project for the wizard. A shorter prompt like "We need to set up a project." is also sufficient.

```text
We need to set up a project.
Ostrem sells marine hardware to boatyards and refit shops: brass compasses, brass handrails, brass cleats and ropes.
The logo is supplied as SVG in more than one color, with several variants: an icon, a horizontal lock-up with wordmark, a dark app tile, and a simplified favicon.
The images and logo are inside the ostrem-images folder.
```

--------------------------------

### GET /merchants/:merchantId - Response body example

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/merchant-management/latest/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.md

Displayed response body from a GET request to retrieve a merchant by ID with include parameters for merchant-addresses and merchant-opening-hours.

```json
{
    "data": {
        "type": "merchants",
        "id": "MER000006",
        "attributes": {
            "merchantName": "Sony Experts",
            "merchantUrl": "/en/merchant/sony-experts",
            "contactPersonRole": "Owner",
            "contactPersonTitle": "Mr",
            "contactPersonFirstName": "Sven",
            "contactPersonLastName": "Fehnker",
            "contactPersonPhone": "+49 30 234567691",
            "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png",
            "publicEmail": "support@sony-experts.com",
            "publicPhone": "+49 30 234567691",
            "description": "Capture your moment with the best cameras from Sony. From pocket-size to professional-style, they all pack features to deliver the best quality pictures.Discover the range of Sony cameras, lenses and accessories, and capture your favorite moments with precision and style with the best cameras can offer.",
            "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png",
            "deliveryTime": "1-3 days",
            "latitude": "11.547788",
            "longitude": "48.131058",
            "faxNumber": "+49 30 234567600",
            "legalInformation": {
                "terms": "<p><span style=\"font-weight: bold;\">General Terms</span><br><br>(1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website. <br><br>(2) We do not collect information from visitors of our site or other details to help you with your experience.<br><br><span style=\"font-weight: bold;\">Using your Information</span><br><br>We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways: <br><br>To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.<br><br><span style=\"font-weight: bold;\">Protecting visitor information</span><br><br>Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.</p>",
                "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it's not obligatory. To meet the withdrawal deadline, it's sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.",
                "imprint": "<p>Sony Experts<br><br>Matthias-Pschorr-Straße 1<br>80336 München<br>DE<br><br>Phone: 030 1234567<br>Email: support@sony-experts.com<br><br>Represented by<br>Managing Director: Max Mustermann<br>Register Court: Munich<br>Register Number: HYY 134306<br></p>",
                "dataPrivacy": "Sony Experts values the privacy of your personal data."
            },
            "categories": [
                {
                    "categoryKey": "demoshop",
                    "name": "Demoshop"
                }
            ]
        },
        "links": {
            "self": "https://glue.mysprykershop.com/merchants/MER000006?include=merchant-addresses,merchant-opening-hours"
        },
        "relationships": {
            "merchant-opening-hours": {
                "data": [
                    {
                        "type": "merchant-opening-hours",
                        "id": "MER000006"
                    }
                ]
            },
            "merchant-addresses": {
                "data": [
                    {
                        "type": "merchant-addresses",
                        "id": "MER000006"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "merchant-opening-hours",
            "id": "MER000006",
            "attributes": {
                "weekdaySchedule": [
                    {
                        "day": "MONDAY",
                        "timeFrom": "07:00:00.000000",
                        "timeTo": "13:00:00.000000"
                    },
                    {
                        "day": "MONDAY",
                        "timeFrom": "14:00:00.000000",
                        "timeTo": "20:00:00.000000"
                    }
                ]
            }
        }
    ]
}
```

--------------------------------

### Start the development server with npm run start

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/frontend-development/latest/oryx/contribute-to-oryx.md

Starts the development server for the Storefront. The server automatically reloads when source files are changed.

```bash
npm run start
```

--------------------------------

### Install dependencies and build Back Office frontend

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/business-intelligence/latest/amazon-quicksight-third-party-integration/install-amazon-quicksight.md

Run these commands to install the newly added dependencies and build the Back Office frontend.

```bash
npm install
console frontend:zed:build
```

--------------------------------

### GET /carts

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/cart-and-checkout/latest/base-shop/manage-using-glue-api/glue-api-retrieve-customer-carts.md

This snippet documents the GET /carts endpoint for retrieving customer carts, including the response structure and an example response with cart rules included.

```APIDOC
## GET /carts

### Description
Retrieves a list of carts belonging to the authenticated customer. The response can include related resources such as cart rules or vouchers when requested via the `include` query parameter.

### Method
GET

### Endpoint
/carts

### Parameters
#### Query Parameters
- **include** (string) - Optional - Specifies related resources to include in the response. Supported values: `cart-rules`, `vouchers`.

### Response
#### Success Response (200)
- **data** (array) - List of cart objects.
  - **type** (string) - Resource type, always `carts`.
  - **id** (string) - Unique identifier of the cart.
  - **attributes** (object) - Cart attributes.
    - **priceMode** (string) - Price mode of the cart (e.g., `GROSS_MODE`).
    - **currency** (string) - Currency used in the cart.
    - **store** (string) - Store identifier.
    - **name** (string) - Name of the cart.
    - **isDefault** (boolean) - Whether this is the default cart.
    - **totals** (object) - Totals of the cart.
      - **expenseTotal** (integer|null) - Total expenses.
      - **discountTotal** (integer|null) - Total discount amount.
      - **taxTotal** (integer|null) - Total tax amount.
      - **subtotal** (integer|null) - Subtotal amount.
      - **grandTotal** (integer|null) - Grand total amount.
    - **discounts** (array) - List of discounts applied to the cart.
      - **displayName** (string) - Display name of the discount.
      - **amount** (integer) - Discount amount.
      - **code** (string|null) - Discount code, if any.
  - **links** (object) - Links related to the cart.
    - **self** (string) - URL to the cart resource.
  - **relationships** (object) - Related resources, if included.
    - **cart-rules** (object) - Cart rules relationship data.
      - **data** (array) - List of related cart rule identifiers.
        - **type** (string) - Resource type, always `cart-rules`.
        - **id** (string) - Cart rule identifier.
- **links** (object) - Pagination links.
  - **self** (string) - URL to the current request.
- **included** (array) - Included related resources when requested.
  - **type** (string) - Resource type (e.g., `cart-rules`).
  - **id** (string) - Resource identifier.
  - **attributes** (object) - Attributes of the included resource.
    - **amount** (integer) - Discount amount.
    - **code** (string|null) - Discount code.
    - **discountType** (string) - Type of discount (e.g., `cart_rule`).
    - **displayName** (string) - Display name of the discount.
    - **isExclusive** (boolean) - Whether the discount is exclusive.
    - **expirationDateTime** (string) - Expiration date and time.
    - **discountPromotionAbstractSku** (string|null) - Abstract SKU for promotion, if any.
    - **discountPromotionQuantity** (integer|null) - Quantity for promotion, if any.
  - **links** (object) - Links for the included resource.
    - **self** (string) - URL to the resource.

#### Response Example
```json
{
    "data": [
        {
            "type": "carts",
            "id": "59743e37-0182-5153-9935-77106741a9d2",
            "attributes": {
                "priceMode": "GROSS_MODE",
                "currency": "EUR",
                "store": "DE",
                "name": "Purchases",
                "isDefault": true,
                "totals": {
                    "expenseTotal": null,
                    "discountTotal": null,
                    "taxTotal": null,
                    "subtotal": null,
                    "grandTotal": null
                },
                "discounts": []
            },
            "links": {
                "self": "https://glue.mysprykershop.com/carts/59743e37-0182-5153-9935-77106741a9d2"
            }
        },
        {
            "type": "carts",
            "id": "2fd32609-b6b0-5993-9254-8d2f271941e4",
            "attributes": {
                "priceMode": "GROSS_MODE",
                "currency": "EUR",
                "store": "DE",
                "name": "My Cart",
                "isDefault": false,
                "totals": {
                    "expenseTotal": 0,
                    "discountTotal": 2965,
                    "taxTotal": 4261,
                    "subtotal": 29651,
                    "grandTotal": 26686
                },
                "discounts": [
                    {
                        "displayName": "10% Discount for all orders above",
                        "amount": 2965,
                        "code": null
                    }
                ]
            },
            "links": {
                "self": "https://glue.mysprykershop.com/carts/2fd32609-b6b0-5993-9254-8d2f271941e4"
            },
            "relationships": {
                "cart-rules": {
                    "data": [
                        {
                            "type": "cart-rules",
                            "id": "1"
                        }
                    ]
                }
            }
        },
        {
            "type": "carts",
            "id": "2b72635a-9363-56f5-9ba7-55631b8ad71e",
            "attributes": {
                "priceMode": "GROSS_MODE",
                "currency": "EUR",
                "store": "DE",
                "name": "New",
                "isDefault": false,
                "totals": {
                    "expenseTotal": 0,
                    "discountTotal": 10206,
                    "taxTotal": 14666,
                    "subtotal": 102063,
                    "grandTotal": 91857
                },
                "discounts": [
                    {
                        "displayName": "10% Discount for all orders above",
                        "amount": 10206,
                        "code": null
                    }
                ]
            },
            "links": {
                "self": "https://glue.mysprykershop.com/carts/2b72635a-9363-56f5-9ba7-55631b8ad71e"
            },
            "relationships": {
                "cart-rules": {
                    "data": [
                        {
                            "type": "cart-rules",
                            "id": "1"
                        }
                    ]
                }
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/carts?include=cart-rules"
    },
    "included": [
        {
            "type": "cart-rules",
            "id": "1",
            "attributes": {
                "amount": 10206,
                "code": null,
                "discountType": "cart_rule",
                "displayName": "10% Discount for all orders above",
                "isExclusive": false,
                "expirationDateTime": "2020-12-31 00:00:00.000000",
                "discountPromotionAbstractSku": null,
                "discountPromotionQuantity": null
            },
            "links": {
                "self": "https://glue.mysprykershop.com/cart-rules/1"
            }
        }
    ]
}
```
```

--------------------------------

### Install npm dependencies and build project (alternative)

Source: https://github.com/spryker/spryker-docs/blob/master/docs/about/all/releases/security-releases/security-release-notes-202312.0.md

Alternative commands to install npm dependencies and build the project. The mp:build command is optional and only for the Marketplace setup.

```bash
npm install && npm run yves && npm run zed
npm run mp:build (optional, only for the Marketplace setup)
```

--------------------------------

### Bootstrap Docker setup

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/integrate-and-configure/integrate-custom-location-for-static-assets.md

Run this command to bootstrap the Docker setup with the specified deploy file.

```bash
docker/sdk boot {deploy.dev.yml}
```

--------------------------------

### Installer users configuration in UserConfig

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/guidelines/security-guidelines.md

Example of installer users configuration in UserConfig that should be moved to Parameter Store before production release. Avoid using demo users in production environments.

```php
namespace Pyz\Zed\User;

class UserConfig extends \Spryker\Zed\User\UserConfig
{
    public function getInstallerUsers(): array
    {
        return [
            [
                'firstName' => 'Admin',
                'lastName' => 'Spryker',
                'username' => 'admin@spryker.com',
                'password' => 'change123',
                'localeName' => 'de_DE',
                'isAgent' => 1,
            ],
            // ...
        ];
    }
}
```

--------------------------------

### Run the application

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/frontend-development/latest/oryx/getting-started/set-up-oryx.md

Starts the development server. The application becomes available at localhost:3000.

```shell
npm run dev
```

--------------------------------

### Initialize project with QA automation

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/sdks/sdk/spryks/spryks-qa-automation.md

Run this command to start the project initialization process, where you can select QA automation steps. If none are selected, the default list from settings.yaml is used.

```bash
spryker-sdk sdk:init:project
```

--------------------------------

### Switch to a Demo Shop version

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/updating-spryker/switch-demo-shop-version.md

Switches to the specified Demo Shop version, then builds and runs the project.

```shell
git checkout {DEMOSHOP_VERSION} && \
docker/sdk bootstrap deploy.dev.yml && \
docker/sdk up --build --assets --data --jobs
```

--------------------------------

### Register ProductMeasurementUnitInstallerPlugin and run setup:init-db

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/product-information-management/latest/base-shop/install-and-upgrade/install-features/install-the-measurement-units-feature.md

Register the ProductMeasurementUnitInstallerPlugin in the InstallerDependencyProvider to install infrastructural measurement units, then run the console command to execute installer plugins and populate the spy_product_measurement_unit table.

```php
<?php

namespace Pyz\Zed\Installer;

use Spryker\Zed\Installer\InstallerDependencyProvider as SprykerInstallerDependencyProvider;
use Spryker\Zed\ProductMeasurementUnit\Communication\Plugin\Installer\ProductMeasurementUnitInstallerPlugin;

class InstallerDependencyProvider extends SprykerInstallerDependencyProvider
{
    /**
     * @return \Spryker\Zed\Installer\Dependency\Plugin\InstallerPluginInterface[]
     */
    public function getInstallerPlugins()
    {
        return [
            new ProductMeasurementUnitInstallerPlugin(),
        ];
    }
}
```

```bash
console setup:init-db
```

--------------------------------

### Initialize database with installer plugins

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/customer-relationship-management/latest/base-shop/install-and-upgrade/install-glue-api/install-the-company-roles-backend-api.md

Runs the installer plugins that write permission plugins to the spy_permission table, making them available for assignment to roles.

```bash
docker/sdk console setup:init-db
```

--------------------------------

### Response for GET /multi-factor-auth-types

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/multi-factor-authentication/latest/manage-using-glue-api/glue-api-retrieve-mfa-methods.md

Example response for the GET /multi-factor-auth-types request. Shows the MFA method type (email) and its status (deactivated). Possible statuses: deactivated, activation is pending, activated.

```json
{
  "data": [
    {
      "type": "multi-factor-auth-types",
      "attributes": {
        "type": "email",
        "status": "deactivated"
      }
    }
  ]
}
```

--------------------------------

### Install Purchasing Control feature modules with Composer

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/cart-and-checkout/latest/base-shop/install-and-upgrade/install-features/install-the-purchasing-control-feature.md

Use this Composer command to install the Purchasing Control feature and its required Spryker modules. This command updates dependencies and ignores the ext-grpc platform requirement. Run it after completing the prerequisites listed in the installation guide.

```bash
composer require spryker-feature/purchasing-control:"^2.0.0" spryker/sales:"^11.83.0" spryker/sales-extension:"^1.15.0" spryker-shop/checkout-page:"^3.40.0" spryker-shop/company-page:"^2.36.0" spryker-shop/customer-page:"^2.77.0" spryker-shop/shop-ui:"^1.108.0" --update-with-dependencies --ignore-platform-req=ext-grpc
```

--------------------------------

### Start queue:task:start for sync.storage.hello

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/backend-development/data-manipulation/data-publishing/handle-data-with-publish-and-synchronization.md

Synchronizes data with the key-value store (Redis or Valkey) by starting the sync.storage.hello queue task.

```bash
console queue:task:start sync.storage.hello
```

--------------------------------

### Create module navigation.xml

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/backend-development/zed/add-navigation-in-the-back-office.md

Create the module navigation configuration file for the HelloWorld module.

```bash
touch src/Pyz/Zed/HelloWorld/Communication/navigation.xml

```

--------------------------------

### Run multiple commands without entering the CLI: composer install && console transfer:generate && console propel:install

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/sdks/the-docker-sdk/running-commands-with-the-docker-sdk.md

Run several commands without entering the CLI by passing them together inside a quoted string separated by &&. The example chains composer install, console transfer:generate, and console propel:install.

```bash
docker/sdk cli "composer install && console transfer:generate && console propel:install"

```

--------------------------------

### Boot and start the instance after changing the PHP image

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/set-up-spryker-locally/troubleshooting-installation/an-error-during-front-end-setup.md

Bash command to fetch the changes and start the instance using 'docker/sdk boot && docker/sdk up' after updating the PHP image in deploy.*.yaml. This is the second step of the solution.

```bash
docker/sdk boot && docker/sdk up

```

--------------------------------

### Example nested dependency path in package-lock.json

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/upgrade-and-migrate/upgrade-to-angular-18.md

Example of a dependency that may end up in a nested location after npm install, indicating broken hoisting. If you see this path, regenerate the lock file and reinstall.

```json
vendor/spryker-shop/zed-ui/node_modules/@spryker/notification
```

--------------------------------

### Install frontend dependencies and build Zed

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/product-information-management/latest/base-shop/third-party-integrations/smart-product-management/install-smart-product-management.md

Run these commands to install frontend dependencies and build the Zed frontend after integrating the Smart Product Management feature.

```bash
npm install
console frontend:project:install-dependencies
console frontend:zed:build
```

--------------------------------

### Request examples for retrieving company roles

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/customer-relationship-management/latest/base-shop/manage-using-glue-api/company-account/glue-api-retrieve-company-roles.md

Example GET requests to retrieve all company roles for the current user, a specific company role by ID, and a company role with related companies included.

```http
GET https://glue.mysprykershop.com/company-roles/mine
```

```http
GET https://glue.mysprykershop.com/company-roles/2f0a9d3e-9e69-53eb-8518-284a0db04376
```

```http
GET https://glue.mysprykershop.com/company-roles/2f0a9d3e-9e69-53eb-8518-284a0db04376?include=companies
```

--------------------------------

### Resolve plugins with findPlugin and requirePlugin

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/frontend-development/latest/oryx/building-applications/oryx-application-orchestration/oryx-application.md

Use findPlugin to get a plugin or undefined if not available, and requirePlugin to get a plugin or throw an error if not registered. Examples shown with class reference and string name.

```ts
app.findPlugin(MyPlugin);
app.requirePlugin('my-plugin-name');
```

--------------------------------

### Clone the Marketplace B2B Demo Shop and start Claude Code

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/ai/ai-dev/ai-dev-project-starter-wizard.md

Clone the Marketplace B2B Demo Shop repository and start Claude Code in the clone without booting or installing the project first.

```text
git clone https://github.com/spryker-shop/b2b-demo-marketplace.git my-project
cd my-project
claude
```

--------------------------------

### Install or update Mutagen and Mutagen Compose

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-macos.md

Removes any existing Mutagen packages, installs the latest versions of Mutagen and Mutagen Compose, then restarts the Mutagen daemon. Run this before starting Spryker in development mode.

```bash
brew list | grep mutagen | xargs brew remove && brew install mutagen-io/mutagen/mutagen mutagen-io/mutagen/mutagen-compose && mutagen daemon stop && mutagen daemon start
```

--------------------------------

### Bootstrap Docker setup with docker/sdk boot

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/integrate-and-configure/Integrate-profiler-module.md

Boot the Docker setup using the development deployment file. This step is required after enabling the xhprof extension.

```shell
docker/sdk boot deploy.dev.yml
```

--------------------------------

### GET warehouse-user-assignments requests

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/warehouse-management-system/latest/unified-commerce/manage-using-glue-api/manage-warehouse-user-assignments/glue-api-retrieve-warehouse-user-assignments.md

Two example GET requests to retrieve a warehouse user assignment by ID. The second request includes the `include=users` query parameter to also retrieve information about the authenticated user.

```http
https://glue-backend.mysprykershop.com/warehouse-user-assignments/99e048ef-8cd8-5e52-aca9-50a590a469c2
```

```http
https://glue-backend.mysprykershop.com/warehouse-user-assignments/99e048ef-8cd8-5e52-aca9-50a590a469c2?include=users
```

--------------------------------

### Boot the stack with docker/sdk

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/oauth/latest/install-and-upgrade/set-up-keycloak-for-local-development.md

Boots the local development stack using the deploy.dev.yml configuration and starts the services.

```bash
docker/sdk boot deploy.dev.yml
docker/sdk up
```

--------------------------------

### Initialize Composer

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/developing-standalone-modules/publish-standalone-modules-on-packagist.md

Run composer init to create composer.json and follow the prompts for package details.

```bash
composer init
```

--------------------------------

### GET /carts/{cartId}

Source: https://github.com/spryker/spryker-docs/blob/master/docs/pbc/all/discount-management/latest/base-shop/manage-using-glue-api/glue-api-retrieve-discounts-in-carts-of-registered-users.md

This snippet documents the GET endpoint for retrieving a cart of a registered user, including discount information. It covers the endpoint, parameters, and response structure with examples for both promotional items and vouchers.

```APIDOC
## GET /carts/{cartId}

### Description
Retrieves a cart of a registered user by its ID, including discounts applied to the cart. The response includes discount details such as display name, amount, and code. Optionally, the response can include related vouchers or promotional items.

### Method
GET

### Endpoint
`https://glue.mysprykershop.com/carts/{cartId}`

### Parameters
#### Path Parameters
- **cartId** (string) - Required - Unique identifier of the cart to retrieve.

#### Query Parameters
- **include** (string) - Optional - Comma-separated list of related resources to include. Possible values: `vouchers`, `promotional-items`.

### Response
#### Success Response (200)
- **data** (object) - Cart resource object.
  - **type** (string) - Resource type, always `carts`.
  - **id** (string) - Unique identifier of the cart.
  - **attributes** (object) - Cart attributes.
    - **priceMode** (string) - Price mode of the cart (e.g., `GROSS_MODE`).
    - **currency** (string) - Currency used in the cart.
    - **store** (string) - Store name.
    - **name** (string) - Cart name (optional).
    - **isDefault** (boolean) - Whether the cart is the default cart (optional).
    - **totals** (object) - Cart totals.
      - **expenseTotal** (integer) - Total expenses.
      - **discountTotal** (integer) - Total discount amount.
      - **taxTotal** (integer) - Total tax amount.
      - **subtotal** (integer) - Subtotal amount.
      - **grandTotal** (integer) - Grand total amount.
      - **priceToPay** (integer) - Amount to pay (optional).
    - **discounts** (array) - List of discounts applied to the cart.
      - **displayName** (string) - Display name of the discount.
      - **amount** (integer) - Discount amount.
      - **code** (string|null) - Discount code, if applicable.
    - **thresholds** (array) - List of thresholds (empty in examples).
  - **links** (object) - Links related to the cart.
    - **self** (string) - Self link to the cart.
  - **relationships** (object) - Related resources (optional).
    - **promotional-items** (object) - Promotional items relationship (optional).
      - **data** (array) - List of promotional item references.
        - **type** (string) - Resource type, `promotional-items`.
        - **id** (string) - Promotional item ID.
    - **vouchers** (object) - Vouchers relationship (optional).
      - **data** (array) - List of voucher references.
        - **type** (string) - Resource type, `vouchers`.
        - **id** (string) - Voucher code.
- **included** (array) - Included resources when `include` parameter is used.
  - **promotional-items** (object) - Promotional item details.
    - **type** (string) - Resource type.
    - **id** (string) - Promotional item ID.
    - **attributes** (object) - Promotional item attributes.
      - **sku** (string) - SKU of the promotional item.
      - **quantity** (integer) - Quantity of the promotional item.
    - **links** (object) - Links for the promotional item.
      - **self** (string) - Self link.
  - **vouchers** (object) - Voucher details.
    - **type** (string) - Resource type.
    - **id** (string) - Voucher code.
    - **attributes** (object) - Voucher attributes.
      - **amount** (integer) - Voucher amount.
      - **code** (string) - Voucher code.
      - **discountType** (string) - Discount type, e.g., `voucher`.
      - **displayName** (string) - Display name of the voucher.
      - **isExclusive** (boolean) - Whether the voucher is exclusive.
      - **expirationDateTime** (string) - Expiration date and time.
      - **discountPromotionAbstractSku** (string|null) - Abstract SKU for discount promotion, if any.
      - **discountPromotionQuantity** (integer|null) - Quantity for discount promotion, if any.
    - **links** (object) - Links for the voucher.
      - **self** (string) - Self link.

#### Response Example
```json
{
    "data": {
        "type": "carts",
        "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2",
        "attributes": {
            "priceMode": "GROSS_MODE",
            "currency": "EUR",
            "store": "DE",
            "name": "My Cart",
            "isDefault": true,
            "totals": {
                "expenseTotal": 0,
                "discountTotal": 11113,
                "taxTotal": 15107,
                "subtotal": 111128,
                "grandTotal": 100015
            },
            "discounts": [
                {
                    "displayName": "10% Discount for all orders above",
                    "amount": 11113,
                    "code": null
                }
            ],
            "thresholds": []
        },
        "links": {
            "self": "https://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2"
        },
        "relationships": {
            "promotional-items": {
                "data": [
                    {
                        "type": "promotional-items",
                        "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "promotional-items",
            "id": "bfc600e1-5bf1-50eb-a9f5-a37deb796f8a",
            "attributes": {
                "sku": "112",
                "quantity": 2
            },
            "links": {
                "self": "https://glue.mysprykershop.com/promotional-items/bfc600e1-5bf1-50eb-a9f5-a37deb796f8a"
            }
        }
    ]
}
```

#### Response Example with Vouchers
```json
{
    "data": {
        "type": "carts",
        "id": "976af32f-80f6-5f69-878f-4ea549ee0830",
        "attributes": {
            "priceMode": "GROSS_MODE",
            "currency": "EUR",
            "store": "DE",
            "totals": {
                "expenseTotal": 0,
                "discountTotal": 25766,
                "taxTotal": 25407,
                "subtotal": 184893,
                "grandTotal": 159127,
                "priceToPay": 159127
            },
            "discounts": [
                {
                    "displayName": "5% discount on all white products",
                    "amount": 7277,
                    "code": null
                },
                {
                    "displayName": "10% Discount for all orders above",
                    "amount": 18489,
                    "code": null
                }
            ],
            "thresholds": []
        },
        "links": {
            "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830?include=vouchers"
        },
        "relationships": {
            "vouchers": {
                "data": [
                    {
                        "type": "vouchers",
                        "id": "sprykercu2d"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "vouchers",
            "id": "sprykercu2d",
            "attributes": {
                "amount": 7277,
                "code": "sprykercu2d",
                "discountType": "voucher",
                "displayName": "5% discount on all white products",
                "isExclusive": false,
                "expirationDateTime": "2021-02-27 00:00:00.000000",
                "discountPromotionAbstractSku": null,
                "discountPromotionQuantity": null
            },
            "links": {
                "self": "https://glue.mysprykershop.com/carts/976af32f-80f6-5f69-878f-4ea549ee0830/cart-codes/sprykercu2d"
            }
        }
    ]
}
```
```

--------------------------------

### Compile and install OCaml

Source: https://github.com/spryker/spryker-docs/blob/master/docs/dg/dev/sdks/the-docker-sdk/configure-a-mount-mode.md

Install build prerequisites, download and extract OCaml, configure and compile it, then install and clean up.

```bash
sudo apt-get install build-essential make
```

```bash
wget http://caml.inria.fr/pub/distrib/ocaml-{ocaml-version}/ocaml-{ocaml-version}.tar.gz
```

```bash
tar xvf ocaml-{ocaml-version}.tar.gz
```

```bash
cd ocaml-{ocaml-version}
```

```bash
./configure
make world
make opt
umask 022
```

```bash
sudo make install
sudo make clean
```
Tokens:
Raw