Changelog

The GraphQL schema changelog is a list of all upcoming and previous updates to the GA and Preview GraphQL schemas. It also includes announcements for deprecated, retired, and decommissioned (breaking) functionality.

Schema Changes on August 30, 2024

• The following changes were made:

  • The object Account was updated to include the below new fields:
    • website
    • contactAddress
    • contactPhoneNumber
    • contactEmail
    • accountMemberships
  • The below new objects were added:
    • AccountContactAddress
    • AccountMembershipDetails
    • UserMembershipDetails
  • The object User was updated to include the below new fields:
    • status
    • userMemberships
  • A new query accountMembershipsByAccessType was added.

Schema Changes on August 29, 2024

• The following changes were made:

  • The query publishedProductsSearchInternal was updated to include the below new fields:
    • useProductionVersion
    • companyAdminIsCuratingCatalog
  • The below new queries were added:
    • publishedProductsSearchTesting
    • publishedProductsSearch
  • The below enums were added:
    • SegmentedProductVisibilityType
    • DistributorProductType
    • DistributorId
    • MarkupStatus
  • The below input objects were added:
    • PublishedProductSearchChannelSettingsTesting
    • PublishedProductSearchCompanySettingsInternal
    • PublishedProductSearchFiltersTesting
    • CustomAccountDetailsInput
  • The object DistributorProduct was updated to include the below new fields:
    • type
    • manufacturerPartNumber
    • price
    • productEnrichedContent
  • The below new objects were added:
    • ProductEnrichedContent
    • GraphqlImage
    • ProductPrice
    • MarkupDetails
  • The below objects were updated:
    • Distributor was updated to include a new field defaultPriceType.
    • DistributorProductImport was updated to include a new field markupDetails.
  • The below input objects were updated:
    • IngramRegistrationInput was updated to include the below new fields:
      • accountNumber
      • subscriptionKey
    • UpdateDistributorAccountInput was updated to include the new field customAccountDetails.

Schema Changes on August 28, 2024

• The following changes were made:

  • The input objects CreateAccountWebhookConfigurationInput, UpdateWebhookConfigurationInput, and CreateTenantWebhookConfigurationInput were updated to include a new field destination.
  • The below new objects were added:
    • WebhookDestinationInput
    • WebhookEndpoint
  • The object WebhookConfiguration was updated to include a new field destination.
  • A new union WebhookDestination was added.

Schema Changes on August 27, 2024

• The following changes were made:

  • The below objects were updated:
    • Account was updated to include a new field programApplicant.
    • ProgramStep and ProgramStepInput were updated to include a new field props.
    • ProgramApplicant was updated to include new fields companyId and isValidated.
  • The enum ProgramApplicantStatus was updated to include a new field DELETED.
  • A new object ValidateProgramApplicantPayload was added.
  • The below input objects were updated:
    • ProgramApplicantFilter was updated to include a new field isValidated.
    • UpdateProgramApplicantInput was updated to include a new field companyId.
  • A new input object ValidateProgramApplicantInput was added.

Schema Changes on August 26, 2024

• The following changes were made:

  • The below new objects were added:
    • InvalidAmountForIncludedItemsError
    • InvalidKeepBillDateOnPricingPlanChangeConfigurationError
  • The below unions were updated:
    • CreatePricingPlanError was updated to include a new error type InvalidKeepBillDateOnPricingPlanChangeConfigurationError.
    • UpdatePricingPlanError was updated to include a new error type InvalidKeepBillDateOnPricingPlanChangeConfigurationError.
    • UpdateEditionPricingError was updated to include a new error type InvalidAmountForIncludedItemsError.
    • SetMarketplacePriceError was updated to include a new error type ApplicationStatusLaunchedInWorkingVersionNotAllowedError.
    • SetResellerCompanyPriceError was updated to include a new error type ApplicationStatusLaunchedInWorkingVersionNotAllowedError.
  • A new enum ApplicationStatus was added.

Schema Changes on August 14, 2024

• The following changes were made:

  • A new object NumberOutOfBoundsError was added.
  • A new field position was added to:
    • Input objects - CreateProductEditionInput, UpdateProductEditionInput.
    • Objects - ProductEdition.
  • A new error type NumberOutOfBoundsError was added to unions CreateProductEditionError and UpdateProductEditionErrors.

Schema Changes on August 8, 2024

• The following changes were made:

  • The below new objects were added:
    • Product
    • ReadPsaCompanyPayload
    • PsaCompanyMappingsConnection
    • PsaCompanyMappingReadError
    • ReadPsaProductMappingPayload
    • PsaProductMappingReadError
    • CreatePsaAdditionForSubscriptionPayload
    • CreatePsaAdditionForSubscriptionAndAgreementPayload
    • CreatePsaAdditionForSubscriptionError
    • CreatePsaAdditionForSubscriptionAndAgreementError
    • PsaSyncedSubscriptionsFilter
    • PsaSyncedSubscriptionsOrderBy
    • PsaSyncedSubscriptionsConnection
    • PsaSyncedSubscription
    • PsaSyncedSubscriptionOrder
    • PsaSyncedSubscriptionOrderLine
    • PsaSyncedSubscriptionOriginalOrderLine
    • SyncedPsaAgreement
  • The below input objects were updated:
    • CreatePsaConnectorInput and UpdatePsaConnectorInput were updated to include the below new fields:
      • configuration
      • credentials
    • PsaProductMappingsFilter was updated to include the below new fields:
      • psaProductName
      • productName
  • The below objects were updated:
    • PsaConnector was updated to include the below new fields:
      • configuration
      • credentials
    • PsaConnectorConfiguration was updated to include a new field credentials.
    • PsaCompanyMapping was updated to include the below new fields:
      • companyName
      • createdDate
      • updatedDate
      • createdBy
      • updatedBy
    • PsaProductMapping was updated to include the below new fields:
      • product
      • productName
      • productId
      • createdOn
      • updatedOn
  • The query psaCompanyMappings was updated to include the below:
    • New fields:
      • first
      • after
      • last
      • before
      • filter
      • orderBy
    • Return field PsaCompanyMappingsConnection.
  • The below new queries were added.
    • readCompanyMappingByAccountIdAndOrPsaAccountId
    • readPsaProductMappingByItemIdsOrPsaProductId
    • psaSyncedSubscriptions
  • The following new mutations were added:
    • removeCompanyMapping
    • createPsaAdditionForSubscription
    • createPsaAdditionForSubscriptionAndAgreement
  • The following input objects were added:
    • RemoveCompanyMappingInput
    • PsaCompanyMappingsFilter
    • PsaCompanyMappingsOrderBy
    • CreatePsaAdditionForSubscriptionInput
    • CreatePsaAdditionForSubscriptionAndAgreementInput
  • The below new enums were added:
    • PsaCompanyMappingsOrderField
    • PsaProductMappingOrderField
    • PsaSyncedSubscriptionStatus
    • SyncPsaSubscriptionOrderField

Schema Changes on August 6, 2024

• The following changes were made:

  • Below queries were added:
    • commissionEvent
    • commissionCyclesByYear
    • commissionCycleExecutions
    • commissionEventReport
    • eventsMissingByCycle
  • Below input objects were added:
    • CommissionEventFilter
    • TriggerCommissionImportProcessInput
    • TriggerCommissionRetryProcessInput
    • TriggerCommissionCancelProcessInput
    • LocalizedStringInput
    • LocalizedURLInput
    • LocalizedPhoneNumberInput
    • LocalizedEmailAddressInput
  • Below objects were added:
    • CommissionEventConnection
    • CommissionEvent
    • CommissionCycle
    • CommissionEventsSummary
    • CommissionCycleExecutionsConnection
    • CommissionEventErrorSummary
    • BatchMissingEvents
    • TriggerCommissionImportProcessPayload
    • TriggerCommissionRetryProcessPayload
    • TriggerCommissionCancelProcessPayload
    • InvalidInputAmountError
    • InvalidInputFieldError
    • PageInfo
    • LocalizedString
    • LocalizedURL
    • LocalizedPhoneNumber
    • LocalizedEmailAddress
  • Below enums were added:
    • ProcessStatus
    • EventStatus
    • OrderDirection
  • Below unions were added:
    • TriggerCommissionImportError
    • TriggerCommissionCancelError
  • Below mutations were added:
    • triggerCommissionImportProcess
    • triggerCommissionRetryProcess
    • triggerCommissionCancelProcess
  • Below interfaces were added:
    • UserError
    • AsynchronousProcess
    • AsynchronousProcessExecutionError

Schema Changes on July 29, 2024

• The following changes were made:

  • The object BalanceTransaction was updated to include a new field source.
  • The below objects were added:
    • CloseCreditMemoPayload
    • CreditMemoHasNoBalanceError
    • CreditMemoBalanceReservedError
  • A new union CloseCreditMemoError was added.
  • A new mutation closeCreditMemo was added.
  • A new input object CloseCreditMemoInput was added.
  • The input object CreditMemoBalanceStatus was updated to include a new field CLOSED.
  • The object SubscriptionDefinition was updated with the new field addOnSubscriptions.

Schema Changes on July 5, 2024

• The following changes were made:

  • The below objects were added:
    • CuratedCompanyCatalog
    • CuratedCompanyCatalogInput
  • The query curatedCompanyCatalog was updated to include a new argument CuratedCompanyCatalogInput and return field CuratedCompanyCatalog.

Schema Changes on July 4, 2024

• The enum DownloadEntityType was updated to include the following new fields:
  • PRICE_BOOK
  • PRODUCT_INTEGRATION
  • PRICE_BOOK_SCHEDULE
  • PRODUCT_INTEGRATION_CREDENTIAL
  • PRODUCT_INTEGRATION_AUTHENTICATION_BOOKMARK
  • PRODUCT_INTEGRATION_AUTHENTICATION_OPEN_ID
  • PRODUCT_INTEGRATION_AUTHENTICATION_OPEN_ID_CONNECT
  • PRODUCT_INTEGRATION_AUTHENTICATION_SAML

Schema Changes on June 28, 2024

• The following objects were added:
  • SubscriptionInformation
  • SubscriptionState
  • ContractVendorEndDateResponse
  • SubscriptionUpdateResponse
  • SubscriptionUpdateValidationError
  • SubscriptionUpdateRequestStatusResponse
  • SubscriptionUpdateRequest
  • SubscriptionUpdateRequestItem
  • SubscriptionUpdateRequestInput
  • SubscriptionUpdateRequestItemInput
• The following input objects were added:
  • ContractVendorEndDateRequestInput
  • ContractVendorEndDateRequestItemInput
• A new enum RequestStatus was added.
• A new query subscriptionUpdateRequestStatus was added.
• A new mutation subscriptionUpdateRequest was added.

Schema Changes on June 27, 2024

• The following enums were added:
  • PriceBookMarkupType - Lists all applicable markup types for a price book.
  • PricingPlanStatus - Status of pricing plan.
• A new object PriceBookVersionExistsForInputVersionedDateError was added that represents an error when the price book version for the provided input version date already exists.
• The union CreateOrUpdatePriceBookVersionError was updated to include a new possible error type PriceBookVersionExistsForInputVersionedDateError.
• The union CreateOrUpdatePricingEventError was updated to include the following new possible error types:
  • ContractFeeNotConfiguredOnPricingPlanError
  • DuplicatePriceBookConditionNameError
  • DuplicatePriceBookConditionPropertyError
  • DuplicatePriceBookNameError
  • DuplicatePricingPlanForPriceBookError
  • DuplicatePricingUnitError
  • DuplicateUnitQtyTierError
  • FeesMissingOnPricingPlanError
  • FlatFeeNotConfiguredOnPricingPlanError
  • InvalidContractFeePriceConfiguration
  • InvalidCreateOrUpdatePriceBookInputError
  • InvalidFlatFeePriceConfiguration
  • InvalidPriceBookPriority
  • InvalidPriceValueForFee
  • InvalidRevenueModuleForMarkups
  • InvalidSetupFeePriceConfiguration
  • MarkupOnWorkingVersionNotAllowedError
  • PriceBookDateChangeNotAllowed
  • PriceBookDateRangeError
  • PriceBookEndDateError
  • PriceBookEntryFeesMissing
  • PriceBookEntryPricesForFeesNotProvidedError
  • PriceBookStartDateError
  • PricingPlanUnitFeeNotConfiguredError
  • SetupFeeNotConfiguredOnPricingPlanError
  • UnitPriceRangeNotConfiguredOnPricingPlanError
  • UnitSetupFeeNotConfiguredOnPricingPlanError

Schema Changes on June 26, 2024

• The following objects were added:
  • DistributorProduct
  • CategoryOutput
  • SubCategoryOutput
  • Distributor
  • DistributorOld
  • DistributorAccount
  • DistributorAccountConnectionStatus
  • DistributorAccountSettings
  • MarkupFeeSettings
  • MarkupFee
  • DistributorProductImportsConnection
  • DistributorProductImport
  • ImportDetails
  • PublishDetails
  • SyncDetails
  • ProductImporterDetails
  • MarketplaceProductDetails
  • PricingPlanDetails
  • EditionDetails
  • LastImportedProductData
  • DistributorsProductsFiltersData
  • SubCategory
  • Category
  • Vendor
  • InvalidAccountCredentialsError
  • InvalidSftpCredentialsError
  • DuplicateAccountError
  • InvalidDistributorProductIdsError
  • ShippingConnectorNotSetupError
  • DistributorAccountError
  • DeleteDistributorAccountPayload
  • RegisterDistributorAccountPayload
  • UpdateDistributorAccountPayload
  • UpdateUnitPricePayload
  • UpdateDistributorProductInput
  • UpdateDistributorProductPayload
  • TriggerDistributorsProductsImportsPayload
  • DistributorsProductsConnection
  • TriggerBalanceOperationEventPayload
• The following input objects were added:
  • DeleteDistributorAccountInput
  • AccountDetailsInput
  • RegisterDistributorAccountInput
  • SynnexRegistrationInput
  • IngramRegistrationInput
  • UpdateDistributorAccountInput
  • DistributorAccountSettingsInput
  • MarkupFeeSettingsInput
  • MarkupFeeInput
  • BasicAccountDetailsInput
  • SFTPDetailsInput
  • UpdateUnitPriceInput
  • TriggerDistributorsProductsImportsInput
  • DistributorsProductsImportsOrderByInput
  • DistributorProductImportsFilter
  • DistributorsProductsFilter
  • DistributorsProductsOrderByInput
  • CategoryFilterInput
  • DistributorAccountFilter
  • TriggerBalanceOperationEventInput
• The enums were added:
  • DistributorId
  • MarkupFeeType
  • ProductType
  • ImportStatus
  • PublishStatus
  • SyncStatus
  • ImportStatusFilter
  • SortDirectionInput
  • OrderDirection
• The following unions were added:
  • RegisterDistributorAccountError
  • UpdateDistributorAccountError
  • TriggerDistributorsProductsImportsError
• The following queries are added:
  • distributorsDetails
  • distributorAccount
  • distributorsProducts
  • distributorsProductsFiltersData
  • distributorProductImports
• The following mutations are added:
  • registerDistributorAccount
  • updateDistributorAccount
  • deleteDistributorAccount
  • triggerDistributorsProductsImports
  • triggerBalanceOperationEvent
• The object VoidInvoicePayload was updated to include a new field creditMemos.
• The union VoidInvoiceError was updated to include the following possible error types:
  • InvoiceLinkedToPaymentError
  • InvoiceBalanceReservedError
  • InvoiceSiblingCreditMemoAppliedError

Schema Changes on June 25, 2024

• The object CreditMemoLine was updated to include a new field associatedInvoiceLineId.
• The following enums were added:
  • CreditMemoOrderField
  • CreditMemoStatus
• A new union CreditMemoConnectionError was added.
• The following new objects were added:
  • Invoice
  • InvoiceLine
  • InvalidScopeError
  • CostPeriodInfo
  • RecordedSubscription
  • TaxDetail
  • TaxType
  • Edition

Schema Changes on June 24, 2024

• The following mutations were added:
  • removePrivacyPolicyLink - Removes a privacy policy link for a product.
  • removeTermsAndConditionsLink - Removes a terms and conditions link for a product.
• The following input objects were added:
  • RemovePrivacyPolicyLinkPayload - Payload returned on removing the privacy policy link.
  • LocalizedFieldLocaleError - Error when the localized field does not contain the locale.
  • ProductVariantProcessCancelledError - Error when the product variant process is canceled.
• The following unions were added:
  • RemovePrivacyPolicyLinkErrors - A union type that encapsulates all possible errors that may occur on removing a privacy policy link.
  • RemoveTermsAndConditionsLinkErrors - A union type that encapsulates all possible errors that may occur when removing a terms and conditions link.
• The union type ProductVariantsCreationProcessExecutionError was updated to include new possible error type ProductVariantProcessCancelledError.
• A new query productVariantsCreationProcessByProductRefId was added to query the variants creation process by product ref id.

Schema Changes on June 7, 2024

• The object Account was updated to include the following new fields:
  • Tenant - The Tenant that account belongs to.
  • allowMembershipCreationByMarketplaceUsers - Allows membership creation by marketplace users.
• The enum AccountMembershipRole was updated to include a new field CORPORATE_ADMIN.
• The query activeCart was updated to include a new argument locale.
• The object CartItem was updated to include the following new fields:
  • isAddonItem - Identifies if the cart item is an addon item or not.
  • parentItemId - Identifier for the main cart item ID to which addon item is associated. Populated only if isAddonItem is true, null otherwise.
• The following new objects were added:
  • ExpiredDiscountCodeError
  • UpdateCartCustomAttributesPayload
• The enum CartFieldType was updated to include a new field DATE.
• The following new input objects were added:
  • UpdateCartCustomAttributesInput
  • CartCustomAttributeInput
  • CartCustomAttributesInput
  • UpdateCartItemCustomAttributesInput
  • CartItemCustomAttributesInput
  • CartItemCustomAttributeInput
• The input object ActiveCartOfUserInput was updated to include a new field locale.

Schema Changes on May 29, 2024

• The query publishedProductsSearchInternal was updated to include new arguments: forceDefaultProductSearchFields, tenantSettings, userSettings, and useProductionVersion.
• The following queries were added:
  • productSearchSettings
  • publishedProductsSearchInternal
  • productSearchSettings
• The input object PublishedProductSearchChannelSettingsInternal was updated to include a new field minimumReviewsForRating.
• A new input object PublishedProductSearchUserSettingsInternal was added.

Schema Changes on May 17, 2024

• The following input objects were added:
  • PsaMorInput
  • PsaFieldValueInput
  • CreatePsaConnectorInput
  • UpdatePsaConnectorInput
  • CreatePsaConnectorConfigurationInput
  • UpdatePsaConnectorConfigurationInput
  • ReadPsaConnectorConfigurationInput
  • CreatePsaCompanyMappingInput
  • UpdatePsaCompanyMappingInput
  • PsaCompanyInput
  • CreatePsaProductMappingInput
  • PsaProductInput
  • RemovePsaProductMappingInput
  • PsaProductMappingsFilter
  • PsaProductMappingsOrderBy
  • CreatePsaAdditionInput
• The following objects were added:
  • PsaMor
  • PsaFieldValue
  • CreatePsaConnectorPayload
  • UpdatePsaConnectorPayload
  • CreatePsaConnectorConfigurationPayload
  • UpdatePsaConnectorConfigurationPayload
  • PsaConnectorInputError
  • PsaConnectorConfigurationError
  • PsaConnector
  • PsaConnectorConfiguration
  • PsaCompanyMapping
  • PsaCompany
  • CreatePsaCompanyMappingPayload
  • UpdatePsaCompanyMappingPayload
  • PsaCompanyInputError
  • PsaProductMappingConnection
  • PsaProductMapping
  • PsaProduct
  • ProductDetails
  • PageInformation
  • CreatePsaProductMappingPayload
  • RemovePsaProductMappingPayload
  • PsaProductInputError
  • PsaAgreement
  • CreatePsaAdditionPayload
  • CreatePsaAdditionError
  • PageInformation
• The following enums were added:
  • PsaConnectorType
  • MorType
  • OrderDirectionBy
  • PsaProductName
• The following mutations were added:
  • createPsaConnector
  • updatePsaConnector
  • createPsaConnectorConfiguration
  • updatePsaConnectorConfiguration
  • createPsaCompanyMapping
  • updatePsaCompanyMapping
  • createPsaProductMapping
  • removePsaProductMapping
  • createPsaAddition
• The following queries were added:
  • psaConnectors
  • psaConnectorConfiguration
  • psaCompaniesByName
  • psaCompanyMappings
  • psaProductsByName
  • psaProductMappings
  • psaAgreementsByCompanyId

Schema Changes on May 9, 2024

The enum UsageFileUploadStatus was updated to include a new field UPLOAD_PROCESSING.

Schema Changes on April 26, 2024

• The mutation createAllocation was updated the following authorization scopes:
  • ROLE_CHANNEL_ADMIN
  • ROLE_CHANNEL_SUPPORT
  • ROLE_PARTNER
  • ROLE_BILLING_ADMIN
  • ROLE_SYS_ADMIN
  • ROLE_RESELLER
  • ROLE_SALES_SUPPORT
  • ROLE_CHANNEL_PRODUCT_SUPPORT
  • ROLE_CORPORATE_ADMIN
  • ROLE_INTERNAL
  • billing-charge.subscription-allocation.write.instance
  • billing-charge.subscription-allocation.write.tenant
  • billing-charge.subscription-allocation.write.account
• A new query allocation was added.
• A new input object SubscriptionAllocationInput was added.

Schema Changes on April 10, 2024

The following changes were made:

• The enum DownloadEntityType has been updated with the following new fields:
  • PRODUCT_MEDIA
  • PRODUCT_FEATURE_CHARACTERISTIC
  • PRODUCT_CONSOLIDATE
  • PRODUCT_IMAGE

Schema Changes on April 8, 2024

The following changes were made:

• The input object AccountsFilter has been updated to include a new boolean field searchExternalId.
• The input object UsersFilter has been updated to include a new field roles.

Schema Changes on March 18, 2024

• Following mutations were added:
  • createOrUpdatePriceBook - Creates a new price book or updates the existing price book.
  • createOrUpdatePriceBookVersion - Creates price book version by price book Id or updates price book version by its Id.
• Following objects were added:
  • InvalidCreateOrUpdatePriceBookVersionInputError - Represents an error when provided input for creating or updating price book version is not valid.
  • InvalidCreateOrUpdatePriceBookInputError - Represents an error when provided input for creating or updating price book is not valid.
  • InvalidCreateOrUpdatePricingEventInputError - Represents an error when provided input for creating or updating pricing event is not valid.
  • CreateOrUpdatePriceBookPayload - Payload for creating or updating price books.
  • PriceBookEntryPricesForFeesNotProvidedError - Represents an error with the prices for different fees of price book entry not provided while creating or updating price book entry.
  • CreateOrUpdatePriceBookVersionPayload - Payload for create or update price book version.
  • PriceBookVersionConnection - A connection type used to page through a list of price book versions.
• Following input objects were added:
  • CreateOrUpdatePriceBookInput - Input for creating or updating price books.
  • CreateOrUpdatePriceBookMetaDataInput - Input to create or update price book metadata.
  • CreateOrUpdatePriceBookConditionInput - Input to create or update price book condition.
  • CreateOrUpdatePriceBookEntryInput - Input to create or update price book entry.
  • PriceBookConditionInput - Input to add or update price book condition.
  • createOrUpdateEntryInput - Input to create or update product entry in price book.
  • RemoveEntryFeesInput - Input to remove fees from price book entry.
  • CreateOrUpdatePriceBookVersionInput - Input for creating or updating price book version.
  • UpdatePriceBookEntryVersionInput - Input to update price book entry version.
  • PriceBookEntryVersionInput - Input to add or update price book entry version.
  • PriceBookEntryVersionUnitPriceInput - Input for setting custom prices on the unit fee of the price book version.
  • UpdatePriceBookConditionVersionInput - Input to update price book condition version.
  • PriceBookConditionVersionInput - Input to add or update price book condition version.
  • PriceConditionVersionInput - Input for associating or updating or removing the companies/segments to price book condition version.
  • UpdatePriceBookVersionInput - Input for updating price book version metadata.
  • PriceBookVersionFilter - Definition used to filter price book versions returned in the query.
  • PriceBookVersionOrderBy - Definition used to order price book versions returned in the query.
• A new field uuid has been added to the PriceBookEntryUnitPrice object.
• A new boolean field isDeleted has been added to the PriceBook object.
• The following enums were added:
  • PriceBookAction - Action enum for price book.
  • PriceBookConditionAction - Action enum for price book condition.
  • PriceBookEntryAction - Action enum for price book entry.
  • PriceBookEntryVersionActionEnum - Enum for price book entry version action.
  • PriceBookConditionVersionActionEnum - Enum for price book condition version action.
  • PriceBookVersionOrderField - List of fields to sort price book versions returned in the query.
• The following unions were added:
  • CreateOrUpdatePriceBookError - A union type that encapsulates all possible errors that can occur when creating or updating a price book.
  • CreateOrUpdatePriceBookVersionError - A union type that encapsulates all possible errors that may occur while creating or updating price book versions.
• The queries priceBookVersion and priceBookVersions have been updated with new arguments and return fields.
• The object PriceBookVersion has been updated with two new fields versionedBy and versionedDate.

Schema Changes on March 13, 2024

• The input objects CreateTenantWebhookConfigurationInput, UpdateWebhookConfigurationInput, and CreateAccountWebhookConfigurationInput have been updated with a new boolean field active.
• The query webhookConfigurations has been updated with a new argument filter.
• A new input object WebhookConfigurationFilter has been added to filter webhook configurations.
• The enum WebhookStatus has been updated with two new fields FAILED_DELETED_CONFIGURATION and FAILED_INACTIVE_CONFIGURATION.

Schema Changes on November 24, 2023

The Inventory Sync GraphQL API was promoted from Preview to Early Availability status.

Schema Changes on November 10, 2023

New Checkout GraphQL APIs were released to support end-to-end self-serve checkout. These APIs enable customers to create a truly headless checkout experience.

Schema Changes on October 13, 2023

The following changes were made to Product GraphQL APIs:

• New mutation (triggerProductPublicationProcess) - initiates the product publication process for one or multiple products and returns the productPublicationProcesses object, which includes the status, trigger date, and errors if the process fails.
• New mutation (productPublicationProcess) - allows users to track the publication process of a product by process ID.

Schema Changes on September 25, 2023

The following changes were made to the schema:

• Updated the ProductImage object to support product profile images.
• Updated pricing plan APIs;
  • New error message for invalid grace period units.
  • New field modifiedBy added to the updatePriceBookCondition mutation- email ID of the user modifying the pricing.
  • New field removedBy added to the removeConditionProperties mutation - email ID of the user removing any properties.

Schema Changes on August 11, 2023

The following new Product GraphQL APIs were introduced in the Early Availability status:

• Create the product shell
• Create editions
• Create pricing plans

Schema changes on July 24, 2023

New enums PricingFeeType and PricingVersionType were added for pricing plan APIs.

Schema changes on June 1, 2023

The following changes were made:

• New webhook objects were added.
• New error types were added to the product API schema.
• New union UpdateEditionPricingError and following error types were added pricing plan APIs:
  • PricingPlanTerminationFeeValueError
  • DuplicateUnitForIncludedItemsError
  • InvalidUnitsForIncludedItemsError

Schema Changes on May 30, 2023

A new field PRODUCT_CUSTOM_ATTRIBUTE was added to the DownloadEntityType enum.

Schema Changes on April 6, 2023

The product integration GraphQL APIs were moved to the Early Availability (EA) phase from the preview.

Schema changes on March 1, 2023

The following changes were made:

• New union UpdateProductEditionErrors and new object ProductEditionFeature were added to the product API schema.

Schema Changes on February 27, 2023

The deprecated fields state and tag were removed from the Product Information Management (PIM) GraphQL APIs.

Schema Changes on February 15, 2023

The following changes were made to the schema:

• New Serialized Fulfillment GraphQL APIs were added. With these changes, GraphQL APIs support a Serialized Fulfillment system that can track individually identified items within a shipment of physical products.

Schema changes on January 27, 2023

The following changes were made:

• Several improvements were made for the pricing plan APIs.
• New fields and options were added to the accounts query and object. With these additions, the accounts query supports new filters to further refine results.
  • Additionally, the AccountAccessType enum supports new values: NON_CHANNEL_ADMIN and NON_VENDOR.
  • The accounts orderBy field allows for DATE and NAME.
• New mutations were added that allow a Marketplace Manager or Reseller Manager to assign an account to a Reseller as a client, or to remove such an assignment.
• New queries were added to allow searching for account memberships involving Resellers.

Schema changes on January 13, 2023

The following changes were made:

• New fields (idpID and username) were added to the updateUser mutation in Preview.
• New fields that capture contact details were added to the User and Account objects, also in the Preview status.

Additionally, the schema for the following areas were also updated:

• Account Association
• File Uploader
• Inventory
• Price Book
• Products

Schema changes on December 2, 2022

The following updates were made:

• Account Association
• Notifications
• Price Book
• Products
• Product Integrations

Schema changes on September 29, 2022

The following changes were made:

• Updated pricing plan APIs to support context to fetch pricing plan details, define developer and markup prices for flat fee, and update pricing details.
• New fields were added to the userActivity object and query.

Schema changes on August 24, 2022

The following updates were made:

• Several authorizations in the Price Book API were updated to include ROLE_PARTNER.

Schema changes on August 17, 2022

The following updates were made:

• The ProductEdition object now includes a name field when it is returned in a query.

• The createProduct mutation accepts additional input fields (name, description, shortDescription).

• New queries and mutations support Inventory records for physical products.

• New queries and mutations allow users to view and modify notification templates.

Schema changes on June 30, 2022

The following updates were made:

• New mutations and queries were added to support custom prices.

• Several elements of the existing Price Book API were updated.

• The name attribute of the Product object changed type.

Schema changes on May 18, 2022

The following updates were made:

• The productId attribute was added as a required attribute for the updateProductEdition mutation.

• A new Shared integration configurations topic was added under the Product management guide.

Schema changes on April 29, 2022

The following new features were added:

• New mutations for variant options, variant option values and variant creation.

• A new query for the marketplace product.

Schema changes on April 22, 2022

The following updates were made:

• Two items within the Product Associations API were renamed.

• A new query allows users to retrieve currency exchange rates.

Schema changes on April 8, 2022

The following updates were made:

• New standard attributes were added to the Account and User objects.

• Account and User objects can now include custom attributes.

• The mutations and queries for Account and User objects include the new attributes in the payload.

• A new mutation allows users to update an Insights dataset.

• Insights datasets include a new revision attribute, which stores a new type of object.

Schema changes on March 30, 2022

The following update was made:

• The queries and mutations related to pricing plans were updated to allow null values in certain fields.

Schema changes on March 10, 2022

The following new features were added:

• A new mutation for deleting accounts was added.

• New fields in user definitions were made available for update using an existing mutation.

Schema changes on January 26, 2022

The following updates were made:

• Some price book items were promoted from Preview to Early Availability status for all customers on the AWS-US and AWS-EU clusters.

• The queries and mutations related to price book conditions were updated to include segment information.

Schema changes on January 19, 2022

The following updates were made:

• Existing User, Account, and Account Membership mutations were made available in Preview status for all customers.

• Existing User, Account, and Account Membership queries were promoted to Generally Available (GA) status for all customers. The GraphQL Explorer and Schema Introspection tools were similarly promoted to GA for all customers.

• Marketplace Managers were given access to a new Enable GraphQL Mutations setting to manage whether users can execute GraphQL mutations that change marketplace data in the AppDirect GraphQL Explorer.

New Account Membership mutations were added in Preview status for all customers. The following tasks are supported:

• Create a new Account Membership that links a User with an existing Account, with or without an invitation being sent to the user's email address.

• Delete an existing Account Membership.

• Update roles assigned to Users within Account Memberships

Schema changes on January 5, 2022

The following updates were made:

• Selected Objects, Input Objects, and Enums related to Product APIs were renamed to conform to standards.

• The API was updated to inherit the vendorId parameter from the client making an API call, rendering this parameter optional.

• The authorization rules for Product APIs were added to the reference documentation.

Schema changes on December 15, 2021

Selected price book schema mutations and queries (added June 17, 2021) were promoted from Preview to Early Availability status. The updated items support the following tasks:

• Retrieve a specific price book by ID, pricing plan ID, or by name.

• Retrieve a specific price book condition.

• Retrieve a specific price book entry.

• Create a new price book, price book condition, or price book entry

• Update an existing price book

A query was added in Early Availability (EA) status for AWS-US and AWS-EU customers:

• Retrieve all price books.

Schema changes on December 8, 2021

The user, account, and account membership queries were made available in Early Availability status to customers on the AWS-EU cluster. The GraphQL Explorer and Schema Introspection tools were also made available in Early Availability status to customers on the AWS-EU cluster.

Additions were made to the Account object and associated schema items, also in Early Availability status for AWS-US and AWS-EU customers. The following have been added:

• The Account object includes a countryCode attribute.

• The AccountAccessType enum includes two new possible values: REFERRAL and CUSTOMER.

New user, account, and account membership mutations were added in Preview status for customers on both the AWS-US and the AWS-EU clusters. The following tasks are supported:

• Create a new Account

• Update an existing Account

• Update an existing User

• Activate or deactivate an existing Account Membership

New Subscription mutations and a query were made available in Early Availability status to customers on the AWS-EU cluster. The following tasks are supported:

• Terminate a subscription by changing its status to can celled, without triggering vendor notifications.

• Create a price change with a price definition on an existing subscription.

• Retrieve an upcoming price change operation for an existing subscription by subscription ID.

Schema changes on November 17, 2021

New queries and mutations were added to support the creation of Product Associations between existing product editions. The following tasks are supported:

• Create a product association between a specific edition of a product, and editions of other products that it requires.

• Remove a specific product association between an edition and other product editions.

• Retrieve a list of all product associations that a given product edition has to editions of other products that it requires

Schema changes on October 27, 2021

The GraphQL Explorer and Schema Introspection tools became available in Early Availability status to customers on the AWS-US cluster.

• The GraphQL Explorer is a browser-based tool that simplifies the construction of GraphQL queries and mutations.

• The GraphQL Schema Introspection tool provides documentation of the GraphQL schema within the GraphQL Explorer.

Schema changes on October 20, 2021

The user queries and account queries from the releases transitioned from Preview status to Early Availability status for customers on the AWS-US cluster.

Addition of account membership, Search feed resources, and Insights queries to the EA schema. The following tasks are supported:

• Retrieve a specific account membership by user ID and account ID

• Retrieve a list of account memberships by account ID

• Retrieve a list of account memberships by user ID

• Retrieve the current or most recently used account membership by user ID

• Retrieve the user definition for the current user

• Retrieve Search feed resources for the current user

• Create an Insights dataset

• Push data to an Insights dataset

• Create a metric for an Insights dataset

• Retrieve an Insights dataset by ID

• Retrieve a metric for an Insights dataset by ID

• Retrieve a metric by ID

Schema changes on September 29, 2021

Addition of user queries to the Preview schema. The following tasks are supported:

• Retrieve a user by AppDirect ID.

• Retrieve a user by external ID.

• Retrieve a user by username

• Retrieve a list of all users.

Schema changes on September 1, 2021

Addition of account (company) queries to the Preview schema. The following tasks are supported:

The terminology was changed. Instead of "company", the term "account" is now used.

• Retrieve an account by AppDirect ID.

• Retrieve an account by external ID.

• Retrieve a list of all accounts.

Schema changes on June 17, 2021

Addition of price book mutations and queries to the Preview schema. The following tasks are supported:

• Create, update, and delete price books.

• Create, update, and delete price book conditions.

• Create, update, and delete price book entries.

• Retrieve price books.

Schema changes on December 20, 2020

Initial release of the Preview schema. The following tasks are supported:

• Create new products in the staging catalog.

• Read products.

• Request product publication to the production catalog.