Shopware API Quickstart

This repository provides a quickstart template specifically designed for working with the Shopware 6 Admin API using JavaScript. It is intended exclusively for developers who need to interact with the Shopware 6 Admin API. Please note: This template is not suitable for use with the Shopware Storefront API.

If your goal is to create a frontend website and use Shopware 6 solely as a backend, you should utilize the official Shopware API client instead: @shopware/api-client.

This template uses this Shopware 6 Admin API client: Shopware 6 Admin API Client.

Differences Between This Client and the Official Shopware API Client

Purpose:

• This Client: Designed for the Shopware 6 Admin API, making backend tasks like editing products and bulk updates straightforward. It's ideal for developers managing and automating backend operations.

• Official Client: Focused on the Shopware Storefront API, optimized for frontend development. Best for retrieving data to build and manage e-commerce websites.

Use Case:

• This Client: Ideal for developers who need to automate backend tasks, perform bulk updates, or directly manipulate the data within the Shopware Admin system. It's a great tool for those looking to script complex operations or manage large datasets in Shopware's backend.

• Official Client: Best suited for developers building frontend applications that rely on data from Shopware. It helps in fetching the necessary data to populate a storefront, handle customer interactions, and manage orders and checkout processes.

Getting Started

Prerequisites

• Node.js and npm installed on your development machine.
• Access to a Shopware 6 instance with API credentials.
• Alternatively, a preconfigured Docker setup with dockware to start a Shopware 6 instance for testing. The credentials for the API are preconfigured in the .env.example file.

Using This Template

On GitHub, click on "Use this template" to create a new repository based on this template.
Alternatively, you can use this link: Use this template

After creating your repository, follow these steps to set up the project:

1. Clone your repository:

git clone https://github.com/your-username/your-repository.git
cd your-repository

2. Install the dependencies:

npm install

3. Copy the example environment file and configure your Shopware 6 instance details:

cp .env.example .env

Then, open the .env file and replace the placeholder values with your actual Shopware API credentials:

SHOPWARE_API_URL=https://your-shopware-instance.com
SHOPWARE_API_CLIENT_ID=your-client-id
SHOPWARE_API_CLIENT_SECRET=your-client-secret

Important Notes:

• Client ID and Secret: You can use your Shopware API Client ID and Secret as usual.

• Username and Password: Alternatively, you can use your Shopware admin username as SHOPWARE_API_CLIENT_ID and your password as SHOPWARE_API_CLIENT_SECRET for authentication.

• Generating API Credentials: You can generate the Shopware Admin API credentials in your Shopware backend under Settings > System > Integrations. These credentials can also be used for authentication.

Make sure to keep your .env file secure and do not share your credentials.

Usage

Run the example script to see the API in action:

node index.js

Docker

If you need a Shopware 6 instance to test the API and have Docker installed, you can start a Shopware 6 instance using the following command:

docker-compose up -d
# or if you have a newer Docker version
docker compose up -d

The Docker setup uses dockware and is preconfigured. The API credentials are already set up in the .env.example file, so you can start testing immediately.

Customization

Feel free to modify the example code and add your own logic to interact with the Shopware 6 Admin API as needed.

Contributing

Contributions are welcome! Please fork this repository and submit a pull request with your changes.

License

This project is licensed under the MIT License. However, as this is a template repository, users are free to replace this license with one of their choice. For more information about the MIT License, please refer to the MIT License.