The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

Product ResourceFeedback

Requires resource_feedbacks access scope.

Important

Product ResourceFeedback is only for use with the Sales Channel SDK.

The Product ResourceFeedback API allows you to communicate the state of a shop's individual products, as it pertains to your application, by sending product feedback within the Shopify admin. Once created, product resource feedback is used help merchants get your app setup on their store by addressing missing steps or fixing problems.

Send product feedback

You can send feedback on a product to let merchants know what steps they need to take to make sure your app is set up correctly. Feedback can have one of two states: requires_action or success. You will need to send a requires_action feedback request for each step that the merchant is required to complete. If there are multiple setup steps requiring merchant action, send feedback with a state of requires_action as merchants complete prior steps. Send a success feedback request to remove the feedback message from Shopify admin.

Important

Sending feedback replaces previously sent feedback for the Shop. Unlike REST-style APIs, you don't need to make a PATCH or PUT request to update any previously sent feedback. Send a new POST request to push the latest state of a shop or its resources to Shopify.

Formatting the resource feedback message field

If your state is requires_action you can send up to ten string messages, which communicate the action to be taken by the merchant. Each string must be a single message up to 100 characters long, must start with a capital letter (but not use all caps), and must end with a period. You must adhere to the message formatting rules or your requests will fail:

Examples:

  • Needs at least one image.
  • Needs to be a shippable product.

    • Merchants viewing individual products will see your app's messages as a bulleted list of errors. Other user interfaces in Shopify admin will report statistics like the number of errors your app has reported. Once the merchant has made a single or a series of updates to validate the product, your app can send a status ofsuccess.

    Was this section helpful?
    Anchor to section titled 'The Product ResourceFeedback resource'

    The Product ResourceFeedback resource

    Properties
    created_at
    deprecated
    DateTime when the resource feedback record was stored by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone.
    updated_at
    deprecated
    DateTime when the resource feedback record was last updated by Shopify. Type: ISO 8601 UTC DateTime as string with year, month (or week), day, hour, minute, second, time zone.
    resource_id
    read-only
    ->productId
    Unique id of the resource.
    resource_type
    read-only
    ->productId
    Type of resource for which feedback is returned. eg. Shop, Product.
    state
    ->state
    Indicates the state that the Shop or resource is in, from the perspective of your app.
    messages
    ->messages

    A concise set of copy strings to be displayed to merchants, to guide them in resolving problems your app encounters when trying to make use of their Shop and its resources.

    Required only when state is requires_action. Disallowed when state is success.

    Content restrictions for product feedback: ten messages up to 100 characters long.

    feedback_generated_at
    ->feedbackGeneratedAt

    The time at which the payload is constructed. Used to help determine whether incoming feedback is outdated compared to feedback already received, and if it should be ignored upon arrival. Type: ISO 8601 UTC DateTime as string with year, month [or week], day, hour, minute, second, millisecond, and time zone.

    Note

    If you queue a Feedback API payload for delivery at a later time, do not update this value when the API call is actually made; ensure that the current time is set when building the payload.

    resource_updated_at
    ->productUpdatedAt

    The forwarded updated_at timestamp of the product. Used only for versioned resources, where the updated_at timestamp changes based on merchant actions. When required, it is used along with feedback_generated_at to help determine whether incoming feedback is outdated compared to feedback already received, and if it should be ignored upon arrival.

    Was this section helpful?
    {}The Product ResourceFeedback resource
    {
  "created_at": "2024-09-19 14:10:57 UTC",
  "updated_at": "2024-09-19 14:10:57 UTC",
  "resource_id": 321,
  "resource_type": "Product",
  "state": "requires_action",
  "messages": [
    "Needs at least one image."
  ],
  "feedback_generated_at": "2024-09-19T14:10:57.144040Z",
  "resource_updated_at": "2024-09-19 14:10:57 UTC"
}
    Anchor to section titled 'POST request, Create a new Product ResourceFeedback'

    post
    Create a new Product ResourceFeedback

    bulkProductResourceFeedbackCreate

    Create product feedback.

    Anchor to section titled 'Parameters of Create a new Product ResourceFeedback'

    Parameters

    api_version
    string
    required
    feedback_generated_at
    required
    An ISO 8601 date and time indicating when the feedback was generated by your app.
    messages
    required
    An array containing up to ten messages.
    product_id
    string
    required
    resource_updated_at
    required
    The forwarded updated_at timestamp of the product.
    state
    required
    Must be one of the following values:
    Was this section helpful?
    Anchor to section titled 'Examples of Create a new Product ResourceFeedback'

    Examples

    Path parameters
    productid=632910392
    string
    required
    Was this section helpful?
    post
    /admin/api/2024-07/products/632910392/resource_feedback.json
    Copy
    curl -d '{"resource_feedback":{"state":"requires_action","messages":["Needs at least one image."],"resource_updated_at":"2024-09-19T10:50:00-04:00","feedback_generated_at":"2024-09-19T14:51:30.225719Z"}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2024-07/products/632910392/resource_feedback.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
    {}Response
    JSON
    HTTP/1.1 202 Accepted
{
  "resource_feedback": {
    "created_at": "2024-09-19T10:51:30-04:00",
    "updated_at": "2024-09-19T10:51:30-04:00",
    "resource_id": 632910392,
    "resource_type": "Product",
    "resource_updated_at": "2024-09-19T10:50:00-04:00",
    "messages": [
      "Needs at least one image."
    ],
    "feedback_generated_at": "2024-09-19T10:51:30-04:00",
    "state": "requires_action"
  }
}
    Anchor to section titled 'GET request, Receive a list of all Product ResourceFeedbacks'

    get
    Receive a list of all Product ResourceFeedbacks

    product
    Retrieve all product feedback from your app associated with the product.
    Anchor to section titled 'Parameters of Receive a list of all Product ResourceFeedbacks'

    Parameters

    api_version
    string
    required
    product_id
    string
    required
    product_id
    Retrieve feedback for a specific product, by product id.
    Was this section helpful?
    Anchor to section titled 'Examples of Receive a list of all Product ResourceFeedbacks'

    Examples

    Was this section helpful?
    get
    /admin/api/2024-07/products/632910392/resource_feedback.json
    Copy
    curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-07/products/632910392/resource_feedback.json" \
-H "X-Shopify-Access-Token: {access_token}"
    {}Response
    JSON
    HTTP/1.1 200 OK
{
  "resource_feedback": [
    {
      "created_at": "2024-09-19T10:51:26-04:00",
      "updated_at": "2024-09-19T10:51:26-04:00",
      "resource_id": 632910392,
      "resource_type": "Product",
      "resource_updated_at": "2024-09-19T10:50:00-04:00",
      "messages": [
        "Needs at least one image."
      ],
      "feedback_generated_at": "2024-09-19T09:51:26-04:00",
      "state": "requires_action"
    }
  ]
}