createNewStoreLocation - StoreHarmony API

Request

Path Params

accountid

string

required

ID of the account user requesting the switch

Header Params

sessiontoken

string

required

Body Params application/json

storeinfo

object (StoreFinancialInfo)

optional

Details of the store VAT or currency

taxRate

number <double>

required

The tax rate applicable to the store's transactions, expressed as a decimal (e.g., 0.15 for 15% tax).

>= 0<= 100

vatType

string

required

The type of VAT applied to the store, such as standard rate, reduced rate, or zero rate.

Match pattern:

inclusive|exclusive

currency

string

required

The currency code for the store's transactions, in 3-letter ISO 4217 format (e.g., USD, EUR).

Match pattern:

^[A-Z]{3}$

storeName

string

optional

storeCountry

string

optional

storeState

string

optional

storeCity

string

optional

storeFullAddress

string

optional

storeLocLat

string

optional

storeLocLng

string

optional

storeCountryCode

string

optional

storeStateCode

string

optional

storeCityCode

string

optional

email

string

optional

mobile

string

optional

storeProfileType

string

optional

storeUsers

integer <int32>

optional

licensePlan

string

optional

Example

{
  "storeinfo": {
    "taxRate": 0,
    "vatType": "string",
    "currency": "string"
  },
  "storeName": "string",
  "storeCountry": "string",
  "storeState": "string",
  "storeCity": "string",
  "storeFullAddress": "string",
  "storeLocLat": "string",
  "storeLocLng": "string",
  "storeCountryCode": "string",
  "storeStateCode": "string",
  "storeCityCode": "string",
  "email": "string",
  "mobile": "string",
  "storeProfileType": "string",
  "storeUsers": 0,
  "licensePlan": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://gateway.storeharmony.com/cloudapi/user//createNewLocation' \
--header 'sessiontoken;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "storeinfo": {
        "taxRate": 0,
        "vatType": "string",
        "currency": "string"
    },
    "storeName": "string",
    "storeCountry": "string",
    "storeState": "string",
    "storeCity": "string",
    "storeFullAddress": "string",
    "storeLocLat": "string",
    "storeLocLng": "string",
    "storeCountryCode": "string",
    "storeStateCode": "string",
    "storeCityCode": "string",
    "email": "string",
    "mobile": "string",
    "storeProfileType": "string",
    "storeUsers": 0,
    "licensePlan": "string"
}'

Responses

🟢200OK

*/*

OK

Body

accessToken

string

optional

sessionId

string

optional

originalStoreId

string

optional

success

boolean

optional

sitename

string

optional

siteTitle

string

optional

siteSEO

string

optional

domain

string

optional

businessname

string

optional

address

string

optional

stateOfCountry

string

optional

country

string

optional

insuranceTrackId

string

optional

licensePlan

string

optional

id

string

optional

category

string

optional

logoPath

string

optional

emailAddress

string

optional

contactPhone

string

optional

contactPhone2

string

optional

facebookId

string

optional

twitterId

string

optional

instagramId

string

optional

youtubechannel

string

optional

whatsappline

string

optional

currency

string

optional

cacNo

string

optional

bvnNo

string

optional

tinNo

string

optional

aboutStore

string

optional

openingTime

string

optional

closingTime

string

optional

userClass

string

optional

taxRate

number <double>

optional

taxType

string

optional

faviconurl

string

optional

storeGpsLatitude

number <double>

optional

storeGpsLongitude

number <double>

optional

businessTagline

string

optional

storePolicy

string

optional

storeRole

string

optional

contactEmail2

string

optional

basicStoreInfo

string

optional

aboutUs

string

optional

cloudOnlyStore

boolean

optional

enableLiveStore

boolean

optional

defaultCustomerName

string

optional

customerId

string

optional

newPassword

string

optional

oldPassword

string

optional

staffId

string

optional

logo

string

optional

seoTags

string

optional

tagLine

string

optional

secondarySiteThemeColor

string

optional

primarySiteThemeColor

string

optional

primaryButtonColor

string

optional

primaryThemeFont

string

optional

mergeWithCentral

boolean

optional

defaultGateway

object (PaymentGatewayInfo)

optional

gatewayProviderName

string

optional

gatewayType

string

optional

policyRemark

string

optional

features

object (Features)

optional

primaryColor

string

optional

helpline

string

optional

whatsappNo

string

optional

contactEmail

string

optional

contactAddress

string

optional

skypeAddress

string

optional

facebookPage

string

optional

youtubePage

string

optional

googlePlus

string

optional

skypeId

string

optional

transxIdPref

string

optional

googleCredentials

string

optional

reserveOrderSupport

boolean

optional

pinterestSupport

string

optional

deliverytime

integer <int32>

optional

returnsSupported

boolean

optional

cashOnDelivery

boolean

optional

socialMediaEnabled

boolean

optional

promoOngoing

boolean

optional

realtimeEnabled

boolean

optional

wholesaleEnabled

boolean

optional

mobileAppEnabled

boolean

optional

mobileAppLink

string

optional

vatType

string

optional

gpsLat

number <double>

optional

gpsLng

number <double>

optional

partners

array[string]

optional

gpsEnabled

boolean

optional

defaultBank

object (BankAccountData)

optional

Bank account data to be created

bankCode

string

required

internalAccountNo

string

optional

bankFullName

string

required

userBankAccNo

string

required

userBankAccName

string

required

activated

boolean

optional

defaultAccount

boolean

optional

accountType

string

optional

paymentGateways

array[object (PaymentGatewayInfo) {3}]

optional

gatewayProviderName

string

optional

gatewayType

string

optional

policyRemark

string

optional

bankAccounts

array[object (BankAccountData) {8}]

optional

bankCode

string

required

internalAccountNo

string

optional

bankFullName

string

required

userBankAccNo

string

required

userBankAccName

string

required

activated

boolean

optional

defaultAccount

boolean

optional

accountType

string

optional

deliveryPoints

array[object (DeliveryPoints) {3}]

optional

pname

string

optional

ptype

string

optional

pid

string

optional

banners

array[object (ProductBanner) {5}]

optional

itemId

string

optional

bannerUrl

string

optional

serialId

integer <int32>

optional

title

string

optional

addedDate

string <date-time>

optional

ads

array[object (AdBanner) {2}]

optional

bannerRedirectUrl

string

optional

bannerImageUrl

string

optional

storeGroups

array[string]

optional

monthlyFees

integer <int64>

optional

googleCredentials

string

optional

expireDate

string <date-time>

optional

Example

{
  "accessToken": "string",
  "sessionId": "string",
  "originalStoreId": "string",
  "success": true,
  "sitename": "string",
  "siteTitle": "string",
  "siteSEO": "string",
  "domain": "string",
  "businessname": "string",
  "address": "string",
  "stateOfCountry": "string",
  "country": "string",
  "insuranceTrackId": "string",
  "licensePlan": "string",
  "id": "string",
  "category": "string",
  "logoPath": "string",
  "emailAddress": "string",
  "contactPhone": "string",
  "contactPhone2": "string",
  "facebookId": "string",
  "twitterId": "string",
  "instagramId": "string",
  "youtubechannel": "string",
  "whatsappline": "string",
  "currency": "string",
  "cacNo": "string",
  "bvnNo": "string",
  "tinNo": "string",
  "aboutStore": "string",
  "openingTime": "string",
  "closingTime": "string",
  "userClass": "string",
  "taxRate": 0,
  "taxType": "string",
  "faviconurl": "string",
  "storeGpsLatitude": 0,
  "storeGpsLongitude": 0,
  "businessTagline": "string",
  "storePolicy": "string",
  "storeRole": "string",
  "contactEmail2": "string",
  "basicStoreInfo": "string",
  "aboutUs": "string",
  "cloudOnlyStore": true,
  "enableLiveStore": true,
  "defaultCustomerName": "string",
  "customerId": "string",
  "newPassword": "string",
  "oldPassword": "string",
  "staffId": "string",
  "logo": "string",
  "seoTags": "string",
  "tagLine": "string",
  "secondarySiteThemeColor": "string",
  "primarySiteThemeColor": "string",
  "primaryButtonColor": "string",
  "primaryThemeFont": "string",
  "mergeWithCentral": true,
  "defaultGateway": {
    "gatewayProviderName": "string",
    "gatewayType": "string",
    "policyRemark": "string"
  },
  "features": {
    "primaryColor": "string",
    "helpline": "string",
    "whatsappNo": "string",
    "contactEmail": "string",
    "contactAddress": "string",
    "skypeAddress": "string",
    "facebookPage": "string",
    "youtubePage": "string",
    "googlePlus": "string",
    "skypeId": "string",
    "transxIdPref": "string",
    "googleCredentials": "string",
    "reserveOrderSupport": true,
    "pinterestSupport": "string",
    "deliverytime": 0,
    "returnsSupported": true,
    "cashOnDelivery": true,
    "socialMediaEnabled": true,
    "promoOngoing": true,
    "realtimeEnabled": true,
    "wholesaleEnabled": true,
    "mobileAppEnabled": true,
    "mobileAppLink": "string",
    "vatType": "string",
    "gpsLat": 0,
    "gpsLng": 0,
    "partners": [
      "string"
    ],
    "gpsEnabled": true
  },
  "defaultBank": {
    "bankCode": "string",
    "internalAccountNo": "string",
    "bankFullName": "string",
    "userBankAccNo": "string",
    "userBankAccName": "string",
    "activated": true,
    "defaultAccount": true,
    "accountType": "string"
  },
  "paymentGateways": [
    {
      "gatewayProviderName": "string",
      "gatewayType": "string",
      "policyRemark": "string"
    }
  ],
  "bankAccounts": [
    {
      "bankCode": "string",
      "internalAccountNo": "string",
      "bankFullName": "string",
      "userBankAccNo": "string",
      "userBankAccName": "string",
      "activated": true,
      "defaultAccount": true,
      "accountType": "string"
    }
  ],
  "deliveryPoints": [
    {
      "pname": "string",
      "ptype": "string",
      "pid": "string"
    }
  ],
  "banners": [
    {
      "itemId": "string",
      "bannerUrl": "string",
      "serialId": 0,
      "title": "string",
      "addedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "ads": [
    {
      "bannerRedirectUrl": "string",
      "bannerImageUrl": "string"
    }
  ],
  "storeGroups": [
    "string"
  ],
  "monthlyFees": 0,
  "googleCredentials": "string",
  "expireDate": "2019-08-24T14:15:22Z"
}