get
https://{subdomain}.myshoplaza.com/openapi/2025-06/shop
The Get Shop 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.
Requiresread_shopaccess scope. More access scope
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
fields | string | No | Specifies which fields to include in the response. Use commas to separate multiple fields. | id,name,email |
Response Description
Public Response Fields
Success Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | Success | Response status code |
message | string | Operation result message | |
data.account | string | acc_123456 | Shop account identifier |
data.address1 | string | 123 Main Street | Primary address line |
data.address2 | string | Suite 456 | Secondary address line |
data.city | string | New York | City name |
data.country_code | string | US | ISO country code |
data.created_at | string | 2024-04-23T09:32:57+08:00 | Creation timestamp |
data.currency | string | USD | Shop currency |
data.customer_email | string | [email protected] | Shop owner email |
data.domain | string | shop.example.com | Custom domain |
data.email | string | [email protected] | Shop email |
data.icon.alt | string | Shop logo | Icon alternative text |
data.icon.path | string | /images/shop-icon.png | Icon file path |
data.icon.src | string | https://cdn.example.com/shop-icon.png | Icon URL |
data.id | integer | 123456 | Shop ID |
data.name | string | My Awesome Shop | Shop name |
data.phone | string | +1234567890 | Contact phone number |
data.primary_locale | string | en-US | Primary locale |
data.province_code | string | NY | State/province code |
data.root_url | string | https://shop.example.com | Shop root URL |
data.shop_owner | string | John Doe | Shop owner name |
data.state | string | New York | State/province name |
data.system_domain | string | example.myshoplaza.com | System domain |
data.timezone | string | America/New_York | Shop timezone |
data.updated_at | string | 2024-04-23T09:32:57+08:00 | Last update timestamp |
data.zip | string | 10001 | ZIP/postal code |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |