CWS External Sync API Pro/Documentation/Getting Started

Getting Started

Installation, setup, and first synchronization

Prerequisites

Requirements

Shopware

6.5 or higher

PHP

8.2+

SSL/TLS

Valid HTTPS certificate

File Transfer (optional)

SFTP/FTPS access

Setup

Installation

From Shopware Store

  1. 1. Open Shopware Administration
  2. 2. Go to Extensions → Store
  3. 3. Search for “CWS External Sync API Pro”
  4. 4. Click Install
  5. 5. Activate the plugin

Manual Installation

  1. 1. Download plugin from CWS
  2. 2. Extract to custom/plugins/
  3. 3. Run: bin/console plugin:refresh
  4. 4. Install & activate via Administration

Activation

Activate Plugin

  1. 1. Administration → Extensions → My Extensions
  2. 2. Find “CWS External Sync API Pro”
  3. 3. Click the toggle to activate
  4. 4. Confirm the installation
  5. 5. Navigate to CWS External Sync in left menu

Background Processing

Queue Worker Setup

For production, run a persistent queue worker to process imports in the background.

Start Queue Worker

bin/console messenger:consume async --time-limit=3600

For production, use systemd, supervisor, or cloud-native task runner.

Authentication

Create API Token

In Shopware Administration

  1. 1. CWS External Sync → API Tokens
  2. 2. Click “Create Token”
  3. 3. Enter name (e.g., “ERP Integration”)
  4. 4. Select scopes (stock:write, prices:write, etc)
  5. 5. Optionally set expiration and IP allowlist
  6. 6. Save and copy token (shown only once!)

⚠️ Important

Token is displayed only once. Store it securely in environment variables. If lost, create a new one.

Testing

First API Call

Test with cURL (Dry-Run)

curl -X POST https://SHOP_URL/api/external-sync/dry-run \
  -H "Authorization: Bearer API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [{
      "identifier": { "type": "productNumber", "value": "SW10001" },
      "stock": { "quantity": 100 }
    }]
  }'

Quick Start

10-Minute Quick Start

⏱ Step 1 (2 min)

Install plugin

Use Shopware Store installation

⏱ Step 2 (2 min)

Create API token

Admin → CWS External Sync → Create token with stock:write scope

⏱ Step 3 (3 min)

Test dry-run

Use cURL example above to test payload (no data modified)

⏱ Step 4 (2 min)

Execute live update

Same request without dry-run endpoint to actually update products

✓ Done

Check logs

CWS External Sync → Logs to verify results

Next Steps

Continue Learning

API Reference

Complete API documentation

Security

Token management and best practices

Data Mapping

Field reference guide

← Back to Documentation
Shopware Extension Partner