Connection walkthrough

Adobe Commerce
Step-by-step setup

Choose the path for your deployment. Adobe Commerce on PaaS or on-premises uses four signed integration credentials here. Commerce as a Cloud Service uses Adobe IMS OAuth server-to-server credentials and its tenant REST endpoint.

11 stepsVisual references includedChecked 2026-09-30

Before you start

Ticks are kept in this browser only.

Follow the path that matches your account. Provider screenshots come from the linked official documentation and may show a different theme or older navigation. Configuration examples are labelled separately.

Permissions to choose

Use these exact permission names. Conditional permissions are needed only for the features described.

Permission / scopeWhen neededWhat it allows
PaaS: Magento_Sales::actions_view - Orders → Actions → ViewRequiredAllows the current connector to list and read orders, including their recorded refund totals.In the standard Magento 2.4.8 permission tree: Sales → Operations → Orders → Actions → View. Your developer should check the installed version's route ACL if labels or permissions differ.
PaaS: Magento_Sales::shipment - ShipmentsRequiredAllows Revient to read shipment dates and tracking references.Sales → Operations → Shipments. This provider ACL also covers some shipment write endpoints; the credential itself is not guaranteed to be read-only. Revient uses GET requests for this connector.
PaaS: Invoices, Credit Memos, Customers, Catalog and All resourcesNot requestedThe current connector reads order refund totals and shipments; it does not call invoice or credit-memo endpoints. Do not grant unrelated resources for this setup.
SaaS: commerce.accsRequiredIncludes Adobe Commerce as a Cloud Service access in the IMS token request.
SaaS: openid, AdobeID, email, profileRequiredAdobe's documented identity scopes for this Commerce SaaS authentication flow.
SaaS: additional_info.roles, additional_info.projectedProductContextRequiredCarries Adobe role and product context for the Commerce request.
SaaS: entitled product profile and resource permissionsRequiredThe credential must be authorised for the actual Commerce organisation and environment. Scope text alone does not grant store access.Ask your Commerce administrator to confirm the least available access for GET orders and shipments. These scopes do not themselves express a read-only Sales role.

Apply only the permissions for your chosen deployment. For SaaS, copy the credential's assigned scope values and verify the seven values listed here are present. Do not paste PaaS tokens into the SaaS fields.

Your steps

PaaS or on-premises: create a signed integration

An authorised store administrator completes this once. Use four credentials from one dedicated integration. Your store developer can help review version-specific permissions.

  1. Open the integration form

    Your Commerce Admin → System → Extensions → Integrations

    • Choose Add New Integration and name it Revient (read only). Use your organisation's integration contact email.
    • For this manual credential setup, leave Callback URL and Identity Link URL blank. Revient does not provide a Magento token-exchange callback.
    • If Commerce requests your current password, enter it only in your own Commerce Admin. Revient never needs that password.
    Provider screenshotOfficial Adobe reference: locate Integration Info and API. Use the field instructions above for Revient.Adobe: integration screens and activation ↗

    Official Adobe reference: locate Integration Info and API. Use the field instructions above for Revient.

    You should seeThe dedicated integration form is open with the API section available.
  2. Choose the resources Revient reads

    Integration form → API → Resource Access

    • Set Resource Access to Custom. Expand Sales, then Operations.
    • Select Orders → Actions → View and Shipments. Review automatically selected parent or child boxes before saving; avoid selecting the entire Sales branch.
    • Check the permission table against your installed version. If the tree differs, ask your developer to verify the GET orders and shipments route ACLs. Do not solve a missing permission by selecting All.
    Provider screenshotOfficial Adobe reference: the resource picker. Follow the permission checklist above, not the selections in Adobe's example.Adobe: integration screens and activation ↗

    Official Adobe reference: the resource picker. Follow the permission checklist above, not the selections in Adobe's example.

    You should seeThe integration has order-view and shipment access, with unrelated resources left unselected.
  3. Activate and collect the four credentials

    Integrations list → your Revient integration → Activate

    • Save the integration, then activate it. Review the resource list and choose Allow.
    • Copy Consumer Key, Consumer Secret, Access Token and Access Token Secret from the resulting token screen into your secure credential manager. All four must come from this integration.
    • Finish with Done. Keep the default security settings; do not enable standalone bearer-token use or anonymous API access.
    Provider screenshotOfficial Adobe reference: the four field names to copy. Values pictured in documentation are examples, not usable Revient credentials.Adobe: integration screens and activation ↗

    Official Adobe reference: the four field names to copy. Values pictured in documentation are examples, not usable Revient credentials.

    You should seeThe integration is Active and you have all four credential values ready for the Revient form.
  4. Enter the credentials in Revient

    Revient → Integrations → Adobe Commerce → Connect

    • Choose PaaS / on-premises in Deployment.
    • Enter the public HTTPS storefront URL and the four matching credentials. Paste each into the field with the same name.
    • Select Connect. Revient signs its API reads with OAuth 1.0a HMAC-SHA256; it does not need your administrator login.
    You should seeThe selected store appears in connection management. Any authentication or permission failure is shown before you rely on its evidence.
  5. Check one known order and shipment

    Revient → selected store → Manage

    • Run Check connection, then Sync now. Open the intake queue to follow the job.
    • Compare one known order's original ID, currency, total, refund total and date with Commerce Admin. Check a shipped order's tracking reference separately; a successful order probe does not prove shipment access.
    • Import payment-provider dispute facts separately when needed. A paid, refunded or shipped order alone does not establish a lost dispute.
    You should seeSource order facts are visible in intake. Records without the facts needed for a case stay as drafts.
For your developer

SaaS: prepare an Adobe IMS connection

Your organisation's Commerce administrator or developer prepares these credentials. This is merchant-owned Adobe configuration, not a Revient public OAuth consent screen.

  1. Identify the correct Commerce instance

    Adobe Experience Cloud → Quick access → Commerce

    • Open Commerce Cloud Manager and select the organisation that owns the store.
    • Find the intended instance and open its information icon. Copy its REST endpoint, including the tenant identifier.
    • Use the existing test instance for testing. Do not substitute the storefront URL, Admin URL or GraphQL URL.
    You should seeYou have the REST base URL for the correct organisation, region and environment.
  2. Add Commerce to a dedicated Developer Console project

    Adobe Developer Console → correct organisation → project or workspace

    • Create or select a dedicated project. Choose Add API (or Add Service → API in a workspace).
    • Select Adobe Commerce as a Cloud Service and choose OAuth Server-to-Server for its authentication. Complete any required product-profile selection and save the configured API.
    • If the Commerce service is unavailable, ask your Adobe administrator to check your Commerce entitlement and developer product access. Adding an unrelated Adobe API will not grant Commerce access.
    You should seeThe project contains the Commerce SaaS API and an OAuth Server-to-Server credential.
  3. Collect the credential values and confirm scopes

    Developer Console → Credentials → OAuth Server-to-Server

    • Copy Client ID, an active Client Secret and Organization ID from this credential.
    • Open the scopes per service or token-generation request. Copy the Commerce scope list as comma-separated values; verify every value in the reference below is assigned.
    • Have your Commerce administrator confirm that the credential can read orders and shipments in the selected environment. A generated IMS token is not proof of the required Commerce access.
    You should seeThe client, organisation, endpoint and scope list all refer to the same intended Commerce environment.
  4. Select the SaaS deployment in Revient

    Revient → Integrations → Adobe Commerce → Connect

    • Set Deployment to Adobe Commerce as a Cloud Service. The fields change to the SaaS connection values.
    • Enter the tenant API base URL, Adobe client ID, client secret, organisation ID and scopes. Select Connect.
    • Revient obtains and renews IMS access tokens on the server. No browser OAuth callback is required for this server-to-server method.
    You should seeThe connection check can read the orders endpoint using the selected tenant and credential.
  5. Validate a source record before assessment

    Revient → Adobe Commerce → selected store → Manage

    • Run Check connection, then Sync now. Follow the import job in the intake queue.
    • Compare a known order and shipment with the source: original IDs, order date, currency, amount, refund total and tracking references.
    • Leave unavailable dispute facts unknown. Attach a payment-provider export when the dispute is held outside Commerce.
    You should seeLive source values have been checked. An incomplete order remains draft intake instead of becoming an invented lost dispute.
Your steps

Review the collected evidence

Check the source facts and processing result after completing the provider-specific connection steps.

  1. Check the case and automatic evidence results

    Revient → Integrations → Intake, then Cases → Evidence

    • Compare order-time customer/email and address fields using the endpoint and credentials for this deployment. PaaS and SaaS use different authentication; missing data is not corrected by switching endpoint types.
    • Shopify intake accepts only CHARGEBACK disputes with final status LOST and a verified remaining disputed balance. Inquiries, won and open outcomes are excluded before customer enrichment, tracking, scoring and AI.
    • Confirmed lost chargebacks with missing facts appear in Cases as Needs information. Missing facts remain unknown until supported by evidence.
    • Historical non-qualifying records remain in internal audit history, outside merchant intake and active Cases.
    • Cases combines retained Test and ordinary records. A small Test badge identifies records that cannot be routed, sold or counted in live financial totals. AI still requires its approved configuration and valid permissions.
    • For each outbound, replacement or return parcel, check the tracking number, event dates and item coverage. Registration requires a confirmed lost dispute and verified notification-disabled settings. Delivery photos and signatures are separate private assets; unavailable assets are labelled, and a recipient postcode does not prove the delivery address.
    • Use the row menu for one case. Select at least two checkboxes to show bulk actions. Refresh evidence requests current connected-source data and then checks it; Recheck stored evidence uses the facts already retained. Follow each row's progress and refusal reason.
    • Archive retains history and may be blocked by active obligations. Use the Archived filter to restore a case. Reimporting its source does not restore it.
    You should seeYou can identify the current evidence, unknown fields, processing state and next merchant action without losing historical assessments.

Match these fields in Revient

Enter your own account’s values. Example values are for orientation; do not paste them as credentials.

Revient fieldWhere to find itExample / guidance
DeploymentYour Commerce administrator or hosting agreement.PaaS / on-premises OR Adobe Commerce as a Cloud Service
PaaS: Store URLYour public HTTPS storefront base URL. Revient adds /rest/V1 itself; do not paste the Admin URL or /rest/V1 endpoint.https://shop.example.com
PaaS: Consumer keyKeep privateThe activated integration's Consumer Key field.Paste the complete value from your integration
PaaS: Consumer secretKeep privateThe same integration's Consumer Secret field.Paste the complete value from your integration
PaaS: Access tokenKeep privateThe same integration's Access Token field.Paste the complete value from your integration
PaaS: Access token secretKeep privateThe same integration's Access Token Secret field.Paste the complete value from your integration
SaaS: Commerce SaaS API base URLCommerce Cloud Manager → information icon beside the chosen instance → REST endpoint.https://na1-sandbox.api.commerce.adobe.com/your-tenant-id
SaaS: Adobe client IDKeep privateDeveloper Console → your project/workspace → Credentials → OAuth Server-to-Server.Copy Client ID from your credential
SaaS: Adobe client secretKeep privateThe same OAuth Server-to-Server credential's client-secret section.Copy an active Client Secret
SaaS: Adobe organisation IDThe credential details in the organisation that owns the Commerce tenant.Your verified identifier ending @AdobeOrg
SaaS: Adobe credential scopesThe credential's scopes per service / generated token request for Commerce as a Cloud Service.openid,AdobeID,email,profile,additional_info.roles,additional_info.projectedProductContext,commerce.accs

If something goes wrong

401 or signature rejected

Check all four values belong to the same active integration. Confirm the server clock and final HTTPS store URL. After reauthorising in Commerce, use Revient Reconnect with the newly issued tokens.

403 / consumer is not authorised

Review the GET endpoint's resource in the installed version's webapi.xml with your developer. Reauthorise after changing API access. Do not grant All or change bearer-token security as a shortcut.

Orders appear but tracking is missing

Confirm the original order actually has a shipment and the integration permits Shipments. The order connection check alone does not validate shipment retrieval.

URL rejected or connection returns HTML

Supply the public HTTPS storefront base, not the Admin login URL. Check REST routing and firewall rules. Redirects and private-network addresses are rejected by Revient.

SaaS invalid_scope

Use the scopes assigned to this credential's Commerce service, including commerce.accs. If that scope is absent, check that the correct API was added and the organisation is entitled to it.

SaaS 401 / 403

Confirm the active secret, organisation ID, tenant endpoint and product access belong together. Ask the Commerce administrator to review resource permissions for this environment.

SaaS URL rejected

Copy the REST base shown by Commerce Cloud Manager. Revient expects a public Adobe Commerce API hostname plus one tenant path, without /rest or /V1.

Common questions

What evidence does Adobe Commerce supply?

The same order, refund-total and shipment facts as the deployment you connect. Authorisation letters and the lost dispute come from the payment provider when the commerce record does not contain them. Only a confirmed lost dispute becomes a case.

Can I use the same four-token setup for SaaS?

No. This connector's PaaS path uses OAuth 1.0a credentials. Commerce as a Cloud Service requires the Adobe IMS server-to-server path shown separately above.

Does commerce.accs mean read-only order access?

No. It identifies access to the Commerce service. The assigned product access and Commerce permissions determine what the credential can do. Revient performs sales-data reads through this connector.

Do I need invoices and credit-memo access?

The current Revient reader obtains refund totals from order records and separately reads shipments. It does not retrieve invoice or credit-memo documents; upload any relevant documents as evidence when needed.

What is the difference between Refresh evidence and Recheck stored evidence?

Refresh evidence queues new reads from available connected sources and already selected mailbox messages, then tracking and reassessment. Recheck stored evidence reassesses the retained facts without claiming a new provider read. Existing findings stay visible until the work finishes; unavailable sources and partial refusals are reported for each case.

Which disputes receive recovery scoring?

Shopify intake accepts only CHARGEBACK disputes with final status LOST and a verified remaining disputed balance. Inquiries, won and open outcomes are excluded before customer enrichment, tracking, scoring and AI. Historical non-qualifying records remain in internal audit history, outside merchant intake and active Cases. An order or tracking number alone does not establish a lost dispute. Supply the actual confirmed loss and preserve its original order and dispute identities.

Will testing send messages or release a case?

Evidence-testing mode blocks customer, agency and buyer delivery. Importing records or reviewing an assessment does not release a case.

What happens when I disconnect?

New reads stop and the Revient connection is disabled. Evidence already retained remains subject to the workspace retention and removal controls. Revoke the application or key in the provider account as well if you want to remove its access there.

Source documentation

Use these provider pages if a menu name has moved or your plan shows different options.

Set up another source