orderClose

mutation

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

Closes an open order.

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?

Close an order
orderClose reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation OrderClose($input: OrderCloseInput!) {
6    orderClose(input: $input) {
7      order {
8        canMarkAsPaid
9        cancelReason
10        cancelledAt
11        clientIp
12        confirmed
13        customer {
14          displayName
15          email
16        }
17        discountCodes
18      }
19      userErrors {
20        field
21        message
22      }
23    }
24  }`,
25  {
26    variables: {
27      "input": {
28        "id": "gid://shopify/Order/148977776"
29      }
30    },
31  },
32);
33
34const data = await response.json();
35

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-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"
    }
  }
}'

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 data = await response.json();

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"
      }
    },
  },
});

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

1{
2  "input": {
3    "id": "gid://shopify/Order/148977776"
4  }
5}

Response

JSON

1{
2  "orderClose": {
3    "order": {
4      "canMarkAsPaid": false,
5      "cancelReason": null,
6      "cancelledAt": null,
7      "clientIp": "216.191.105.144",
8      "confirmed": true,
9      "customer": {
10        "displayName": "Bob Bobsen",
11        "email": "bob@example.com"
12      },
13      "discountCodes": []
14    },
15    "userErrors": []
16  }
17}