| layout | group | title | menu_title | return_to | menu_order | level3_subgroup | redirect_from | functional_areas | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
tutorial |
rest-api |
Order processing tutorial |
Initial tasks |
|
0 |
order-tutorial |
|
|
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.
{:.tutorial-before}
Complete the following prerequisites:
- Install a Magento 2.1.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.
-
Know how to construct a REST call in Magento. See [Construct a request]({{ page.baseurl }}/get-started/gs-web-api-request.html) for details.
-
Find the Magento REST API documentation. You can view the [static REST API documentation on devdocs]({{ site.baseurl }}/swagger/){:target="_blank"} or [generate a local API reference]({{ page.baseurl }}/rest/generate-local.html).
-
Find the Magento Merchant documentation. Refer to Getting Started with {{site.data.var.ce}} 2.1 for information about the Luma store that is created when you install Magento with the sample data.
- [REST Tutorials]({{ page.baseurl }}/rest/tutorials/index.html) provides additional information about completing any Magento REST tutorial.