Selecting Fields

In many endpoints you'll find a fields query parameter that can be passed to the endpoint. You can use the fields query parameter to specify which fields in the entity should be returned in the response.

Please note that if you pass a fields query parameter, only the fields you pass in the value along with the id of the entity will be returned in the response.

Also, the fields query parameter does not affect the expanded relations. You'll have to use the expand parameter instead.

Selecting One Field

For example, when you retrieve a list of products, you can retrieve only the titles of the products by passing title as a value to the fields query parameter:

As mentioned above, the expanded relations such as variants will still be returned as they're not affected by the fields parameter.

You can ensure that only the title field is returned by passing an empty value to the expand query parameter. For example:

Selecting Multiple Fields

You can pass more than one field by seperating the field names in the fields query parameter with a comma.

For example, to select the title and handle of the products:

Retrieve Only the ID

You can pass an empty fields query parameter to return only the ID of an entity. For example:

You can also pair with an empty expand query parameter to ensure that the relations aren't retrieved as well. For example:

Selecting One Field#

Selecting Multiple Fields#

Retrieve Only the ID#

Selecting One Field

Selecting Multiple Fields

Retrieve Only the ID