REST tutorials

The REST tutorials provide an introduction to Magento web APIs. In general, the tutorials guide you through commonly-performed complex tasks:

Complete these prerequisites

Before you begin any tutorial, make sure you know the basics about Magento Open Source

  • Install a Magento 2.3 (or later) instance with sample data.

The sample data defines a functional store, called Luma, that sells fitness clothing and accessories. The store does not provide any sandbox accounts for testing credit card payments, so transactions will be simulated using an offline payment method.

Performing steps

Although some steps require that you configure Magento in some way, you perform most steps by sending one or more REST calls to Magento. Each step that makes a REST call provides the following information:


This section lists the HTTP verb and full path to the endpoint. The basic structure of a REST call in Magento is

<HTTP verb> http://<host>/rest/<scope>/<endpoint>


Element Description
HTTP verb One of GET, POST, PUT, or DELETE
host The hostname or IP address (and optionally, port) of the Magento installation.
scope Specifies which store the call affects. In this tutorial, this value is default.
endpoint The full URI (Uniform Resource Identifier) to the endpoint. These values always start with /V1. For example, /V1/orders/4.


The Scope: section is included when the tutorial requires that you send requests to different stores.

HTTP headers:

This section indicates which key/value pairs you must specify in the HTTP headers. All calls require one or more HTTP headers.


This section lists the information that is sent to Magento. All payload samples are valid and can be copied and pasted into your calls, but you might need to change the id values that Magento returns.


This section lists the information that Magento sends to the REST client. These values are often referenced in other steps in the tutorial. The values Magento returns might be different than the values listed in the examples provided in this tutorial.