This is a beta release of documentation for Magento 2.4, published for previewing soon-to-be-released functionality. Content in this version is subject to change. Links to the v2.4 code base may not properly resolve until the code is officially released.

Use REST APIs

Edit on GitHub
Log an Issue

The Magento REST API defines a set of functions that a developer can use to perform requests and receive responses. These interactions are performed using the HTTP protocol.

The caller issues an HTTP request, which contains the following elements:

  • An HTTP header that provides authentication and other instructions
  • A verb, which can be one of GET, POST, PUT, or DELETE.
  • An endpoint, which is a Uniform Resource Indicator (URI) that identifies the server, the web service, and the resource being acted on.
  • The call payload, which is set of input parameters and attributes that you supply with the request.

Magento returns a response payload as well as an HTTP status code.

This guide introduces web API, REST, and cURL command concepts. It shows you how to authenticate and construct and run REST web API calls. You run REST web API calls through cURL commands or a REST client.

Read the following sections to get up and running with the Magento web APIs:

© 2020 Magento. All rights reserved.