Get shop

GET 
/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.

Request

Query Parameters

fields string[]

Specifies which fields to include in the response. Example: ?fields=id&fields=name

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

accountstring

Account of the shop

address1string

Address1 of the shop

address2string

Address2 of the shop

citystring

City of the shop

country_codestring

Country code of the shop

created_atstring

Created time of the shop

currencystring

Currency of the shop

customer_emailstring

Customer email of the shop

domainstring

Domain of the shop

emailstring

Email of the shop

icon object

Icon of the shop

altstring

Alt of the icon

pathstring

Path of the icon

srcstring

Src of the icon

subscription object

Subscription status of the shop

typestring

The type of the subscription

idint32

ID of the shop

namestring

Name of the shop

phonestring

Phone of the shop

primary_localestring

Primary locale of the shop

province_codestring

Province of the shop

root_urlstring

Root URL of the shop

shop_ownerstring

Owner of the shop

statestring

State or province of the shop

system_domainstring

The system domain of the shop

timezonestring

The timezone of the shop

updated_atstring

The updated time of the shop

zipstring

The zip of the shop

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "account": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "country_code": "string",
    "created_at": "string",
    "currency": "string",
    "customer_email": "string",
    "domain": "string",
    "email": "string",
    "icon": {
      "alt": "string",
      "path": "string",
      "src": "string"
    },
    "subscription": {
      "type": "string"
    },
    "id": 0,
    "name": "string",
    "phone": "string",
    "primary_locale": "string",
    "province_code": "string",
    "root_url": "string",
    "shop_owner": "string",
    "state": "string",
    "system_domain": "string",
    "timezone": "string",
    "updated_at": "string",
    "zip": "string"
  }
}