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.

Arguments

Anchor to inputinput • OrderMarkAsPaidInput!required: The input for the mutation.

Was this section helpful?

Anchor to OrderMarkAsPaidPayload returnsOrderMarkAsPaidPayload returns

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

Was this section helpful?

Mutation Reference

1mutation orderMarkAsPaid($input: OrderMarkAsPaidInput!) {
2  orderMarkAsPaid(input: $input) {
3    order {
4      # Order fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "input": {
3    "id": "gid://shopify/<objectName>/10079785100"
4  }
5}

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

input OrderMarkAsPaidInput {
  id: ID!
}