The "active order" is what is also known as the "cart" - it is the order that is currently being worked on by the customer.
An order remains active until it is completed, and during this time it can be modified by the customer in various ways:
This guide will cover how to manage the active order.
Since all the mutations that we will be using in this guide require an Order object, we will define a fragment that we can
reuse in all of our mutations.
The __typename field is used to determine the type of the object returned by the GraphQL server. In this case, it will always be 'Order'.
Some GraphQL clients such as Apollo Client will automatically add the __typename field to all queries and mutations, but if you are using a different client you may need to add it manually.
This fragment can then be used in subsequent queries and mutations by using the ... spread operator in the place where an Order object is expected.
You can then embed the fragment in the query or mutation by using the ${ACTIVE_ORDER_FRAGMENT} syntax:
For the remainder of this guide, we will list just the body of the query or mutation, and assume that the fragment is defined and imported as above.
This fragment can then be used in subsequent queries and mutations. Let's start with a query to get the active order using the activeOrder query:
To add an item to the active order, we use the addItemToOrder mutation, as we have seen in the Product Detail Page guide.
If you have defined any custom fields on the OrderLine entity, you will be able to pass them as a customFields argument to the addItemToOrder mutation.
See the Configurable Products guide for more information.
To remove an item from the active order, we use the removeOrderLine mutation,
and pass the id of the OrderLine to remove.
To change the quantity of an item in the active order, we use the adjustOrderLine mutation.
If you have defined any custom fields on the OrderLine entity, you will be able to update their values by passing a customFields argument to the adjustOrderLine mutation.
See the Configurable Products guide for more information.
If you have defined any Promotions which use coupon codes, you can apply the a coupon code to the active order
using the applyCouponCode mutation.
To remove a coupon code from the active order, we use the removeCouponCode mutation.
Here is a live example which demonstrates adding, updating and removing items from the active order:
Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.
Talk to the team