Adobe Commerce REST

The Adobe Commerce REST connector lets your workflows interact with a Magento 2 / Adobe Commerce store via the REST API. Best for admin and back-office operations: product CRUD, order management, inventory, shipments, and invoices.

For storefront operations like catalog browsing, cart management, and checkout flows, use the Adobe Commerce GraphQL connector instead — it supports precise field selection and is optimized for storefront use cases.

For the full API reference, see the Adobe Commerce REST API documentation.

Connection setup

Create an Integration in Magento Admin

Go to System → Integrations → Add New Integration. Give it a name (e.g., “Spojit”) and configure the API tab to grant access to the resources your workflows need.

Activate and copy the tokens

Click Activate on the integration. Copy the Access Token — this is a permanent token that works until revoked.

Add the connection in Spojit

Go to Connections in Spojit, click Add Connection, select Adobe Commerce REST, and enter:

Base URL: Your store URL (e.g., https://mystore.com)
Access Token: The integration access token
Store Code (optional): Defaults to default

Tools

Products

list-products — Search/list products

query

string

Filter by product name (uses ‘like’ matching with % wildcards).

sku

string

Filter by exact SKU.

status

number

Filter by status: 1 = enabled, 2 = disabled.

typeId

string

Filter by product type: simple, configurable, grouped, bundle, virtual, downloadable.

pageSize

number

default:"20"

Number of results per page.

currentPage

number

default:"1"

Page number.

sortField

string

Field to sort by (e.g., name, price, created_at).

sortDir

string

Sort direction: ASC or DESC.

Example request:

{
  "query": "shirt",
  "status": 1,
  "pageSize": 5,
  "currentPage": 1,
  "sortField": "price",
  "sortDir": "ASC"
}

Example response:

{
  "items": [
    {
      "id": 42,
      "sku": "WS-001",
      "name": "Blue Cotton Shirt",
      "attribute_set_id": 4,
      "price": 29.99,
      "status": 1,
      "visibility": 4,
      "type_id": "simple",
      "created_at": "2025-01-15 10:30:00",
      "updated_at": "2025-03-20 14:22:10",
      "weight": 0.5,
      "extension_attributes": {
        "stock_item": {
          "item_id": 42,
          "product_id": 42,
          "qty": 150,
          "is_in_stock": true
        }
      },
      "custom_attributes": [
        { "attribute_code": "description", "value": "<p>A comfortable blue cotton shirt.</p>" },
        { "attribute_code": "url_key", "value": "blue-cotton-shirt" }
      ]
    }
  ],
  "search_criteria": {
    "filter_groups": [
      { "filters": [{ "field": "name", "value": "%shirt%", "condition_type": "like" }] },
      { "filters": [{ "field": "status", "value": "1", "condition_type": "eq" }] }
    ],
    "page_size": 5,
    "current_page": 1,
    "sort_orders": [{ "field": "price", "direction": "ASC" }]
  },
  "total_count": 12
}

get-product — Get product by SKU

sku

string

required

Product SKU.

Example request:

{
  "sku": "WS-001"
}

Example response:

{
  "id": 42,
  "sku": "WS-001",
  "name": "Blue Cotton Shirt",
  "attribute_set_id": 4,
  "price": 29.99,
  "status": 1,
  "visibility": 4,
  "type_id": "simple",
  "created_at": "2025-01-15 10:30:00",
  "updated_at": "2025-03-20 14:22:10",
  "weight": 0.5,
  "extension_attributes": {
    "website_ids": [1],
    "category_links": [
      { "position": 0, "category_id": "5" }
    ],
    "stock_item": {
      "item_id": 42,
      "product_id": 42,
      "stock_id": 1,
      "qty": 150,
      "is_in_stock": true,
      "manage_stock": true
    }
  },
  "media_gallery_entries": [
    {
      "id": 101,
      "media_type": "image",
      "label": "Front view",
      "position": 1,
      "disabled": false,
      "types": ["image", "small_image", "thumbnail"],
      "file": "/w/s/ws-001-front.jpg"
    }
  ],
  "custom_attributes": [
    { "attribute_code": "description", "value": "<p>A comfortable blue cotton shirt.</p>" },
    { "attribute_code": "short_description", "value": "Blue cotton shirt, lightweight and breathable." },
    { "attribute_code": "url_key", "value": "blue-cotton-shirt" },
    { "attribute_code": "meta_title", "value": "Blue Cotton Shirt" }
  ]
}

create-product — Create a product

product

object

required

Product object with sku, name, price, attribute_set_id, type_id, etc.

Example request:

{
  "product": {
    "sku": "WS-002",
    "name": "Red Running Shoes",
    "price": 89.99,
    "attribute_set_id": 4,
    "type_id": "simple",
    "status": 1,
    "visibility": 4,
    "weight": 1.2,
    "extension_attributes": {
      "stock_item": {
        "is_in_stock": true,
        "qty": 200
      }
    },
    "custom_attributes": [
      { "attribute_code": "description", "value": "<p>Lightweight red running shoes.</p>" },
      { "attribute_code": "url_key", "value": "red-running-shoes" }
    ]
  }
}

Example response:

{
  "id": 43,
  "sku": "WS-002",
  "name": "Red Running Shoes",
  "attribute_set_id": 4,
  "price": 89.99,
  "status": 1,
  "visibility": 4,
  "type_id": "simple",
  "created_at": "2025-04-01 09:15:00",
  "updated_at": "2025-04-01 09:15:00",
  "weight": 1.2,
  "extension_attributes": {
    "website_ids": [1],
    "stock_item": {
      "item_id": 43,
      "product_id": 43,
      "stock_id": 1,
      "qty": 200,
      "is_in_stock": true
    }
  },
  "custom_attributes": [
    { "attribute_code": "description", "value": "<p>Lightweight red running shoes.</p>" },
    { "attribute_code": "url_key", "value": "red-running-shoes" }
  ]
}

update-product — Update product by SKU

sku

string

required

Product SKU.

product

object

required

Product fields to update.

Example request:

{
  "sku": "WS-002",
  "product": {
    "price": 79.99,
    "status": 1,
    "custom_attributes": [
      { "attribute_code": "description", "value": "<p>Lightweight red running shoes, now on sale.</p>" }
    ]
  }
}

Example response:

{
  "id": 43,
  "sku": "WS-002",
  "name": "Red Running Shoes",
  "attribute_set_id": 4,
  "price": 79.99,
  "status": 1,
  "visibility": 4,
  "type_id": "simple",
  "created_at": "2025-04-01 09:15:00",
  "updated_at": "2025-04-01 12:30:45",
  "weight": 1.2
}

delete-product — Delete product by SKU

sku

string

required

Product SKU.

Example request:

{
  "sku": "WS-002"
}

Example response:

true

Orders

list-orders — Search/list orders

status

string

Filter by order status (e.g., pending, processing, complete, canceled, closed).

customerEmail

string

Filter by customer email address.

createdAfter

string

Filter orders created after this date (YYYY-MM-DD HH:MM:SS).

createdBefore

string

Filter orders created before this date (YYYY-MM-DD HH:MM:SS).

minGrandTotal

number

Filter orders with grand total greater than or equal to this value.

pageSize

number

default:"20"

Number of results per page.

currentPage

number

default:"1"

Page number.

sortField

string

Field to sort by (e.g., created_at, grand_total, increment_id).

sortDir

string

Sort direction: ASC or DESC.

Example request:

{
  "status": "processing",
  "pageSize": 5,
  "sortField": "created_at",
  "sortDir": "DESC"
}

Example response:

{
  "items": [
    {
      "entity_id": 1001,
      "increment_id": "000000101",
      "state": "processing",
      "status": "processing",
      "store_id": 1,
      "customer_email": "jane@example.com",
      "customer_firstname": "Jane",
      "customer_lastname": "Smith",
      "grand_total": 119.98,
      "subtotal": 109.98,
      "tax_amount": 10.00,
      "shipping_amount": 5.00,
      "total_qty_ordered": 2,
      "base_currency_code": "USD",
      "created_at": "2025-03-28 16:42:00",
      "updated_at": "2025-03-28 17:10:00",
      "items": [
        {
          "item_id": 2001,
          "sku": "WS-001",
          "name": "Blue Cotton Shirt",
          "qty_ordered": 2,
          "price": 29.99,
          "row_total": 59.98
        }
      ],
      "payment": {
        "method": "checkmo",
        "additional_information": []
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      { "filters": [{ "field": "status", "value": "processing", "condition_type": "eq" }] }
    ],
    "page_size": 5,
    "current_page": 1
  },
  "total_count": 23
}

get-order — Get order by ID

number

required

Order entity ID.

Example request:

{
  "id": 1001
}

Example response:

{
  "entity_id": 1001,
  "increment_id": "000000101",
  "state": "processing",
  "status": "processing",
  "store_id": 1,
  "customer_email": "jane@example.com",
  "customer_firstname": "Jane",
  "customer_lastname": "Smith",
  "grand_total": 119.98,
  "subtotal": 109.98,
  "tax_amount": 10.00,
  "shipping_amount": 5.00,
  "total_qty_ordered": 2,
  "base_currency_code": "USD",
  "created_at": "2025-03-28 16:42:00",
  "items": [
    {
      "item_id": 2001,
      "order_id": 1001,
      "sku": "WS-001",
      "name": "Blue Cotton Shirt",
      "qty_ordered": 2,
      "qty_invoiced": 0,
      "qty_shipped": 0,
      "price": 29.99,
      "row_total": 59.98
    }
  ],
  "billing_address": {
    "firstname": "Jane",
    "lastname": "Smith",
    "street": ["123 Main St"],
    "city": "Austin",
    "region_code": "TX",
    "postcode": "73301",
    "country_id": "US",
    "telephone": "5125551234"
  },
  "payment": {
    "method": "checkmo",
    "additional_information": []
  },
  "extension_attributes": {
    "shipping_assignments": [
      {
        "shipping": {
          "address": {
            "firstname": "Jane",
            "lastname": "Smith",
            "street": ["123 Main St"],
            "city": "Austin",
            "region_code": "TX",
            "postcode": "73301",
            "country_id": "US"
          },
          "method": "flatrate_flatrate"
        },
        "items": []
      }
    ]
  },
  "status_histories": [
    {
      "status": "processing",
      "comment": null,
      "created_at": "2025-03-28 16:42:00"
    }
  ]
}

create-invoice — Create invoice

orderId

number

required

The order entity ID to invoice.

capture

boolean

default:"true"

Whether to capture payment.

items

array

Specific items and quantities to invoice. Omit to invoice all items.

notify

boolean

default:"false"

Send invoice email notification to customer.

comment

string

Invoice comment.

Example request:

{
  "orderId": 1001,
  "capture": true,
  "items": [
    { "order_item_id": 2001, "qty": 2 }
  ],
  "notify": true,
  "comment": "Invoice for order #000000101"
}

Example response:

The response is the newly created invoice entity ID.

create-shipment — Create shipment

orderId

number

required

The order entity ID to ship.

items

array

Specific items and quantities to ship. Omit to ship all items.

tracks

array

Tracking information for the shipment.

notify

boolean

default:"false"

Send shipment email notification to customer.

comment

string

Shipment comment.

Example request:

{
  "orderId": 1001,
  "items": [
    { "order_item_id": 2001, "qty": 2 }
  ],
  "tracks": [
    {
      "track_number": "1Z999AA10123456784",
      "title": "UPS",
      "carrier_code": "ups"
    }
  ],
  "notify": true,
  "comment": "Shipped via UPS Ground"
}

Example response:

The response is the newly created shipment entity ID.

Customers, Inventory & Store

list-customers — Search customers

Search customers with filters.

string

Filter by email.

firstname

string

Filter by first name (uses ‘like’ matching).

lastname

string

Filter by last name (uses ‘like’ matching).

groupId

number

Filter by customer group ID.

createdAfter

string

Filter customers created after this date (YYYY-MM-DD HH:MM:SS).

pageSize

number

default:"20"

Results per page.

currentPage

number

default:"1"

Page number.

sortField

string

Field to sort by (e.g., email, firstname, created_at).

sortDir

string

Sort direction: ASC or DESC.

Example request:

{
  "email": "jane@example.com"
}

Example response:

{
  "items": [
    {
      "id": 1,
      "group_id": 1,
      "email": "jane@example.com",
      "firstname": "Jane",
      "lastname": "Smith",
      "store_id": 1,
      "website_id": 1,
      "created_at": "2025-01-10 08:15:00",
      "updated_at": "2025-03-20 11:30:00",
      "addresses": [
        {
          "id": 1,
          "firstname": "Jane",
          "lastname": "Smith",
          "street": ["123 Main St"],
          "city": "Austin",
          "region_id": 57,
          "postcode": "73301",
          "country_id": "US",
          "telephone": "5125551234",
          "default_billing": true,
          "default_shipping": true
        }
      ],
      "extension_attributes": {
        "is_subscribed": false
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      { "filters": [{ "field": "email", "value": "jane@example.com", "condition_type": "eq" }] }
    ],
    "page_size": 20,
    "current_page": 1
  },
  "total_count": 1
}

get-customer — Get customer by ID

number

required

Customer ID.

Example request:

{
  "id": 1
}

Example response:

{
  "id": 1,
  "group_id": 1,
  "email": "jane@example.com",
  "firstname": "Jane",
  "lastname": "Smith",
  "store_id": 1,
  "website_id": 1,
  "created_at": "2025-01-10 08:15:00",
  "updated_at": "2025-03-20 11:30:00",
  "addresses": [
    {
      "id": 1,
      "firstname": "Jane",
      "lastname": "Smith",
      "street": ["123 Main St"],
      "city": "Austin",
      "region_id": 57,
      "postcode": "73301",
      "country_id": "US",
      "telephone": "5125551234",
      "default_billing": true,
      "default_shipping": true
    }
  ],
  "extension_attributes": {
    "is_subscribed": false
  }
}

create-customer — Create customer

customer

object

required

Customer object with email, firstname, lastname, etc.

password

string

Customer password (if omitted, customer must reset password).

Example request:

{
  "customer": {
    "email": "john@example.com",
    "firstname": "John",
    "lastname": "Doe",
    "website_id": 1,
    "group_id": 1
  },
  "password": "SecurePass123!"
}

Example response:

{
  "id": 2,
  "group_id": 1,
  "email": "john@example.com",
  "firstname": "John",
  "lastname": "Doe",
  "store_id": 1,
  "website_id": 1,
  "created_at": "2025-04-01 14:00:00",
  "updated_at": "2025-04-01 14:00:00",
  "addresses": [],
  "extension_attributes": {
    "is_subscribed": false
  }
}

get-source-items — Get inventory source items

Get inventory levels across sources (MSI - Multi Source Inventory).

sku

string

Filter by SKU.

sourceCode

string

Filter by source code (e.g., default).

pageSize

number

default:"20"

Number of items per page.

currentPage

number

default:"1"

Page number.

Example request:

{
  "sku": "WS-001",
  "sourceCode": "default"
}

Example response:

{
  "items": [
    {
      "sku": "WS-001",
      "source_code": "default",
      "quantity": 150,
      "status": 1
    }
  ],
  "search_criteria": {
    "filter_groups": [
      { "filters": [{ "field": "sku", "value": "WS-001", "condition_type": "eq" }] },
      { "filters": [{ "field": "source_code", "value": "default", "condition_type": "eq" }] }
    ],
    "page_size": 20,
    "current_page": 1
  },
  "total_count": 1
}

get-store-config — Get store configuration

No parameters required.Example response:

[
  {
    "id": 1,
    "code": "default",
    "website_id": 1,
    "locale": "en_US",
    "base_currency_code": "USD",
    "default_display_currency_code": "USD",
    "timezone": "America/Chicago",
    "weight_unit": "lbs",
    "base_url": "https://mystore.com/",
    "base_link_url": "https://mystore.com/",
    "base_media_url": "https://mystore.com/media/",
    "secure_base_url": "https://mystore.com/",
    "secure_base_link_url": "https://mystore.com/"
  }
]

Coupons

list-coupons — Search coupon codes

Search and list coupon codes with optional filtering by code or rule ID. Returns paginated results.

code

string

Filter by coupon code (uses ‘like’ matching).

ruleId

number

Filter by cart price rule ID.

pageSize

number

default:"20"

Number of coupons per page.

currentPage

number

default:"1"

Page number.

Example request:

{
  "code": "SUMMER",
  "pageSize": 5
}

Example response:

{
  "items": [
    {
      "coupon_id": 1,
      "rule_id": 5,
      "code": "SUMMER2025",
      "usage_limit": 100,
      "usage_per_customer": 1,
      "times_used": 12,
      "is_primary": true,
      "created_at": "2025-05-01 00:00:00",
      "type": 0
    }
  ],
  "search_criteria": {
    "filter_groups": [
      { "filters": [{ "field": "code", "value": "%SUMMER%", "condition_type": "like" }] }
    ],
    "page_size": 5,
    "current_page": 1
  },
  "total_count": 3
}

Advanced

raw-rest-request — Execute any REST endpoint

Execute any Adobe Commerce REST API endpoint not covered by other tools.See the Adobe Commerce REST API reference for all available endpoints.

method

string

required

HTTP method: GET, POST, PUT, or DELETE.

path

string

required

Path after /rest/{storeCode}/V1/ (e.g., cmsBlock/1 or products/attribute-sets/sets/list).

body

object

Request body (for POST/PUT).

queryParams

string

Query string parameters (without leading ?).

Example request:

{
  "method": "GET",
  "path": "cmsBlock/1"
}

Example response:

{
  "id": 1,
  "identifier": "footer-links",
  "title": "Footer Links",
  "content": "<ul><li><a href=\"/about\">About Us</a></li></ul>",
  "creation_time": "2025-01-01 00:00:00",
  "update_time": "2025-02-15 10:30:00",
  "active": true
}

Documentation Index

​Connection setup

​Tools

​Products

​Orders

​Customers, Inventory & Store

​Coupons

​Advanced

Connection setup

Tools

Products

Orders

Customers, Inventory & Store

Coupons

Advanced