setPaymentMethodAndPlaceOrder mutation

The setPaymentMethodAndPlaceOrder mutation has been deprecated. Use the setPaymentMethodOnCart and placeOrder mutations instead. You can run the two methods in the same call if your use case allows it.

The setPaymentMethodAndPlaceOrder mutation sets the cart payment method and converts the cart into an order. The mutation returns the resulting order ID. You cannot manage orders with GraphQL, because orders are part of the backend. You can use REST or SOAP calls to manage orders to their completion.

Perform the following actions before using the setPaymentMethodAndPlaceOrder mutation:

• Create an empty cart
• Add one or more products to the cart
• Set the billing address
• Set the shipping address (non-virtual carts only)
• Set the shipping method (non-virtual carts only)
• For guest customers, assign an email to the cart

Syntax

1
2
3
4
5
6
7
mutation {
  setPaymentMethodAndPlaceOrder(
    input: SetPaymentMethodAndPlaceOrderInput
  ) {
    PlaceOrderOutput
  }
}

Example usage

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
mutation {
  setPaymentMethodAndPlaceOrder(
    input: {
      cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG"
      payment_method: {
        code: "checkmo"
      }
    }
  ) {
    order {
      order_id
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
{
  "data": {
    "setPaymentMethodAndPlaceOrder": {
      "order": {
        "order_id": "000000006"
      }
    }
  }
}

Input attributes

The placeOrderInput object must contain the following attribute:

PaymentMethodInput attributes

Output attributes

The placeOrderOutput object contains the order object, which contains the following attribute:

Errors