# Adobe Commerce Magento Component

![](/docs/img/components/icons/60/YWRvYmUtY29tbWVyY2UtbWFnZW50bw==.png)

#### Adobe Commerce (Magento) is an open-source e-commerce platform. Use the Adobe Commerce component to manage your Products, Orders, Customers, and Transactions.

Component key: **adobe-commerce-magento**

## Description[​](#description "Direct link to Description")

[Adobe Commerce (Magento)](https://business.adobe.com/products/magento/magento-commerce.html#) is an open-source e-commerce platform.

Use the Adobe Commerce component to manage your Products, Orders, Customers, and Transactions.

#### API Documentation[​](#api-documentation "Direct link to API Documentation")

This component was built using the [Adobe Commerce REST API Overview](https://developer.adobe.com/commerce/webapi/rest/).

## Connections[​](#connections "Direct link to Connections")

### API Access Key[​](#api-access-key "Direct link to API Access Key")

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

1. Using your [API access key](https://developer.adobe.com/commerce/marketplace/guides/eqp/v1/access-keys/), obtain a session token.

2. You create your API access key from one, or both, of the **Marketplace Developer Portal** user interfaces:

   <!-- -->

   1. production - [https://commercedeveloper.adobe.com](https://commercedeveloper.adobe.com/)
   2. sandbox - [https://commercedeveloper-sandbox.adobe.com](https://commercedeveloper-sandbox.adobe.com/)

3. From the **Marketplace Developer Portal**, sign in, click on your 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 your own use. Then, click **Continue**.

7. Enter this API Key value into your connection configuration.

| Input                      | Notes                                                                                                                                                 | Example                                  |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| Application ID             | https\://developer.adobe.com/commerce/marketplace/guides/eqp/v1/access-keys/#what-is-an-api-access-key                                                | AQ17NZ49WC                               |
| Application Secret         | https\://developer.adobe.com/commerce/marketplace/guides/eqp/v1/access-keys/#what-is-an-api-access-key                                                | 8820c99614d65f923df7660276f20e029d73e2ca |
| Use Production Environment | Set true for production environment (https\://commercedeveloper-api.adobe.com), false for sandbox (https\://commercedeveloper-sandbox-api.adobe.com). | false                                    |

## Triggers[​](#triggers "Direct link to Triggers")

### Webhook[​](#webhook "Direct link to Webhook")

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

<!-- -->

***

## Data Sources[​](#data-sources "Direct link to Data Sources")

### Product Attribute Types[​](#product-attribute-types "Direct link to Product Attribute Types")

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

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

***

### Product Option Types[​](#product-option-types "Direct link to Product Option Types")

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

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

***

### Product Types[​](#product-types "Direct link to Product Types")

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

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

***

## Actions[​](#actions "Direct link to Actions")

### Cancel Order[​](#cancel-order "Direct link to Cancel Order")

Cancels a specified order. | **key: cancelOrder**

| Input      | Notes     | Example |
| ---------- | --------- | ------- |
| Connection |           |         |
| Order ID   | Order ID. |         |

### Example Payload for <!-- -->Cancel Order

```
{
  "data": true
}
```

***

### Create Customer[​](#create-customer "Direct link to Create Customer")

Create customer account. | **key: createCustomer**

| Input        | Notes         | Example     |
| ------------ | ------------- | ----------- |
| Connection   |               |             |
| Customer     | Customer.     | See Example |
| Password     | Password.     |             |
| Redirect URL | Redirect URL. |             |

### Example Payload for <!-- -->Create Customer

```
{
  "data": {
    "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"
      }
    ]
  }
}
```

***

### Create Order[​](#create-order "Direct link to Create Order")

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

| Input      | Notes   | Example     |
| ---------- | ------- | ----------- |
| Connection |         |             |
| Entity     | Entity. | See Example |

***

### Create Product Attributes[​](#create-product-attributes "Direct link to Create Product Attributes")

Save attribute data | **key: createProductAttributes**

| Input      | Notes      | Example     |
| ---------- | ---------- | ----------- |
| Attribute  | Attribute. | See Example |
| Connection |            |             |

### Example Payload for <!-- -->Create Product Attributes

```
{
  "data": {
    "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"
      }
    ]
  }
}
```

***

### Create Product Options[​](#create-product-options "Direct link to Create Product Options")

Save Custom Option | **key: createProductOptions**

| Input      | Notes   | Example     |
| ---------- | ------- | ----------- |
| Connection |         |             |
| Option     | Option. | See Example |

### Example Payload for <!-- -->Create Product Options

```
{
  "data": {
    "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": {}
  }
}
```

***

### Create Products[​](#create-products "Direct link to Create Products")

Create a new Product | **key: createProducts**

| Input      | Notes    | Example     |
| ---------- | -------- | ----------- |
| Connection |          |             |
| Product    | Product. | See Example |

### Example Payload for <!-- -->Create Products

```
{
  "data": {
    "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"
      }
    ]
  }
}
```

***

### Delete Customer[​](#delete-customer "Direct link to Delete Customer")

Delete customer by Customer ID. | **key: deleteCustomer**

| Input       | Notes        | Example |
| ----------- | ------------ | ------- |
| Connection  |              |         |
| Customer ID | Customer ID. |         |

### Example Payload for <!-- -->Delete Customer

```
{
  "data": true
}
```

***

### Get Customer[​](#get-customer "Direct link to Get Customer")

Get customer by Customer ID. | **key: getCustomer**

| Input       | Notes        | Example |
| ----------- | ------------ | ------- |
| Connection  |              |         |
| Customer ID | Customer ID. |         |

### Example Payload for <!-- -->Get Customer

```
{
  "data": {
    "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"
      }
    ]
  }
}
```

***

### Get Order[​](#get-order "Direct link to Get Order")

Loads a specified order. | **key: getOrder**

| Input      | Notes     | Example |
| ---------- | --------- | ------- |
| Connection |           |         |
| Order ID   | Order ID. |         |

***

### Get Transaction[​](#get-transaction "Direct link to Get Transaction")

Loads a specified transaction. | **key: getTransaction**

| Input          | Notes           | Example |
| -------------- | --------------- | ------- |
| Connection     |                 |         |
| Transaction ID | Transaction ID. |         |

### Example Payload for <!-- -->Get Transaction

```
{
  "data": {
    "transaction_id": 0,
    "parent_id": 0,
    "order_id": 0,
    "payment_id": 0,
    "txn_id": "string",
    "parent_txn_id": "string",
    "txn_type": "string",
    "is_closed": 0,
    "additional_information": [
      "string"
    ],
    "created_at": "string",
    "child_transactions": [
      {}
    ],
    "extension_attributes": {}
  }
}
```

***

### GraphQL Raw Request[​](#graphql-raw-request "Direct link to GraphQL Raw Request")

Send raw GraphQL request to Adobe Commerce | **key: graphQLRawRequest**

| Input         | Notes                                                                                            | Example     |
| ------------- | ------------------------------------------------------------------------------------------------ | ----------- |
| Connection    |                                                                                                  |             |
| GraphQL Query |                                                                                                  | See Example |
| Store         | Input your store name for the GraphQL endpoint (https\://<!-- -->\<your store><!-- -->/graphql). | my-store    |

***

### List Order Items[​](#list-order-items "Direct link to List Order Items")

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

| Input             | Notes              | Example |
| ----------------- | ------------------ | ------- |
| Connection        |                    |         |
| Condition Type    | Condition type.    |         |
| Current Page      | Current page.      |         |
| Field             | Field.             |         |
| Page Size         | Page size.         |         |
| Sorting Direction | Sorting direction. |         |
| Sorting Field     | Sorting field.     |         |
| Value             | Value.             |         |

***

### List Orders[​](#list-orders "Direct link to List Orders")

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

| Input             | Notes              | Example |
| ----------------- | ------------------ | ------- |
| Connection        |                    |         |
| Condition Type    | Condition type.    |         |
| Current Page      | Current page.      |         |
| Field             | Field.             |         |
| Page Size         | Page size.         |         |
| Sorting Direction | Sorting direction. |         |
| Sorting Field     | Sorting field.     |         |
| Value             | Value.             |         |

### Example Payload for <!-- -->List Orders

```
{
  "data": {
    "items": [],
    "search_criteria": {
      "filter_groups": [
        {
          "filters": [
            {
              "field": "string",
              "value": "string",
              "condition_type": "string"
            }
          ]
        }
      ],
      "sort_orders": [
        {
          "field": "string",
          "direction": "string"
        }
      ],
      "page_size": 0,
      "current_page": 0
    },
    "total_count": 0
  }
}
```

***

### List Product Attributes[​](#list-product-attributes "Direct link to List Product Attributes")

Retrieve all attributes for entity type | **key: listProductAttributes**

| Input             | Notes              | Example |
| ----------------- | ------------------ | ------- |
| Connection        |                    |         |
| Condition Type    | Condition type.    |         |
| Current Page      | Current page.      |         |
| Field             | Field.             |         |
| Page Size         | Page size.         |         |
| Sorting Direction | Sorting direction. |         |
| Sorting Field     | Sorting field.     |         |
| Value             | Value.             |         |

### Example Payload for <!-- -->List Product Attributes

```
{
  "data": {
    "items": [
      {
        "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"
          }
        ]
      }
    ],
    "search_criteria": {
      "filter_groups": [
        {
          "filters": [
            {
              "field": "string",
              "value": "string",
              "condition_type": "string"
            }
          ]
        }
      ],
      "sort_orders": [
        {
          "field": "string",
          "direction": "string"
        }
      ],
      "page_size": 0,
      "current_page": 0
    },
    "total_count": 0
  }
}
```

***

### List Product Option Types[​](#list-product-option-types "Direct link to List Product Option Types")

Get custom option types | **key: listProductOptionTypes**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

### Example Payload for <!-- -->List Product Option Types

```
{
  "data": [
    {
      "label": "string",
      "code": "string",
      "group": "string",
      "extension_attributes": {}
    }
  ]
}
```

***

### List Product Types[​](#list-product-types "Direct link to List Product Types")

Retrieve available product types | **key: listProductTypes**

| Input      | Notes | Example |
| ---------- | ----- | ------- |
| Connection |       |         |

### Example Payload for <!-- -->List Product Types

```
{
  "data": [
    {
      "name": "string",
      "label": "string",
      "extension_attributes": {}
    }
  ]
}
```

***

### List Products[​](#list-products "Direct link to List Products")

Get product list | **key: listProducts**

| Input             | Notes              | Example |
| ----------------- | ------------------ | ------- |
| Connection        |                    |         |
| Condition Type    | Condition type.    |         |
| Current Page      | Current page.      |         |
| Field             | Field.             |         |
| Page Size         | Page size.         |         |
| Sorting Direction | Sorting direction. |         |
| Sorting Field     | Sorting field.     |         |
| Value             | Value.             |         |

### Example Payload for <!-- -->List Products

```
{
  "data": {
    "items": [
      {
        "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": null,
                  "sku": null,
                  "option_id": null,
                  "qty": null,
                  "position": null,
                  "is_default": null,
                  "price": null,
                  "price_type": null,
                  "can_change_quantity": null,
                  "extension_attributes": null
                }
              ],
              "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": null,
                  "extension_attributes": null
                }
              ],
              "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"
          }
        ]
      }
    ],
    "search_criteria": {
      "filter_groups": [
        {
          "filters": [
            {
              "field": "string",
              "value": "string",
              "condition_type": "string"
            }
          ]
        }
      ],
      "sort_orders": [
        {
          "field": "string",
          "direction": "string"
        }
      ],
      "page_size": 0,
      "current_page": 0
    },
    "total_count": 0
  }
}
```

***

### List Transactions[​](#list-transactions "Direct link to List Transactions")

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

| Input             | Notes              | Example |
| ----------------- | ------------------ | ------- |
| Connection        |                    |         |
| Condition Type    | Condition type.    |         |
| Current Page      | Current page.      |         |
| Field             | Field.             |         |
| Page Size         | Page size.         |         |
| Sorting Direction | Sorting direction. |         |
| Sorting Field     | Sorting field.     |         |
| Value             | Value.             |         |

### Example Payload for <!-- -->List Transactions

```
{
  "data": {
    "items": [
      {
        "transaction_id": 0,
        "parent_id": 0,
        "order_id": 0,
        "payment_id": 0,
        "txn_id": "string",
        "parent_txn_id": "string",
        "txn_type": "string",
        "is_closed": 0,
        "additional_information": [
          "string"
        ],
        "created_at": "string",
        "child_transactions": [
          {}
        ],
        "extension_attributes": {}
      }
    ],
    "search_criteria": {
      "filter_groups": [
        {
          "filters": [
            {
              "field": "string",
              "value": "string",
              "condition_type": "string"
            }
          ]
        }
      ],
      "sort_orders": [
        {
          "field": "string",
          "direction": "string"
        }
      ],
      "page_size": 0,
      "current_page": 0
    },
    "total_count": 0
  }
}
```

***

### REST Raw Request[​](#rest-raw-request "Direct link to REST Raw Request")

Send raw HTTP request to Adobe Commerce | **key: restRawRequest**

| Input                   | Notes                                                                                                                                                                                                                                                                                                                 | Example                                                       |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| Connection              |                                                                                                                                                                                                                                                                                                                       |                                                               |
| Data                    | The HTTP body payload to send to the URL.                                                                                                                                                                                                                                                                             | {"exampleKey": "Example Data"}                                |
| Debug Request           | Enabling this flag will log out the current request.                                                                                                                                                                                                                                                                  | false                                                         |
| 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.                                                                                                                                                                                                                                                                             | 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.                                                                                                                                                                                                                                                       | false                                                         |
| Retry Delay (ms)        | The delay in milliseconds between retries.                                                                                                                                                                                                                                                                            | 0                                                             |
| Timeout                 | The maximum time that a client will await a response to its request                                                                                                                                                                                                                                                   | 2000                                                          |
| URL                     | Input the path only (/orders), The base URL is already included (https\://commercedeveloper-sandbox-api.adobe.com for sandbox or https\://commercedeveloper-api.adobe.com for production). For example, to connect to https\://commercedeveloper-sandbox-api.adobe.com/orders, only /orders is entered in this field. | /orders                                                       |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries.                                                                                                                                                                                                                                      | false                                                         |

***

### Search Customers[​](#search-customers "Direct link to Search Customers")

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

| Input             | Notes              | Example |
| ----------------- | ------------------ | ------- |
| Connection        |                    |         |
| Condition Type    | Condition type.    |         |
| Current Page      | Current page.      |         |
| Field             | Field.             |         |
| Page Size         | Page size.         |         |
| Sorting Direction | Sorting direction. |         |
| Sorting Field     | Sorting field.     |         |
| Value             | Value.             |         |

### Example Payload for <!-- -->Search Customers

```
{
  "data": {
    "items": [
      {
        "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"
          }
        ]
      }
    ],
    "search_criteria": {
      "filter_groups": [
        {
          "filters": [
            {
              "field": "string",
              "value": "string",
              "condition_type": "string"
            }
          ]
        }
      ],
      "sort_orders": [
        {
          "field": "string",
          "direction": "string"
        }
      ],
      "page_size": 0,
      "current_page": 0
    },
    "total_count": 0
  }
}
```

***

### Update Customer[​](#update-customer "Direct link to Update Customer")

Create or update a customer. | **key: updateCustomer**

| Input         | Notes          | Example     |
| ------------- | -------------- | ----------- |
| Connection    |                |             |
| Customer      | Customer.      | See Example |
| Customer ID   | Customer ID.   |             |
| Password Hash | Password hash. |             |

### Example Payload for <!-- -->Update Customer

```
{
  "data": {
    "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"
      }
    ]
  }
}
```

***
