Expanding resources
Some resources allow you to request additional information as an expanded resource by using the expands request parameter. When an object contains related data, you can expand it inline rather than making separate API calls.
The expands parameter is available on all GET requests.
Available expand parameters
| Parameter | Description | Applies to |
|---|---|---|
sources | External system references | Products, categories, companies, customers, contacts, clusters |
parent | Parent resource in hierarchical structures | Companies, customers, contacts, clusters |
translation | Translated fields for all available languages | Products, categories, clusters |
order_items | All items within an order | Orders |
order_items.product | Product data for each order item | Orders |
addresses | Shipping and billing addresses | Orders |
clusterConfig | Cluster configuration settings | Clusters |
options | All options within a product cluster | Clusters |
products | Related products | Clusters, pricesheets |
defaultProduct | Default product for a cluster or option | Clusters, options |
surcharges | Additional fees and surcharges | Products |
inventoryBalance | Stock levels and availability | Products |
note
The expand parameters listed above represent only a subset of all available expansion options. For a complete list of available expand parameters for each entity, refer to the individual entity documentation pages.
Multiple expansions
Combine multiple expansions in a single request by separating them with commas:
GET /v2/products/123?expands=sources,parent,translation
See also
- Localized Strings for retrieving translations with
?expands=translation - Pagination for controlling page sizes alongside expansions
- REST API Reference for the full endpoint specification