Appearance
Credentials & targets
For merchants
Credentials
Where: Settings → Extensions → Credentials
A credential tells the plugin how to authenticate with a receiving system. One credential can be shared by several targets.
| Authentication type | Fields | What is sent |
|---|---|---|
| None | — | No authentication. |
| API key | Header name (default X-Api-Key), Secret | <Header name>: <secret> |
| Basic | Username, Secret (password) | Authorization: Basic … |
| Bearer token | Secret (token) | Authorization: Bearer <token> |
| OAuth2 (client credentials) | Token URL, Client ID, Scope (optional), Secret (client secret) | The plugin fetches an access token from the token URL and sends Authorization: Bearer <access token>, fetching a new one when it expires. |
The secret is write-only. After saving, the list only shows whether a secret is set; the edit screen shows leave blank to keep current. Secrets are encrypted in the database and never returned by the API. Type a new value to rotate it.
The credential's secret is also the shared secret for acknowledgement callbacks — see Acknowledgement callback.
Export targets
Where: Settings → Extensions → Export targets
A target is one receiving system.
General settings
| Field | Default | Meaning |
|---|---|---|
| Name | — | Shown in lists, on the order card and in Flow Builder. |
| Active | on | Inactive targets cannot be exported to. |
| Mapping | — | Which mapping renders the payload. Its published version is used. |
| Execution mode | Synchronous | Synchronous: exported during the flow that triggers it. Asynchronous (queued): handed to a background worker, with automatic retries. |
| Sales channels | all | Not enforced in 0.9.0-beta.1 — see Exporting orders. |
Connection settings
| Field | Default | Meaning |
|---|---|---|
| Endpoint URL | — | Full URL, e.g. https://erp.example.com/api/orders. |
| HTTP method | POST | POST, PUT or PATCH. |
| Transport | HTTP (JSON) | The only transport shipped. Sends the mapping's format (JSON or XML) with a matching Content-Type. |
| Timeout (ms) | 30000 | How long to wait for the response. |
| Verify TLS certificate | on | Turn off only for a test system with a self-signed certificate. |
| Credential | — | How to authenticate. |
Test connection sends a GET request to the endpoint URL with the configured authentication and reports whether the server answered, and with which HTTP status. Any HTTP answer counts as reachable — an endpoint that only accepts POST may answer 405, which still proves the URL, network and TLS are fine.
Delivery & acknowledgement
How the plugin decides an export has succeeded:
| Acknowledgement mode | Export succeeds when… | Extra fields |
|---|---|---|
| None (2xx completes) | The endpoint answers with any 2xx status. | — |
| Synchronous (read response) | The endpoint answers 2xx and the value at Acknowledgement path in the JSON response equals Expected acknowledgement value (if set). | Acknowledgement path — dot path in the response, e.g. data.status. Expected acknowledgement value — e.g. accepted. |
| Asynchronous (await callback) | The endpoint answers 2xx, and later the receiving system calls back to confirm. Until then the export is awaiting acknowledgement. | Correlation ID path — where in the outgoing payload the plugin writes a correlation ID (e.g. meta.correlationId). Acknowledgement timeout (seconds) — default 3600; after that the export is marked failed. |
The asynchronous mode needs the receiving system to implement the acknowledgement callback.