Shop Details

GET 
/openapi/2022-01/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

To specify which fields you wanna get, separated by comma, e.g. id,name,email

Responses

200

200

application/json

Schema

Schema

shop object
accountstring
Example: [email protected]
address1string
Example: address1
address2string
Example:
citystring
Example: city
country_codestring
Example: CN
created_atstring
Example: 2023-11-08T11:51:39Z
currencystring
Example: USD
customer_emailstring
Example: [email protected]
domainstring
Example: test-shoplazza.stg.myshoplaza.com
emailstring
Example: [email protected]
icon object
altstring
Example:
pathstring
Example: 55f1a60e47d1462c7d88dec3844369f0.png
srcstring
Example: http://img.staticdj.com/55f1a60e47d1462c7d88dec3844369f0.png
subscription object
typestring
Example: base
idinteger
Default value: 0
Example: 633130
namestring
Example: test-shoplazza
phonestring
Example: 15014471143
primary_localestring
Example: en-US
province_codestring
Example: CN-GD
root_urlstring
Example:
shop_ownerstring
Example: test-shoplazza
statestring
Example: available
system_domainstring
Example: test-shoplazza.stg.myshoplaza.com
timezonestring
Example: 800
updated_atstring
Example: 2024-04-29T09:18:01Z
zipstring
Example: 515300

Example

{
  "shop": {
    "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"
    },
    "subscription": {
      "type": "base"
    },
    "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": 800,
    "updated_at": "2024-04-29T09:18:01Z",
    "zip": "515300"
  }
}

Result

{
  "shop": {
    "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"
    },
     "subscription": {
        "type": "base"
      },
    "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"
  }
}

400

400

application/json

Schema

Schema

errorstring
Example: Unauthorized

Example

{
  "error": "Unauthorized"
}

Result

{
  "error": "Unauthorized"
}

401

401

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "header store id not exist"
  ]
}

Result

{ "errors": ["header store id not exist"] }

500

500

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Response message parsing error"
  ]
}

Result

{ "errors": ["Response message parsing error"] }

520

520

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "No Context"
  ]
}

Result

{ "errors": ["No Context"] }