Query store information

Requires read_store_information access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20260301/merchants/shop.json

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 .

Query a store's information, including the store ID, store name, primary domain, currency, and other details.

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 to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Status Codes

For the complete list of codes and messages, see Http status code.

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

dataobject

Response data.
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

Example: 1
created_at string

The date and time when the store was created. Format: ISO 8601. Example: 2023-04-12T22:59:52+08:00
Example: 2023-04-12T22:59:52+08:00
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 standard. For example, USD.
Example: USD
customer_email string

The merchant's email address for customer communication.
Example: bar@shopline.com
domain string

Primary domain for a store. Example: handle.myshopline.com.
Example: handle.myshopline.com
email string

The merchant's email address used for communication with SHOPLINE.
Example: foo@shoplineapp.com
iana_timezone string

The IANA time zone set for the store.
Example: Asia/Shanghai
id long

The store's unique identifier.
Example: 1631700219512
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.
Example: en
location_country_code string

The country or region code where the store is located, following ISO 3611-1 international standards. Example: US.
Example: CN
merchant_id string

The corresponding ID for the store's merchant.
Example: 4216472541
name string

The name of the store.
Example: Shopline
sales_channelsobject[]

A list of sales channels currently installed in the store.
channel_handle string

The unique identifier for the sales channel.
Example: web
standard_logo string

The standard logo used for the store.
Example: https://d2w9suv6wak03e.cloudfront.net/image/store/3100111249/1624603774370/32c8ea2e39ad480fa7a94d36ce013f25.png?w=102&h=113
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. Example: 2023-04-12T22:59:52+08:00.
Example: 2021-09-16T13:03:48+08:00

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/merchants/shop.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal