GET v1/store

Gets the store to which the user is currently logged in.
The store unique ID and the currently logged-in user are identified by the provided security token.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Returns information about a store to which the user currently logged in.

StoreModel

Name	Description	Type	Additional information
ID	The unique ID of the store.	globally unique identifier	None.
FriendlyID	The friendly ID of the store.	integer	None.
Name	The name of the store.	string	None.
Description	The description of the store.	string	None.
ExternalID	The ID of the store in an external application.	string	None.
PrimaryCurrencyID	The unique ID of the primary currency in the store. The billing will always be performed using the primary currency. Secondary currencies are used for display only.	globally unique identifier	None.
ShowCurrencyCode	Determines whether to show currency abbreviation.	boolean	None.
RequireOrderApproval	Indicates if orders in the store should be approved prior to submission.	boolean	None.
TaxFormatType	Defines whether the tax appears as part of the price in the store products.	TaxFormatType	None.
TaxFormat	The tax display format built using the following placeholders: {Price}, {Tax} and {PriceIncludingTax}.	string	None.
SeoConfiguration	The SEO configuration of the store.	StoreSeoConfigurationModel	None.
StoreType	The store type.	StoreType	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": "c0791ed7-63fb-4008-a7ed-4c9a3372af37",
  "FriendlyID": 2,
  "Name": "sample string 3",
  "Description": "sample string 4",
  "ExternalID": "sample string 5",
  "PrimaryCurrencyID": "ecb76721-d34c-460b-bced-bd8d168d9ed8",
  "ShowCurrencyCode": true,
  "RequireOrderApproval": true,
  "TaxFormatType": 1,
  "TaxFormat": "sample string 9",
  "SeoConfiguration": {
    "TitleTag": "sample string 1",
    "TitleTagType": 1,
    "Title": "sample string 2",
    "Description": "sample string 3"
  },
  "StoreType": 1,
  "Attributes": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}