Magento eCommerce Platform

Magento is an open source PHP-based ecommerce platform that provides online merchants with a flexible shopping cart system as well as complete control over their online store's appearance, structure, and functionality. Magento offers powerful marketing tools, search engine optimization features, and catalog management tools. The software was created using the Zend Framework.

API Versions: v1.9, v2.3, v2.4

API Types: REST

Authentication and Authorization: OAuth v1

Key Capabilities: $filter, Custom Fields Support, Batch

Prerequisites

  • Magento API login and password information
  • You are familiar with Magento objects and the Magento APIs
  • If you use the Bulk API, verify that you have enabled the Bulk API feature in your organization

Triggers

  • New Customer: Triggers when a new customer account is created

  • New Product: Triggers when a new product is created

  • Customer Updated: Triggers when an existing customer account is updated

  • Product Updated: Triggers when an existing product is updated

  • New Order: Triggers when a new order is created

  • New Order Credit Memo: Triggers when a credit memo for an order is created

  • New Order Invoice: Triggers when an invoice for an order is created

  • New Order Shipment: Triggers when a shipment of an order is created

  • Shipment Updated: Triggers when an existing shipment is updated

  • Order Status Updated: Triggers when a status of an existing order is updated

Actions

  • getOrderById: Retrieves information about an order specified by the id

  • updateProduct: Updates a product specified by the id

  • getListOfProducts: Retrieves list of products

  • getOrderItemsByOrderId: Retrieves a list of order items with detailed information

  • updateStockItems: Updates stock items specified by the idsupdateProductInStore

  • updateProductInStore: Updates a product of the specified store

  • getAddressesByOrderId: Retrieves information about the billing and shipping addresses of the specified order

  • getProductById: Retrieves the product specified by the id

  • getCustomerById: Retrieves information of the customer specified by the id

  • updateCustomerAddress: Updates the specified customer's address

  • getCommentsByOrderId: Retrieves comments for the specified order

  • updateStockItemById: Updates a stock item specified by the id

  • getListOfCustomers: Retrieves a list of customers. Only admin can retrieve the list of customers with all their attributes.

  • deleteProduct: Deletes the specified product

  • getStockItemById: Retrieves information about a stock item. The list of attributes that will be returned for stock items is configured in the admin panel.

  • createCustomer: Creates a customer

  • assignCategoryToProduct: Assign a category to the specified product

  • createProduct: Creates a product

  • getShippingAddressByOrderId: Retrieves shipping address of the specified order

  • removeCategoryFromProduct: Removes a category from the specified product

  • deleteCustomer: Deletes a customer specified by the id

  • getBillingAddressByOrderId: Retrieves billing address information of the specified order

  • getCustomerAddressByAddressId: Retrieves a customer address specified by the id

  • updateCustomer: Updates the details of the specified customer

  • getCategoryIdsOfProduct: Retrieves the category ids assigned to the specified product

  • getCustomerAddresses: Retrieves a list of addresses of the specified customer

  • createCustomerAddress: Creates an address for the specified customer

  • getStockItems: Retrieves a list of stock items. The list of attributes that will be returned for the stock items is configured in the admin panel.

  • getListOfOrders: Retrieves a list of orders

  • queryCustomers: Retrieves customers which match a specified criteria

  • updateProduct: Updates a product

  • updateCategory: Updates a category

  • getDefaultCustomerGroup: Retrieves default customer group

  • getCustomerById: Retrieves information of the customer specified by the id

  • getAttributeMetadata: Retrieves all attribute metadata

  • getCustomerBillingAddress: Retrieves default billing address for the given customerId

  • queryProducts: Retrieves list of products

  • createCategory: Creates a category service

  • queryCustomerGroups: Retrieves customer groups

  • getCustomerAddressById: Retrieves a customer address specified by the id

  • queryAttributes: Retrieve all attributes for entity type

  • createCustomer: Creates a customer

  • getMediaAttributes: Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set

  • createProduct: Creates a product

  • getAttributeOptions: Retrieves list of attribute options

  • updateAttributeSet: Updates attribute set data

  • getAttributeByAttributeCode: Retrieves a specific attribute

  • updateAttribute: Updates a attribute data

  • queryCategories: Retrieves category list

  • createCustomerGroup: Creates a customer group

  • getCustomerShippingAddress: Retrieves default shipping address for the given customerId

  • getCategoryById: Retrives information about category by category id

  • queryCategoryAttributes: Retrieves all attributes for entity type

  • queryAttributeSetsGroups: Retrieves list of attribute groups

  • updateCustomer: Updates the details of the specified customer

  • queryAttributeSets: Retrieves list of Attribute Sets

  • getCustomerGroupById: Retrieves customer group by group ID

  • getAttributeSetById: Retrieves attribute set information based on given ID

  • updateCustomerGroup: Updates a customer group by Id

Custom Actions

Magento connector also lets you create your own custom actions for performing specific tasks. The actions you create look and work exactly like the other predefined actions do.

Learn more about how to create custom actions.