orderClose - admin-graphql - MUTATION

Version: 2024-04

Description:

Closes an open order.

Access Scopes

`write_orders` access scope. Also: User needs manage_orders_information permission.

Arguments

• input: OrderCloseInput! - The input for the mutation.

Returns

• order: Order The closed order.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Close an order

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation OrderClose($input: OrderCloseInput!) { orderClose(input: $input) { order { canMarkAsPaid cancelReason cancelledAt clientIp confirmed customer { displayName email } discountCodes } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"id\": \"gid://shopify/Order/148977776\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation OrderClose($input: OrderCloseInput!) {\n      orderClose(input: $input) {\n        order {\n          canMarkAsPaid\n          cancelReason\n          cancelledAt\n          clientIp\n          confirmed\n          customer {\n            displayName\n            email\n          }\n          discountCodes\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"id\": \"gid://shopify/Order/148977776\"\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation OrderClose($input: OrderCloseInput!) {\n    orderClose(input: $input) {\n      order {\n        canMarkAsPaid\n        cancelReason\n        cancelledAt\n        clientIp\n        confirmed\n        customer {\n          displayName\n          email\n        }\n        discountCodes\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"id\": \"gid://shopify/Order/148977776\"\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation OrderClose($input: OrderCloseInput!) {\n    orderClose(input: $input) {\n      order {\n        canMarkAsPaid\n        cancelReason\n        cancelledAt\n        clientIp\n        confirmed\n        customer {\n          displayName\n          email\n        }\n        discountCodes\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"id\" => \"gid://shopify/Order/148977776\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation OrderClose($input: OrderCloseInput!) {\n    orderClose(input: $input) {\n      order {\n        canMarkAsPaid\n        cancelReason\n        cancelledAt\n        clientIp\n        confirmed\n        customer {\n          displayName\n          email\n        }\n        discountCodes\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"id\": \"gid://shopify/Order/148977776\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation OrderClose($input: OrderCloseInput!) {\n  orderClose(input: $input) {\n    order {\n      canMarkAsPaid\n      cancelReason\n      cancelledAt\n      clientIp\n      confirmed\n      customer {\n        displayName\n        email\n      }\n      discountCodes\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "input": {
      "id": "gid://shopify/Order/148977776"
    }
  }

  response: {
    "data": {
      "orderClose": {
        "order": {
          "canMarkAsPaid": false,
          "cancelReason": null,
          "cancelledAt": null,
          "clientIp": "216.191.105.144",
          "confirmed": true,
          "customer": {
            "displayName": "Bob Bobsen",
            "email": "bob@example.com"
          },
          "discountCodes": []
        },
        "userErrors": []
      }
    }
  }