Show & Hide - vPlan

The query parameters show and hide allow clients to requests a limited set of properties.

In addition to reducing the amount of data transferred, this can be helpful in reducing errors caused by
additional features added in a release update.

show specifies which properties the client will receive.
hide specifies which properties will be removed from the response.

Both must contain a comma separated list of properties.

For the properties of the main object this is pretty straight forward.
Sub-objects added via eager loading come in 2 flavors:

single sub-object, e.g. collection or address for an order
format: related object.property

list of sub-objects, e.g. order_rows
format: related objects.*.property or related objects.item #.property

Please note that * can be used to show or hide all properties of a sub-object.

Examples:

As shown in the last example show and hide can be combined. This is primarily useful if you want specific properties from the main object and hide properties from related objects.