orderClose
mutation

Choose a version:

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

Closes an open order.

Anchor to section titled 'Arguments'

Arguments

Anchor to input input OrderCloseInput! required: The input for the mutation.

Was this section helpful?

Anchor to section titled 'OrderClosePayload returns'

OrderClosePayload returns

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

Was this section helpful?

Code examples for MUTATION: orderClose

Query Reference for MUTATION: orderClose

"mutation orderClose($input: OrderCloseInput!) {\n  orderClose(input: $input) {\n    order {\n      # Order fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: orderClose

"{\n  \"input\": {\n    \"id\": \"gid://shopify/<objectName>/10079785100\"\n  }\n}"

Schema Reference for MUTATION: orderClose

"input OrderCloseInput {\n  id: ID!\n}\n"

Display Examples for MUTATION: orderClose

[]

orderClosemutation

Arguments

OrderClosePayload returns

orderClose
mutation