This tutorial shows a system integrator how REST APIs are used in the lifecycle of an order, including configuring a store and creating a customer; creating quotes, orders, invoices, and shipments; preparing for checkout; and more order-related tasks.
The 10-step tutorial generally takes 30 minutes.
Before you begin
Complete the following prerequisites:
- 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.
Install a REST client. You can use any REST client to send calls to Magento. Postman is recommended.
Set up two-factor authentication. This tutorial assumes Google Authenticator is your 2FA solution.
Know how to construct a REST call in Magento. See Construct a request for details.
Find the Magento Merchant documentation. Refer to Getting Started with Magento Open Source 2.1 for information about the Luma store that is created when you install Magento with the sample data.
- REST Tutorials provides additional information about completing any Magento REST tutorial.