Skip to main content
adobe-commerce-magento icon

Adobe Commerce Magento Connector

SourceAPI DocsAPI ChangelogConnector Changelog

Description​

Adobe Commerce (Magento) is an open-source e-commerce platform.

Use the Adobe Commerce component to manage the Products, Orders, Customers, and Transactions in an Adobe Commerce store.

API Documentation​

This component was built using the Adobe Commerce REST API Overview.

Connections​

API Access Key (Deprecated)​

key: adobeCommerceApiKey
Deprecated

This connection authenticates against the Adobe Commerce Marketplace Developer API, the portal used to submit and manage extensions. It does not authenticate against a merchant's store, so it cannot read or write store data such as orders, products, customers or transactions. Use the OAuth 1.0a connection for store data.

The Marketplace EQP API uses a two-step process to authenticate a client application and authorize access to resources:

  1. Using the API access key, obtain a session token.
  2. Create the API access key from one, or both, of the Marketplace Developer Portal user interfaces:
    1. production - https://commercedeveloper.adobe.com
    2. sandbox - https://commercedeveloper-sandbox.adobe.com
  3. From the Marketplace Developer Portal, sign in, click on the account name (top, right corner), and choose either the Account Information or the Marketplace Profile link.
  4. From the left-hand side navigation menu, click on Manage API Keys.
  5. Click Create API Access Key.
  6. In the "Create New API Key" dialog, enter an API Key Name. This name is for internal reference only. Then, click Continue.
  7. The API access key consists of two values, an Application ID and an Application Secret. Enter both into the connection configuration, along with the Use Production Environment toggle set to match the portal (production or sandbox) used to create the key.

Configure the Connection​

  • Application ID: the application ID generated by the Marketplace Developer Portal when the API access key is created.
  • Application Secret: the application secret generated alongside the Application ID.
  • Use Production Environment: a boolean toggle. Set to true to use the production environment (https://commercedeveloper-api.adobe.com); set to false to use the sandbox environment (https://commercedeveloper-sandbox-api.adobe.com). Defaults to false (sandbox).
InputNotesExample
Application ID

The application ID half of a Marketplace API access key. Generate one in the Marketplace Developer Portal under your account name > Account Information > Manage API Keys. See API access keys.

XXXXXXXXXX
Application Secret

The application secret issued alongside the application ID above, from the same Marketplace API access key. The key can be regenerated or deleted at any time under Manage API Keys. See API access keys.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Use Production Environment

Set true for production environment (https://commercedeveloper-api.adobe.com), false for sandbox (https://commercedeveloper-sandbox-api.adobe.com).

false

OAuth 1.0a​

key: adobeCommerceOauth1

OAuth 1.0a authenticates requests against a merchant's own Adobe Commerce store, and is the authentication method to use for reading and writing store data such as orders, products, customers and transactions.

An integration activated in the Adobe Commerce Admin issues four credentials: a consumer key, a consumer secret, an access token and an access token secret. There is no login screen and no token to request: the four values sign every request directly, and neither secret is ever transmitted to the store.

Prerequisites​

  • A merchant-hosted Adobe Commerce store reachable over HTTPS. A store reachable only over plain HTTP is not supported.
  • An administrator account with permission to create integrations

Adobe Commerce as a Cloud Service authenticates through Adobe's Identity Management System instead and is not supported by this connection. Refer to Authentication in Adobe Commerce as a Cloud Service.

Setup Steps​

To create an integration and obtain its credentials:

  1. Log in to the Adobe Commerce Admin.
  2. Navigate to System > Extensions > Integrations.
  3. Click Add New Integration and enter a Name.
  4. Open the API tab and grant the resource access the integration requires. Reading orders, products and customers requires at least Sales, Catalog and Customers.
  5. Click Save.
  6. Click Activate on the new integration, review the requested access, and click Allow.
  7. Copy all four values from the Integration Tokens for Extensions dialog.

The four values are shown only at activation, so they must be copied before the dialog is closed. Lost credentials are replaced by reauthorizing the integration, which issues a new set. The credentials do not expire. They stay valid until the integration is deactivated or reauthorized.

Refer to Integrations for more information on creating and activating an integration, and to Authentication for Adobe's description of the OAuth 1.0a method.

Configure the Connection​

Create a connection of type OAuth 1.0a and configure the following fields:

  • Enter the store's base URL into Store URL, without a trailing slash and without the /rest path (for example, https://www.example.com).
  • Enter the four values copied at activation into Consumer Key, Consumer Secret, Access Token and Access Token Secret.
  • Optionally set Store Code. It defaults to default, the store view code a single-store installation ships with, and forms the <store_code> segment of the /rest/<store_code>/V1 request path. Change it only on a store that serves multiple store views.
InputNotesExample
Access Token

The access token issued when the integration was activated. Unlike a bearer token it is not sufficient on its own: it identifies the integration, and the access token secret below proves possession.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Access Token Secret

The access token secret issued alongside the access token above. It is used to sign each request and is never sent to the store.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Consumer Key

The consumer key shown when an integration is activated under System > Extensions > Integrations in the Adobe Commerce Admin. See Authentication.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Consumer Secret

The consumer secret issued alongside the consumer key above. It is used to sign each request and is never sent to the store.

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Store Code

The store view code requests are scoped to, used as the <store_code> segment of /rest/<store_code>/V1. Leave as default unless the store serves multiple store views.

default
Store URL

The base URL of the Adobe Commerce store, without a trailing slash and without the /rest path.

https://www.example.com

Triggers​

New and Updated Records​

Retrieves existing and ongoing records for a specified Adobe Commerce resource type. Load history once, check for changes on a schedule, or both. | key: pollChangesTrigger

InputNotesExample
Connection

The Adobe Commerce connection to use.

Look-back Date

The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each record modified on or after this date once, ignoring the field and visibility filters.

2026-01-01
Resource Type

The Magento resource collection to poll for new and updated records.

orders
Show New Records

When true, records whose created_at falls after the last poll are included in the payload's body.data.created array.

true
Show Updated Records

When true, records whose updated_at falls after the last poll but were created earlier are included in the payload's body.data.updated array.

true

This trigger polls an Adobe Commerce (Magento) store on a configured schedule for records whose updated_at is at or after the last poll time. Records are split into created and updated arrays based on their created_at timestamp.

How It Works​

  1. Run on the configured schedule (e.g., every 5 minutes)
  2. Query the selected resource collection (Orders, Customers, or Products) using searchCriteria filtering on updated_at >= lastPolledAt, sorted ascending
  3. Split results: records whose created_at is also after the last poll are categorized as created; older records modified since the last poll are categorized as updated
  4. Persist the new poll timestamp to trigger state for use on the next run
  5. If the page cap is reached, advance the cursor to the newest fetched updated_at to resume from there on the next poll (at-least-once semantics)

Initial Sync

An initial sync seeds a complete starting state rather than a change feed, so inputs that narrow which changes are reported would leave gaps in it: Show New Records and Show Updated Records are ignored while it runs, and are the only inputs it ignores. It begins on the first recurrence, when the trigger has no stored position and a Look-back Date (YYYY-MM-DD, read as midnight UTC) is set, and seeds each record modified on or after that date once. Left empty, there is no sync and the trigger starts from its first recurrence.

The window has no fixed upper bound, so a record modified mid-drain is swept into the sync. Each recurrence fetches up to a fixed page cap, with batching on or off alike. A window that fits under the cap finishes in one recurrence, and the position is set to that recurrence's start time. A larger window spans several recurrences: the position advances to the newest updated_at received, the next recurrence resumes from exactly there, and the record on that boundary can be delivered twice. Only the first recurrence ignores the toggles, so records delivered by later recurrences of the same drain are filtered by them. Nothing in the payload marks the handoff.

Resource Type still applies throughout. The trigger has no page-size or field-selection input, so nothing else is suppressed.

Batching

Batching is enabled per flow on this trigger: each changed record is dispatched as its own execution, or grouped by the configured batch size. Batch size and batch concurrency can both be overridden per instance. Raising concurrency increases the request volume sent to Adobe Commerce.

To turn it on, select the flow's trigger, open the Flow control tab, and switch on Enable Batching. Under Batch Size, keep Trigger default or choose Custom batch size. Batch Concurrency is optional; leave it blank for no batch-level limit.

With batching off a downstream step reads body.data.created and body.data.updated. With batching on those fields do not exist: each execution receives one { "changeType": ..., "record": ... } item, or an array of them when the batch size is greater than 1. Any step reading the older shape must be updated before batching is enabled. Because batching is enabled per flow, that change is scoped to the flow rather than to the component or to other flows using the same trigger.

Returned Data​

With batching off, the trigger returns an object with two arrays: created for new records and updated for modified records. Fields shown are representative. The full response object includes additional properties.

Example Response
{
  "data": {
    "created": [
      {
        "entity_id": 1042,
        "increment_id": "000000142",
        "status": "pending",
        "state": "new",
        "customer_email": "jane.doe@example.com",
        "grand_total": 199.5,
        "order_currency_code": "USD",
        "created_at": "2026-05-26 14:30:00",
        "updated_at": "2026-05-26 14:30:00"
      }
    ],
    "updated": [
      {
        "entity_id": 980,
        "increment_id": "000000087",
        "status": "complete",
        "state": "complete",
        "customer_email": "john.smith@example.com",
        "grand_total": 75.25,
        "order_currency_code": "USD",
        "created_at": "2026-04-12 09:00:00",
        "updated_at": "2026-05-26 15:45:00"
      }
    ]
  }
}
Example Payload for New and Updated Records⤓
Loading…

Webhook​

Receive webhook requests from Adobe Commerce for webhooks you configure. | key: myTrigger

Data Sources​

Product Attribute Types​

Retrieve list of product attribute types. | key: productAttributeTypes | type: picklist

InputNotesExample
Connection

The Adobe Commerce connection to use.

Example Payload for Product Attribute Types⤓
Loading…

Product Option Types​

Get custom option types. | key: productOptionTypes | type: picklist

InputNotesExample
Connection

The Adobe Commerce connection to use.

Example Payload for Product Option Types⤓
Loading…

Product Types​

Retrieve available product types. | key: productTypes | type: picklist

InputNotesExample
Connection

The Adobe Commerce connection to use.

Example Payload for Product Types⤓
Loading…

Select Customer​

A picklist of customers in the Adobe Commerce store. | key: selectCustomer | type: picklist

InputNotesExample
Connection

The Adobe Commerce connection to use.

Example Payload for Select Customer⤓
Loading…

Select Order​

A picklist of orders in the Adobe Commerce store. | key: selectOrder | type: picklist

InputNotesExample
Connection

The Adobe Commerce connection to use.

Example Payload for Select Order⤓
Loading…

Select Transaction​

A picklist of transactions in the Adobe Commerce store. | key: selectTransaction | type: picklist

InputNotesExample
Connection

The Adobe Commerce connection to use.

Example Payload for Select Transaction⤓
Loading…

Actions​

Cancel Order​

Cancels a specified order. | key: cancelOrder

InputNotesExample
Connection

The Adobe Commerce connection to use.

Order ID

The order to act on, identified by its Magento entity_id rather than the customer-facing increment ID. Pick an order from the dropdown or supply the ID directly.

1
Example Payload for Cancel Order⤓
Loading…

Create Customer​

Create customer account. | key: createCustomer

InputNotesExample
Connection

The Adobe Commerce connection to use.

Customer

The customer record to save, as a JSON object under a customer key. The default value lists every field the endpoint accepts; remove the ones that do not apply.

{
  "customer": {
    "id": 0,
    "group_id": 0,
    "default_billing": "string",
    "default_shipping": "string",
    "confirmation": "string",
    "created_at": "string",
    "updated_at": "string",
    "created_in": "string",
    "dob": "string",
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "prefix": "string",
    "suffix": "string",
    "gender": 0,
    "store_id": 0,
    "taxvat": "string",
    "website_id": 0,
    "addresses": [
      {
        "id": 0,
        "customer_id": 0,
        "region": {
          "region_code": "string",
          "region": "string",
          "region_id": 0,
          "extension_attributes": {}
        },
        "region_id": 0,
        "country_id": "string",
        "street": [
          "string"
        ],
        "company": "string",
        "telephone": "string",
        "fax": "string",
        "postcode": "string",
        "city": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "prefix": "string",
        "suffix": "string",
        "vat_id": "string",
        "default_shipping": true,
        "default_billing": true,
        "extension_attributes": {},
        "custom_attributes": [
          {
            "attribute_code": "string",
            "value": "string"
          }
        ]
      }
    ],
    "disable_auto_group_change": 0,
    "extension_attributes": {
      "company_attributes": {
        "customer_id": 0,
        "company_id": 0,
        "job_title": "string",
        "status": 0,
        "telephone": "string",
        "extension_attributes": {}
      },
      "assistance_allowed": 0,
      "is_subscribed": true
    },
    "custom_attributes": [
      {
        "attribute_code": "string",
        "value": "string"
      }
    ]
  }
}
Password

The password to set on the new customer account. When provided it is added to the request body as password; leave it blank to omit it from the request.

Redirect URL

The URL sent alongside the new customer account as redirectUrl, used as the destination of the account confirmation link. Leave it blank to omit it from the request.

https://www.example.com/customer/account/confirm
Example Payload for Create Customer⤓
Loading…

Create Order​

Performs persist operations for a specified order. | key: createOrder

InputNotesExample
Connection

The Adobe Commerce connection to use.

Order

The order to create, as a JSON object under an entity key. The default value lists every field the endpoint accepts; remove the ones that do not apply.

{
  "entity": {
    "adjustment_negative": 0,
    "adjustment_positive": 0,
    "applied_rule_ids": "string",
    "base_adjustment_negative": 0,
    "base_adjustment_positive": 0,
    "base_currency_code": "string",
    "base_discount_amount": 0,
    "base_discount_canceled": 0,
    "base_discount_invoiced": 0,
    "base_discount_refunded": 0,
    "base_grand_total": 0,
    "base_discount_tax_compensation_amount": 0,
    "base_discount_tax_compensation_invoiced": 0,
    "base_discount_tax_compensation_refunded": 0,
    "base_shipping_amount": 0,
    "base_shipping_canceled": 0,
    "base_shipping_discount_amount": 0,
    "base_shipping_discount_tax_compensation_amnt": 0,
    "base_shipping_incl_tax": 0,
    "base_shipping_invoiced": 0,
    "base_shipping_refunded": 0,
    "base_shipping_tax_amount": 0,
    "base_shipping_tax_refunded": 0,
    "base_subtotal": 0,
    "base_subtotal_canceled": 0,
    "base_subtotal_incl_tax": 0,
    "base_subtotal_invoiced": 0,
    "base_subtotal_refunded": 0,
    "base_tax_amount": 0,
    "base_tax_canceled": 0,
    "base_tax_invoiced": 0,
    "base_tax_refunded": 0,
    "base_total_canceled": 0,
    "base_total_due": 0,
    "base_total_invoiced": 0,
    "base_total_invoiced_cost": 0,
    "base_total_offline_refunded": 0,
    "base_total_online_refunded": 0,
    "base_total_paid": 0,
    "base_total_qty_ordered": 0,
    "base_total_refunded": 0,
    "base_to_global_rate": 0,
    "base_to_order_rate": 0,
    "billing_address_id": 0,
    "can_ship_partially": 0,
    "can_ship_partially_item": 0,
    "coupon_code": "string",
    "created_at": "string",
    "customer_dob": "string",
    "customer_email": "string",
    "customer_firstname": "string",
    "customer_gender": 0,
    "customer_group_id": 0,
    "customer_id": 0,
    "customer_is_guest": 0,
    "customer_lastname": "string",
    "customer_middlename": "string",
    "customer_note": "string",
    "customer_note_notify": 0,
    "customer_prefix": "string",
    "customer_suffix": "string",
    "customer_taxvat": "string",
    "discount_amount": 0,
    "discount_canceled": 0,
    "discount_description": "string",
    "discount_invoiced": 0,
    "discount_refunded": 0,
    "edit_increment": 0,
    "email_sent": 0,
    "entity_id": 0,
    "ext_customer_id": "string",
    "ext_order_id": "string",
    "forced_shipment_with_invoice": 0,
    "global_currency_code": "string",
    "grand_total": 0,
    "discount_tax_compensation_amount": 0,
    "discount_tax_compensation_invoiced": 0,
    "discount_tax_compensation_refunded": 0,
    "hold_before_state": "string",
    "hold_before_status": "string",
    "increment_id": "string",
    "is_virtual": 0,
    "order_currency_code": "string",
    "original_increment_id": "string",
    "payment_authorization_amount": 0,
    "payment_auth_expiration": 0,
    "protect_code": "string",
    "quote_address_id": 0,
    "quote_id": 0,
    "relation_child_id": "string",
    "relation_child_real_id": "string",
    "relation_parent_id": "string",
    "relation_parent_real_id": "string",
    "remote_ip": "string",
    "shipping_amount": 0,
    "shipping_canceled": 0,
    "shipping_description": "string",
    "shipping_discount_amount": 0,
    "shipping_discount_tax_compensation_amount": 0,
    "shipping_incl_tax": 0,
    "shipping_invoiced": 0,
    "shipping_refunded": 0,
    "shipping_tax_amount": 0,
    "shipping_tax_refunded": 0,
    "state": "string",
    "status": "string",
    "store_currency_code": "string",
    "store_id": 0,
    "store_name": "string",
    "store_to_base_rate": 0,
    "store_to_order_rate": 0,
    "subtotal": 0,
    "subtotal_canceled": 0,
    "subtotal_incl_tax": 0,
    "subtotal_invoiced": 0,
    "subtotal_refunded": 0,
    "tax_amount": 0,
    "tax_canceled": 0,
    "tax_invoiced": 0,
    "tax_refunded": 0,
    "total_canceled": 0,
    "total_due": 0,
    "total_invoiced": 0,
    "total_item_count": 0,
    "total_offline_refunded": 0,
    "total_online_refunded": 0,
    "total_paid": 0,
    "total_qty_ordered": 0,
    "total_refunded": 0,
    "updated_at": "string",
    "weight": 0,
    "x_forwarded_for": "string",
    "items": [
      {
        "additional_data": "string",
        "amount_refunded": 0,
        "applied_rule_ids": "string",
        "base_amount_refunded": 0,
        "base_cost": 0,
        "base_discount_amount": 0,
        "base_discount_invoiced": 0,
        "base_discount_refunded": 0,
        "base_discount_tax_compensation_amount": 0,
        "base_discount_tax_compensation_invoiced": 0,
        "base_discount_tax_compensation_refunded": 0,
        "base_original_price": 0,
        "base_price": 0,
        "base_price_incl_tax": 0,
        "base_row_invoiced": 0,
        "base_row_total": 0,
        "base_row_total_incl_tax": 0,
        "base_tax_amount": 0,
        "base_tax_before_discount": 0,
        "base_tax_invoiced": 0,
        "base_tax_refunded": 0,
        "base_weee_tax_applied_amount": 0,
        "base_weee_tax_applied_row_amnt": 0,
        "base_weee_tax_disposition": 0,
        "base_weee_tax_row_disposition": 0,
        "created_at": "string",
        "description": "string",
        "discount_amount": 0,
        "discount_invoiced": 0,
        "discount_percent": 0,
        "discount_refunded": 0,
        "event_id": 0,
        "ext_order_item_id": "string",
        "free_shipping": 0,
        "gw_base_price": 0,
        "gw_base_price_invoiced": 0,
        "gw_base_price_refunded": 0,
        "gw_base_tax_amount": 0,
        "gw_base_tax_amount_invoiced": 0,
        "gw_base_tax_amount_refunded": 0,
        "gw_id": 0,
        "gw_price": 0,
        "gw_price_invoiced": 0,
        "gw_price_refunded": 0,
        "gw_tax_amount": 0,
        "gw_tax_amount_invoiced": 0,
        "gw_tax_amount_refunded": 0,
        "discount_tax_compensation_amount": 0,
        "discount_tax_compensation_canceled": 0,
        "discount_tax_compensation_invoiced": 0,
        "discount_tax_compensation_refunded": 0,
        "is_qty_decimal": 0,
        "is_virtual": 0,
        "item_id": 0,
        "locked_do_invoice": 0,
        "locked_do_ship": 0,
        "name": "string",
        "no_discount": 0,
        "order_id": 0,
        "original_price": 0,
        "parent_item_id": 0,
        "price": 0,
        "price_incl_tax": 0,
        "product_id": 0,
        "product_type": "string",
        "qty_backordered": 0,
        "qty_canceled": 0,
        "qty_invoiced": 0,
        "qty_ordered": 0,
        "qty_refunded": 0,
        "qty_returned": 0,
        "qty_shipped": 0,
        "quote_item_id": 0,
        "row_invoiced": 0,
        "row_total": 0,
        "row_total_incl_tax": 0,
        "row_weight": 0,
        "sku": "string",
        "store_id": 0,
        "tax_amount": 0,
        "tax_before_discount": 0,
        "tax_canceled": 0,
        "tax_invoiced": 0,
        "tax_percent": 0,
        "tax_refunded": 0,
        "updated_at": "string",
        "weee_tax_applied": "string",
        "weee_tax_applied_amount": 0,
        "weee_tax_applied_row_amount": 0,
        "weee_tax_disposition": 0,
        "weee_tax_row_disposition": 0,
        "weight": 0,
        "parent_item": {},
        "product_option": {
          "extension_attributes": {
            "custom_options": [
              {
                "option_id": null,
                "option_value": null,
                "extension_attributes": null
              }
            ],
            "bundle_options": [
              {
                "option_id": null,
                "option_qty": null,
                "option_selections": [],
                "extension_attributes": null
              }
            ],
            "downloadable_option": {
              "downloadable_links": [
                null
              ]
            },
            "giftcard_item_option": {
              "giftcard_amount": "string",
              "custom_giftcard_amount": 0,
              "giftcard_sender_name": "string",
              "giftcard_recipient_name": "string",
              "giftcard_sender_email": "string",
              "giftcard_recipient_email": "string",
              "giftcard_message": "string",
              "extension_attributes": {
                "giftcard_created_codes": []
              }
            },
            "configurable_item_options": [
              {
                "option_id": null,
                "option_value": null,
                "extension_attributes": null
              }
            ]
          }
        },
        "extension_attributes": {
          "gift_message": {
            "gift_message_id": 0,
            "customer_id": 0,
            "sender": "string",
            "recipient": "string",
            "message": "string",
            "extension_attributes": {
              "entity_id": "string",
              "entity_type": "string",
              "wrapping_id": 0,
              "wrapping_allow_gift_receipt": true,
              "wrapping_add_printed_card": true
            }
          },
          "gw_id": "string",
          "gw_base_price": "string",
          "gw_price": "string",
          "gw_base_tax_amount": "string",
          "gw_tax_amount": "string",
          "gw_base_price_invoiced": "string",
          "gw_price_invoiced": "string",
          "gw_base_tax_amount_invoiced": "string",
          "gw_tax_amount_invoiced": "string",
          "gw_base_price_refunded": "string",
          "gw_price_refunded": "string",
          "gw_base_tax_amount_refunded": "string",
          "gw_tax_amount_refunded": "string"
        }
      }
    ],
    "billing_address": {
      "address_type": "string",
      "city": "string",
      "company": "string",
      "country_id": "string",
      "customer_address_id": 0,
      "customer_id": 0,
      "email": "string",
      "entity_id": 0,
      "fax": "string",
      "firstname": "string",
      "lastname": "string",
      "middlename": "string",
      "parent_id": 0,
      "postcode": "string",
      "prefix": "string",
      "region": "string",
      "region_code": "string",
      "region_id": 0,
      "street": [
        "string"
      ],
      "suffix": "string",
      "telephone": "string",
      "vat_id": "string",
      "vat_is_valid": 0,
      "vat_request_date": "string",
      "vat_request_id": "string",
      "vat_request_success": 0,
      "extension_attributes": {}
    },
    "payment": {
      "account_status": "string",
      "additional_data": "string",
      "additional_information": [
        "string"
      ],
      "address_status": "string",
      "amount_authorized": 0,
      "amount_canceled": 0,
      "amount_ordered": 0,
      "amount_paid": 0,
      "amount_refunded": 0,
      "anet_trans_method": "string",
      "base_amount_authorized": 0,
      "base_amount_canceled": 0,
      "base_amount_ordered": 0,
      "base_amount_paid": 0,
      "base_amount_paid_online": 0,
      "base_amount_refunded": 0,
      "base_amount_refunded_online": 0,
      "base_shipping_amount": 0,
      "base_shipping_captured": 0,
      "base_shipping_refunded": 0,
      "cc_approval": "string",
      "cc_avs_status": "string",
      "cc_cid_status": "string",
      "cc_debug_request_body": "string",
      "cc_debug_response_body": "string",
      "cc_debug_response_serialized": "string",
      "cc_exp_month": "string",
      "cc_exp_year": "string",
      "cc_last4": "string",
      "cc_number_enc": "string",
      "cc_owner": "string",
      "cc_secure_verify": "string",
      "cc_ss_issue": "string",
      "cc_ss_start_month": "string",
      "cc_ss_start_year": "string",
      "cc_status": "string",
      "cc_status_description": "string",
      "cc_trans_id": "string",
      "cc_type": "string",
      "echeck_account_name": "string",
      "echeck_account_type": "string",
      "echeck_bank_name": "string",
      "echeck_routing_number": "string",
      "echeck_type": "string",
      "entity_id": 0,
      "last_trans_id": "string",
      "method": "string",
      "parent_id": 0,
      "po_number": "string",
      "protection_eligibility": "string",
      "quote_payment_id": 0,
      "shipping_amount": 0,
      "shipping_captured": 0,
      "shipping_refunded": 0,
      "extension_attributes": {
        "notification_message": "string",
        "vault_payment_token": {
          "entity_id": 0,
          "customer_id": 0,
          "public_hash": "string",
          "payment_method_code": "string",
          "type": "string",
          "created_at": "string",
          "expires_at": "string",
          "gateway_token": "string",
          "token_details": "string",
          "is_active": true,
          "is_visible": true
        }
      }
    },
    "status_histories": [
      {
        "comment": "string",
        "created_at": "string",
        "entity_id": 0,
        "entity_name": "string",
        "is_customer_notified": 0,
        "is_visible_on_front": 0,
        "parent_id": 0,
        "status": "string",
        "extension_attributes": {}
      }
    ],
    "extension_attributes": {
      "shipping_assignments": [
        {
          "shipping": {
            "address": {
              "address_type": "string",
              "city": "string",
              "company": "string",
              "country_id": "string",
              "customer_address_id": 0,
              "customer_id": 0,
              "email": "string",
              "entity_id": 0,
              "fax": "string",
              "firstname": "string",
              "lastname": "string",
              "middlename": "string",
              "parent_id": 0,
              "postcode": "string",
              "prefix": "string",
              "region": "string",
              "region_code": "string",
              "region_id": 0,
              "street": [
                null
              ],
              "suffix": "string",
              "telephone": "string",
              "vat_id": "string",
              "vat_is_valid": 0,
              "vat_request_date": "string",
              "vat_request_id": "string",
              "vat_request_success": 0,
              "extension_attributes": {}
            },
            "method": "string",
            "total": {
              "base_shipping_amount": 0,
              "base_shipping_canceled": 0,
              "base_shipping_discount_amount": 0,
              "base_shipping_discount_tax_compensation_amnt": 0,
              "base_shipping_incl_tax": 0,
              "base_shipping_invoiced": 0,
              "base_shipping_refunded": 0,
              "base_shipping_tax_amount": 0,
              "base_shipping_tax_refunded": 0,
              "shipping_amount": 0,
              "shipping_canceled": 0,
              "shipping_discount_amount": 0,
              "shipping_discount_tax_compensation_amount": 0,
              "shipping_incl_tax": 0,
              "shipping_invoiced": 0,
              "shipping_refunded": 0,
              "shipping_tax_amount": 0,
              "shipping_tax_refunded": 0,
              "extension_attributes": {}
            },
            "extension_attributes": {}
          },
          "items": [
            {
              "additional_data": "string",
              "amount_refunded": 0,
              "applied_rule_ids": "string",
              "base_amount_refunded": 0,
              "base_cost": 0,
              "base_discount_amount": 0,
              "base_discount_invoiced": 0,
              "base_discount_refunded": 0,
              "base_discount_tax_compensation_amount": 0,
              "base_discount_tax_compensation_invoiced": 0,
              "base_discount_tax_compensation_refunded": 0,
              "base_original_price": 0,
              "base_price": 0,
              "base_price_incl_tax": 0,
              "base_row_invoiced": 0,
              "base_row_total": 0,
              "base_row_total_incl_tax": 0,
              "base_tax_amount": 0,
              "base_tax_before_discount": 0,
              "base_tax_invoiced": 0,
              "base_tax_refunded": 0,
              "base_weee_tax_applied_amount": 0,
              "base_weee_tax_applied_row_amnt": 0,
              "base_weee_tax_disposition": 0,
              "base_weee_tax_row_disposition": 0,
              "created_at": "string",
              "description": "string",
              "discount_amount": 0,
              "discount_invoiced": 0,
              "discount_percent": 0,
              "discount_refunded": 0,
              "event_id": 0,
              "ext_order_item_id": "string",
              "free_shipping": 0,
              "gw_base_price": 0,
              "gw_base_price_invoiced": 0,
              "gw_base_price_refunded": 0,
              "gw_base_tax_amount": 0,
              "gw_base_tax_amount_invoiced": 0,
              "gw_base_tax_amount_refunded": 0,
              "gw_id": 0,
              "gw_price": 0,
              "gw_price_invoiced": 0,
              "gw_price_refunded": 0,
              "gw_tax_amount": 0,
              "gw_tax_amount_invoiced": 0,
              "gw_tax_amount_refunded": 0,
              "discount_tax_compensation_amount": 0,
              "discount_tax_compensation_canceled": 0,
              "discount_tax_compensation_invoiced": 0,
              "discount_tax_compensation_refunded": 0,
              "is_qty_decimal": 0,
              "is_virtual": 0,
              "item_id": 0,
              "locked_do_invoice": 0,
              "locked_do_ship": 0,
              "name": "string",
              "no_discount": 0,
              "order_id": 0,
              "original_price": 0,
              "parent_item_id": 0,
              "price": 0,
              "price_incl_tax": 0,
              "product_id": 0,
              "product_type": "string",
              "qty_backordered": 0,
              "qty_canceled": 0,
              "qty_invoiced": 0,
              "qty_ordered": 0,
              "qty_refunded": 0,
              "qty_returned": 0,
              "qty_shipped": 0,
              "quote_item_id": 0,
              "row_invoiced": 0,
              "row_total": 0,
              "row_total_incl_tax": 0,
              "row_weight": 0,
              "sku": "string",
              "store_id": 0,
              "tax_amount": 0,
              "tax_before_discount": 0,
              "tax_canceled": 0,
              "tax_invoiced": 0,
              "tax_percent": 0,
              "tax_refunded": 0,
              "updated_at": "string",
              "weee_tax_applied": "string",
              "weee_tax_applied_amount": 0,
              "weee_tax_applied_row_amount": 0,
              "weee_tax_disposition": 0,
              "weee_tax_row_disposition": 0,
              "weight": 0,
              "parent_item": {},
              "product_option": {
                "extension_attributes": null
              },
              "extension_attributes": {
                "gift_message": null,
                "gw_id": null,
                "gw_base_price": null,
                "gw_price": null,
                "gw_base_tax_amount": null,
                "gw_tax_amount": null,
                "gw_base_price_invoiced": null,
                "gw_price_invoiced": null,
                "gw_base_tax_amount_invoiced": null,
                "gw_tax_amount_invoiced": null,
                "gw_base_price_refunded": null,
                "gw_price_refunded": null,
                "gw_base_tax_amount_refunded": null,
                "gw_tax_amount_refunded": null
              }
            }
          ],
          "stock_id": 0,
          "extension_attributes": {}
        }
      ],
      "payment_additional_info": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "company_order_attributes": {
        "order_id": 0,
        "company_id": 0,
        "company_name": "string",
        "extension_attributes": {}
      },
      "applied_taxes": [
        {
          "code": "string",
          "title": "string",
          "percent": 0,
          "amount": 0,
          "base_amount": 0,
          "extension_attributes": {
            "rates": [
              {
                "code": null,
                "title": null,
                "percent": null,
                "extension_attributes": null
              }
            ]
          }
        }
      ],
      "item_applied_taxes": [
        {
          "type": "string",
          "item_id": 0,
          "associated_item_id": 0,
          "applied_taxes": [
            {
              "code": "string",
              "title": "string",
              "percent": 0,
              "amount": 0,
              "base_amount": 0,
              "extension_attributes": {
                "rates": []
              }
            }
          ],
          "extension_attributes": {}
        }
      ],
      "converting_from_quote": true,
      "base_customer_balance_amount": 0,
      "customer_balance_amount": 0,
      "base_customer_balance_invoiced": 0,
      "customer_balance_invoiced": 0,
      "base_customer_balance_refunded": 0,
      "customer_balance_refunded": 0,
      "base_customer_balance_total_refunded": 0,
      "customer_balance_total_refunded": 0,
      "gift_cards": [
        {
          "id": 0,
          "code": "string",
          "amount": 0,
          "base_amount": 0
        }
      ],
      "base_gift_cards_amount": 0,
      "gift_cards_amount": 0,
      "base_gift_cards_invoiced": 0,
      "gift_cards_invoiced": 0,
      "base_gift_cards_refunded": 0,
      "gift_cards_refunded": 0,
      "gift_message": {
        "gift_message_id": 0,
        "customer_id": 0,
        "sender": "string",
        "recipient": "string",
        "message": "string",
        "extension_attributes": {
          "entity_id": "string",
          "entity_type": "string",
          "wrapping_id": 0,
          "wrapping_allow_gift_receipt": true,
          "wrapping_add_printed_card": true
        }
      },
      "gw_id": "string",
      "gw_allow_gift_receipt": "string",
      "gw_add_card": "string",
      "gw_base_price": "string",
      "gw_price": "string",
      "gw_items_base_price": "string",
      "gw_items_price": "string",
      "gw_card_base_price": "string",
      "gw_card_price": "string",
      "gw_base_tax_amount": "string",
      "gw_tax_amount": "string",
      "gw_items_base_tax_amount": "string",
      "gw_items_tax_amount": "string",
      "gw_card_base_tax_amount": "string",
      "gw_card_tax_amount": "string",
      "gw_base_price_incl_tax": "string",
      "gw_price_incl_tax": "string",
      "gw_items_base_price_incl_tax": "string",
      "gw_items_price_incl_tax": "string",
      "gw_card_base_price_incl_tax": "string",
      "gw_card_price_incl_tax": "string",
      "gw_base_price_invoiced": "string",
      "gw_price_invoiced": "string",
      "gw_items_base_price_invoiced": "string",
      "gw_items_price_invoiced": "string",
      "gw_card_base_price_invoiced": "string",
      "gw_card_price_invoiced": "string",
      "gw_base_tax_amount_invoiced": "string",
      "gw_tax_amount_invoiced": "string",
      "gw_items_base_tax_invoiced": "string",
      "gw_items_tax_invoiced": "string",
      "gw_card_base_tax_invoiced": "string",
      "gw_card_tax_invoiced": "string",
      "gw_base_price_refunded": "string",
      "gw_price_refunded": "string",
      "gw_items_base_price_refunded": "string",
      "gw_items_price_refunded": "string",
      "gw_card_base_price_refunded": "string",
      "gw_card_price_refunded": "string",
      "gw_base_tax_amount_refunded": "string",
      "gw_tax_amount_refunded": "string",
      "gw_items_base_tax_refunded": "string",
      "gw_items_tax_refunded": "string",
      "gw_card_base_tax_refunded": "string",
      "gw_card_tax_refunded": "string",
      "pickup_location_code": "string",
      "notification_sent": 0,
      "send_notification": 0,
      "reward_points_balance": 0,
      "reward_currency_amount": 0,
      "base_reward_currency_amount": 0
    }
  }
}
Example Payload for Create Order⤓
Loading…

Create Product Attributes​

Save attribute data | key: createProductAttributes

InputNotesExample
Product Attribute

The product attribute to save, as a JSON object under an attribute key. The default value lists every field the endpoint accepts; remove the ones that do not apply.

{
  "attribute": {
    "extension_attributes": {
      "is_pagebuilder_enabled": true
    },
    "is_wysiwyg_enabled": true,
    "is_html_allowed_on_front": true,
    "used_for_sort_by": true,
    "is_filterable": true,
    "is_filterable_in_search": true,
    "is_used_in_grid": true,
    "is_visible_in_grid": true,
    "is_filterable_in_grid": true,
    "position": 0,
    "apply_to": [
      "string"
    ],
    "is_searchable": "string",
    "is_visible_in_advanced_search": "string",
    "is_comparable": "string",
    "is_used_for_promo_rules": "string",
    "is_visible_on_front": "string",
    "used_in_product_listing": "string",
    "is_visible": true,
    "scope": "string",
    "attribute_id": 0,
    "attribute_code": "string",
    "frontend_input": "string",
    "entity_type_id": "string",
    "is_required": true,
    "options": [
      {
        "label": "string",
        "value": "string",
        "sort_order": 0,
        "is_default": true,
        "store_labels": [
          {
            "store_id": 0,
            "label": "string"
          }
        ]
      }
    ],
    "is_user_defined": true,
    "default_frontend_label": "string",
    "frontend_labels": [
      {
        "store_id": 0,
        "label": "string"
      }
    ],
    "note": "string",
    "backend_type": "string",
    "backend_model": "string",
    "source_model": "string",
    "default_value": "string",
    "is_unique": "string",
    "frontend_class": "string",
    "validation_rules": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "custom_attributes": [
      {
        "attribute_code": "string",
        "value": "string"
      }
    ]
  }
}
Connection

The Adobe Commerce connection to use.

Example Payload for Create Product Attributes⤓
Loading…

Create Product Options​

Save Custom Option | key: createProductOptions

InputNotesExample
Connection

The Adobe Commerce connection to use.

Product Option

The custom product option to save, as a JSON object under an option key. The option is tied to a product through its product_sku field. The default value lists every field the endpoint accepts.

{
  "option": {
    "product_sku": "string",
    "option_id": 0,
    "title": "string",
    "type": "string",
    "sort_order": 0,
    "is_require": true,
    "price": 0,
    "price_type": "string",
    "sku": "string",
    "file_extension": "string",
    "max_characters": 0,
    "image_size_x": 0,
    "image_size_y": 0,
    "values": [
      {
        "title": "string",
        "sort_order": 0,
        "price": 0,
        "price_type": "string",
        "sku": "string",
        "option_type_id": 0
      }
    ],
    "extension_attributes": {}
  }
}
Example Payload for Create Product Options⤓
Loading…

Create Products​

Create a new Product | key: createProducts

InputNotesExample
Connection

The Adobe Commerce connection to use.

Product

The product to save, as a JSON object under a product key. The default value lists every field the endpoint accepts; remove the ones that do not apply.

{
  "product": {
    "id": 0,
    "sku": "string",
    "name": "string",
    "attribute_set_id": 0,
    "price": 0,
    "status": 0,
    "visibility": 0,
    "type_id": "string",
    "created_at": "string",
    "updated_at": "string",
    "weight": 0,
    "extension_attributes": {
      "website_ids": [
        0
      ],
      "category_links": [
        {
          "position": 0,
          "category_id": "string",
          "extension_attributes": {}
        }
      ],
      "discounts": [
        {
          "discount_data": {
            "amount": 0,
            "base_amount": 0,
            "original_amount": 0,
            "base_original_amount": 0
          },
          "rule_label": "string",
          "rule_id": 0
        }
      ],
      "bundle_product_options": [
        {
          "option_id": 0,
          "title": "string",
          "required": true,
          "type": "string",
          "position": 0,
          "sku": "string",
          "product_links": [
            {
              "id": "string",
              "sku": "string",
              "option_id": 0,
              "qty": 0,
              "position": 0,
              "is_default": true,
              "price": 0,
              "price_type": 0,
              "can_change_quantity": 0,
              "extension_attributes": {}
            }
          ],
          "extension_attributes": {}
        }
      ],
      "stock_item": {
        "item_id": 0,
        "product_id": 0,
        "stock_id": 0,
        "qty": 0,
        "is_in_stock": true,
        "is_qty_decimal": true,
        "show_default_notification_message": true,
        "use_config_min_qty": true,
        "min_qty": 0,
        "use_config_min_sale_qty": 0,
        "min_sale_qty": 0,
        "use_config_max_sale_qty": true,
        "max_sale_qty": 0,
        "use_config_backorders": true,
        "backorders": 0,
        "use_config_notify_stock_qty": true,
        "notify_stock_qty": 0,
        "use_config_qty_increments": true,
        "qty_increments": 0,
        "use_config_enable_qty_inc": true,
        "enable_qty_increments": true,
        "use_config_manage_stock": true,
        "manage_stock": true,
        "low_stock_date": "string",
        "is_decimal_divided": true,
        "stock_status_changed_auto": 0,
        "extension_attributes": {}
      },
      "downloadable_product_links": [
        {
          "id": 0,
          "title": "string",
          "sort_order": 0,
          "is_shareable": 0,
          "price": 0,
          "number_of_downloads": 0,
          "link_type": "string",
          "link_file": "string",
          "link_file_content": {
            "file_data": "string",
            "name": "string",
            "extension_attributes": {}
          },
          "link_url": "string",
          "sample_type": "string",
          "sample_file": "string",
          "sample_file_content": {
            "file_data": "string",
            "name": "string",
            "extension_attributes": {}
          },
          "sample_url": "string",
          "extension_attributes": {}
        }
      ],
      "downloadable_product_samples": [
        {
          "id": 0,
          "title": "string",
          "sort_order": 0,
          "sample_type": "string",
          "sample_file": "string",
          "sample_file_content": {
            "file_data": "string",
            "name": "string",
            "extension_attributes": {}
          },
          "sample_url": "string",
          "extension_attributes": {}
        }
      ],
      "giftcard_amounts": [
        {
          "attribute_id": 0,
          "website_id": 0,
          "value": 0,
          "website_value": 0,
          "extension_attributes": {}
        }
      ],
      "configurable_product_options": [
        {
          "id": 0,
          "attribute_id": "string",
          "label": "string",
          "position": 0,
          "is_use_default": true,
          "values": [
            {
              "value_index": 0,
              "extension_attributes": {}
            }
          ],
          "extension_attributes": {},
          "product_id": 0
        }
      ],
      "configurable_product_links": [
        0
      ]
    },
    "product_links": [
      {
        "sku": "string",
        "link_type": "string",
        "linked_product_sku": "string",
        "linked_product_type": "string",
        "position": 0,
        "extension_attributes": {
          "qty": 0
        }
      }
    ],
    "options": [
      {
        "product_sku": "string",
        "option_id": 0,
        "title": "string",
        "type": "string",
        "sort_order": 0,
        "is_require": true,
        "price": 0,
        "price_type": "string",
        "sku": "string",
        "file_extension": "string",
        "max_characters": 0,
        "image_size_x": 0,
        "image_size_y": 0,
        "values": [
          {
            "title": "string",
            "sort_order": 0,
            "price": 0,
            "price_type": "string",
            "sku": "string",
            "option_type_id": 0
          }
        ],
        "extension_attributes": {}
      }
    ],
    "media_gallery_entries": [
      {
        "id": 0,
        "media_type": "string",
        "label": "string",
        "position": 0,
        "disabled": true,
        "types": [
          "string"
        ],
        "file": "string",
        "content": {
          "base64_encoded_data": "string",
          "type": "string",
          "name": "string"
        },
        "extension_attributes": {
          "video_content": {
            "media_type": "string",
            "video_provider": "string",
            "video_url": "string",
            "video_title": "string",
            "video_description": "string",
            "video_metadata": "string"
          }
        }
      }
    ],
    "tier_prices": [
      {
        "customer_group_id": 0,
        "qty": 0,
        "value": 0,
        "extension_attributes": {
          "percentage_value": 0,
          "website_id": 0
        }
      }
    ],
    "custom_attributes": [
      {
        "attribute_code": "string",
        "value": "string"
      }
    ]
  },
  "saveOptions": true
}
Example Payload for Create Products⤓
Loading…

Delete Customer​

Delete customer by Customer ID. | key: deleteCustomer

InputNotesExample
Connection

The Adobe Commerce connection to use.

Customer ID

The customer to act on, identified by their Magento customer id. Pick a customer from the dropdown or supply the ID directly.

1
Example Payload for Delete Customer⤓
Loading…

Get Customer​

Get customer by Customer ID. | key: getCustomer

InputNotesExample
Connection

The Adobe Commerce connection to use.

Customer ID

The customer to act on, identified by their Magento customer id. Pick a customer from the dropdown or supply the ID directly.

1
Example Payload for Get Customer⤓
Loading…

Get Order​

Loads a specified order. | key: getOrder

InputNotesExample
Connection

The Adobe Commerce connection to use.

Order ID

The order to act on, identified by its Magento entity_id rather than the customer-facing increment ID. Pick an order from the dropdown or supply the ID directly.

1
Example Payload for Get Order⤓
Loading…

Get Transaction​

Loads a specified transaction. | key: getTransaction

InputNotesExample
Connection

The Adobe Commerce connection to use.

Transaction ID

The payment transaction to retrieve, identified by its Magento transaction_id rather than the payment gateway's own txn_id. Pick a transaction from the dropdown or supply the ID directly.

1
Example Payload for Get Transaction⤓
Loading…

List Order Items​

Lists order items that match specified search criteria. | key: listOrderItems

InputNotesExample
Connection

The Adobe Commerce connection to use.

Fetch All

When true, walks the result set page by page and returns every record instead of a single page. Page Size still controls how many records each page requests (100 when left blank), while Current Page is ignored because paging always restarts at page 1. Paging stops after 100 pages.

false
Condition Type

The Magento condition type used to compare Field against Value, such as an equality or range operator. Omit it to let Magento apply its own default comparison.

gteq
Current Page

The page of results to return, counting from 1. Ignored when Fetch All is enabled, which always starts at page 1.

1
Field

The record field the search filter is applied to. Only one filter is supported: Field, Condition Type and Value together build searchCriteria[filterGroups][0][filters][0], so a single request can filter on one field only.

updated_at
Page Size

How many records to return per page. When Fetch All is enabled and this is left blank, each page requests 100 records.

50
Sorting Direction

The direction the Sorting Field is ordered in. It has no effect unless Sorting Field is also set.

DESC
Sorting Field

The record field that results are sorted by. Pair it with Sorting Direction to control the order.

created_at
Value

The value that Field is compared against. It belongs to the same single filter as Field and Condition Type, so only one value can be matched per request. Dates use the Magento YYYY-MM-DD HH:MM:SS UTC format rather than ISO 8601.

2026-01-01 00:00:00
Example Payload for List Order Items⤓
Loading…

List Orders​

Lists orders that match specified search criteria. | key: listOrders

InputNotesExample
Connection

The Adobe Commerce connection to use.

Fetch All

When true, walks the result set page by page and returns every record instead of a single page. Page Size still controls how many records each page requests (100 when left blank), while Current Page is ignored because paging always restarts at page 1. Paging stops after 100 pages.

false
Condition Type

The Magento condition type used to compare Field against Value, such as an equality or range operator. Omit it to let Magento apply its own default comparison.

gteq
Current Page

The page of results to return, counting from 1. Ignored when Fetch All is enabled, which always starts at page 1.

1
Field

The record field the search filter is applied to. Only one filter is supported: Field, Condition Type and Value together build searchCriteria[filterGroups][0][filters][0], so a single request can filter on one field only.

updated_at
Page Size

How many records to return per page. When Fetch All is enabled and this is left blank, each page requests 100 records.

50
Sorting Direction

The direction the Sorting Field is ordered in. It has no effect unless Sorting Field is also set.

DESC
Sorting Field

The record field that results are sorted by. Pair it with Sorting Direction to control the order.

created_at
Value

The value that Field is compared against. It belongs to the same single filter as Field and Condition Type, so only one value can be matched per request. Dates use the Magento YYYY-MM-DD HH:MM:SS UTC format rather than ISO 8601.

2026-01-01 00:00:00
Example Payload for List Orders⤓
Loading…

List Product Attributes​

Retrieve product attributes that match specified search criteria. | key: listProductAttributes

InputNotesExample
Connection

The Adobe Commerce connection to use.

Fetch All

When true, walks the result set page by page and returns every record instead of a single page. Page Size still controls how many records each page requests (100 when left blank), while Current Page is ignored because paging always restarts at page 1. Paging stops after 100 pages.

false
Condition Type

The Magento condition type used to compare Field against Value, such as an equality or range operator. Omit it to let Magento apply its own default comparison.

gteq
Current Page

The page of results to return, counting from 1. Ignored when Fetch All is enabled, which always starts at page 1.

1
Field

The record field the search filter is applied to. Only one filter is supported: Field, Condition Type and Value together build searchCriteria[filterGroups][0][filters][0], so a single request can filter on one field only.

updated_at
Page Size

How many records to return per page. When Fetch All is enabled and this is left blank, each page requests 100 records.

50
Sorting Direction

The direction the Sorting Field is ordered in. It has no effect unless Sorting Field is also set.

DESC
Sorting Field

The record field that results are sorted by. Pair it with Sorting Direction to control the order.

created_at
Value

The value that Field is compared against. It belongs to the same single filter as Field and Condition Type, so only one value can be matched per request. Dates use the Magento YYYY-MM-DD HH:MM:SS UTC format rather than ISO 8601.

2026-01-01 00:00:00
Example Payload for List Product Attributes⤓
Loading…

List Product Option Types​

Get custom option types | key: listProductOptionTypes

InputNotesExample
Connection

The Adobe Commerce connection to use.

Example Payload for List Product Option Types⤓
Loading…

List Product Types​

Retrieve available product types | key: listProductTypes

InputNotesExample
Connection

The Adobe Commerce connection to use.

Example Payload for List Product Types⤓
Loading…

List Products​

Get product list | key: listProducts

InputNotesExample
Connection

The Adobe Commerce connection to use.

Fetch All

When true, walks the result set page by page and returns every record instead of a single page. Page Size still controls how many records each page requests (100 when left blank), while Current Page is ignored because paging always restarts at page 1. Paging stops after 100 pages.

false
Condition Type

The Magento condition type used to compare Field against Value, such as an equality or range operator. Omit it to let Magento apply its own default comparison.

gteq
Current Page

The page of results to return, counting from 1. Ignored when Fetch All is enabled, which always starts at page 1.

1
Field

The record field the search filter is applied to. Only one filter is supported: Field, Condition Type and Value together build searchCriteria[filterGroups][0][filters][0], so a single request can filter on one field only.

updated_at
Page Size

How many records to return per page. When Fetch All is enabled and this is left blank, each page requests 100 records.

50
Sorting Direction

The direction the Sorting Field is ordered in. It has no effect unless Sorting Field is also set.

DESC
Sorting Field

The record field that results are sorted by. Pair it with Sorting Direction to control the order.

created_at
Value

The value that Field is compared against. It belongs to the same single filter as Field and Condition Type, so only one value can be matched per request. Dates use the Magento YYYY-MM-DD HH:MM:SS UTC format rather than ISO 8601.

2026-01-01 00:00:00
Example Payload for List Products⤓
Loading…

List Transactions​

Lists transactions that match specified search criteria. | key: listTransactions

InputNotesExample
Connection

The Adobe Commerce connection to use.

Fetch All

When true, walks the result set page by page and returns every record instead of a single page. Page Size still controls how many records each page requests (100 when left blank), while Current Page is ignored because paging always restarts at page 1. Paging stops after 100 pages.

false
Condition Type

The Magento condition type used to compare Field against Value, such as an equality or range operator. Omit it to let Magento apply its own default comparison.

gteq
Current Page

The page of results to return, counting from 1. Ignored when Fetch All is enabled, which always starts at page 1.

1
Field

The record field the search filter is applied to. Only one filter is supported: Field, Condition Type and Value together build searchCriteria[filterGroups][0][filters][0], so a single request can filter on one field only.

updated_at
Page Size

How many records to return per page. When Fetch All is enabled and this is left blank, each page requests 100 records.

50
Sorting Direction

The direction the Sorting Field is ordered in. It has no effect unless Sorting Field is also set.

DESC
Sorting Field

The record field that results are sorted by. Pair it with Sorting Direction to control the order.

created_at
Value

The value that Field is compared against. It belongs to the same single filter as Field and Condition Type, so only one value can be matched per request. Dates use the Magento YYYY-MM-DD HH:MM:SS UTC format rather than ISO 8601.

2026-01-01 00:00:00
Example Payload for List Transactions⤓
Loading…

Raw Request (GraphQL)​

Send a raw GraphQL request to Adobe Commerce. | key: graphQLRawRequest

InputNotesExample
Connection

The Adobe Commerce connection to use.

GraphQL Query

The GraphQL operation to send to the store's /graphql endpoint. The default value is a placeholder outline; replace it with the query or mutation to run.

query myCartQuery{
    cart(cart_id: String!): Cart
  }
Store

The hostname of the storefront that receives the GraphQL request. The request is sent to https://<host>/graphql, so this must be a bare host with no scheme and no path.

www.example.com

Raw Request (REST)​

Send a raw HTTP request to Adobe Commerce. | key: restRawRequest

InputNotesExample
Connection

The Adobe Commerce connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only. The base URL comes from the connection: the Store URL for the OAuth 1.0a connection, or the Marketplace sandbox or production host for the API Access Key connection. The path is appended to that base as-is, so a store REST path includes its /rest/<store_code>/V1 prefix, where <store_code> is whatever the OAuth 1.0a connection's Store Code field holds (for example, /rest/default/V1/orders for the default store view).

/rest/default/V1/orders
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Search Customers​

Retrieve customers which match a specified criteria. | key: searchCustomers

InputNotesExample
Connection

The Adobe Commerce connection to use.

Fetch All

When true, walks the result set page by page and returns every record instead of a single page. Page Size still controls how many records each page requests (100 when left blank), while Current Page is ignored because paging always restarts at page 1. Paging stops after 100 pages.

false
Condition Type

The Magento condition type used to compare Field against Value, such as an equality or range operator. Omit it to let Magento apply its own default comparison.

gteq
Current Page

The page of results to return, counting from 1. Ignored when Fetch All is enabled, which always starts at page 1.

1
Field

The record field the search filter is applied to. Only one filter is supported: Field, Condition Type and Value together build searchCriteria[filterGroups][0][filters][0], so a single request can filter on one field only.

updated_at
Page Size

How many records to return per page. When Fetch All is enabled and this is left blank, each page requests 100 records.

50
Sorting Direction

The direction the Sorting Field is ordered in. It has no effect unless Sorting Field is also set.

DESC
Sorting Field

The record field that results are sorted by. Pair it with Sorting Direction to control the order.

created_at
Value

The value that Field is compared against. It belongs to the same single filter as Field and Condition Type, so only one value can be matched per request. Dates use the Magento YYYY-MM-DD HH:MM:SS UTC format rather than ISO 8601.

2026-01-01 00:00:00
Example Payload for Search Customers⤓
Loading…

Update Customer​

Update an existing customer. | key: updateCustomer

InputNotesExample
Connection

The Adobe Commerce connection to use.

Customer

The customer record to save, as a JSON object under a customer key. The default value lists every field the endpoint accepts; remove the ones that do not apply.

{
  "customer": {
    "id": 0,
    "group_id": 0,
    "default_billing": "string",
    "default_shipping": "string",
    "confirmation": "string",
    "created_at": "string",
    "updated_at": "string",
    "created_in": "string",
    "dob": "string",
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "prefix": "string",
    "suffix": "string",
    "gender": 0,
    "store_id": 0,
    "taxvat": "string",
    "website_id": 0,
    "addresses": [
      {
        "id": 0,
        "customer_id": 0,
        "region": {
          "region_code": "string",
          "region": "string",
          "region_id": 0,
          "extension_attributes": {}
        },
        "region_id": 0,
        "country_id": "string",
        "street": [
          "string"
        ],
        "company": "string",
        "telephone": "string",
        "fax": "string",
        "postcode": "string",
        "city": "string",
        "firstname": "string",
        "lastname": "string",
        "middlename": "string",
        "prefix": "string",
        "suffix": "string",
        "vat_id": "string",
        "default_shipping": true,
        "default_billing": true,
        "extension_attributes": {},
        "custom_attributes": [
          {
            "attribute_code": "string",
            "value": "string"
          }
        ]
      }
    ],
    "disable_auto_group_change": 0,
    "extension_attributes": {
      "company_attributes": {
        "customer_id": 0,
        "company_id": 0,
        "job_title": "string",
        "status": 0,
        "telephone": "string",
        "extension_attributes": {}
      },
      "assistance_allowed": 0,
      "is_subscribed": true
    },
    "custom_attributes": [
      {
        "attribute_code": "string",
        "value": "string"
      }
    ]
  }
}
Customer ID

The customer to act on, identified by their Magento customer id. Pick a customer from the dropdown or supply the ID directly.

1
Password Hash

An already-hashed password to store on the customer, for migrating an account whose credentials were created elsewhere. When provided it is added to the request body as passwordHash; leave it blank to omit it from the request.

Example Payload for Update Customer⤓
Loading…

Changelog​

2026-10-13​

Added opt-in batching to the New and Updated Records trigger, dispatching each changed record individually or in configured batches; enabling it changes the shape a downstream step receives

2026-09-28​

Added merchant store authentication so that actions, triggers, and data sources read and write data in an Adobe Commerce store:

  • Added the OAuth 1.0a connection, which authenticates against a merchant store with an integration's consumer key and access token credentials and takes a Store URL plus an optional Store Code for installations serving multiple store views
  • Updated the API Access Key connection to API Access Key (Deprecated); it authenticates against the Adobe Commerce Marketplace Developer portal rather than a merchant store, so it cannot read or write orders, products, customers, or transactions
  • Fixed the Select Order, Select Customer, Select Transaction, Product Types, Product Attribute Types, and Product Option Types data sources, which failed to load their options; all six now present their options ordered by label
  • Added an optional Look-back Date input for performing an initial sync of records on the New and Updated Records trigger. The initial sync backfills every record modified on or after the specified date, seeding each once and ignoring the trigger's filters; later recurrences are unaffected. Leave it empty to start from the first recurrence with no backfill
  • Updated the New and Updated Records trigger to walk a truncated backlog forward in oldest-first order, so a set of changes larger than one recurrence's page cap drains across later recurrences instead of repeating the most recent records
  • Updated the Webhook trigger so it no longer offers a synchronous response or a schedule
  • Updated every action to raise an API failure as an error carrying message, data, status, and headers as fields, replacing the single JSON-encoded message string
  • Added inline action calling support to 19 actions for improved example output during configuration

2026-06-11​

Added Fetch All toggle to paginated list actions (List Products, List Orders, List Order Items, List Product Attributes, List Transactions, Search Customers) that automatically paginates through all results using searchCriteria[currentPage]/searchCriteria[pageSize]; when disabled, existing single-page behavior is preserved

2026-05-28​

Added New and Updated Records polling trigger that monitors orders, customers, or products for changes and routes newly created records and updated records to separate branches

2026-05-20​

Applied automated security patches and code formatting updates

2026-04-30​

Updated spectral version

2026-04-07​

Added global debug support across all actions for improved troubleshooting

2026-03-05​

Added inline data sources for orders, transactions, and customers to enhance data selection capabilities