Preview

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

PsaOnboardingStatusPayload

This page contains

    Fields

    executionId: ID
    overallStatus: PsaOnboardingExecutionStatus PREVIEW
    currentStep: PsaOnboardingStepName PREVIEW
    distiAccountSetup: PsaOnboardingStepProgress PREVIEW

    Disti distributor account from configurePsaOnboarding. Synthesized as COMPLETED when the execution has a Disti account id (setup is not a worker step).

    company: PsaOnboardingCompanyStatus PREVIEW

    Company import + mapping. Phase 1 mapping (COMPANY_SYNC) is the same atomic outcome as import.

    product: PsaOnboardingProductStatus PREVIEW

    Disti catalog sync, Disti product import progress (counts when Disti is refreshed), and product bind.

    tax: PsaOnboardingTaxStatus PREVIEW

    Tax settings import. Status is COMPLETED when psaTaxConfiguration rows exist for this MOR.

    steps: [PsaOnboardingStepProgress!]! PREVIEW

    Worker and synthesized steps in order. userErrors on a FAILED step is the same cause rolled up onto company / product / tax; nested feature children (catalogSync, companyImport, …) stay empty so a client that reads the feature does not see the cause twice there.

    userErrors: [PsaOnboardingStatusError!]! PREVIEW

    Queries for PsaOnboardingStatusPayload

    psaOnboardingStatus PREVIEW

    Poll Magical Onboarding progress for a started execution. Reads feature collections (company_import_records, mappings, tax, product bind) plus Disti catalog progress when catalog sync has started. Collection query failures return COLLECTION_LOAD_FAILED rather than falling back to worker steps.