Skip to main content

supplyPurchaseOrderLookup

Finds the purchase order a downstream system already holds under a purchase order number.

Business Rules​

  • The integration must support looking up purchase orders.
  • The number names at most one downstream document, so the result is one order or null.
  • Neither system is changed by asking.

Error Scenarios​

  • **NOT_FOUND**: the integration does not exist.
  • **VALIDATION**: the integration cannot look up purchase orders, the number is unusable, or the downstream system refused the request.

Permissions Required​

  • integration:read_external_data permission.
supplyPurchaseOrderLookup(
  integrationId: ID!
  poNumber: String!
): PurchaseOrderLookupResult

Arguments​

supplyPurchaseOrderLookup.integrationId ● ID! non-null scalar common​

The integration to ask.

supplyPurchaseOrderLookup.poNumber ● String! non-null scalar common​

The purchase order number to look for.

Type​

PurchaseOrderLookupResult object purchase-orders​

A purchase order that already exists in a downstream system under the number being looked up.