How to create order using REST API?

Question

I need to use the Magento REST API to create an order from a mobile client. In my case, the mobile side will implement the payment directly using PayPal SDK. What I need to do is to create an order by setting the payment method to a money order and performing a guest checkout. Which API(s) should I use to achieve this?

Answer 1

I finally figured it out. Here is what I'm doing.

Get a single product

curl -g -X GET "$base_url/index.php/rest/V1/products/24-MB05/" \
-H "Authorization: Bearer $token" 

Create cart

curl -g -X POST "$base_url/index.php/rest/V1/guest-carts/" \
-H "Authorization: Bearer $token" 

Get Cart

curl -g -X GET "$base_url/index.php/rest/V1/guest-carts/56241bf6bc084cd7589426c8754fc9c5" \
-H "Authorization: Bearer $token" 

Add Product To Cart

curl -g -X POST "$base_url/index.php/rest/V1/guest-carts/56241bf6bc084cd7589426c8754fc9c5/items" \
-H "Authorization: Bearer $token" \
-H "Content-Type:application/json" \
 -d '{ "cartItem": { "quote_id": "56241bf6bc084cd7589426c8754fc9c5", "sku": "24-MB05", "qty": 1 } }'

Add shipping information

curl -g -X POST "$base_url/index.php/rest/V1/guest-carts/56241bf6bc084cd7589426c8754fc9c5/shipping-information" \
    -H "Authorization: Bearer $token" \
    -H "Content-Type:application/json" \
     -d '
{
    "addressInformation": {
        "shippingAddress": {
            "region": "MH",
            "region_id": 0,
            "country_id": "IN",
            "street": [
                "Chakala,Kalyan (e)"
            ],
            "company": "abc",
            "telephone": "1111111",
            "postcode": "12223",
            "city": "Mumbai",
            "firstname": "Sameer",
            "lastname": "Sawant",
            "email": "abc@abc.com",
            "prefix": "address_",
            "region_code": "MH",
            "sameAsBilling": 1
        },
        "billingAddress": {
            "region": "MH",
            "region_id": 0,
            "country_id": "IN",
            "street": [
                "Chakala,Kalyan (e)"
            ],
            "company": "abc",
            "telephone": "1111111",
            "postcode": "12223",
            "city": "Mumbai",
            "firstname": "Sameer",
            "lastname": "Sawant",
            "email": "abc@abc.com",
            "prefix": "address_",
            "region_code": "MH"
        },
        "shipping_method_code": "flatrate",
        "shipping_carrier_code": "flatrate"
    }
}
 '

Get Payment Method

curl -g -X GET "$base_url/index.php/rest/V1/guest-carts/56241bf6bc084cd7589426c8754fc9c5/payment-information" \
    -H "Authorization: Bearer $token" 

Place Order

curl -g -X PUT "$base_url/index.php/rest/V1/guest-carts/56241bf6bc084cd7589426c8754fc9c5/order" \
    -H "Authorization: Bearer $token" \
    -H "Content-Type:application/json" \
     -d '
{
    "paymentMethod": {
        "method": "checkmo"
    }
}'                      

Answer 2

I think there is a little mistake: For placing order, on the body, it has to be paymentMethod the first key, like this:

{
    "paymentMethod": { 
        "method": "checkmo" 
    }
}

Answer 3

1. create empty cart url : http://www.[yoursite].com/rest/V1/carts/mine call: post response: cartID eg: 4290

2. Add item to the cart url : http://www.[yoursite].com/rest/V1/carts/mine/items body:

   {"cartItem":{
       "sku":"JFCO00017",
       "qty":1,
       "name":"Devil May Cry III 3 Dante",
       "price":81.55,
       "product_type":"simple",
       "quote_id":"4290",
       "product_option":
           {"extension_attributes":
              {
                "custom_options":[
                 {"option_id":"thumbnail",
            "option_value":"\/d\/e\/devilmaycryiii3dantecosplay_1_.jpg"
              },
              {
                "option_id":"color_2",
                "option_value":"Red"
              },
              {
               "option_id":"google_size",
               "option_value":"xxs"}]
          }
       }
     }
   }
   

3. Add billling info url : http://www.[yoursite].com/rest/V1/carts/mine/billing-address body:

   {
   "address": {
   "city": "Springfield",
   "company": "iprag",
   "countryId": "IN",
   "email": "customer_email@domain.com",
   "firstname": "Jane",
   "lastname": "Doe",
   "postcode": "90210",
   "region": "UP",
   "saveInAddressBook": 1,
   "street": ["Street"],
   "telephone": "5551234"
   },
   "useForShipping": true
   }
   

4. get shipping-methods url : http://www.[yoursite].com/rest/V1/carts/mine/shipping-methods

   {
   "carrier_code": "flatrate",
   "method_code": "flatrate",
   "carrier_title": "Flat Rate",
   "method_title": "Fixed",
   "amount": 10,
   "base_amount": 10,
   "available": true,
   "error_message": "",
   "price_excl_tax": 10,
   "price_incl_tax": 10
   

   }

5. add shipping info url : http://www.[yoursite].com/rest/V1/carts/mine/shipping-information body:

   {
    "addressInformation": {
    "billingAddress": {
       "city": "Springfield",
       "company": "iprag",
       "email": "customer_email@domain.com",
       "firstname": "Jane",
       "lastname": "Doe",
       "postcode": "335001",
       "region": "UP",
       "street": ["Street"],
       "telephone": "5551234"
   },
   "shippingAddress": {
       "city": "Springfield",
       "company": "iprag",
       "email": "customer_email@domain.com",
       "firstname": "Jane",
       "lastname": "Doe",
       "postcode": "335001",
       "region": "UP",
       "street": ["Street"],
       "telephone": "5551234"
     },
     "shippingCarrierCode": "flatrate",
     "shippingMethodCode": "flatrate"
   }
   }
   

response: payment method and cart detail

5. Order place URL : http://www.[yoursite].com/rest/V1/carts/mine/order body :

   {
    "paymentMethod":{"method":"checkmo"},
    "shippingMethod":
       {
         "method_code":"flatrate",
   
         "carrier_code":"flatrate",
         "additionalProperties":{}
   
       }
   
   }
   

response: orderid

Answer 4

There is an official tutorial showing how to make an order through REST API:
Order processing tutorial for Magento 2.2

They included very detailed steps:

1. Configure the store
2. Get the admin token
3. Create a customer
4. Create a quote
5. Add items to the cart
6. Prepare for checkout
7. Create an order
8. Create an invoice
9. Create a shipment
10. Issue a partial refund

The tutorial included how to add different kinds of products, different shipping method and many other useful information with sample codes.