Skip to main content

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 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.

Was this page helpful?

Tell us more…

Help us improve our content. Responses are anonymous.

Thanks

We appreciate your feedback!