Magento e-commerce Platform

Magento is an open source e-commerce platform built with PHP. It offers a flexible shopping cart system and gives merchants full control over their store's design, structure and features. Magento includes tools for marketing, SEO, and catalog management, and is built on 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 ID

  • updateProduct: Updates a product specified by ID

  • getListOfProducts: Retrieves list of products

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

  • updateStockItems: Updates stock items specified by 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 ID

  • getCustomerById: Retrieves information of the customer who is specified by ID

  • updateCustomerAddress: Updates the specified customer's address

  • getCommentsByOrderId: Retrieves comments for the specified order

  • updateStockItemById: Updates a stock item specified by 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 who is specified by ID

  • getBillingAddressByOrderId: Retrieves billing address information of the specified order

  • getCustomerAddressByAddressId: Retrieves a customer address that is specified by 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 who is specified by ID

  • getAttributeMetadata: Retrieves all attribute metadata

  • getCustomerBillingAddress: Retrieves the default billing address for the specified customerId

  • queryProducts: Retrieves list of products

  • createCategory: Creates a category service

  • queryCustomerGroups: Retrieves customer groups

  • getCustomerAddressById: Retrieves a customer address that is specified by 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 an attribute data

  • queryCategories: Retrieves category list

  • createCustomerGroup: Creates a customer group

  • getCustomerShippingAddress: Retrieves the default shipping address for the specified 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

You can also create your own custom actions for performing specific tasks. The actions that you create look and work exactly like the other predefined actions do.

Learn more about how to create custom actions.