Get Shop
curl --request GET \
--url https://api.launchmystore.io/api/v1/shop.json \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.launchmystore.io/api/v1/shop.json"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.launchmystore.io/api/v1/shop.json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.launchmystore.io/api/v1/shop.json",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.launchmystore.io/api/v1/shop.json"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.launchmystore.io/api/v1/shop.json")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.launchmystore.io/api/v1/shop.json")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 123,
"state": "<string>",
"message": "<string>",
"data": {
"shop": {
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"businessEmail": "<string>",
"ownerName": "<string>",
"business": "<string>",
"phone": "<string>",
"storeURL": "<string>",
"storeAdd": "<string>",
"country": "<string>",
"category": "<string>",
"gstNumber": "<string>",
"isProfileComplete": true,
"availableCountries": [
{}
],
"availableLanguages": [
{}
],
"defaultLanguage": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}Shop
Get Shop
Retrieve shop information and settings
GET
/
api
/
v1
/
shop.json
Get Shop
curl --request GET \
--url https://api.launchmystore.io/api/v1/shop.json \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.launchmystore.io/api/v1/shop.json"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.launchmystore.io/api/v1/shop.json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.launchmystore.io/api/v1/shop.json",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.launchmystore.io/api/v1/shop.json"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.launchmystore.io/api/v1/shop.json")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.launchmystore.io/api/v1/shop.json")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 123,
"state": "<string>",
"message": "<string>",
"data": {
"shop": {
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"businessEmail": "<string>",
"ownerName": "<string>",
"business": "<string>",
"phone": "<string>",
"storeURL": "<string>",
"storeAdd": "<string>",
"country": "<string>",
"category": "<string>",
"gstNumber": "<string>",
"isProfileComplete": true,
"availableCountries": [
{}
],
"availableLanguages": [
{}
],
"defaultLanguage": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}Get Shop
Returns a curated, store-descriptive view of the shop account. The response is an allow-list of safe fields — financial data (balances, wallet / credit balances, payout state), billing and Stripe Connect identifiers, referral data, IP, 2FA state, POS permissions, and other internal account columns are never included, regardless of scope.Request
curl -X GET "https://api.launchmystore.io/api/v1/shop.json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
const response = await fetch('https://api.launchmystore.io/api/v1/shop.json', {
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
}
});
Response
The response uses the standard envelope. The shop record is nested underdata.shop.
integer
HTTP status code (e.g.,
200)string
Result state —
success on success, error on failurestring
Human-readable message, or
null on successobject
Response data wrapper
Show data
Show data
object
The shop account object
Show Shop Object
Show Shop Object
string
Unique shop ID
string
Shop name (falls back to the business name when unset)
string
Store host derived from
storeURL (e.g. mystore.launchmystore.io
or www.custom-domain.com), scheme strippedstring
Business contact email (the account login email is not exposed)
string
Store owner name
string
Business / legal name
string
Shop phone number
string
Store URL
string
Store address
string
Store country (drives the store’s currency)
string
Store category / industry
string
Tax registration number, when set
boolean
Whether the merchant finished store onboarding
array
Countries the store ships to / supports
array
Language codes enabled for the store
string
Default / primary language code
string
Shop creation timestamp (ISO 8601)
string
Last update timestamp (ISO 8601)
This endpoint returns only the allow-listed fields documented above. Account
balances, wallet/credit balances, payout and billing state, Stripe Connect
identifiers, referral data, IP, 2FA state, POS permissions, the login email,
and every other internal column are never returned — a
read_shop app sees
only store-descriptive data.Example Response
{
"status": 200,
"state": "success",
"message": null,
"data": {
"shop": {
"id": "9f1c2b7e-3d4a-4f6b-8c1d-2e5a6b7c8d90",
"name": "My Awesome Store",
"business": "My Awesome Store LLC",
"domain": "mystore.launchmystore.io",
"businessEmail": "billing@mystore.com",
"ownerName": "Jane Doe",
"phone": "+1 (555) 123-4567",
"storeURL": "https://mystore.launchmystore.io",
"storeAdd": "123 Commerce St, San Francisco, CA 94102",
"country": "United States",
"category": "Apparel",
"gstNumber": null,
"isProfileComplete": true,
"availableCountries": ["United States", "Canada"],
"availableLanguages": ["en"],
"defaultLanguage": "en",
"createdAt": "2023-01-15T10:00:00.000Z",
"updatedAt": "2024-03-20T14:30:00.000Z"
}
},
"count": null,
"pagination": null
}
Error Response
Errors return the same envelope withstate set to error and a message.
{
"status": 404,
"state": "error",
"message": "Shop not found",
"data": null
}
| Status | Description |
|---|---|
401 | Invalid or missing access token |
403 | App doesn’t have read_shop scope |
404 | Shop not found |