PUT

Updates the ordering type of products in a smart collection

https://shopify.com/admin/api/2021-01/smart_collections/{smart_collection_id}/order.json

https://shopify.dev/docs/admin-api/rest/reference/products/smartcollection#order-2021-01

Access Token Required: API Key

Path Parameters

smart_collection_idstringrequired

smart_collection_id

Query Params

productsstring

An array of product IDs, in the order that you want them to appear at the top of the collection. When products is specified but empty, any previously sorted products are cleared.

sort_orderstring

The type of sorting to apply. Valid values are listed in the Properties section above. (default: (current value))

products[]integer

products[]

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'https://shopify.com/admin/api/2021-01/smart_collections/{smart_collection_id}/order.json' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}