validatePurchaseOrders mutation

By default, Adobe Commerce validates purchase orders automatically. However, purchase orders can become stuck in certain circumstances, such as when the message queue system is down and the purchase order is in the PENDING state. You might need to run the validatePurchaseOrders mutation to manually validate purchase orders.

You must specify one or more purchase order UIDs as input.

Syntax

Copy
mutation {
    validatePurchaseOrders(
        input: ValidatePurchaseOrdersInput!
    ) {
        ValidatePurchaseOrdersOutput
    }
}
Copied to your clipboard
mutation {
    validatePurchaseOrders(
        input: ValidatePurchaseOrdersInput!
    ) {
        ValidatePurchaseOrdersOutput
    }
}

Reference

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

Headers

A valid customer authentication token is required.

Example usage

The following example validates purchase orders.

Request:

Copy
mutation {
  validatePurchaseOrders(
    input: {
        purchase_order_uids: ["Nw==", "OA=="]
    }
  ) {
    purchase_orders {
        number
        status
    }
    errors {
        message
        type
    }
  }
}
Copied to your clipboard
mutation {
  validatePurchaseOrders(
    input: {
        purchase_order_uids: ["Nw==", "OA=="]
    }
  ) {
    purchase_orders {
        number
        status
    }
    errors {
        message
        type
    }
  }
}

Response:

Copy
{
  "data": {
    "validatePurchaseOrders": {
      "purchase_orders": [
        {
          "number": "000000007",
          "status": "APPROVAL_REQUIRED"
        },
        {
          "number": "000000008",
          "status": "APPROVAL_REQUIRED"
        }
      ],
      "errors": []
    }
  }
}
Copied to your clipboard
{
  "data": {
    "validatePurchaseOrders": {
      "purchase_orders": [
        {
          "number": "000000007",
          "status": "APPROVAL_REQUIRED"
        },
        {
          "number": "000000008",
          "status": "APPROVAL_REQUIRED"
        }
      ],
      "errors": []
    }
  }
}

Last updated 11/8/2023

Was this helpful?

Yes

No