English

简体中文

English

简体中文

Appearance

About Shop ​

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Store management is a foundational component of Genstore merchant operations. It enables merchants to maintain store information across multiple locations. This module handles essential store data including names, domains, contact information, addresses, and time zones.

Core Features

  • Get Store Info: Access basic store information including name, domain, and contact details.
  • Get Location Details: Retrieve information for a specific store location.
  • Create Location: Add a new store location to the system.
  • Update Location: Modify existing store location information.
  • Delete Location: Remove a store location from the system.
  • List Locations: Fetch store locations with scroll pagination.
  • Count Locations: Get total number of store locations.

Use Cases

  • Smart Notifications: Time zone-based notification system helps merchants:
    • Send notifications at appropriate hours.
    • Deliver rewards when customers are active.
    • Improve engagement through better timing.
  • Store Info Management: Operations teams maintain accurate store details for customer access.
  • Multi-location Operations: Merchants efficiently manage multiple store locations from a single interface.

Endpoints

EVENT shop/update: Shop info update

EVENT shop/redact: Requests to delete shop data

Shop Object ​

A shop object

Properties ​

shopobject
Represents the shop information
- Hide child properties
shopIdnumber
Shop's unique identifier, A 64-bit integer.
shopNamestring
The name of the shop.
domainstring
The shop's domain.
descriptionstring
The shop's description.
logostring
The shop's logo. it will display in shop web page.
mailstring
The email address of the store, which users can use to contact the merchants.
countrystring
The shop's country code, 2 letters.
currencystring
The main currency of the store adopts the three-character code in accordance with the ISO 4217 standard.
timezonestring
The time zone of the store.
ianaTimezonestring
The name of the timezone assigned by the IANA.
weightUnitstring
The weight units of the store, with optional values of lb (pound), oz (ounce), g (gram), and kg (kilogram).
bash
{
  "shop": {
    "country": "US",
    "mail": "[email protected]",
    "timezone": "-4",
    "domain": "online-shop.genstore.com",
    "shopName": "Sun's Shop",
    "description": "This is a test shop descirption",
    "logo": "https://statics.genstore.com/folder/qefadfasdfafwerw.png",
    "currency": "USD",
    "shopId": "1234567890",
    "ianaTimezone": "America/New_York",
    "weightUnit": "kg"
  }
}

EVENT Shop info update ​

Notify external services of store information changes.

Access scope

Requires ANY of the following access scopes: read_shops write_shops

Topic

EVENT shop/update 

Event Data

shopobject
The shop info.
- Hide child properties
shopIdnumber
The ID for the shop. A 64-bit integer.
shopNamestring
The name of the shop.
domainstring
The shop's domain.
descriptionstring
The shop's description.
logostring
The shop's logo. it will display in shop web page.
mailstring
The email address of the store, which users can use to contact the merchants.
countrystring
The shop's country code, 2 letters.
currencystring
The main currency of the store adopts the three-character code in accordance with the ISO 4217 standard.
timezonestring
The time zone of the store.
ianaTimezonestring
The name of the timezone assigned by the IANA.
weightUnitstring
The weight units of the store, with optional values of lb (pound), oz (ounce), g (gram), and kg (kilogram).
shopStatusnumber
The status of Shop. Enumeration value: 0 - disabled, 1 - trial version, 2 - pay version, 3 - arrearage
json
{
  "shop": {
    "country": "US",
    "shopStatus": "",
    "mail": "[email protected]",
    "timezone": "-4",
    "domain": "online-shop.genstore.com",
    "shopName": "Sun's Shop",
    "description": "This is a test shop descirption",
    "logo": "https: //statics.genstore.com/folder/qefadfasdfafwerw.png",
    "currency": "USD",
    "shopId": "1234567890",
    "ianaTimezone": "America/New_York",
    "weightUnit": "kg"
  }
}

EVENT Requests to delete shop data ​

Requests to delete shop data.

Access scope

Requires ANY of the following access scopes: read_shops write_shops

Topic

EVENT shop/redact 

Event Data

shopIdnumber
The id of the shop, Long type, 64bit integer.
shopDomainstring
The Shop's init domain, with value like {shopCode}.genmystore.com
json
{
  "shopDomain": "aaaa.genmystore.com",
  "shopId": "1234"
}