placeOrder mutation

The placeOrder mutation converts the cart into an order and returns an 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 placeOrder mutation:

• Create an empty cart
• Add one or more products to the cart
• Set the billing address
• Set the shipping address
• Set the shipping method
• Set the payment method
• For guest customers, assign an email to the cart

As of Commerce 2.4.7, the PlaceOrderOutput object can contain orderV2, which provides full details about the order. When the mutation runs, Commerce generates and returns a token in the orderV2.token field. You can supply the token value to the guestOrderByToken query to retrieve details about an order created by a guest shopper.

Syntax

Copy
mutation {
  placeOrder(
    input: PlaceOrderInput
  ) {
    PlaceOrderOutput
  }
}
Copied to your clipboard
mutation {
  placeOrder(
    input: PlaceOrderInput
  ) {
    PlaceOrderOutput
  }
}

Reference

The placeOrder reference provides detailed information about the types and fields defined in this mutation.

Example usage

Request:

Copy
mutation {
  placeOrder(
    input: {
      cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG"
    }
  ) {
    orderV2 {
      number
      token
    }
    errors {
      message
      code
    }
  }
}
Copied to your clipboard
mutation {
  placeOrder(
    input: {
      cart_id: "IeTUiU0oCXjm0uRqGCOuhQ2AuQatogjG"
    }
  ) {
    orderV2 {
      number
      token
    }
    errors {
      message
      code
    }
  }
}

Response:

Copy
{
  "data": {
    "placeOrder": {
      "orderV2": {
        "number": "000000006",
        "token": "0:3:OSScWU6PKLn3kFyMhNWyskG0opgVvFBnJmtuaFHKGwDFT83S6Kv9U39iYwixuU+vhwDz2AF4pCs3GtLhHbQ="
      },
      "errors": []
    }
  }
}
Copied to your clipboard
{
  "data": {
    "placeOrder": {
      "orderV2": {
        "number": "000000006",
        "token": "0:3:OSScWU6PKLn3kFyMhNWyskG0opgVvFBnJmtuaFHKGwDFT83S6Kv9U39iYwixuU+vhwDz2AF4pCs3GtLhHbQ="
      },
      "errors": []
    }
  }
}

Errors

Last updated 4/2/2024

Was this helpful?

Yes

No