How do I sort metaobject items by a field in the metaobject. Is there a method to perform this? Also, how are the metaobject items retrieves … what is the default sort order?
Topic summary
Sorting Shopify metaobject items by a chosen field, with focus on Liquid and API options.
-
API route: One reply claims you can sort via the Admin API using orderby and direction on /admin/api/metaobjects.json, and mentions a Metaobject.sort(‘field’,‘direction’) method. They also state the default order is ascending by creation date. These points weren’t further verified by others.
-
Liquid approach: Items are accessed with shop.metaobjects..values. Sorting strings works with the Liquid filter sort: ‘field’ (e.g., title/name). Code snippets are central to the discussion.
-
Sorting by date: sort: ‘date’ did not work for some. A workaround is to store a date_string field and sort by it. A more robust fix reported by multiple participants is using sort_natural: ‘date’, which treats the stored YYYY-MM-DD as a string and sorts correctly.
-
Open questions: Whether the API endpoint can be called from Liquid, and whether it needs enabling, remains unanswered.
-
Status: Partially resolved. Effective Liquid solution for date sorting via sort_natural; API-based sorting and default-order details are not conclusively settled.
Hello @royn
To sort metaobject items by a field in the metaobject, you can use the orderby parameter in the query. The orderby parameter takes the name of the field that you want to sort by, and the direction that you want to sort in. For example, to sort by the title field in ascending order, you would use the following query:
https://{shop_domain}/admin/api/metaobjects.json?orderby=title&direction=asc
To sort by the title field in descending order, you would use the following query:
https://{shop_domain}/admin/api/metaobjects.json?orderby=title&direction=desc
Is there a method to perform this?
Yes, there is a method to perform this. The method is called sort(). The sort() method takes two parameters: the name of the field that you want to sort by, and the direction that you want to sort in. For example, to sort by the title field in ascending order, you would use the following code:
Metaobject.sort('title', 'asc');
To sort by the title field in descending order, you would use the following code:
Metaobject.sort('title', 'desc');
How are the metaobject items retrieved… what is the default sort order?
Metaobject items are retrieved in ascending order by their creation date. The default sort order is ascending by creation date.
How would I do this (sort items in a metaobject) using liquid code. See below. I want to sort by artist.name or artist.sort_order
assign artists = shop.metaobjects.artist.values
for artist in artists
echo artist.name
endfor
1 Like
To sort my ‘categories’ array by the title, I’m using
assign categories = shop.metaobjects.help_faq_category.values
assign categories = categories | sort: ‘title’
Can the API endpoint be called from a liquid file? Is it necessary to enable the endpoint? I can’t reach it
Is it possible to sort by date? I was only able to achieve sorting by name asc and desc. I tried adding a “date” field, but when I use it for sorting it gets me an empty array it seems..
assign categories = shop.metaobjects.categories.values
assign categories = categories | sort: ‘name’ // works
assign categories = categories | sort: ‘name’ | reverse // works too
assign categories = categories | sort: ‘date’ // doesn’t work
I’m trying to figure this out as well… I saw in another post that the SORT filter only works on strings and not date fields. For a hack, I added a new field to my metaobject called date_string and then did sort: 'date_string' and that works fine.
I ran into the same problem. It was annoying because it seems that the date is stored as string in the database (in the form of YYYY-MM-DD) but gets converted to a date type when read by the sort filter.
I was able to resolve this by using the sort_natural filter which seems to read the date as string instead.
To sort a metaobject by date use:
assign sortable_metaboject = shop.metaobjects.my_object.values
assign sorted_metaobject = sortable_metaobject | sort_natural: 'date'
11 Likes
Thank you Phip. Worked for me!