Magento – Magento rest API For Order

I have used a fresh installation for the following using Magento2 CE 2.2.0-dev, and left the default "Luma" theme as well.

Concerning external payment methods (gateways) such as MiGS, Braintree, PayPal, and others, Magento supports these gateways out of the box but provides NO APIs for them that you can use along with other "Checkout" APIs.

So, if you are planning to build a checkout app/page using Magento's APIs, you will need to manually integrate with these services using their SDK/API, fortunately, you can learn a lot by checking how Magento integrates with these services in the built-in integrations.

To understand this, i had to configure Braintree since it is the easiest:

1. Create sandbox account at https://www.braintreepayments.com/sandbox
2. Access Magento Admin Area.
3. Stores > Configuration > Sales > Payment Methods > Braintree > Configure.
4. Make sure "Environment" is "Sandbox", and enter "Merchant ID", "Public Key", and "Private Key".
5. Save Config.
6. You may need to reindex and/or refresh cache.

Upon adding a product to the cart and proceeding to checkout, in the last step, choose the Braintree payment method, then after clicking the "Place Order" button, you will notice the following AJAX requests:

1. 2 requests to Braintree API to validate the card, perform the transaction, and responds with transaction status.
2. A request to Magento's API guest-carts/cartId/payment-information with the usual body as explained in Magento's API documentation.

After that the process continues as expected with redirection to success page when the last request responds in JSON containing the order entity_id

This confirms that calls to external services -Braintree in our example- is performed by the checkout page NOT by Magento internally, so we will need to do the same if we are to develop our own checkout page/app.

As for controlling the order status, i dug deeper and found out that using payment methods like MiGS, Braintree, or PayPal, resulted in an order with status processing instead of the usual pending, i suspected that this is either a payment-method configuration or an observer, but it appeared to be a configuration, here are more details.

Class: Magento\Sales\Model\Order\Payment

Method: Place()

There is a conditional that checks if Initialization is required for the method if ($methodInstance->isInitializeNeeded()), if that's the case, a method initialize() is executed which you define, and allows you to specify both state and status.

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"
    }
}'