Preview

ProductIntegrationEvent is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

ProductIntegrationEvent

Base integration event type owned by graphql-rest-proxy. Extended in integration-events-query.graphqls with monolith-only fields.

This page contains

    Fields

    id: ID!

    Unique identifier for the event (event token).

    type: ProductIntegrationEventType! PREVIEW

    Type of product integration event (for example SUBSCRIPTION_ORDER or SUBSCRIPTION_CANCEL).

    createdAt: DateTime

    Date when the event was created.

    updatedAt: DateTime

    Date when event metadata was last updated, when available.

    product: Product PREVIEW

    Product associated with this event.

    account: Account PREVIEW

    Company account associated with this event.

    orderId: Int

    Purchase order identifier associated with this event.

    subscription: SubscriptionDefinition PREVIEW

    Subscription associated with this event.

    asynchronous: Boolean

    Whether the event is processed asynchronously.

    consumed: Boolean

    Whether the event has been consumed by the vendor.

    substatus: String

    Event substatus, when available.

    note: String

    Additional note on the event, when available.

    successful: Boolean

    Whether vendor processing succeeded, when the event has been consumed.

    successMessage: String

    Success message returned by the vendor, when the event succeeded.

    errorCode: String

    Vendor error code, when the event failed.

    errorMessage: String

    Vendor error message, when the event failed.

    manuallyResolved: Boolean

    Whether the event has been manually resolved.

    Parent objects of ProductIntegrationEvent

    ProductIntegrationEventConnection PREVIEW

    Relay-style connection wrapper for ProductIntegrationEvent. Authoritative definition owned by graphql-rest-proxy / schema registry.

    Queries for ProductIntegrationEvent

    productIntegrationEvent PREVIEW

    A single product integration event, looked up by event identifier (event token). Returns null when the event is not found.

    productIntegrationEvents PREVIEW

    Product integration events for the current marketplace, returned as a cursor-paginated connection.