The Update Shop API updates shop-related information, such as the customer email. It ensures secure and validated updates to a shop's data. This API is especially useful for: 1. Updating customer-related shop details. 2. Managing shop information programmatically.
🔒
Requires write_shop access scope. For more access scope
The Update Shop API updates shop-related information, such as the customer email. It ensures secure and validated updates to a shop's data.
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "Collection not found"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
String
"store is not active"
Indicates an error encountered during the process
Error Detail
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
