savedSearchCreate mutation

Creates a saved search.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation savedSearchCreate($input: SavedSearchCreateInput!) { savedSearchCreate(input: $input) { 
  1. <font style="color:#1F61A0;">savedSearch</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “input”: { 
  1. <font style="color:#8B2BB9;">"resourceType"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"name"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  5. <font style="color:#8B2BB9;">"query"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
} }

Arguments

Argument Description
input
(
[SavedSearchCreateInput!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearchcreateinput)

) REQUIRED		 Specifies the input fields for a saved search.

SavedSearchCreateInput fields

  • name ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
    A descriptive name of the saved search.
  • query ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
    The query string of a saved search. This includes search terms and filters.
  • resourceType ([SearchResultType!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/searchresulttype)) REQUIRED
    The type of resouce this saved search is searching in.

Return fields

  • savedSearch ([SavedSearch](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/savedsearch))
    The saved search that was created.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.