Anchor to orderMarkAsPaidorder
orderMarkAsPaid
mutation
Requires 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 Arguments
Arguments
- Anchor to inputinput•Order
Mark requiredAs Paid Input! The input for the mutation.
Was this section helpful?
Anchor to OrderMarkAsPaidPayload returnsOrderMarkAsPaidPayload returns
- Anchor to orderorder•
The order marked as paid.
- Anchor to userErrorsuser•
Errors [UserError!]! non-null The list of errors that occurred from executing the mutation.
Was this section helpful?
Mutation Reference
mutation orderMarkAsPaid($input: OrderMarkAsPaidInput!) {
orderMarkAsPaid(input: $input) {
order {
# Order fields
}
userErrors {
field
message
}
}
}
Input
{
"input": {
"id": "gid://shopify/<objectName>/10079785100"
}
}
{
"input": {
"id": "gid://shopify/<objectName>/10079785100"
}
}
input OrderMarkAsPaidInput {
id: ID!
}