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

POST /api/202412/shops/location: Create warehouse location

PUT /api/202412/shops/locations/{locationId}: Update warehouse location

DELETE /api/202412/shops/locations/{locationId}: Delete warehouse location

GET /api/202412/shops/info: Get shop details

GET /api/202412/shops/locations/count: Get warehouse locations count

GET /api/202412/shops/locations/{locationId}: Get warehouse location details

GET /api/202412/shops/languages: Get language list

GET /api/202412/shops/locations: Get location list

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"
  }
}

POST Create warehouse location ​

Create a warehouse location.

Access scope

Requires ANY of the following access scopes: write_shops

Endpoint

POST /api/202412/shops/location 

Request Params

locationobject
Location information of the warehouse.
- Hide child properties
locationNamestring
countrystring
provincestring
citystring
address1string
address2string
zipcodestring
phonestring
latitudestring
longitudestring

Response Data

locationobject
Location information of the warehouse.
- Hide child properties
locationNamestring
The name of the warehousing location.
countrystring
The country and region code of the warehousing address.
provincestring
The provincial - level unit code of the warehousing address.
citystring
The city of the warehousing address, which is filled in by merchants.
address1string
The location's street address.
address2string
The optional second line of the location's street address.
zipcodestring
The zip or postal code.
phonestring
The phone number of the location.
latitudestring
The latitude of the warehouse.
longitudestring
The longitude of the warehouse.
locationIdnumber
The ID of the warehousing location.
isDefaultboolean
Whether it is the default warehousing address or not.
stopStatusboolean
Has this warehousing address been stoped.
bash
curl -X POST \ 
https://{shop}.genmystore.com/api/202412/shops/location" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"location":{
		"zipcode":"k1n5t5",
		"country":"US",
		"locationName":"Shanghai warehousing",
		"province":"PN",
		"city":"上海市",
		"address2":"Unit 42",
		"phone":"86-13112341234",
		"address1":"126 York Street",
		"latitude":"36.30556423523153",
		"longitude":"104.48060937499996"
	}
}'
json
HTTP/1.1 200 OK
{
  "location": {
    "country": "US",
    "locationName": "Shanghai warehousing",
    "city": "上海市",
    "address2": "Unit 42",
    "address1": "126 York Street",
    "latitude": "36.30556423523153",
    "zipcode": "k1n5t5",
    "isDefault": "true",
    "province": "PN",
    "phone": "86-13112341234",
    "locationId": "1234657809123",
    "stopStatus": "true",
    "longitude": "104.48060937499996"
  }
}

PUT Update warehouse location ​

Update the warehouse location.

Access scope

Requires ANY of the following access scopes: write_shops

Endpoint

PUT /api/202412/shops/locations/{locationId} 

Request Params

locationobject
- Hide child properties
locationNamestring
The name of the warehousing location.
countrystring
The country and region code of the warehousing address.
provincestring
The provincial - level unit code of the warehousing address.
citystring
The city of the warehousing address, which is filled in by merchants.
address1string
The location's street address.
address2string
The optional second line of the location's street address.
zipcodestring
The zip or postal code.
phonestring
The phone number of the location.
latitudestring
The latitude of the warehouse.
longitudestring
The longitude of the warehouse.
locationIdnumber
The ID of the warehousing location.

Response Data

{}
bash
curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/shops/locations/{locationId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"location":{
		"zipcode":"k1n5t5",
		"country":"US",
		"locationName":"Shanghai warehousing",
		"province":"PN",
		"city":"上海市",
		"address2":"Unit 42",
		"phone":"86-13112341234",
		"address1":"126 York Street",
		"locationId":"12345",
		"latitude":"36.30556423523153",
		"longitude":"104.48060937499996"
	}
}'
json
HTTP/1.1 200 OK
{}

DELETE Delete warehouse location ​

Delete the warehousing location.

Access scope

Requires ANY of the following access scopes: write_shops

Endpoint

DELETE /api/202412/shops/locations/{locationId} 

Request Params

locationIdnumber
The warehouse location ID.

Response Data

{}
bash
curl -X DELETE \ 
https://{shop}.genmystore.com/api/202412/shops/locations/{locationId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{}

GET Get shop details ​

Get store basic information.

Access scope

Requires ANY of the following access scopes: read_shops write_shops

Endpoint

GET /api/202412/shops/info 

Request Params

{}

Response Data

shopobject
Information of the shop.
- 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).
originDomainstring
The domain assigned by the store initialization.
shopStatusnumber
The status of Shop. 0: disabled, 1: trial version, 2: pay version, 3: arrearage
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/info" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "shop": {
    "country": "US",
    "mail": "[email protected]",
    "timezone": "-4",
    "shopName": "Sun's Shop",
    "description": "This is a test shop descirption",
    "originDomain": "aaa.genstore.com",
    "shopStatus": "1",
    "domain": "online-shop.genstore.com",
    "logo": "https: //statics.genstore.com/folder/qefadfasdfafwerw.png",
    "currency": "USD",
    "shopId": "1234567890",
    "ianaTimezone": "America/New_York",
    "weightUnit": "kg"
  }
}

GET Get warehouse locations count ​

Get the count of warehouse locations.

Access scope

Requires ANY of the following access scopes: read_shops write_shops

Endpoint

GET /api/202412/shops/locations/count 

Request Params

{}

Response Data

countnumber
The number of warehouse locations.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/locations/count" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "count": "123"
}

GET Get warehouse location details ​

Get the details of the warehouse locations.

Access scope

Requires ANY of the following access scopes: read_shops write_shops

Endpoint

GET /api/202412/shops/locations/{locationId} 

Request Params

locationIdnumber
The ID of the warehouse.

Response Data

locationobject
The information of the warehouse location.
- Hide child properties
locationNamestring
The name of the warehousing location.
countrystring
The country and region code of the warehousing address.
provincestring
The provincial - level unit code of the warehousing address.
citystring
The city of the warehousing address, which is filled in by merchants.
address1string
The location's street address.
address2string
The optional second line of the location's street address.
zipcodestring
The zip or postal code.
phonestring
The phone number of the location.
latitudestring
The latitude of the warehouse.
longitudestring
The longitude of the warehouse.
locationIdnumber
The ID of the warehousing location.
isDefaultboolean
Whether it is the default warehousing address or not.
stopStatusboolean
Has this warehousing address been stoped.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/locations/{locationId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "location": {
    "country": "US",
    "locationName": "Shanghai warehousing",
    "city": "上海市",
    "address2": "Unit 42",
    "address1": "126 York Street",
    "latitude": "36.30556423523153",
    "zipcode": "k1n5t5",
    "isDefault": "true",
    "province": "PN",
    "phone": "86-13112341234",
    "locationId": "1234657809123",
    "stopStatus": "true",
    "longitude": "104.48060937499996"
  }
}

GET Get language list ​

Get a list of languages supported by the store.

Access scope

Requires ANY of the following access scopes: read_shops write_shops

Endpoint

GET /api/202412/shops/languages 

Request Params

{}

Response Data

languagesobject
List of languages.
- Hide child properties
publishedListarray
List of published languages.
+ Show child properties
unPublishedListarray
List of unpublished languages.
+ Show child properties
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/languages" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "languages": {
    "publishedList": [
      {
        "translateStatus": "true",
        "isDefault": "true",
        "language": "en-US"
      }
    ],
    "unPublishedList": [
      {
        "translateStatus": "false",
        "isDefault": "false",
        "language": "zh-CN"
      }
    ]
  }
}

GET Get location list ​

Retrieve a list of store locations using infinite scrolling pagination.

Access scope

Requires ANY of the following access scopes: read_shops write_shops

Endpoint

GET /api/202412/shops/locations 

Request Params

pageTokenstring
Parameters for infinite scrolling pagination. Leave empty for the first request.
limitnumber
Pagination size limit, Default limit is 10.

Response Data

locationsobject
Warehouse list information.
- Hide child properties
countrystring
The country and region code of the warehousing address.
locationNamestring
The name of the warehousing location.
citystring
The city of the warehousing address, which is filled in by merchants.
address2string
The optional second line of the location's street address.
address1string
The location's street address.
latitudestring
The latitude of the warehouse.
zipcodestring
The zip or postal code.
isDefaultboolean
Whether it is the default warehousing address or not.
provincestring
The provincial - level unit code of the warehousing address.
phonestring
The phone number of the location.
locationIdnumber
The ID of the warehousing location.
stopStatusboolean
Has this warehousing address been stoped.
longitudestring
The longitude of the warehouse.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/shops/locations" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "locations": {
    "country": "US",
    "locationName": "Shanghai warehousing",
    "city": "上海市",
    "address2": "Unit 42",
    "address1": "126 York Street",
    "latitude": "36.30556423523153",
    "zipcode": "200000",
    "isDefault": "true",
    "province": "PN",
    "phone": "86-13112341234",
    "locationId": "1234657809123",
    "stopStatus": "true",
    "longitude": "104.48060937499996"
  }
}