CWS External Sync API Pro/Documentation/API Reference

API Reference

Complete REST API documentation

Auth

Authentication

Bearer Token

All API requests require Bearer token authentication via header.

Authorization: Bearer YOUR_API_TOKEN

Endpoints

Available Endpoints

POST /api/external-sync/stock/upsert

Update product stock quantities

POST /api/external-sync/prices/upsert

Update product prices with currency support

POST /api/external-sync/dry-run

Test request without modifying data

GET /api/external-sync/jobs/{jobId}

Check import job status

GET /api/external-sync/runs/{runId}

Get detailed run results

Rate Limits

Rate Limiting

Requests per hour

1,000 per token

Items per request

10,000 max

Payload size

100 MB max

Example

Example Request

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

← Back to Documentation