Preview

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

ProductIntegrationEventItem

A product integration event.

This page contains

    Fields

    id: ID!

    Unique identifier (event token).

    type: ProductIntegrationEventType PREVIEW

    Type of product integration event.

    createdAt: DateTime

    Date when the event was created.

    updatedAt: DateTime

    Date when event metadata was last updated.

    product: Product PREVIEW

    Product associated with this event.

    account: Account PREVIEW

    Company account associated with this event.

    accountName: String

    Display name of the company account associated with this event.

    orderId: Int

    Purchase order identifier associated with this event.

    subscription: SubscriptionRecord 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.

    successMessage: String

    Success message returned by the vendor.

    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.

    status: ProductIntegrationEventStatus! PREVIEW

    Computed processing status of this event.

    partner: String!

    Partner code of the marketplace on which this event was generated.

    accountIdentifier: String

    ISV-assigned account identifier returned when the event was processed.

    userIdentifier: String

    ISV-assigned user identifier returned when the event was processed.

    identifier: String

    Generic identifier associated with the event.

    productPublished: Boolean

    Whether the product associated with this event is published.

    creator: User PREVIEW

    User who triggered this integration event.

    edition: ProductEdition

    Product edition associated with this integration event.

    Parent objects of ProductIntegrationEventItem

    ProductIntegrationEventListResult PREVIEW

    Cursor-paginated result set returned by vendorIntegrationEventList.

    Queries for ProductIntegrationEventItem

    vendorIntegrationEventDetail PREVIEW

    Fetch a single integration event by its unique token. Returns null if the event does not exist or the caller cannot access it.

    vendorIntegrationEventList PREVIEW

    Paginated list of integration events for the calling developer's products.

    • Developers (ROLE_DEVELOPER) see events across ALL marketplaces for products owned by their vendor company.
    • Channel admins (ROLE_CHANNEL_ADMIN, ROLE_CHANNEL_SUPPORT, ROLE_CHANNEL_PRODUCT_SUPPORT) see only events for their marketplace. Any partner value in the filter is silently overridden.
    • Corporate admins (ROLE_CORPORATE_ADMIN) see events for all owned marketplaces.
    • Superusers (ROLE_SUPERUSER) see all events without any scoping.