Anchor to section titled 'undefined'

orderMarkAsPaid
mutation

Requires write_orders access scope. Also: The user must have mark_orders_as_paid permission.

Marks an order as paid. You can only mark an order as paid if it isn't already fully paid.

Anchor to section titled 'Arguments'

Arguments

Anchor to input
input
OrderMarkAsPaidInput!
required

The input for the mutation.

Was this section helpful?
Anchor to section titled 'OrderMarkAsPaidPayload returns'

OrderMarkAsPaidPayload returns

Anchor to OrderMarkAsPaidPayload.order
order
Order

The order marked as paid.

Anchor to OrderMarkAsPaidPayload.userErrors
userErrors
[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation orderMarkAsPaid($input: OrderMarkAsPaidInput!) {
  orderMarkAsPaid(input: $input) {
    order {
      # Order fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "input": {
    "id": "gid://shopify/<objectName>/10079785100"
  }
}
input OrderMarkAsPaidInput {
  id: ID!
}