The Shop Properties object provides detailed metadata about a shop, including its identity, contact information, operational settings, and customization details. This information is used for managing and displaying shop-specific details within the system. Below is an improved breakdown of the fields, including clear descriptions and examples for better usability.
Requires
shopaccess scope. For more info, refer to:access scope
Shop properties
| Field | Type | Desc |
|---|---|---|
| id | integer | A unique identifier for the shop. |
| name | string | Shop name |
| string | The primary email address of the shop owner. | |
| domain | string | The shop’s custom domain |
| address1 | string | Street address, for example: 1 Rue des Carrieres |
| address2 | string | Apartment/floor/room number, for example: Suite 1234 |
| zip | string | ZIP code, for example: 87036 |
| city | string | City, for example: SAN JOSE |
| phone | string | The contact phone number of the shop, e.g.+86 150 1447 1143 |
| primary_locale | string | The primary language and locale settings of the shop, in IETF language tag format. |
| created_at | string | The timestamp indicating when the shop was created, in ISO 8601 format. |
| updated_at | string | The timestamp indicating when the shop’s information was last updated, in ISO 8601 format. |
| country_code | string | The country code of the shop’s location, in ISO 3166-1 alpha-2 format. US |
| currency | string | The currency code used by the shop, in ISO 4217 format, for example: USD |
| customer_email | string | Customer service email |
| timezone | string | The shop’s timezone offset from UTC. |
| shop_owner | string | The name or identifier of the shop owner. |
| account | string | Registered account |
| province_code | string | Province Code, for example: NM |
| root_url | string | |
| system_domain | string | Shop domain |
| icon | object | Shop logo |
| icon.alt | string | Logo alt text |
| icon.src | string | Logo link |
| icon.path | string | Logo file name |
Example
{
"account": "[email protected]",
"address1": "address1",
"address2": "",
"city": "city",
"country_code": "CN",
"created_at": "2023-11-08T11:51:39Z",
"currency": "USD",
"customer_email": "[email protected]",
"domain": "test-shoplazza.stg.myshoplaza.com",
"email": "[email protected]",
"icon": {
"alt": "",
"path": "55f1a60e47d1462c7d88dec3844369f0.png",
"src": "http://img.staticdj.com/55f1a60e47d1462c7d88dec3844369f0.png"
},
"id": 633130,
"name": "test-shoplazza",
"phone": "15014471143",
"primary_locale": "en-US",
"province_code": "CN-GD",
"root_url": "",
"shop_owner": "test-shoplazza",
"state": "available",
"system_domain": "test-shoplazza.stg.myshoplaza.com",
"timezone": "+0800",
"updated_at": "2024-04-29T09:18:01Z",
"zip": "515300"
}