2025-11-07: Schema Service - references

Overview

The Schema Service has been enhanced with support for references. These updates include:

• New REFERENCE mixin schema attribute type for custom schema types, allowing references to products, orders, carts, customers, media, prices, price lists, customer segments, categories and other custom schema types.

• New validateReferences query parameter to control reference validation during create, upsert, and patch operations.

• New expand query parameter to retrieve expanded reference data.

• New media field in custom instance responses containing IDs of media assigned to the custom instance.

Updated endpoints

Endpoint	Description
Creating a custom instance	Added validateReferences query parameter.
Upserting a custom instance	Added validateReferences query parameter.
Patching a custom instance	Added validateReferences query parameter.
Creating custom instances in bulk	Added validateReferences query parameter.
Upserting custom instances in bulk	Added validateReferences query parameter.
Retrieving all custom instances	Added expand query parameter for fetching expanded references. Added media field to the response.
Retrieving a custom instance	Added expand query parameter for fetching expanded references. Added media field to the response.
Searching for custom instances	Added expand query parameter for fetching expanded references. Added media field to the response.
Creating a schema	The REFERENCE attribute type is now available for custom schema types.
Updating a schema	The REFERENCE attribute type is now available for custom schema types.

Known problems

There are no known problems.