Expanding Resources
Expanding resources
Some resources allow to request additional information as an expanded resource by using the expands request parameter. This parameter is available on all GET REST API requests and applies to the response of that request only.
In many cases, an object contains a related object in its response properties. For example, an Orderitem may have an associated Product id. Those objects can be expanded inline with the expands request parameter.
| Expand parameter | Description |
|---|---|
orderItems | expands the order resource with orderItems |
orderItems.product | expands the orderItems resource with the product resource |
translation | expands translated fields for all available languages. |
inventoryBalance | expands all inventory resources for a product |
defaultProduct | expand the cluster or option resource with the default product resource |