v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add Store

Allows org admins to add a store to an org.

post/orgEntity/store

Request body

codestring required

Unique code of the store.

namestring required

Name of the store.

descriptionstring

Short description about the store.

type'STORE' required

Type of the store.

adminType'GENERAL' | 'ADMIN'

Type of the store - normal store or admin store.

isActiveboolean

Pass true to activate the store, false to inactivate.

timeZoneIdinteger

Base time-zone ID of the store.

currencyIdinteger

Base currency ID of the store based on the store location.

languageIdinteger

Unique ID of the base language associated with the store.

parentZoneIdstring

Unique ID of the associated parent zone.

externalIdsstring[]

External IDs of the store.

emailstring

Email Id of the store.

mobilestring

Mobile number of the store.

landlinestring
cityIdinteger
areaIdstring
customFieldsstring[]

Array containing the custom fields and it's value. These custom fields store special or custom information related to the store.

Response

200

OR

Example response

{
  "createdId": 50026755
}