StorefrontUsers
These endpoints are used to manage storefront users
GetAll
Gets all storefront users relevant to specified query parameters
Request
GET /api/storefront/v1/storefront-users?storefrontId[&storefrontUserId&skip&take&sorting&search&tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
storefrontUserId | query | Storefront user identifier |
||
skip | query | Defines page start offset from beginning of sorted result list |
||
take | query | Defines page length (how much consequent items of sorted result list should be taken) |
||
sorting | query | Defines sorting order of result list e.g.: "Title ASC, LastModified DESC" |
||
search | query | Search string for partial match |
||
*storefrontId | query | Storefront identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | User identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Create
Creates new storefront user
Request
POST /api/storefront/v1/storefront-users?storefrontId[&tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*storefrontId | query | Storefront identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | User identifier |
||
body | body |
|
Create operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 |
|
Success |
|
401 | Unauthorized |
||
403 | Forbidden |
Get
Gets storefront user by id
Request
GET /api/storefront/v1/storefront-users/{id}?storefrontId[&tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*id | path | Storefront user identifier |
||
*storefrontId | query | Storefront identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | User identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 |
|
Success |
|
404 |
|
Not Found |
|
401 | Unauthorized |
||
403 | Forbidden |
MergeAnonymous
Merges anonymous sorefront user data to regular storefront user account
Request
POST /api/storefront/v1/storefront-users/merge-anonymous?storefrontId[&tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*storefrontId | query | Storefront identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | User identifier |
||
body | body |
|
Merge operation parameters |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | Success |
||
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
GetToken
Gets sorefront user token
Request
GET /api/storefront/v1/storefront-users/token?storefrontUserId&storefrontId[&tenantId&userId]
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*storefrontUserId | query | Storefront user identifier |
||
*storefrontId | query | Storefront identifier |
||
tenantId | query | Tenant identifier |
||
userId | query | User identifier |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
201 | Success |
||
404 |
|
Not Found |
|
409 |
|
Conflict |
|
401 | Unauthorized |
||
403 | Forbidden |
Definitions
PagedOfStorefrontUserDto
Paged list of items
Name | Type | Notes |
---|---|---|
total | integer (int64) | Items count |
items |
|
Items list |
StorefrontUserDto
Items list
Name | Type | Notes |
---|---|---|
userId | string | Storefront user identifier |
tenantId | integer (int32) | Storefront tenant indentifier |
storefrontId | integer (int32) | Storefront identifier |
isAnonymous | boolean | Indicates whether user is an anonymous |
CreateStorefrontUserDto
Dto class, containing create operation parameters for storefront user entity
Name | Type | Notes |
---|---|---|
storefrontUserId | string | Storefront user identifier |
isAnonymous | boolean | Indicates whether user is an anonymous |
Microsoft.AspNetCore.Mvc.ProblemDetails
These endpoints are used to manage storefront users
Name | Type | Notes |
---|---|---|
type | string | |
title | string | |
status | integer (int32) | |
detail | string | |
instance | string |
MergeAnonymousUserDataInput
Dto class, containing parameters for merge anonymous user operation
Name | Type | Notes |
---|---|---|
anonymousStorefrontUserId | string | Anonymous storefront user identifier |
regularStorefrontUserId | string | Regular storefront user identifier |