Edit in GitHubLog an issue

Tutorials

The REST tutorials provide an introduction to Adobe Commerce 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 an Commerce 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.

  • Install a REST client. You can use any REST client to send calls to Commerce. Postman is recommended.

  • Know how to construct a REST call in Commerce. See Construct a request for details.

  • Find the Commerce REST API documentation. You can view the static REST API documentation on devdocs or generate a local API reference.

  • Find the Commerce Merchant documentation. Refer to Getting Started with Magento Open Source for information about the Luma store that is created when you install Commerce with the sample data.

Performing steps#

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

Endpoint:

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

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

where:

ElementDescription
HTTP verbOne of GET, POST, PUT, or DELETE
hostThe hostname or IP address (and optionally, port) of the Commerce installation.
scopeSpecifies which store the call affects. In this tutorial, this value is default.
endpointThe full URI (Uniform Resource Identifier) to the endpoint. These values always start with /V1. For example, /V1/orders/4.

Scope:

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.

Payload:

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

Response:

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

  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.