Anchor to section titled 'undefined'shop
shop
mutation
Unstable
Requires write access scope. Also: App must be configured to use the Storefront API or as a Sales Channel.
The Resource object lets your app report the status of shops and their resources. For example, if
your app is a marketplace channel, then you can use resource feedback to alert merchants that they need to connect their marketplace account by signing in.
Resource feedback notifications are displayed to the merchant on the home screen of their Shopify admin, and in the product details view for any products that are published to your app.
This resource should be used only in cases where you're describing steps that a merchant is required to complete. If your app offers optional or promotional set-up steps, or if it makes recommendations, then don't use resource feedback to let merchants know about them.
Sending feedback on a shop
You can send resource feedback on a shop to let the merchant know what steps they need to take to make sure that your app is set up correctly. Feedback can have one of two states: requires or success. You need to send a requires feedback request for each step that the merchant is required to complete.
If there are multiple set-up steps that require merchant action, then send feedback with a state of requires as merchants complete prior steps. And to remove the feedback message from the Shopify admin, send a success feedback request.
Important
Sending feedback replaces previously sent feedback for the shop. Send a new shop mutation to push the latest state of a shop or its resources to Shopify.
Anchor to section titled 'Arguments'
Arguments
The fields required to create shop feedback.
Was this section helpful?
Anchor to section titled 'ShopResourceFeedbackCreatePayload returns'
ShopResourceFeedbackCreatePayload returns
The shop feedback that's created.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: shopResourceFeedbackCreate
Query Reference for MUTATION: shopResourceFeedbackCreate
"mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n feedback {\n # AppFeedback fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: shopResourceFeedbackCreate
"{\n \"input\": {\n \"feedbackGeneratedAt\": \"2019-09-07T15:50:00Z\",\n \"messages\": [\n \"<your-messages>\"\n ],\n \"state\": \"ACCEPTED\"\n }\n}"Schema Reference for MUTATION: shopResourceFeedbackCreate
"input ResourceFeedbackCreateInput {\n feedbackGeneratedAt: DateTime!\n messages: [String!]\n state: ResourceFeedbackState!\n}\n"Display Examples for MUTATION: shopResourceFeedbackCreate
[
{
"example": {
"type_name": "shopresourcefeedbackcreate",
"title": "Create a shop feedback record indicating a problem specific to your app",
"query_string": "mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n}",
"query_arguments": {
"input": "$input"
},
"variables": {
"input": {
"messages": [
"is not connected. Connect your account to use this sales channel."
],
"state": "REQUIRES_ACTION",
"feedbackGeneratedAt": "2024-09-12T01:10:50.056430Z"
}
},
"response": {
"data": {
"shopResourceFeedbackCreate": {
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/shop_resource_feedback_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) { shopResourceFeedbackCreate(input: $input) { userErrors { field message } } }\",\n \"variables\": {\n \"input\": {\n \"messages\": [\n \"is not connected. Connect your account to use this sales channel.\"\n ],\n \"state\": \"REQUIRES_ACTION\",\n \"feedbackGeneratedAt\": \"2024-09-12T01:10:50.056430Z\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"messages\": [\n \"is not connected. Connect your account to use this sales channel.\"\n ],\n \"state\": \"REQUIRES_ACTION\",\n \"feedbackGeneratedAt\": \"2024-09-12T01:10:50.056430Z\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"messages\": [\"is not connected. Connect your account to use this sales channel.\"],\n \"state\": \"REQUIRES_ACTION\",\n \"feedbackGeneratedAt\": \"2024-09-12T01:10:50.056430Z\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"messages\": [\n \"is not connected. Connect your account to use this sales channel.\"\n ],\n \"state\": \"REQUIRES_ACTION\",\n \"feedbackGeneratedAt\": \"2024-09-12T01:10:50.056430Z\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"messages\" => [\"is not connected. Connect your account to use this sales channel.\"],\n \"state\" => \"REQUIRES_ACTION\",\n \"feedbackGeneratedAt\" => \"2024-09-12T01:10:50.056430Z\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The fields required to create shop feedback.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ResourceFeedbackCreateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ResourceFeedbackCreateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"messages\":[\"is not connected. Connect your account to use this sales channel.\"],\"state\":\"REQUIRES_ACTION\",\"feedbackGeneratedAt\":\"2024-09-12T01:10:50.056430Z\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "shopresourcefeedbackcreate",
"title": "Create a shop feedback record indicating the shop is usable by your app",
"query_string": "mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n}",
"query_arguments": {
"input": "$input"
},
"variables": {
"input": {
"state": "ACCEPTED",
"feedbackGeneratedAt": "2024-09-12T01:10:50.164367Z"
}
},
"response": {
"data": {
"shopResourceFeedbackCreate": {
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/shop_resource_feedback_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) { shopResourceFeedbackCreate(input: $input) { userErrors { field message } } }\",\n \"variables\": {\n \"input\": {\n \"state\": \"ACCEPTED\",\n \"feedbackGeneratedAt\": \"2024-09-12T01:10:50.164367Z\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"state\": \"ACCEPTED\",\n \"feedbackGeneratedAt\": \"2024-09-12T01:10:50.164367Z\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"state\": \"ACCEPTED\",\n \"feedbackGeneratedAt\": \"2024-09-12T01:10:50.164367Z\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"state\": \"ACCEPTED\",\n \"feedbackGeneratedAt\": \"2024-09-12T01:10:50.164367Z\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"state\" => \"ACCEPTED\",\n \"feedbackGeneratedAt\" => \"2024-09-12T01:10:50.164367Z\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The fields required to create shop feedback.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ResourceFeedbackCreateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ResourceFeedbackCreateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"state\":\"ACCEPTED\",\"feedbackGeneratedAt\":\"2024-09-12T01:10:50.164367Z\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "shopresourcefeedbackcreate",
"title": "Sending outdated feedback (previous feedback payload has a greater resource_updated_at value)\n returns an error",
"query_string": "mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n}",
"query_arguments": {
"input": "$input"
},
"variables": {
"input": {
"messages": [
"is not connected. Connect your account to use this sales channel."
],
"state": "REQUIRES_ACTION",
"feedbackGeneratedAt": "1998-06-07T10:00:00Z"
}
},
"response": {
"data": {
"shopResourceFeedbackCreate": {
"userErrors": [
{
"field": [
"input"
],
"message": "Feedback for a later version of this resource was already accepted."
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/shop_resource_feedback_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) { shopResourceFeedbackCreate(input: $input) { userErrors { field message } } }\",\n \"variables\": {\n \"input\": {\n \"messages\": [\n \"is not connected. Connect your account to use this sales channel.\"\n ],\n \"state\": \"REQUIRES_ACTION\",\n \"feedbackGeneratedAt\": \"1998-06-07T10:00:00Z\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"messages\": [\n \"is not connected. Connect your account to use this sales channel.\"\n ],\n \"state\": \"REQUIRES_ACTION\",\n \"feedbackGeneratedAt\": \"1998-06-07T10:00:00Z\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"messages\": [\"is not connected. Connect your account to use this sales channel.\"],\n \"state\": \"REQUIRES_ACTION\",\n \"feedbackGeneratedAt\": \"1998-06-07T10:00:00Z\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"messages\": [\n \"is not connected. Connect your account to use this sales channel.\"\n ],\n \"state\": \"REQUIRES_ACTION\",\n \"feedbackGeneratedAt\": \"1998-06-07T10:00:00Z\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation shopResourceFeedbackCreate($input: ResourceFeedbackCreateInput!) {\n shopResourceFeedbackCreate(input: $input) {\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"messages\" => [\"is not connected. Connect your account to use this sales channel.\"],\n \"state\" => \"REQUIRES_ACTION\",\n \"feedbackGeneratedAt\" => \"1998-06-07T10:00:00Z\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The fields required to create shop feedback.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ResourceFeedbackCreateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ResourceFeedbackCreateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"messages\":[\"is not connected. Connect your account to use this sales channel.\"],\"state\":\"REQUIRES_ACTION\",\"feedbackGeneratedAt\":\"1998-06-07T10:00:00Z\"}",
"typeKind": "MUTATION"
}
]
}
]