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.
Requires access scope.
Important
Product ResourceFeedback is only for use with the Sales Channel SDK.
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
.
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.
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.
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.
Create product feedback.
updated_at
timestamp of the product.