Install Sylius

Order Invoicer connects to your Sylius store through its Admin API (API Platform v2). It authenticates with the credentials of an administrator that has API access: Order Invoicer exchanges them for a short-lived token on each sync. No permanent API key is required.

Prerequisites

• Sylius 2.x with the API enabled (enabled by default)
• Your store is accessible over HTTPS
• An administrator account with API access (ROLE_API_ACCESS)

1. Enable API access for an administrator

The Sylius Admin API is only reachable by administrators that have the ROLE_API_ACCESS role. A regular administrator can authenticate but will be denied API access (403 error).

We recommend creating a dedicated administrator for the integration:

1. Log in to the Sylius admin panel.
2. Open Configuration → Administrators.
3. Create a new administrator (or edit an existing one) and enable the API access option (ROLE_API_ACCESS).
4. Save, then note its email and password.

2. Gather your connection details

You will need three pieces of information:

• Store URL: your store's root address, e.g. https://store.example.com (no /admin or path — Order Invoicer appends /api/v2/admin automatically).
• Administrator email: the email of the administrator with API access.
• Administrator password: that account's password.

3. Connect the store in Order Invoicer

1. In Order Invoicer, add a connector and select Sylius.
2. Enter the Store URL, administrator email and password.
3. Click Test connection to verify your credentials.
4. Save: Order Invoicer will start syncing completed orders.

4. Verify the configuration

You can test API authentication with cURL:

curl -X POST "https://store.example.com/api/v2/admin/administrators/token" \
  -H "Content-Type: application/ld+json" \
  -d '{"email":"admin@example.com","password":"your-password"}'

A response containing a token field confirms the credentials are valid and that the administrator has API access.

Common troubleshooting

"The user doesn't have ROLE_API_ACCESS" error (403)

• The administrator authenticated but lacks API access. Enable the API access option on that account (see step 1), or use a dedicated administrator.

"Invalid credentials" error (401)

• Check the administrator email and password.
• Make sure the account is active.

Connection error or 404

• Check that the URL is the store root (https://store.example.com), not the admin URL (.../admin/...).
• Make sure the store is reachable over HTTPS and the API is enabled.

Support

If you run into difficulties, contact us at contact@orderinvoicer.com.

Note: Once this configuration is complete, you can link your invoicing tool in Order Invoicer.