Choose a version:

orderClose

mutation

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

Marks an open Order as closed. A closed order is one where merchants fulfill or cancel all LineItem objects and complete all financial transactions.

Once closed, the order indicates that no further work is required. The order's closedAt timestamp is set when this mutation completes successfully.

Anchor to Arguments

Arguments

Anchor to inputinput

•OrderCloseInput!

required

The input for the mutation.

Was this section helpful?

Anchor to OrderClosePayload returnsOrderClosePayload returns

Anchor to orderorder •Order: The closed order.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Close an order

Query

mutation OrderClose($input: OrderCloseInput!) {
  orderClose(input: $input) {
    order {
      canMarkAsPaid
      cancelReason
      cancelledAt
      clientIp
      confirmed
      customer {
        displayName
        email
      }
      discountCodes
    }
    userErrors {
      field
      message
    }
  }
}

Variables

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation OrderClose($input: OrderCloseInput!) { orderClose(input: $input) { order { canMarkAsPaid cancelReason cancelledAt clientIp confirmed customer { displayName email } discountCodes } userErrors { field message } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/Order/148977776"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation OrderClose($input: OrderCloseInput!) {
    orderClose(input: $input) {
      order {
        canMarkAsPaid
        cancelReason
        cancelledAt
        clientIp
        confirmed
        customer {
          displayName
          email
        }
        discountCodes
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "id": "gid://shopify/Order/148977776"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation OrderClose($input: OrderCloseInput!) {
    orderClose(input: $input) {
      order {
        canMarkAsPaid
        cancelReason
        cancelledAt
        clientIp
        confirmed
        customer {
          displayName
          email
        }
        discountCodes
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

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

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation OrderClose($input: OrderCloseInput!) {
      orderClose(input: $input) {
        order {
          canMarkAsPaid
          cancelReason
          cancelledAt
          clientIp
          confirmed
          customer {
            displayName
            email
          }
          discountCodes
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "id": "gid://shopify/Order/148977776"
        }
    },
  },
});

Response

{
  "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": []
  }
}

orderClose reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation OrderClose($input: OrderCloseInput!) {

orderClose(input: $input) {

order {

canMarkAsPaid

cancelReason

cancelledAt

clientIp

confirmed

customer {

displayName

}

discountCodes

}

userErrors {

field

message

}

}`,

{

variables: {

"input": {

"id": "gid://shopify/Order/148977776"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation OrderClose($input: OrderCloseInput!) {
  orderClose(input: $input) {
    order {
      canMarkAsPaid
      cancelReason
      cancelledAt
      clientIp
      confirmed
      customer {
        displayName
        email
      }
      discountCodes
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation OrderClose($input: OrderCloseInput!) { orderClose(input: $input) { order { canMarkAsPaid cancelReason cancelledAt clientIp confirmed customer { displayName email } discountCodes } userErrors { field message } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/Order/148977776"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation OrderClose($input: OrderCloseInput!) {
    orderClose(input: $input) {
      order {
        canMarkAsPaid
        cancelReason
        cancelledAt
        clientIp
        confirmed
        customer {
          displayName
          email
        }
        discountCodes
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "id": "gid://shopify/Order/148977776"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation OrderClose($input: OrderCloseInput!) {
      orderClose(input: $input) {
        order {
          canMarkAsPaid
          cancelReason
          cancelledAt
          clientIp
          confirmed
          customer {
            displayName
            email
          }
          discountCodes
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "id": "gid://shopify/Order/148977776"
        }
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation OrderClose($input: OrderCloseInput!) {
    orderClose(input: $input) {
      order {
        canMarkAsPaid
        cancelReason
        cancelledAt
        clientIp
        confirmed
        customer {
          displayName
          email
        }
        discountCodes
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

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

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"input": {

"id": "gid://shopify/Order/148977776"

}

Response

JSON

{

"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": []

}