Exclusive feature only in Adobe Commerce (Learn more)

cancelPurchaseOrders mutation

The cancelPurchaseOrders mutation cancels the specified purchase orders. If the request is successful, the status of each purchase order is CANCELED.

Syntax

Copy
mutation {
    cancelPurchaseOrders(
        input: PurchaseOrdersActionInput!
    ) {
        PurchaseOrdersActionOutput
    }
}
Copied to your clipboard
mutation {
    cancelPurchaseOrders(
        input: PurchaseOrdersActionInput!
    ) {
        PurchaseOrdersActionOutput
    }
}

Reference

The cancelPurchaseOrders reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example cancels purchase orders.

Request:

Copy
mutation {
  cancelPurchaseOrders(
    input: {
        purchase_order_uids: ["NQ=="]
    }
  ) {
    purchase_orders {
        number
        status
    }
    errors {
        message
        type
    }
  }
}
Copied to your clipboard
mutation {
  cancelPurchaseOrders(
    input: {
        purchase_order_uids: ["NQ=="]
    }
  ) {
    purchase_orders {
        number
        status
    }
    errors {
        message
        type
    }
  }
}

Response:

Copy
{
  "data": {
    "cancelPurchaseOrders": {
      "purchase_orders": [
        {
          "number": "000000005",
          "status": "CANCELED"
        }
      ],
      "errors": []
    }
  }
}
Copied to your clipboard
{
  "data": {
    "cancelPurchaseOrders": {
      "purchase_orders": [
        {
          "number": "000000005",
          "status": "CANCELED"
        }
      ],
      "errors": []
    }
  }
}

Last updated 5/7/2025

Was this helpful?

Yes

No