QuoteGraphQl provides basic types and resolvers for Checkout steps.
All endpoints here should accept the same data as the API does. For an api reference, please follow this link
IMPORTANT NOTE: every following mutation and query work without specifying the
quote_idparam (orquoteId). If none quote id is specified the resolver will attempt to load the quote id from Auth header, where auth token should be present. If quoteId is passed, it will treat it as a guest request, so thequote_idshould be encoded.
IMPORTANT NOTE: this endpoint is an alternative for Magento 2 GraphQL Quote endpoint that is storing
quote_idfor authorized customer on server (using state-full approach).
This endpoint allows to get full cart data (items + totals).
query GetCartForCustomer ($_guestCartId_0: String) {
getCartForCustomer(guestCartId: $_guestCartId_0) {
id
tax_amount
subtotal
discount_amount
subtotal_with_discount
grand_total
items {
item_id
qty
product {
price {
maximalPrice {
amount {
value
currency
}
adjustments {
code
amount {
value
currency
}
}
}
}
}
}
}
}{
"_guestCartId_0":"xIXmScRLWb5ntIEsYe2ymzrVXYraivGx"
}type cartItem now implements sub-type of CartItemId, that allows to reference by one of many:
item_id or product SKU. This will become non-nullable in the future releases, when "sku" and "item_id" will be dropped.
This endpoint allows to submit items to cart following the default API payload schema. In beneath example is a simple product option addition to cart.
mutation SaveCartItem ($_cartItem_0: CartItemInput!, $_guestCartId_0: String) {
saveCartItem(cartItem: $_cartItem_0, guestCartId: $_guestCartId_0) {
getCartForCustomer(guestCartId: $_guestCartId_0) {
id
tax_amount
subtotal
discount_amount
subtotal_with_discount
grand_total
items {
item_id
qty
product {
price {
maximalPrice {
amount {
value
currency
}
adjustments {
code
amount {
value
currency
}
}
}
}
}
}
}
}
}{
"_cartItem_0":{
"sku":"Test simple product",
"product_type":"simple",
"qty":1,
"product_option": {
"extension_attributes":{}
}
},
"_guestCartId_0":"xIXmScRLWb5ntIEsYe2ymzrVXYraivGx"
}mutation RemoveCartItem($item_id: Int!, $_guestCartId_0: String) {
removeCartItem(item_id: $item_id, guestCartId: $_guestCartId_0) {
getCartForCustomer(guestCartId: $_guestCartId_0) {
id
tax_amount
subtotal
discount_amount
subtotal_with_discount
grand_total
items {
item_id
qty
product {
price {
maximalPrice {
amount {
value
currency
}
adjustments {
code
amount {
value
currency
}
}
}
}
}
}
}
}
}{
"item_id": 1,
"quoteId": "s44Xcnya8dmbysAeNTOozFsZCh8tyCH9"
}mutation EstimateShippingCosts(
$guestCartId: String!
$address: EstimateShippingCostsAddress!
) {
estimateShippingCosts(address: $address, guestCartId: $guestCartId) {
carrier_code
method_code
carrier_title
method_title
error_message
amount
base_amount
price_excl_tax
price_incl_tax
available
}
}{
"guestCartId": "s44Xcnya8dmbysAeNTOozFsZCh8tyCH9",
"address": {
"region": "New York",
"region_id": 43,
"region_code": "NY",
"country_id": "US",
"street": [
"123 Oak Ave"
],
"postcode": "10577",
"city": "Purchase",
"firstname": "Jane",
"lastname": "Doe",
"customer_id": 4,
"email": "[email protected]",
"telephone": "(512) 555-1111",
"same_as_billing": 1
}
}mutation SaveAddressInformation(
$addressInformation: SaveAddressInformation!
$guestCartId: String
) {
saveAddressInformation(
addressInformation: $addressInformation,
guestCartId: $guestCartId
) {
payment_methods {
code
title
}
totals {
grand_total
items {
name
qty
}
}
}
}{
"guestCartId": "s44Xcnya8dmbysAeNTOozFsZCh8tyCH9",
"addressInformation":{
"shipping_address":{
"region":"New York",
"region_id":43,
"region_code":"NY",
"country_id":"US",
"street":[
"123 Oak Ave"
],
"postcode":"10577",
"city":"Purchase",
"firstname":"Jane",
"lastname":"Doe",
"email":"[email protected]",
"telephone":"512-555-1111"
},
"billing_address":{
"region":"New York",
"region_id":43,
"region_code":"NY",
"country_id":"US",
"street":[
"123 Oak Ave"
],
"postcode":"10577",
"city":"Purchase",
"firstname":"Jane",
"lastname":"Doe",
"email":"[email protected]",
"telephone":"512-555-1111"
},
"shipping_carrier_code":"flatrate",
"shipping_method_code":"flatrate"
}
}mutation SavePaymentInformationAndPlaceOrder(
$paymentInformation: PaymentInformation!,
$guestCartId: String,
) {
savePaymentInformationAndPlaceOrder(
paymentInformation: $paymentInformation,
guestCartId: $guestCartId
) {
orderID
}
}{
"guestCartId": "s44Xcnya8dmbysAeNTOozFsZCh8tyCH9",
"paymentInformation": {
"paymentMethod": {
"method": "checkmo"
},
"billing_address":{
"region":"New York",
"region_id":43,
"region_code":"NY",
"country_id":"US",
"street":[
"123 Oak Ave"
],
"postcode":"10577",
"city":"Purchase",
"firstname":"Jane",
"lastname":"Doe",
"email":"[email protected]",
"telephone":"512-555-1111"
}
}
}