Skip to main content

integrationOrderLookup

Finds external orders by their human-readable order number or reference.

Business Rules​

  • The integration must support looking up orders.
  • Results are limited to ten orders.
  • Existing Endless orders are identified without changing either system.

Error Scenarios​

  • **NOT_FOUND**: the integration does not exist.
  • **VALIDATION**: the integration does not support order lookup or the reference is invalid.

Permissions Required​

  • integration:read_external_data permission.
integrationOrderLookup(
  integrationId: ID!
  reference: String!
): [IntegrationOrderLookupResult!]!

Arguments​

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

The integration ID.

integrationOrderLookup.reference ● String! non-null scalar common​

The human-readable order number or reference to find.

Type​

IntegrationOrderLookupResult object common​

An external order found through an integration order lookup.