--- title: "Query store information" description: > Query a store's information, including the store ID, store name, primary domain, currency, and other details. doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/admin-rest-api/store/query-store-information' md: 'https://developer.shopline.com/docs/admin-rest-api/store/query-store-information.md' --- # Query store information Query a store's information, including the store ID, store name, primary domain, currency, and other details. - **Base URL:** `https://{handle}.myshopline.com/admin/openapi` - **Required Scopes:** `read_store_information` - **API Version:** v20270301 - **API Type:** Admin - **API Protocol:** RESTful ## Endpoint ```http GET /merchants/shop.json ``` ## Base URL * `https://{handle}.myshopline.com/admin/openapi` * `{handle}`: `handle` : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is `open001.myshopline.com` , the store handle is `open001` . ## Required Permissions * `read_store_information` ## Request ### Request Headers * `Content-Type` string (required) The field must be set to the fixed value `application/json; charset=utf-8`. * `Authorization` string (required) The access token for the API resource. Refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ## Response ### Status Codes * `200` For the complete list of codes and messages, see [Http status code](https://developer.shopline.com/docs/apps/api-instructions-for-use/http-status-code.md?lang=en). * `401` * `429` ### Response Headers * `traceId` A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise. ### Response Body #### 200 * `data` object Response data. * `domain` string Primary domain for a store. Example: `handle.myshopline.com`. * `iana_timezone` string The [IANA time zone](https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab) set for the store. * `location_country_code` string The country or region code where the store is located, following [`ISO 3611-1`](https://en.wikipedia.org/wiki/ISO_3166-1) international standards. Example: `US`. * `updated_at` string The update date and time for the store's basic settings, including the store name, domain name, transaction currency, email, and time zone. Format: [`ISO 8601`](https://en.wikipedia.org/wiki/ISO_8601). Example: `2023-04-12T22:59:52+08:00`. * `created_at` string The date and time when the store was created. Format: [`ISO 8601`](https://en.wikipedia.org/wiki/ISO_8601). Example: `2023-04-12T22:59:52+08:00` * `email` string The merchant's email address used for communication with SHOPLINE. * `language` string The default language used for merchant-customer communication in the message center. You can change this in the SHOPLINE Admin under Settings > Languages. * `merchant_id` string The corresponding ID for the store's merchant. * `standard_logo` string The standard logo used for the store. * `biz_store_status` integer The business status of the store. Valid values are: - `1`: To be activated - `2`: Open - `3`: Closed - `4`: Frozen - `5`: Deactivated * `currency` string The settlement currency used by the buyer when placing orders in the store. The value of this parameter is a three-letter currency code that follows the [`ISO 4217`](https://en.wikipedia.org/wiki/ISO_4217) standard. For example, `USD`. * `customer_email` string The merchant's email address for customer communication. * `id` long The store's unique identifier. * `sales_channels` array A list of sales channels currently installed in the store. * `channel_handle` string The unique identifier for the sales channel. * `name` string The name of the store. #### 401 * `errors` string Error message. #### 429 * `errors` string Error message. ## OpenAPI Definition ```json { "tags": [ "Query store information" ], "description": "Query a store's information, including the store ID, store name, primary domain, currency, and other details.", "externalDocs": { "description": "Permission point used by the interface is `read_store_information` , For more information about the use of permission points, see", "url": "ec20/3cv5d7wpfgr6a8z5/xabczf5442284vkq?lang=en", "errorTableDescription": "" }, "operationId": "v9nbZbRk", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The field must be set to the fixed value `application/json; charset=utf-8`.", "required": true, "schema": { "name": "Content-Type", "type": "string", "example": "application/json; charset=utf-8" } }, { "name": "Authorization", "in": "header", "description": " The access token for the API resource. Refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ", "required": true, "style": "string", "schema": { "name": "Authorization", "description": " The access token for the API resource. Refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ", "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" }, "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" } ], "responses": { "200": { "description": "For the complete list of codes and messages, see [Http status code](https://developer.shopline.com/docs/apps/api-instructions-for-use/http-status-code.md?lang=en).", "headers": { "traceId": { "description": "A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise." } }, "content": { "application/json": { "schema": { "name": "body", "type": "object", "properties": { "data": { "name": "data", "description": "Response data.", "type": "object", "properties": { "domain": { "name": "domain", "description": "Primary domain for a store.\nExample: `handle.myshopline.com`.", "type": "string", "example": "handle.myshopline.com" }, "iana_timezone": { "name": "iana_timezone", "description": "The [IANA time zone](https://data.iana.org/time-zones/tzdb-2021a/zone1970.tab) set for the store.", "type": "string", "example": "Asia/Shanghai" }, "location_country_code": { "name": "location_country_code", "description": "The country or region code where the store is located, following [`ISO 3611-1`](https://en.wikipedia.org/wiki/ISO_3166-1) international standards. Example: `US`.", "type": "string", "example": "CN" }, "updated_at": { "name": "updated_at", "description": "The update date and time for the store's basic settings, including the store name, domain name, transaction currency, email, and time zone. Format: [`ISO 8601`](https://en.wikipedia.org/wiki/ISO_8601).\nExample: `2023-04-12T22:59:52+08:00`.", "type": "string", "example": "2021-09-16T13:03:48+08:00" }, "created_at": { "name": "created_at", "description": "The date and time when the store was created. Format: [`ISO 8601`](https://en.wikipedia.org/wiki/ISO_8601).\nExample: `2023-04-12T22:59:52+08:00`", "type": "string", "example": "2023-04-12T22:59:52+08:00" }, "email": { "name": "email", "description": "The merchant's email address used for communication with SHOPLINE. ", "type": "string", "example": "foo@shoplineapp.com" }, "language": { "name": "language", "description": "The default language used for merchant-customer communication in the message center. You can change this in the SHOPLINE Admin under Settings > Languages.", "type": "string", "example": "en" }, "merchant_id": { "name": "merchant_id", "description": "The corresponding ID for the store's merchant.", "type": "string", "example": "4216472541" }, "standard_logo": { "name": "standard_logo", "description": "The standard logo used for the store.", "type": "string", "example": "https://d2w9suv6wak03e.cloudfront.net/image/store/3100111249/1624603774370/32c8ea2e39ad480fa7a94d36ce013f25.png?w=102&h=113" }, "biz_store_status": { "name": "biz_store_status", "description": "The business status of the store. Valid values are:\n- `1`: To be activated\n- `2`: Open\n- `3`: Closed\n- `4`: Frozen\n- `5`: Deactivated", "type": "integer", "example": 1 }, "currency": { "name": "currency", "description": "The settlement currency used by the buyer when placing orders in the store. The value of this parameter is a three-letter currency code that follows the [`ISO 4217`](https://en.wikipedia.org/wiki/ISO_4217) standard. For example, `USD`.", "type": "string", "example": "USD" }, "customer_email": { "name": "customer_email", "description": "The merchant's email address for customer communication.", "type": "string", "example": "bar@shopline.com" }, "id": { "name": "id", "description": "The store's unique identifier.", "type": "long", "example": 1631700219512 }, "sales_channels": { "name": "sales_channels", "description": "A list of sales channels currently installed in the store.", "type": "array", "items": { "type": "object", "properties": { "channel_handle": { "name": "channel_handle", "description": "The unique identifier for the sales channel.", "type": "string", "example": "web" } }, "example": { "channel_handle": "web" } }, "example": [ { "channel_handle": "web" } ] }, "name": { "name": "name", "description": "The name of the store.", "type": "string", "example": "Shopline" } }, "example": { "currency": "USD", "updated_at": "2021-09-16T13:03:48+08:00", "biz_store_status": 1, "customer_email": "bar@shopline.com", "iana_timezone": "Asia/Shanghai", "language": "en", "location_country_code": "CN", "merchant_id": "4216472541", "sales_channels": [ { "channel_handle": "web" } ], "standard_logo": "https://d2w9suv6wak03e.cloudfront.net/image/store/3100111249/1624603774370/32c8ea2e39ad480fa7a94d36ce013f25.png?w=102&h=113", "email": "foo@shoplineapp.com", "id": 1631700219512, "created_at": "2023-04-12T22:59:52+08:00", "domain": "handle.myshopline.com", "name": "Shopline" } } }, "example": { "data": { "currency": "USD", "email": "foo@shoplineapp.com", "name": "Shopline", "sales_channels": [ { "channel_handle": "web" } ], "standard_logo": "https://d2w9suv6wak03e.cloudfront.net/image/store/3100111249/1624603774370/32c8ea2e39ad480fa7a94d36ce013f25.png?w=102&h=113", "biz_store_status": 1, "id": 1631700219512, "location_country_code": "CN", "created_at": "2023-04-12T22:59:52+08:00", "customer_email": "bar@shopline.com", "iana_timezone": "Asia/Shanghai", "updated_at": "2021-09-16T13:03:48+08:00", "domain": "handle.myshopline.com", "language": "en", "merchant_id": "4216472541" } } }, "examples": { "Query a store's information.": { "description": "Query a store's information, including the store ID, store name, primary domain, currency, and other details.", "value": { "data": { "email": "openapi_v2@shoplineapp.com", "sales_channels": [ { "channel_handle": "web" }, { "channel_handle": "post" }, { "channel_handle": "google" }, { "channel_handle": "whatsapp" }, { "channel_handle": "facebook" }, { "channel_handle": "telegram" }, { "channel_handle": "live" } ], "currency": "USD", "language": "en", "location_country_code": "CN", "updated_at": "2024-07-09T16:27:46+08:00", "created_at": "2022-12-30T11:06:43+08:00", "iana_timezone": "Asia/Shanghai", "name": "OpenAPI 测试店铺", "standard_logo": "", "biz_store_status": 2, "customer_email": "ssc56474@gmail.com", "domain": "openapiceshidianpu.preview.myshopline.com", "id": 1672369729606, "merchant_id": "2000234880" } } } } } } }, "401": { "headers": { "traceId": { "description": "A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Error message. ", "type": "string" } }, "required": [ "errors" ] } } } }, "429": { "headers": { "traceId": { "description": "A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Error message. ", "type": "string" } }, "required": [ "errors" ] } } } } }, "security": [ { "oauth2": [] } ], "method": "get", "path": "/merchants/shop.json", "servers": [ { "url": "https://{handle}.myshopline.com/admin/openapi", "variables": { "handle": { "default": "openapiceshidianpu", "description": "`handle` : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is `open001.myshopline.com` , the store handle is `open001` ." } } } ], "info": { "title": "Query store information", "version": "v20270301" }, "authIndexes": [ "read_store_information" ] } ```