Get a store

Management API (v1)

The Norce Management API lets you manage configurations and metadata on a client.

Download OpenAPI description

openapi.json

openapi.yaml

Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

CategoryParametric

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Customer FlagGroup

Operations

Customer Flag

Operations

Customer InfoType

Operations

Product Family

Operations

Product File

Operations

Product Manufacturer

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

Parametric

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

Shopping InfoType

Operations

Store Application

Operations

Store PriceList

Operations

Store

Operations

Get a store

Request

Get a specific store by its internal id

Path

idinteger(int32)required

Store id

Headers

account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/store/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the Store

Bodyapplication/json

Idinteger(int32)

The store identifier

DivisionCodestring or null[ 0 .. 50 ] characters

The unique code of the store (division)

Namestring or null[ 0 .. 50 ] characters

The display name of the store in a specific language

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the store for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

GroupNamestring or null[ 0 .. 50 ] characters

The group name of the store in a specific language, this is a free text field for client to use to classify larger collections of stores, ie. by region or type.

DefaultGroupNamestring or null[ 0 .. 50 ] characters

The group name of the store for the default language

IsGroupNameInheritedboolean

Indicates whether the group name is inherited from the default

SubGroupNamestring or null[ 0 .. 50 ] characters

The subgroup name of the store in a specific language, this is a free text field for client to use to classify larger collections of stores, ie. by city or sub-type.

DefaultSubGroupNamestring or null[ 0 .. 50 ] characters

The subgroup name of the store for the default language

IsSubGroupNameInheritedboolean

Indicates whether the subgroup name is inherited from the default

Descriptionstring or null

The description of the store in a specific language

DefaultDescriptionstring or null

The default description of the store for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

UniqueUrlNamestring or null[ 0 .. 100 ] characters

The unique URL name of the store in a specific language, used for SEO friendly URLs.

DefaultUniqueUrlNamestring or null[ 0 .. 100 ] characters

The unique URL name of the store for the default language

IsUniqueUrlNameInheritedboolean

Indicates whether the unique URL name is inherited from the default

IsUniqueUrlNameManuallyMaintainedboolean

Indicates whether the unique URL name is manually maintained. This is true if the unique URL name has been explicitly set for this store, false if it is automatically generated from the store name.

ImageKeystring or null(guid)

The image key for the store

Keystring(guid)

The unique key identifier for the store

ImageUrlstring or null

The image URL for the store, deprecated, use ImageKey instead.

IsPublicboolean

Indicates whether the store is public

IsActiveboolean

Indicates whether the store is active

EmailAddressstring or null[ 0 .. 255 ] characters

Optional email address of the store

PhoneNumberstring or null[ 0 .. 50 ] characters

Optional phone number of the store

FaxNumberstring or null[ 0 .. 50 ] characters

Optional fax number of the store

AddressLine1string or null[ 0 .. 255 ] characters

Optional Address information, first line of the store address

AddressLine2string or null[ 0 .. 255 ] characters

Optional Address information, second line of the store address

ZipCodestring or null[ 0 .. 50 ] characters

Optional Address information, ZIP code of the store

Longitudenumber or null(double)

Optional longitude coordinate of the store location

Citystring or null[ 0 .. 50 ] characters

Optional the city where the store is located

CountryIdinteger or null(int32)

Optional Address information, the country identifier where the store is located

OpenHoursWeekdaystring or null[ 0 .. 255 ] characters

The opening hours for weekdays

OpenHoursSaturdaystring or null[ 0 .. 255 ] characters

The opening hours for Saturday

OpenHoursSundaystring or null[ 0 .. 255 ] characters

The opening hours for Sunday

Regionstring or null[ 0 .. 100 ] characters

Optional Address information, region where the store is located

Latitudenumber or null(double)

The latitude coordinate of the store location

InfosArray of objects(InfoModel)

The additional info type items for the store

Changedstring or null

The date and time the store was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the store

CulturesArray of objects(DivisionCultureModel)

The culture-specific information for the store

Response

application/json

{
  "Id": 0,
  "DivisionCode": "string",
  "Name": "string",
  "DefaultName": "string",
  "IsNameInherited": true,
  "GroupName": "string",
  "DefaultGroupName": "string",
  "IsGroupNameInherited": true,
  "SubGroupName": "string",
  "DefaultSubGroupName": "string",
  "IsSubGroupNameInherited": true,
  "Description": "string",
  "DefaultDescription": "string",
  "IsDescriptionInherited": true,
  "UniqueUrlName": "string",
  "DefaultUniqueUrlName": "string",
  "IsUniqueUrlNameInherited": true,
  "IsUniqueUrlNameManuallyMaintained": true,
  "ImageKey": "string",
  "Key": "string",
  "ImageUrl": "string",
  "IsPublic": true,
  "IsActive": true,
  "EmailAddress": "string",
  "PhoneNumber": "string",
  "FaxNumber": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "ZipCode": "string",
  "Longitude": 0.1,
  "City": "string",
  "CountryId": 0,
  "OpenHoursWeekday": "string",
  "OpenHoursSaturday": "string",
  "OpenHoursSunday": "string",
  "Region": "string",
  "Latitude": 0.1,
  "Infos": [
    { … }
  ],
  "Changed": "string",
  "ChangedBy": "string",
  "Cultures": [
    { … }
  ]
}

Update a store

Request

Update a specific store by its internal id

Path

idinteger(int32)required

Store id

Headers

account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Store model to update

Idinteger(int32)

The store identifier

DivisionCodestring or null[ 0 .. 50 ] characters

The unique code of the store (division)

Namestring or null[ 0 .. 50 ] characters

The display name of the store in a specific language

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the store for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

GroupNamestring or null[ 0 .. 50 ] characters

The group name of the store in a specific language, this is a free text field for client to use to classify larger collections of stores, ie. by region or type.

DefaultGroupNamestring or null[ 0 .. 50 ] characters

The group name of the store for the default language

IsGroupNameInheritedboolean

Indicates whether the group name is inherited from the default

SubGroupNamestring or null[ 0 .. 50 ] characters

The subgroup name of the store in a specific language, this is a free text field for client to use to classify larger collections of stores, ie. by city or sub-type.

DefaultSubGroupNamestring or null[ 0 .. 50 ] characters

The subgroup name of the store for the default language

IsSubGroupNameInheritedboolean

Indicates whether the subgroup name is inherited from the default

Descriptionstring or null

The description of the store in a specific language

DefaultDescriptionstring or null

The default description of the store for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

UniqueUrlNamestring or null[ 0 .. 100 ] characters

The unique URL name of the store in a specific language, used for SEO friendly URLs.

DefaultUniqueUrlNamestring or null[ 0 .. 100 ] characters

The unique URL name of the store for the default language

IsUniqueUrlNameInheritedboolean

Indicates whether the unique URL name is inherited from the default

IsUniqueUrlNameManuallyMaintainedboolean

Indicates whether the unique URL name is manually maintained. This is true if the unique URL name has been explicitly set for this store, false if it is automatically generated from the store name.

ImageKeystring or null(guid)

The image key for the store

Keystring(guid)

The unique key identifier for the store

ImageUrlstring or null

The image URL for the store, deprecated, use ImageKey instead.

IsPublicboolean

Indicates whether the store is public

IsActiveboolean

Indicates whether the store is active

EmailAddressstring or null[ 0 .. 255 ] characters

Optional email address of the store

PhoneNumberstring or null[ 0 .. 50 ] characters

Optional phone number of the store

FaxNumberstring or null[ 0 .. 50 ] characters

Optional fax number of the store

AddressLine1string or null[ 0 .. 255 ] characters

Optional Address information, first line of the store address

AddressLine2string or null[ 0 .. 255 ] characters

Optional Address information, second line of the store address

ZipCodestring or null[ 0 .. 50 ] characters

Optional Address information, ZIP code of the store

Longitudenumber or null(double)

Optional longitude coordinate of the store location

Citystring or null[ 0 .. 50 ] characters

Optional the city where the store is located

CountryIdinteger or null(int32)

Optional Address information, the country identifier where the store is located

OpenHoursWeekdaystring or null[ 0 .. 255 ] characters

The opening hours for weekdays

OpenHoursSaturdaystring or null[ 0 .. 255 ] characters

The opening hours for Saturday

OpenHoursSundaystring or null[ 0 .. 255 ] characters

The opening hours for Sunday

Regionstring or null[ 0 .. 100 ] characters

Optional Address information, region where the store is located

Latitudenumber or null(double)

The latitude coordinate of the store location

InfosArray of objects(InfoModel)

The additional info type items for the store

Changedstring or null

The date and time the store was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the store

CulturesArray of objects(DivisionCultureModel)

The culture-specific information for the store

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/store/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "DivisionCode": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "GroupName": "string",
    "DefaultGroupName": "string",
    "IsGroupNameInherited": true,
    "SubGroupName": "string",
    "DefaultSubGroupName": "string",
    "IsSubGroupNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "UniqueUrlName": "string",
    "DefaultUniqueUrlName": "string",
    "IsUniqueUrlNameInherited": true,
    "IsUniqueUrlNameManuallyMaintained": true,
    "ImageKey": "string",
    "Key": "string",
    "ImageUrl": "string",
    "IsPublic": true,
    "IsActive": true,
    "EmailAddress": "string",
    "PhoneNumber": "string",
    "FaxNumber": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "ZipCode": "string",
    "Longitude": 0.1,
    "City": "string",
    "CountryId": 0,
    "OpenHoursWeekday": "string",
    "OpenHoursSaturday": "string",
    "OpenHoursSunday": "string",
    "Region": "string",
    "Latitude": 0.1,
    "Infos": [
      {
        "Id": 0,
        "TypeId": 0,
        "Name": "string",
        "Value": "string",
        "Updated": "2019-08-24T14:15:22Z",
        "UpdatedBy": 0
      }
    ],
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true,
        "GroupName": "string",
        "IsGroupNameInherited": true,
        "SubGroupName": "string",
        "IsSubGroupNameInherited": true,
        "UniqueUrlName": "string",
        "IsUniqueUrlNameInherited": true,
        "IsTranslated": true
      }
    ]
  }'

Responses

If the store was successfully updated

Bodyapplication/json

integer(int32)

Response

application/json

List stores

Request

Get a list of all stores

Headers

account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/store \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of stores, if any exists

Bodyapplication/jsonArray [

Idinteger(int32)

The store identifier

DivisionCodestring or null[ 0 .. 50 ] characters

The unique code of the store (division)

Namestring or null[ 0 .. 50 ] characters

The display name of the store in a specific language

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the store for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

GroupNamestring or null[ 0 .. 50 ] characters

The group name of the store in a specific language, this is a free text field for client to use to classify larger collections of stores, ie. by region or type.

DefaultGroupNamestring or null[ 0 .. 50 ] characters

The group name of the store for the default language

IsGroupNameInheritedboolean

Indicates whether the group name is inherited from the default

SubGroupNamestring or null[ 0 .. 50 ] characters

The subgroup name of the store in a specific language, this is a free text field for client to use to classify larger collections of stores, ie. by city or sub-type.

DefaultSubGroupNamestring or null[ 0 .. 50 ] characters

The subgroup name of the store for the default language

IsSubGroupNameInheritedboolean

Indicates whether the subgroup name is inherited from the default

Descriptionstring or null

The description of the store in a specific language

DefaultDescriptionstring or null

The default description of the store for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

UniqueUrlNamestring or null[ 0 .. 100 ] characters

The unique URL name of the store in a specific language, used for SEO friendly URLs.

DefaultUniqueUrlNamestring or null[ 0 .. 100 ] characters

The unique URL name of the store for the default language

IsUniqueUrlNameInheritedboolean

Indicates whether the unique URL name is inherited from the default

IsUniqueUrlNameManuallyMaintainedboolean

Indicates whether the unique URL name is manually maintained. This is true if the unique URL name has been explicitly set for this store, false if it is automatically generated from the store name.

ImageKeystring or null(guid)

The image key for the store

Keystring(guid)

The unique key identifier for the store

ImageUrlstring or null

The image URL for the store, deprecated, use ImageKey instead.

IsPublicboolean

Indicates whether the store is public

IsActiveboolean

Indicates whether the store is active

EmailAddressstring or null[ 0 .. 255 ] characters

Optional email address of the store

PhoneNumberstring or null[ 0 .. 50 ] characters

Optional phone number of the store

FaxNumberstring or null[ 0 .. 50 ] characters

Optional fax number of the store

AddressLine1string or null[ 0 .. 255 ] characters

Optional Address information, first line of the store address

AddressLine2string or null[ 0 .. 255 ] characters

Optional Address information, second line of the store address

ZipCodestring or null[ 0 .. 50 ] characters

Optional Address information, ZIP code of the store

Longitudenumber or null(double)

Optional longitude coordinate of the store location

Citystring or null[ 0 .. 50 ] characters

Optional the city where the store is located

CountryIdinteger or null(int32)

Optional Address information, the country identifier where the store is located

OpenHoursWeekdaystring or null[ 0 .. 255 ] characters

The opening hours for weekdays

OpenHoursSaturdaystring or null[ 0 .. 255 ] characters

The opening hours for Saturday

OpenHoursSundaystring or null[ 0 .. 255 ] characters

The opening hours for Sunday

Regionstring or null[ 0 .. 100 ] characters

Optional Address information, region where the store is located

Latitudenumber or null(double)

The latitude coordinate of the store location

InfosArray of objects(InfoModel)

The additional info type items for the store

Changedstring or null

The date and time the store was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the store

CulturesArray of objects(DivisionCultureModel)

The culture-specific information for the store

]

Response

application/json

[
  {
    "Id": 0,
    "DivisionCode": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "GroupName": "string",
    "DefaultGroupName": "string",
    "IsGroupNameInherited": true,
    "SubGroupName": "string",
    "DefaultSubGroupName": "string",
    "IsSubGroupNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "UniqueUrlName": "string",
    "DefaultUniqueUrlName": "string",
    "IsUniqueUrlNameInherited": true,
    "IsUniqueUrlNameManuallyMaintained": true,
    "ImageKey": "string",
    "Key": "string",
    "ImageUrl": "string",
    "IsPublic": true,
    "IsActive": true,
    "EmailAddress": "string",
    "PhoneNumber": "string",
    "FaxNumber": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "ZipCode": "string",
    "Longitude": 0.1,
    "City": "string",
    "CountryId": 0,
    "OpenHoursWeekday": "string",
    "OpenHoursSaturday": "string",
    "OpenHoursSunday": "string",
    "Region": "string",
    "Latitude": 0.1,
    "Infos": [ … ],
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [ … ]
  }
]

Add a store

Request

Add a new store

Headers

account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Store model to add

Idinteger(int32)

The store identifier

DivisionCodestring or null[ 0 .. 50 ] characters

The unique code of the store (division)

Namestring or null[ 0 .. 50 ] characters

The display name of the store in a specific language

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the store for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

GroupNamestring or null[ 0 .. 50 ] characters

The group name of the store in a specific language, this is a free text field for client to use to classify larger collections of stores, ie. by region or type.

DefaultGroupNamestring or null[ 0 .. 50 ] characters

The group name of the store for the default language

IsGroupNameInheritedboolean

Indicates whether the group name is inherited from the default

SubGroupNamestring or null[ 0 .. 50 ] characters

The subgroup name of the store in a specific language, this is a free text field for client to use to classify larger collections of stores, ie. by city or sub-type.

DefaultSubGroupNamestring or null[ 0 .. 50 ] characters

The subgroup name of the store for the default language

IsSubGroupNameInheritedboolean

Indicates whether the subgroup name is inherited from the default

Descriptionstring or null

The description of the store in a specific language

DefaultDescriptionstring or null

The default description of the store for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

UniqueUrlNamestring or null[ 0 .. 100 ] characters

The unique URL name of the store in a specific language, used for SEO friendly URLs.

DefaultUniqueUrlNamestring or null[ 0 .. 100 ] characters

The unique URL name of the store for the default language

IsUniqueUrlNameInheritedboolean

Indicates whether the unique URL name is inherited from the default

IsUniqueUrlNameManuallyMaintainedboolean

Indicates whether the unique URL name is manually maintained. This is true if the unique URL name has been explicitly set for this store, false if it is automatically generated from the store name.

ImageKeystring or null(guid)

The image key for the store

Keystring(guid)

The unique key identifier for the store

ImageUrlstring or null

The image URL for the store, deprecated, use ImageKey instead.

IsPublicboolean

Indicates whether the store is public

IsActiveboolean

Indicates whether the store is active

EmailAddressstring or null[ 0 .. 255 ] characters

Optional email address of the store

PhoneNumberstring or null[ 0 .. 50 ] characters

Optional phone number of the store

FaxNumberstring or null[ 0 .. 50 ] characters

Optional fax number of the store

AddressLine1string or null[ 0 .. 255 ] characters

Optional Address information, first line of the store address

AddressLine2string or null[ 0 .. 255 ] characters

Optional Address information, second line of the store address

ZipCodestring or null[ 0 .. 50 ] characters

Optional Address information, ZIP code of the store

Longitudenumber or null(double)

Optional longitude coordinate of the store location

Citystring or null[ 0 .. 50 ] characters

Optional the city where the store is located

CountryIdinteger or null(int32)

Optional Address information, the country identifier where the store is located

OpenHoursWeekdaystring or null[ 0 .. 255 ] characters

The opening hours for weekdays

OpenHoursSaturdaystring or null[ 0 .. 255 ] characters

The opening hours for Saturday

OpenHoursSundaystring or null[ 0 .. 255 ] characters

The opening hours for Sunday

Regionstring or null[ 0 .. 100 ] characters

Optional Address information, region where the store is located

Latitudenumber or null(double)

The latitude coordinate of the store location

InfosArray of objects(InfoModel)

The additional info type items for the store

Changedstring or null

The date and time the store was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the store

CulturesArray of objects(DivisionCultureModel)

The culture-specific information for the store

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/store \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "DivisionCode": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "GroupName": "string",
    "DefaultGroupName": "string",
    "IsGroupNameInherited": true,
    "SubGroupName": "string",
    "DefaultSubGroupName": "string",
    "IsSubGroupNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "UniqueUrlName": "string",
    "DefaultUniqueUrlName": "string",
    "IsUniqueUrlNameInherited": true,
    "IsUniqueUrlNameManuallyMaintained": true,
    "ImageKey": "string",
    "Key": "string",
    "ImageUrl": "string",
    "IsPublic": true,
    "IsActive": true,
    "EmailAddress": "string",
    "PhoneNumber": "string",
    "FaxNumber": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "ZipCode": "string",
    "Longitude": 0.1,
    "City": "string",
    "CountryId": 0,
    "OpenHoursWeekday": "string",
    "OpenHoursSaturday": "string",
    "OpenHoursSunday": "string",
    "Region": "string",
    "Latitude": 0.1,
    "Infos": [
      {
        "Id": 0,
        "TypeId": 0,
        "Name": "string",
        "Value": "string",
        "Updated": "2019-08-24T14:15:22Z",
        "UpdatedBy": 0
      }
    ],
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true,
        "GroupName": "string",
        "IsGroupNameInherited": true,
        "SubGroupName": "string",
        "IsSubGroupNameInherited": true,
        "UniqueUrlName": "string",
        "IsUniqueUrlNameInherited": true,
        "IsTranslated": true
      }
    ]
  }'

Responses

If the store was successfully added

Bodyapplication/json

integer(int32)

Response

application/json

List deleted stores

Request

Get a list of all deleted stores, update a deleted store with IsActive = true to activate it again

Headers

account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/store/deleted \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of deleted stores, if any exists

Bodyapplication/jsonArray [

Idinteger(int32)

The store identifier

DivisionCodestring or null[ 0 .. 50 ] characters

The unique code of the store (division)

Namestring or null[ 0 .. 50 ] characters

The display name of the store in a specific language

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the store for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

GroupNamestring or null[ 0 .. 50 ] characters

The group name of the store in a specific language, this is a free text field for client to use to classify larger collections of stores, ie. by region or type.

DefaultGroupNamestring or null[ 0 .. 50 ] characters

The group name of the store for the default language

IsGroupNameInheritedboolean

Indicates whether the group name is inherited from the default

SubGroupNamestring or null[ 0 .. 50 ] characters

The subgroup name of the store in a specific language, this is a free text field for client to use to classify larger collections of stores, ie. by city or sub-type.

DefaultSubGroupNamestring or null[ 0 .. 50 ] characters

The subgroup name of the store for the default language

IsSubGroupNameInheritedboolean

Indicates whether the subgroup name is inherited from the default

Descriptionstring or null

The description of the store in a specific language

DefaultDescriptionstring or null

The default description of the store for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

UniqueUrlNamestring or null[ 0 .. 100 ] characters

The unique URL name of the store in a specific language, used for SEO friendly URLs.

DefaultUniqueUrlNamestring or null[ 0 .. 100 ] characters

The unique URL name of the store for the default language

IsUniqueUrlNameInheritedboolean

Indicates whether the unique URL name is inherited from the default

IsUniqueUrlNameManuallyMaintainedboolean

Indicates whether the unique URL name is manually maintained. This is true if the unique URL name has been explicitly set for this store, false if it is automatically generated from the store name.

ImageKeystring or null(guid)

The image key for the store

Keystring(guid)

The unique key identifier for the store

ImageUrlstring or null

The image URL for the store, deprecated, use ImageKey instead.

IsPublicboolean

Indicates whether the store is public

IsActiveboolean

Indicates whether the store is active

EmailAddressstring or null[ 0 .. 255 ] characters

Optional email address of the store

PhoneNumberstring or null[ 0 .. 50 ] characters

Optional phone number of the store

FaxNumberstring or null[ 0 .. 50 ] characters

Optional fax number of the store

AddressLine1string or null[ 0 .. 255 ] characters

Optional Address information, first line of the store address

AddressLine2string or null[ 0 .. 255 ] characters

Optional Address information, second line of the store address

ZipCodestring or null[ 0 .. 50 ] characters

Optional Address information, ZIP code of the store

Longitudenumber or null(double)

Optional longitude coordinate of the store location

Citystring or null[ 0 .. 50 ] characters

Optional the city where the store is located

CountryIdinteger or null(int32)

Optional Address information, the country identifier where the store is located

OpenHoursWeekdaystring or null[ 0 .. 255 ] characters

The opening hours for weekdays

OpenHoursSaturdaystring or null[ 0 .. 255 ] characters

The opening hours for Saturday

OpenHoursSundaystring or null[ 0 .. 255 ] characters

The opening hours for Sunday

Regionstring or null[ 0 .. 100 ] characters

Optional Address information, region where the store is located

Latitudenumber or null(double)

The latitude coordinate of the store location

InfosArray of objects(InfoModel)

The additional info type items for the store

Changedstring or null

The date and time the store was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the store

CulturesArray of objects(DivisionCultureModel)

The culture-specific information for the store

]

Response

application/json

[
  {
    "Id": 0,
    "DivisionCode": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "GroupName": "string",
    "DefaultGroupName": "string",
    "IsGroupNameInherited": true,
    "SubGroupName": "string",
    "DefaultSubGroupName": "string",
    "IsSubGroupNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "UniqueUrlName": "string",
    "DefaultUniqueUrlName": "string",
    "IsUniqueUrlNameInherited": true,
    "IsUniqueUrlNameManuallyMaintained": true,
    "ImageKey": "string",
    "Key": "string",
    "ImageUrl": "string",
    "IsPublic": true,
    "IsActive": true,
    "EmailAddress": "string",
    "PhoneNumber": "string",
    "FaxNumber": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "ZipCode": "string",
    "Longitude": 0.1,
    "City": "string",
    "CountryId": 0,
    "OpenHoursWeekday": "string",
    "OpenHoursSaturday": "string",
    "OpenHoursSunday": "string",
    "Region": "string",
    "Latitude": 0.1,
    "Infos": [ … ],
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [ … ]
  }
]

Store Warehouse

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations

Product VariantGroup

Operations

Product WarehouseLocation

Operations

Product Warehouse

Operations

Management API (v1)

Schemas

Settings ApplicationCountry

Settings ApplicationCulture

Settings ApplicationCurrency

Settings ApplicationSalesArea

Settings Application

Category

CategoryParametric

Settings ClientAssortment

Settings ClientCurrency

Settings ClientSalesArea

Customer FlagGroup

Customer Flag

Customer InfoType

Product Family

Product File

Product Manufacturer

Parametric Group

Parametric List

Parametric Multiple

Parametric

PriceList Population

PriceList Pricing

PriceList

PriceList SupplierPriceList

PriceList Warehouse

Product FlagGroup

Product Flag

Product InfoType

Product Type

Promotion

Product RelationType

PriceList RoundingRule

Shopping InfoType

Store Application

Store PriceList

Store

Get a store

Request

Responses

Did the information on the page help you?

Update a store

RequestExpand all

Responses

Did the information on the page help you?

List stores

Request

Responses

Did the information on the page help you?

Add a store

RequestExpand all

Responses

Did the information on the page help you?

List deleted stores

Request

Responses

Did the information on the page help you?

Store Warehouse

Supplier PriceList

Supplier PriceListWarehouse

Supplier

Supplier Warehouse

Supplier WarehouseLocation

Product VariantGroup

Product WarehouseLocation

Product Warehouse

Request

Request