Requires read_shop access scope. For more access scope
The Shop Details API allows developers to fetch comprehensive information about a shop by using its unique identifier and configurable query parameters. This endpoint supports retrieving specific fields based on the user’s request. For instance, users can request key shop attributes such as id, name, and email.This API is especially useful for:
Retrieving store metadata like name, owner details, and operational settings.
Customizing query results by specifying required fields.
Verifying shop details through its unique domain prefix (shopdomain).Example: If the shop’s domain is https://store123.myshoplazza.com, the shopdomain would be store123.
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
["Context"]
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
HTTP Status Code
Error Message
Description
400
Bad Request
The request is malformed or contains invalid parameters.
401
UnauthorizedError
Missing or invalid authentication credentials.
404
store is not active
The requested store is inactive or unavailable.
500
Response message parsing error
Internal server error caused by a failure in parsing the response message.
520
No context
The request lacks sufficient context to process successfully.
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
