Back to Website
Show / Hide Table of Contents

StorefrontAPI

Use this API when you are building your online store integration with Customer's Canvas.

You may use Storefront API to integrate your online store with Customer's Canvas. There are three major tasks you need to carry out:

  • Associating the products of your online store (or a storefront) with Customer's Canvas own product specifications by creating special product references.
  • Using the Customer's Canvas product specification attributes and tenant info to display a personalization tool on the frontend.
  • Processing your online store orders by creating projects which hold the personalized designs of your customers.

Interactive API Docs

Api Clients

.Net Client

You can install it from Nuget as follows:

Install-Package Aurigma.StorefrontApi.ApiClient

See on Nuget

Angular Client

This client is compatible with Angular applications only. It won't work with NodeJS or other frontend JS frameworks. You can install the package to your Angular application as follows:

npm install @aurigma/ng-storefront-api-client

See on npm

NodeJS Client (Axious)

This client can be used in a wide range of JavaScript applications. To make API calls, it uses Axios - a popular HTTP library. Although it is possible to use it in both frontend and backend projects, the primary target platform for this library is NodeJS.

Install the package as follows:

npm install @aurigma/axios-storefront-api-client

See on npm

PHP Client

PHP client can be installed through composer as follows:

composer require aurigma/php-storefront-client

See on Packagist

BuildInfo

These endpoints are used to get the technical information about the service such as version, build date and similar. They are also useful for a quick test whether the service is available. All of them are working in the same way and return the same information - use the HEAD or GET flavor of this endpoint based on your preference.

HeadInfo

Returns an assembly build info.

Request
HEAD /api/storefront/v1/info
Responses
Status Code Type Description Samples
200

Success

Headers
X-Aurigma-Version string

A version number

X-Aurigma-Build-Date string

A build date (UTC)

X-Aurigma-Configuration string

A build configuration (Debug | Release)

X-Aurigma-App-Name string

A service name

GetInfo

Returns an assembly build info.

Request
GET /api/storefront/v1/info
Responses
Status Code Type Description Samples
200 BuildInfoModel

Success

ProcessingPipelines

These endpoints are used to manage processing pipelines.

GetAll

Returns all processing pipelines relevant to the specified query parameters.

Request
GET /api/storefront/v1/processing-pipelines[?skip&take&search&tenantId]
Parameters
Name In Type Default Notes
skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many consequent items of sorted result list should be taken).

search query

Search string for partial by processing pipeline name.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProcessingPipelineDto

Success

401

Unauthorized

403

Forbidden

Get

Returns a processing pipeline.

Request
GET /api/storefront/v1/processing-pipelines/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Processing pipeline identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProcessingPipelineDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

ProductLinks

These endpoints are used to get information about tenant product links.

GetAllProductLinks

Returns all product links, relevant to the specified query parameters.

Request
GET /api/storefront/v1/product-links[?skip&take&sorting&search&tenantId]
Parameters
Name In Type Default Notes
skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many 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.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductLinkDto

Success

401

Unauthorized

403

Forbidden

GetProductLink

Returns a product link by its identifier.

Request
GET /api/storefront/v1/product-links/{id}[?productLinkVersionId&productVersionId&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productLinkVersionId query

Product link version identifier. Optional

productVersionId query

Product version identifier which represents linked product version. Optional

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductLinkDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductSummary

Returns a product link summary by product link identifier.

Request
GET /api/storefront/v1/product-links/{id}/summary[?productLinkVersionId&productVersionId&productVariantId&sku&tenantId]
Parameters
Name In Type Default Notes
*id path

Product link identifier.

productLinkVersionId query

Product link version identifier.

productVersionId query

Product link identifier.

productVariantId query

Product variant identifier.

sku query

Product variant SKU.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductSummaryDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetPersonalizationWorkflow

Returns a product link personalization workflow description by product link identifier.

Request
GET /api/storefront/v1/product-links/{id}/personalization-workflow[?productLinkVersionId&productVersionId&productFilterId&tenantId]
Parameters
Name In Type Default Notes
*id path

Product link identifier.

productLinkVersionId query

Product link version identifier.

productVersionId query

Product version identifier.

productFilterId query

Product filter identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PersonalizationWorkflowDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

ProductReferences

These endpoints are used to manage storefront product references.

GetAll

Returns all storefront product references relevant to the specified query parameters.

Request
GET /api/storefront/v1/product-references?storefrontId[&productReference&productSpecificationId&productId&productLinkId&skip&take&sorting&search&sku&tags&customFields&tenantId]
Parameters
Name In Type Default Notes
productReference query

Product reference filter. Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.

productSpecificationId query

Customer's Canvas product specification filter.

productId query

Customer's Canvas product filter.

productLinkId query

Customer's Canvas product link filter.

skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many 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.

sku query

SKU filter.

tags query

List of tags that product should have.

customFields query

Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductReferenceDto

Success

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

Create

Creates a new storefront product reference.

Request
POST /api/storefront/v1/product-references?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

body body CreateProductReferenceDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 ProductReferenceDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 ProductReferenceCreationConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllProductSpecifications

Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.

Request
GET /api/storefront/v1/product-references/product-specifications?storefrontId[&productReference&productSpecificationId&productId&productLinkId&skip&take&sorting&search&sku&tags&customFields&tenantId]
Parameters
Name In Type Default Notes
productReference query

Product reference filter. Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.

productSpecificationId query

Customer's Canvas product specification filter.

productId query

Customer's Canvas product filter.

productLinkId query

Customer's Canvas product link filter.

skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many 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.

sku query

SKU filter.

tags query

List of tags that product should have.

customFields query

Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductSpecificationDto

Success

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllProducts

Returns a list of products associated with storefront product references relevant to the specified query parameters.

Request
GET /api/storefront/v1/product-references/products?storefrontId[&productReference&productSpecificationId&productId&productLinkId&skip&take&sorting&search&sku&tags&customFields&tenantId]
Parameters
Name In Type Default Notes
productReference query

Product reference filter. Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.

productSpecificationId query

Customer's Canvas product specification filter.

productId query

Customer's Canvas product filter.

productLinkId query

Customer's Canvas product link filter.

skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many 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.

sku query

SKU filter.

tags query

List of tags that product should have.

customFields query

Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductDto

Success

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllProductLinks

Returns a list of product links associated with storefront product references relevant to the specified query parameters.

Request
GET /api/storefront/v1/product-references/product-links?storefrontId[&productReference&productSpecificationId&productId&productLinkId&skip&take&sorting&search&sku&tags&customFields&tenantId]
Parameters
Name In Type Default Notes
productReference query

Product reference filter. Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.

productSpecificationId query

Customer's Canvas product specification filter.

productId query

Customer's Canvas product filter.

productLinkId query

Customer's Canvas product link filter.

skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many 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.

sku query

SKU filter.

tags query

List of tags that product should have.

customFields query

Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductLinkDto

Success

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns a storefront product reference.

Request
GET /api/storefront/v1/product-references/{reference}?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*reference path

An external reference to Customer's Canvas product, e.g online store product identifier.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductReferenceDto

Success

409 GeneralConflictDto

Conflict

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Delete

Deletes the storefront product reference.

Request
DELETE /api/storefront/v1/product-references/{reference}?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*reference path

Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductReferenceDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductSpecification

Returns a product specification by the storefront product reference.

Request
GET /api/storefront/v1/product-references/{reference}/product-specification?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*reference path

Product reference - external reference to Customer's Canvas product, e.g online store product identifier.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductSpecificationDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProduct

Returns a product by storefront product reference.

Request
GET /api/storefront/v1/product-references/{reference}/product?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*reference path

An external reference to Customer's Canvas product, e.g online store product identifier.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductSummary

Returns a product summary by storefront product reference.

Request
GET /api/storefront/v1/product-references/{reference}/product-summary?storefrontId[&productVariantId&sku&tenantId]
Parameters
Name In Type Default Notes
*reference path

An external reference to Customer's Canvas product, e.g online store product identifier.

*storefrontId query

Storefront identifier.

productVariantId query

Product variant identifier.

sku query

Product variant SKU.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductSummaryDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductLink

Returns a product link by storefront product reference.

Request
GET /api/storefront/v1/product-references/{reference}/product-link?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*reference path

An external reference to Customer's Canvas product, e.g online store product identifier.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductLinkDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductCostDetails

Returns a product cost details from ecommerce system.

Request
GET /api/storefront/v1/product-references/{reference}/product-cost-details?sku&storefrontId[&storefrontUserId&currencyCode&quantity&tenantId]
Parameters
Name In Type Default Notes
*reference path

An external reference to Customer's Canvas product, e.g online store product identifier.

*sku query

Product SKU.

*storefrontId query

Storefront identifier.

storefrontUserId query

Storefront user identifier.

currencyCode query

Product cost currency code.

quantity query 1

Product quantity.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductCostDetailsDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetPersonalizationWorkflow

Returns a product personalization workflow.

Request
GET /api/storefront/v1/product-references/{reference}/personalization-workflow[?storefrontId&tenantId]
Parameters
Name In Type Default Notes
*reference path

An external reference to Customer's Canvas product, e.g online store product identifier.

storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PersonalizationWorkflowDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductConfig Deprecated

Returns a product personalization workflow configuration by storefront product reference.

Request
GET /api/storefront/v1/product-references/{reference}/product-config?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*reference path

An external reference to Customer's Canvas product, e.g online store product identifier.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

Products

These endpoints are used to get information about tenant products.

GetAllProducts

Returns all products, relevant to the specified query parameters.

Request
GET /api/storefront/v1/products[?skip&take&sorting&search&sku&tags&customFields&tenantId]
Parameters
Name In Type Default Notes
skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many 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.

sku query

SKU of linked ecommerce product.

tags query

List of tags that product should have.

customFields query

Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductDto

Success

401

Unauthorized

403

Forbidden

GetProduct

Returns a product by identifier.

Request
GET /api/storefront/v1/products/{id}[?productVersionId&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query

Product version identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductSummary

Returns a product summary by product identifier.

Request
GET /api/storefront/v1/products/{id}/summary[?productVersionId&productLinkId&productVariantId&sku&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query

Product version identifier.

productLinkId query

Product link identifier.

productVariantId query

Product variant identifier.

sku query

Product variant SKU.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductSummaryDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductOptions

Returns a list of product options.

Request
GET /api/storefront/v1/products/{id}/options[?productVersionId&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query

Product version identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductOptionDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAllProductOptions

Returns a list of product options for all products.

Request
GET /api/storefront/v1/products/options[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductOptionDto

Success

401

Unauthorized

403

Forbidden

GetProductLinks

Returns a list of product links.

Request
GET /api/storefront/v1/products/{id}/links[?productVersionId&skip&take&sorting&search&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query
skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many 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.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductLinkDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductLink

Returns a product link.

Request
GET /api/storefront/v1/products/{id}/links/{productLinkId}[?productVersionId&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

*productLinkId path

Product link identifier.

productVersionId query
tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductLinkDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductVariants

Returns a list of product variants.

Request
GET /api/storefront/v1/products/{id}/variants[?productVersionId&skip&take&options&productFilterId&takeAvailableOnly&sku&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query

Product version identifier.

skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many consequent items of sorted result list should be taken).

options query

Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".

productFilterId query

Defines special filter based on product filter with specified identifier.

takeAvailableOnly query

Defines special filter for available product variants.

sku query

SKU of linked ecommerce product.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductVariantDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductVariant

Returns a product variant.

Request
GET /api/storefront/v1/products/{id}/variants/{productVariantId}[?productVersionId&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

*productVariantId path

Product variant identifier.

productVersionId query

Product version identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductVariantDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductVariantDesigns

Returns a list of product variant designs.

Request
GET /api/storefront/v1/products/{id}/variant-designs[?productVersionId&productVariantId&search&designCustomFields&designPath&skip&take&options&productFilterId&takeAvailableOnly&sku&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query

Product version identifier.

productVariantId query

Product variant identifier.

search query

Search string for design name partial match.

designCustomFields query

Custom attributes dictionary filter for designs. For example: {"public":"true","name":"my item"}

designPath query

Path filter for designs. Subfolders included by default.

skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many consequent items of sorted result list should be taken).

options query

Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".

productFilterId query

Defines special filter based on product filter with specified identifier.

takeAvailableOnly query

Defines special filter for available product variants.

sku query

SKU of linked ecommerce product.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductVariantDesignDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductVariantMockups

Returns a list of product variant mockups.

Request
GET /api/storefront/v1/products/{id}/variant-mockups[?productVersionId&productVariantId&search&mockupCustomFields&mockupPath&skip&take&options&productFilterId&takeAvailableOnly&sku&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query

Product version identifier.

productVariantId query

Product variant identifier.

search query

Search string for design name partial match.

mockupCustomFields query

Custom attributes dictionary filter for mockups. For example: {"public":"true","name":"my item"}

mockupPath query

Path filter for mockups. Subfolders included by default.

skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many consequent items of sorted result list should be taken).

options query

Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".

productFilterId query

Defines special filter based on product filter with specified identifier.

takeAvailableOnly query

Defines special filter for available product variants.

sku query

SKU of linked ecommerce product.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductVariantMockupDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProductVariantDocuments

Returns a list of product variant documents.

Request
GET /api/storefront/v1/products/{id}/variant-documents[?productVersionId&productVariantId&search&documentCustomFields&documentPath&skip&take&options&productFilterId&takeAvailableOnly&sku&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query

Product version identifier.

productVariantId query

Product variant identifier.

search query

Search string for document name partial match.

documentCustomFields query

Custom attributes dictionary filter for documents. For example: {"public":"true","name":"my item"}

documentPath query

Path filter for documents. Subfolders included by default.

skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many consequent items of sorted result list should be taken).

options query

Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".

productFilterId query

Defines special filter based on product filter with specified identifier.

takeAvailableOnly query

Defines special filter for available product variants.

sku query

SKU of linked ecommerce product.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductVariantDocumentDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

UpdateProductVariantResources

Updates product variant resources.

Request
POST /api/storefront/v1/products/{id}/update-variant-resources[?productVersionId&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query

Product version identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

SetProductVariantPrice

Set product variant price.

Request
POST /api/storefront/v1/products/{id}/set-variant-price[?productVersionId&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query

Product version identifier.

tenantId query

Tenant identifier.

body body SetProductVariantPriceDto []

Set product variant price operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAvailableProductTags

Returns a list of all available product tags.

Request
GET /api/storefront/v1/products/available-tags[?search&tenantId]
Parameters
Name In Type Default Notes
search query

Search string for partial match.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 array

Success

401

Unauthorized

403

Forbidden

GetPersonalizationWorkflow

Returns a product personalization workflow description by product identifier.

Request
GET /api/storefront/v1/products/{id}/personalization-workflow[?productVersionId&productLinkId&productFilterId&tenantId]
Parameters
Name In Type Default Notes
*id path

Product identifier.

productVersionId query

Product version identifier.

productLinkId query

Product link identifier.

productFilterId query

Product filter identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PersonalizationWorkflowDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

ProductSpecifications

These endpoints are used to manage tenant product specifications.

GetAll

Returns all product specifications, relevant to the specified query parameters.

Request
GET /api/storefront/v1/product-specifications[?skip&take&sorting&search&tenantId]
Parameters
Name In Type Default Notes
skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many 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.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductSpecificationDto

Success

401

Unauthorized

403

Forbidden

Get

Returns a product specification by identifier.

Request
GET /api/storefront/v1/product-specifications/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Product specification identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProductSpecificationDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetPersonalizationWorkflow

Returns a product personalization workflow description by product specification identifier.

Request
GET /api/storefront/v1/product-specifications/{id}/personalization-workflow[?tenantId]
Parameters
Name In Type Default Notes
*id path

Product specification identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PersonalizationWorkflowDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetConfiguration Deprecated

Returns a product personalization workflow configuration by product specification identifier.

Request
GET /api/storefront/v1/product-specifications/{id}/config[?tenantId]
Parameters
Name In Type Default Notes
*id path

Product specification identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Projects

These endpoints are used to manage tenant projects.

GetAll

Returns all projects, relevant to the specified query parameters.

Request
GET /api/storefront/v1/projects[?ownerId&productReference&status&datePeriod&skip&take&sorting&search&orderId&processingStatus&includeObsolete&storefrontId&tenantId]
Parameters
Name In Type Default Notes
ownerId query

Project owner (storefront user id) filter.

productReference query

Product reference filter.

status query

Project status filter.

datePeriod query

Project date period filter.

skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many 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.

orderId query

Identifier of corresponding order.

processingStatus query

Project processing status filter.

includeObsolete query

Indicates if obsolete projects prepared to be removed should be included to result.

storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProjectDto

Success

401

Unauthorized

403

Forbidden

Get

Returns a project by identifier.

Request
GET /api/storefront/v1/projects/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProjectDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

Delete

Removes a project by identifier.

Request
DELETE /api/storefront/v1/projects/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetPreview

Returns a project preview file by project identifier.

Request
GET /api/storefront/v1/projects/{id}/preview[?tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 file

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetPreviewUrl

Returns a project preview URL by project identifier.

Request
GET /api/storefront/v1/projects/{id}/preview-url[?tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

CreateWithSingleItem

Creates a new project with single item.

Request
POST /api/storefront/v1/projects/with-single-item?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

body body CreateSingleItemProjectDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 ProjectDto

Success

400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

CreateWithMultipleItems

Creates a new project with multiple items.

Request
POST /api/storefront/v1/projects/with-multiple-items?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

body body CreateMultiItemProjectDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 ProjectDto

Success

400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

CreateByRenderHiResScenario

Creates a new project by 'Render HiRes' scenario.

Request
POST /api/storefront/v1/projects/by-scenario/render-hires?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

body body CreateProjectByRenderHiResScenarioDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 ProjectDto

Success

400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

CreateBySpecificPipelineScenario

Creates a new project by 'Specific Pipeline' scenario.

Request
POST /api/storefront/v1/projects/by-scenario/specific-pipeline?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

body body CreateProjectBySpecificPipelineScenarioDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 ProjectDto

Success

400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetAvailableTransitions

Returns all available status transitions for a project.

Request
GET /api/storefront/v1/projects/{id}/transitions[?tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProjectTransitionDto

Success

400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

ChangeStatus

Changes the project status.

Request
POST /api/storefront/v1/projects/{id}/transitions/{transition}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier

*transition path

Transition identifying name.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProjectStatusDto

Success

400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 ProjectTransitionConflictDto

Conflict

401

Unauthorized

403

Forbidden

ForceStatus

Changes the project status forcibly without a proper transition.

Request
POST /api/storefront/v1/projects/{id}/statuses/{status}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

*status path

Project status code.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProjectStatusDto

Success

400 Microsoft.AspNetCore.Mvc.ProblemDetails

Bad Request

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

BatchDelete

Deletes specified projects. These projects will be hide from projects list immediately, but complete projects data cleaning will take some additional time.

Request
DELETE /api/storefront/v1/projects/batch-delete[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier.

body body BatchDeleteProjectsInput

Operation parameters.

Responses
Status Code Type Description Samples
200 PagedOfProjectStatusDto

Success

401

Unauthorized

403

Forbidden

GetAllStatuses

Returns a list of all existing project statuses.

Request
GET /api/storefront/v1/projects/statuses[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProjectStatusDto

Success

401

Unauthorized

403

Forbidden

GetAllTransitions

Returns a list of all existing project status transitions.

Request
GET /api/storefront/v1/projects/transitions[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProjectTransitionDto

Success

401

Unauthorized

403

Forbidden

GetProjectPdfUrl Deprecated

Returns an url to download project print file.

Request
GET /api/storefront/v1/projects/{id}/project-pdf?designUserId&designId[&tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

*designUserId query

Design owner identifier.

*designId query

Design identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProjectPdfResultDto

Success

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProjectPdfZip Deprecated

Returns an archive file, which contains all project print files.

Request
GET /api/storefront/v1/projects/{id}/project-pdf-zip?designUserId&designId[&attachment&tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

*designUserId query

Design owner identifier.

*designId query

Design identifier.

attachment query True

If set to 'true', the requested file will be provided as an attachment with proper filename supplied (default value is 'false').

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 file

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProjectProcessingResults

Returns a project processing results.

Request
GET /api/storefront/v1/projects/{id}/processing-results[?itemId&tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

itemId query

Project item identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProjectProcessingResultsDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

ResumeProjectProcessing

Resumes project processing.

Request
POST /api/storefront/v1/projects/{id}/resume-processing[?itemId&tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

itemId query

Project item identifier. If value is set, only specified item processing will be resumed.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
204

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

RestartProjectProcessing

Restarts a project processing routine.

Request
POST /api/storefront/v1/projects/{id}/restart-processing[?itemId&tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

itemId query

Project item identifier. If value is set, only specified item processing will be restarted.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
204

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetProjectOrder

Returns an order description from the ecommerce system for the specified project.

Request
GET /api/storefront/v1/projects/{id}/order[?tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

AttachDataToProjectOrder

Attachs the specified data to the project's order in ecommerce system.

Request
POST /api/storefront/v1/projects/{id}/order-data[?itemId&tenantId]
Parameters
Name In Type Default Notes
*id path

Project identifier.

itemId query

Project item identifier.

tenantId query

Tenant identifier.

body body OrderDataItemDto []

A list of data items, which should be attached to project's order.

Responses
Status Code Type Description Samples
204

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

Storefronts

These endpoints are used to manage tenant storefronts and storefront product references.

GetAll

Returns all storefronts, relevant to the specified query parameters.

Request
GET /api/storefront/v1/storefronts[?types&skip&take&sorting&search&tenantId]
Parameters
Name In Type Default Notes
types query

Storefront type filter.

skip query

Defines page start offset from beginning of sorted result list.

take query

Defines page length (how many 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.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfStorefrontDto

Success

401

Unauthorized

403

Forbidden

Get

Returns a storefront by identifier.

Request
GET /api/storefront/v1/storefronts/{id}[?tenantId]
Parameters
Name In Type Default Notes
*id path

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 StorefrontDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

StorefrontUsers

These endpoints are used to manage storefront users.

GetAll

Returns all storefront users, relevant to the specified query parameters.

Request
GET /api/storefront/v1/storefront-users?storefrontId[&storefrontUserId&skip&take&sorting&search&tenantId]
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 many 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.

Responses
Status Code Type Description Samples
200 PagedOfStorefrontUserDto

Success

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

Create

Creates a new storefront user.

If a user with the specified identifier already exists then the error with http status code 409 be returned.

Request
POST /api/storefront/v1/storefront-users?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

body body CreateStorefrontUserDto

Operation parameters.

Responses
Status Code Type Description Samples
201 StorefrontUserDto

Success

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

Get

Returns a storefront user by identifier.

Request
GET /api/storefront/v1/storefront-users/{id}?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*id path

Storefront user identifier.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 StorefrontUserDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

Register

Registers a storefront user with the specified identifier.

If an anonymous user with the specified identifier already exists then this user become a 'regular' user.

Request
POST /api/storefront/v1/storefront-users/register?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

body body RegisterStorefrontUserInput

Operation parameters.

Responses
Status Code Type Description Samples
200 StorefrontUserDto

Success

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

MergeAnonymous

Transfers all existing data for the anonymous storefront user to the selected regular storefront user account.

Request
POST /api/storefront/v1/storefront-users/merge-anonymous?storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

body body MergeAnonymousUserDataInput

Operation parameters.

Responses
Status Code Type Description Samples
200

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

GetToken

Returns an API access token for the specified storefront user.

Request
GET /api/storefront/v1/storefront-users/token?storefrontUserId&storefrontId[&tenantId]
Parameters
Name In Type Default Notes
*storefrontUserId query

Storefront user identifier.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 string

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 GeneralConflictDto

Conflict

401

Unauthorized

403

Forbidden

TenantInfo

These endpoints are used to get tenant information.

GetApplicationsInfo

Returns an information about the tenant applications.

Request
GET /api/storefront/v1/tenant-info/applications[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 TenantApplicationsInfoDto

Success

401

Unauthorized

403

Forbidden

GetInfo

Returns an information about the tenant.

Request
GET /api/storefront/v1/tenant-info[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 TenantInfoDto

Success

401

Unauthorized

403

Forbidden

GetMeasureUnitsInfo

Returns an information about the tenant measure units.

Request
GET /api/storefront/v1/tenant-info/measure-units[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 TenantMeasureUnitsInfoDto

Success

401

Unauthorized

403

Forbidden

GetUsersInfo

Returns a list of tenant users.

Request
GET /api/storefront/v1/tenant-info/users[?tenantId]
Parameters
Name In Type Default Notes
tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 TenantUserInfoDto []

Success

401

Unauthorized

403

Forbidden

Definitions

BuildInfoModel

Information about a service.

Name Type Notes
version string

Version number.

buildDate string

Build date (UTC).

configuration string

Build configuration (Debug | Release).

appName string

Service name.

PagedOfProcessingPipelineDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProcessingPipelineDto[]

Items list.

ProcessingPipelineDto

Items list.

Name Type Notes
id integer (int32)

Processing pipeline identifier.

name string

Processing pipeline name.

rawContent string

Processing pipeline raw (uncompiled) content.

Microsoft.AspNetCore.Mvc.ProblemDetails

Name Type Notes
type string
title string
status integer (int32)
detail string
instance string

PagedOfProductLinkDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProductLinkDto[]

Items list.

ProductLinkDto

Items list.

Name Type Notes
id integer (int32)

Product link identifier.

productLinkVersionId integer (int32)

Product link version identifier.

productId integer (int32)

Linked product identifier.

productVersionId integer (int32)

Linked product version identifier.

tenantId integer (int32)

Tenant identifier.

name string

Product link name.

description string

Product link description.

productFilterId integer (int32)

Product filter identifier.

image ImageInfo[]

Product link image info.

created string (date-time)

Product link creation time.

lastModified string (date-time)

Product link modification time.

productFilterOptions ProductFilterOptionDto[]

Product filter options.

personalizationWorkflowId integer (int32)

Personalization workflow identifier.

processingPipelineId integer (int32)

Processing pipeline identifier.

storefrontId integer (int32)

Default storefront identifier.

storefrontProductId string

Default storefront product identifier.

storefrontProductName string

Default storefront product name.

ImageInfo

Product link image info.

Name Type Notes
resourceId string

Product resource identifier.

url string

Product Resource URL.

ProductFilterOptionDto

Product filter options.

Name Type Notes
productOptionId integer (int32)

Product option identifier.

productOptionValueId integer (int32)

Product option value identifier.

productOptionType OptionType

Product option type ('Simple' / 'Size' / 'PageCount').

productOptionTraits array

Product option traits.

productOptionTitle string

Product option title.

productOptionValueTitle string

Product option value title.

isDefault boolean

Indicates if option value should be used as a default value for corresponding option.

OptionType

Product option type ('Simple' / 'Size' / 'PageCount').

Enum Values

Simple Size PageCount

GeneralConflictDto

Information about operation conflict.

Name Type Notes
description string

Problem description.

type ConflictType

Coflict type.

ConflictType

Coflict type.

Enum Values

NameConflict FolderOverwriteConflict IdConflict GeneralConflict

ProductSummaryDto

General information about product that editors need to begin personalization process.

Name Type Notes
productId integer (int32)

Product identifier.

productVersionId integer (int32)

Product version identifier. If product variant is not specified, active version identifier should be used.

productLinkId integer (int32)

Product link identifier. If product link is not specified, should be null.

productLinkVersionId integer (int32)

Product link version identifier. If product link is not specified, should be null.

productFilterId integer (int32)

Product filter identifier for product link. If product link is not specified, should be null.

productVariantId integer (int32)

Product variant identifier. If product variant is not specified, should be null.

productVariantSku string

Product variant SKU. If product variant is not specified, should be null.

productVariantPrice number (double)

Product variant price. If product variant is not specified, should be null.

isProductVariantAvailable boolean

Product variant availability. If product variant is not specified, should be null.

name string

Product name. If product link is specified, name of link will be used.

description string

Product description. If product link is specified, description of link will be used.

image ImageInfo[]

Product image info.

tenantId integer (int32)

Tenant identifier.

personalizationWorkflowId integer (int32)

Personalization workflow identifier.

processingPipelineId integer (int32)

Processing pipeline identifier.

tags array

Product tags.

customFields object

Product custom fields.

options ProductSummaryOptionDto[]

Product options summary. If product link or variant is specified, product options will be filtered by link or variant options.

ProductSummaryOptionDto

Product options summary. If product link or variant is specified, product options will be filtered by link or variant options.

Name Type Notes
id integer (int32)

Option identifier.

tag string

Option identifying tag.

title string

Option title.

description string

Option description.

tooltip string

Option tooltip.

sortIndex integer (int32)

Option sort index.

traits array

Option traits.

useForDesignBinding boolean

Indicates if option is used to bind designs to product.

useForMockupBinding boolean

Indicates if option is used to bind mockups to product.

useForDocumentBinding boolean

Indicates if option is used to bind documents to product.

appearanceData AppearanceDataDto[]

Option appearance.

image ImageInfo[]

Option image info.

productOptionValues ProductSummaryOptionValueDto[]

Option values.

AppearanceDataDto

Option appearance.

Name Type Notes
type

Appearance type.

items AppearanceDataItemDto[]

Appearance items.

AppearanceDataItemDto

Appearance items.

Name Type Notes
key string

Appearance item key.

value string

Appearance item value.

ProductSummaryOptionValueDto

Option values.

Name Type Notes
id integer (int32)

Option value identifier.

tag string

Option value identifying tag.

title string

Option value title.

value string

Option value value.

isDefault boolean

Indicates if option value is used as a default value.

description string

Option value description.

colors array

Option value colors.

image ImageInfo[]

Option value image.

PersonalizationWorkflowDto

Personalization workflow description DTO.

Name Type Notes
id integer (int32)

Workflow identifier.

content string

Processed workflow JSON.

workflowType WorkflowType

Workflow type.

WorkflowType

Workflow type.

Enum Values

UIFramework SimpleEditor DesignEditor WorkflowElements

PagedOfProductReferenceDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProductReferenceDto[]

Items list.

ProductReferenceDto

Items list.

Name Type Notes
productReference string

Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.

productReferenceType ProductReferenceType

Product reference target type.

productReferenceName string

Product reference name, e.g. online store product name.

productSpecificationId integer (int32)

Customer's Canvas product specification identifier.

productId integer (int32)

Customer's Canvas product identifier.

productVersionId integer (int32)

Customer's Canvas product version identifier.

productLinkId integer (int32)

Customer's Canvas product link identifier.

storefrontId integer (int32)

Storefront identifier.

tenantId integer (int32)

Tenant identifier.

created string (date-time)

Storefront product reference creation date and time.

ProductReferenceType

Product reference target type.

Enum Values

ProductSpecification Product ProductLink

CreateProductReferenceDto

Create operation parameters.

Name Type Notes
productReference string

Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.

productReferenceType

Product reference target type.

productReferenceName string

Product reference name, e.g. online store product name.

productSpecificationId integer (int32)

Customer's Canvas product specification identifier.

productId integer (int32)

Customer's Canvas product identifier.

productLinkId integer (int32)

Customer's Canvas product link identifier.

ProductReferenceCreationConflictDto

DTO class, containing information about storefront product reference creation conflict.

Name Type Notes
existingReferences ProductReferenceInfo[]

List of storefront product references, which are already exist.

description string

Problem description.

type ConflictType

Coflict type.

ProductReferenceInfo

List of storefront product references, which are already exist.

Name Type Notes
productReference string

Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.

productReferenceType ProductReferenceType

Product reference target type.

productReferenceName string

Product reference name, e.g. online store product name.

productSpecificationId integer (int32)

Customer's Canvas product specification identifier.

productId integer (int32)

Customer's Canvas product identifier.

productLinkId integer (int32)

Customer's Canvas product link identifier.

storefrontId integer (int32)

Storefront identifier.

PagedOfProductSpecificationDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProductSpecificationDto[]

Items list.

ProductSpecificationDto

Items list.

Name Type Notes
id integer (int32)

Product specification identifier.

tenantId integer (int32)

Tenant identifier.

name string

Product specification name.

productAttributes ProductAttributeDto[]

List of product attributes.

created string (date-time)

Product specification creation time.

lastModified string (date-time)

Product specification modification time.

personalizationWorkflowId integer (int32)

Personalization workflow identifier.

processingPipelineId integer (int32)

Processing pipeline identifier.

ProductAttributeDto

List of product attributes.

Name Type Notes
name string

Product attribute name.

type string

Product attribute type.

value

Product attribute value.

PagedOfProductDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProductDto[]

Items list.

ProductDto

Items list.

Name Type Notes
id integer (int32)

Product identifier.

productVersionId integer (int32)

Product version identifier.

tenantId integer (int32)

Tenant identifier.

name string

Product name.

description string

Product description.

image ImageInfo[]

Product image info.

created string (date-time)

Product creation time.

lastModified string (date-time)

Product modification time.

tags array

Product tags.

customFields object

Product custom fields.

personalizationWorkflowId integer (int32)

Personalization workflow identifier.

processingPipelineId integer (int32)

Processing pipeline identifier.

storefrontId integer (int32)

Default storefront identifier.

storefrontProductId string

Default storefront product identifier.

storefrontProductName string

Default storefront product name.

ProductCostDetailsDto

Dto class, containing information about storefront product cost details.

Name Type Notes
productReference string

Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier.

productSku string

Product SKU.

productQuantity integer (int32)

Product quantity.

productPrice number (double)

Product price.

productCost number (double)

Product cost.

productDiscount number (double)

Product discount.

currencyCode string

Currency code.

tenantId integer (int32)

Tenant identifier.

PagedOfProductOptionDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProductOptionDto[]

Items list.

ProductOptionDto

Items list.

Name Type Notes
id integer (int32)

Product option identifier.

productVersionId integer (int32)

Product version identifier

productId integer (int32)

Product identifier.

tenantId integer (int32)

Tenant identifier.

type OptionType

Option type ('Simple' / 'Size' / 'PageCount').

traits array

Option traits.

title string

Product option title.

sortIndex integer (int32)

Product option sort index.

tag string

Product option identifying tag.

useForDesignBinding boolean

Specifies if the option is used for design binding.

useForMockupBinding boolean

Specifies if the option is used for mockup binding.

useForDocumentBinding boolean

Specifies if the option is used for document binding.

description string

Product option description.

tooltip string

Product option tooltip.

appearanceData AppearanceDataDto[]

Product option appearance.

image ImageInfo[]

Product option image info.

productOptionValues ProductOptionValueDto[]

A list of product option values.

ProductOptionValueDto

A list of product option values.

Name Type Notes
id integer (int32)

Product option value identifier.

title string

Product option value title.

sortIndex integer (int32)

Product option value sort index.

isDefault boolean

Indicates if product option value is used as a default value.

tag string

Product option value identifying tag.

simpleOptionValue SimpleOptionValue[]

Product option value description for 'Simple' option type.

description string

Product option value description.

colors array

Product option value colors.

image ImageInfo[]

Product option value image.

SimpleOptionValue

Product option value description for 'Simple' option type.

Name Type Notes
value string

String Value.

PagedOfProductVariantDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProductVariantDto[]

Items list.

ProductVariantDto

Items list.

Name Type Notes
id integer (int32)

Product variant identifier.

productVersionId integer (int32)

Product version identifier.

productId integer (int32)

Product identifier.

tenantId integer (int32)

Tenant identifier.

isAvailable boolean

Product variant available.

price number (double)

Product variant price.

sortIndex integer (int32)

Product variant sort index.

storefrontProductVariantId string

Product variant identifier (usually SKU) in storefront / online store.

productVariantOptions ProductVariantOptionDto[]

A list of product variant options.

ProductVariantOptionDto

A list of product variant options.

Name Type Notes
productOptionId integer (int32)

Product option identifier.

productOptionValueId integer (int32)

Product option value identifier.

productOptionType OptionType

Product option type ('Simple' / 'Size' / 'PageCount').

productOptionTraits array

Product option traits.

productOptionTitle string

Product option title.

productOptionValueTitle string

Product option value title.

simpleOptionValue SimpleOptionValue[]

Product option value description for 'Simple' option type.

PagedOfProductVariantDesignDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProductVariantDesignDto[]

Items list.

ProductVariantDesignDto

Items list.

Name Type Notes
productVariantId integer (int32)

Product variant identifier.

productVersionId integer (int32)

Product version identifier.

productId integer (int32)

Product identifier.

tenantId integer (int32)

Tenant identifier.

isAvailable boolean

Product variant available.

price number (double)

Product variant price.

sortIndex integer (int32)

Product variant sort index.

storefrontProductVariantId string

Product variant identifier (usually SKU) in storefront / online store.

designId string

Design identifier.

designName string

Design name.

designGroup string

Design grouping tag.

designHasDataSchema boolean

Design data schema tag. Indicates if design has data schema.

designHasToggleSet boolean

Design toggle set tag. Indicated if design has toggle set.

productVariantOptions ProductVariantOptionDto[]

A list of product variant options.

productVariantResources ProductVariantResourceDto[]

A list of product variant resources.

ProductVariantResourceDto

A list of product variant resources.

Name Type Notes
resourceId string

Resource identifier.

name string

Resource name.

url string

Resource url.

type ProductVariantResourceType

Resource type.

resourcePreview ProductVariantResourcePreview[]

Product variant resource description for 'Preview' resource type.

ProductVariantResourceType

Resource type.

Enum Values

Preview EditorModel Custom

ProductVariantResourcePreview

Product variant resource description for 'Preview' resource type.

Name Type Notes
width integer (int32)

Preview with in pixels.

height integer (int32)

Preview heigth in pixels.

mockupId string

Mockup which is used to create preview.

surfaceIndex integer (int32)

Design surface index which is used to create preivew.

PagedOfProductVariantMockupDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProductVariantMockupDto[]

Items list.

ProductVariantMockupDto

Items list.

Name Type Notes
productVariantId integer (int32)

Product variant identifier.

productVersionId integer (int32)

Product version identifier.

productId integer (int32)

Product identifier.

tenantId integer (int32)

Tenant identifier.

storefrontProductVariantId string

Product variant identifier in online store (usually SKU).

mockupId string

Mockup identifier.

mockupName string

Mockup name.

mockupType ProductVariantMockupType

Mockup type.

surfaceIndex integer (int32)

Surface index indicates a surface of a design to which mockup should be applied.

surfaceUsageType SurfaceUsageType

Surface usage type defines a scheme for applying mockup to design surfaces.

productVariantOptions ProductVariantOptionDto[]

A list of product variant options.

ProductVariantMockupType

Mockup type.

Enum Values

Thumbnail Editor Preview

SurfaceUsageType

Surface usage type defines a scheme for applying mockup to design surfaces.

Enum Values

Individual Custom All

PagedOfProductVariantDocumentDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProductVariantDocumentDto[]

Items list.

ProductVariantDocumentDto

Items list.

Name Type Notes
productVariantId integer (int32)

Product variant identifier.

productVersionId integer (int32)

Product version identifier.

productId integer (int32)

Product identifier.

tenantId integer (int32)

Tenant identifier.

isAvailable boolean

Product variant available.

price number (double)

Product variant price.

sortIndex integer (int32)

Product variant sort index.

storefrontProductVariantId string

Product variant identifier (usually SKU) in storefront / online store.

documentId string

Document identifier.

documentName string

Document name.

documentGroup string

Document grouping tag.

productVariantOptions ProductVariantOptionDto[]

A list of product variant options.

productVariantResources ProductVariantResourceDto[]

A list of product variant resources.

SetProductVariantPriceDto

Set product variant price operation parameters.

Name Type Notes
price number (double)

Price.

variantIds array

Identifiers of variants for price setting.

PagedOfProjectDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProjectDto[]

Items list.

ProjectDto

Items list.

Name Type Notes
id integer (int32)

Project identifier.

productReference string

Storefront product identifier.

storefrontId integer (int32)

Storefront identifier.

tenantId integer (int32)

Project tenant indentifier.

orderId string

Order identifier in ecommerce system.

orderUrl string

Order url in ecommerce system.

orderNumber integer (int32)

Order number in ecommerce system.

orderLineItemId string

Order item identifier from storefront order.

orderLineItemIndex integer (int32)

Order item index from storefront order.

customerId string

Customer identifier in ecommerce system.

customerName string

Customer name in ecommerce system.

name string

Project name.

ownerId string

Project owner identifier.

items ProjectItemDto[]

List of project items.

status integer (int32)

Project status code.

created string (date-time)

Project creation time.

lastModified string (date-time)

Project modification time.

description string

Description of the project.

processingStatus ProjectProcessingStatus

Project processing status.

ProjectItemDto

List of project items.

Name Type Notes
id integer (int32)

Item identifier.

name string

Item name.

quantity integer (int32)

Item quantity information.

orderLineItemId string

Order item identifier from storefront order.

orderLineItemIndex integer (int32)

Order item index from storefront order.

productReference string

Storefront product reference (i.e external reference to Customer's Canvas product specification).

fields object

Item information.

hidden

Additional item information.

designIds array

A list of design identifiers associated to the item.

sku string

SKU.

resources ProjectItemResourceDto[]

External resources descriptions.

ProjectItemResourceDto

External resources descriptions.

Name Type Notes
resourceId string

Resource ID.

name string

Resource name.

type ProjectItemResourceType

Resource type.

ProjectItemResourceType

Resource type.

Enum Values

General Preview Hires

ProjectProcessingStatus

Project processing status.

Enum Values

Pending InProgress Completed Failed

CreateSingleItemProjectDto

Create operation parameters.

Name Type Notes
productReference string

Product reference (i.e external reference to Customer's Canvas product specification - main subject of this project).

orderLineItemIndex integer (int32)

Line item index from ecommerce system order.

orderLineItemId string

Line Item identifier from ecommerce system order.

items ProjectItemParametersDto[]

List of project items.

orderId string

Order identifier in ecommerce system.

orderUrl string

Order url in ecommerce system.

orderNumber integer (int32)

Order number in ecommerce system.

customerId string

Customer identifier in ecommerce system.

customerName string

Customer name in ecommerce system.

name string

Project name.

ownerId string

Project owner identifier.

item

List of project items.

description string

Description of the project.

ProjectItemParametersDto

List of project items.

Name Type Notes
name string

Item name.

quantity integer (int32)

Item quantity information.

orderLineItemIndex integer (int32)

Line item index from ecommerce system order.

orderLineItemId string

Line Item identifier from ecommerce system order.

productReference string

Storefront product identifier.

fields object

Item information.

hidden

Additional item information.

designIds array

A list of design identifiers associated to the item.

sku string

SKU.

resources ProjectItemResourceParametersDto[]

External resources descriptions.

ProjectItemResourceParametersDto

External resources descriptions.

Name Type Notes
url string

Resource URL.

name string

Resource name.

type

Resource type.

resourceId string

Original resource identifier.

CreateMultiItemProjectDto

Create operation parameters.

Name Type Notes
orderId string

Order identifier in ecommerce system.

orderUrl string

Order url in ecommerce system.

orderNumber integer (int32)

Order number in ecommerce system.

customerId string

Customer identifier in ecommerce system.

customerName string

Customer name in ecommerce system.

name string

Project name.

ownerId string

Project owner identifier.

items ProjectItemParametersDto[]

List of project items.

description string

Description of the project.

CreateProjectByRenderHiResScenarioDto

Create operation parameters.

Name Type Notes
ownerId string

Project owner identifier.

name string

Project name.

description string

Description of the project.

orderDetails

Ecommerce system order description.

orderLineItemIndex integer (int32)

Line item index from ecommerce system order.

orderLineItemId string

Line Item identifier from ecommerce system order.

scenario

List of project items.

CreateProjectBySpecificPipelineScenarioDto

Create operation parameters.

Name Type Notes
ownerId string

Project owner identifier.

name string

Project name.

description string

Description of the project.

orderDetails

Ecommerce system order description.

items ProjectItemParametersDto[]

List of project items.

scenario

'Specific Pipeline' scenario params. For more information check BackOffice.Web.PublicApi.ApiStorefront.Models.SpecificPipelineScenarioDto.

PagedOfProjectTransitionDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProjectTransitionDto[]

Items list.

ProjectTransitionDto

Items list.

Name Type Notes
name string

Transition identifying name.

displayName string

Transition display name.

startStatus integer (int32)

Project status code from which transition to the result status code can be done.

resultStatus integer (int32)

Transition result project status code.

ProjectStatusDto

Dto class, containing the information about project status.

Name Type Notes
code integer (int32)

Status code.

displayName string

Status display name.

ProjectTransitionConflictDto

Dto class, containing information about the project transition conflict.

Name Type Notes
availableTransitions ProjectTransitionDto[]

A list of all available status transitions for the project.

description string

Problem description.

type ConflictType

Coflict type.

BatchDeleteProjectsInput

Operation parameters.

Name Type Notes
ids array

Identifiers of projects that should be deleted.

PagedOfProjectStatusDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProjectStatusDto[]

Items list.

ProjectPdfResultDto

Dto class, containing result of 'get project pdf url' operation.

Name Type Notes
url string

Project pdf url.

ProjectProcessingResultsDto

Dto class, containing description of project processing results.

Name Type Notes
status ProjectProcessingStatus

Project processing status.

statusDescription string

Project status description.

outputFileDetails ProjectOutputFileDetailsDto[]

Collection of project output file descriptions.

ProjectOutputFileDetailsDto

Collection of project output file descriptions.

Name Type Notes
projectItemId integer (int32)

Project item identifier.

orderLineItemId string

Order item identifier from storefront.

orderLineItemIndex integer (int32)

Order item index from storefront.

url string

Project output file URL.

name string

Project output file name.

format string

Project output file format.

artifactId string

Output artifact file identifier.

anonymousAccess boolean

Project output file access strategy.

size integer (int64)

Project output file size in bytes.

OrderDataItemDto

A list of data items, which should be attached to project's order.

Name Type Notes
key string

Order data item key (eventuall order metadata field name).

value string

Order data item value.

type OrderDataItemValueType

Order data item type.

OrderDataItemValueType

Order data item type.

Enum Values

PlainText CommaSeparatedList SerializedJson

PagedOfStorefrontDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items StorefrontDto[]

Items list.

StorefrontDto

Items list.

Name Type Notes
id integer (int32)

Storefront identifier.

tenantId integer (int32)

Tenant identifier.

name string

Storefront name.

type StorefrontType

Storefront ecommerce system type.

created string (date-time)

Storefront entity creation date and time.

StorefrontType

Storefront ecommerce system type.

Enum Values

Custom ShopifyLegacy DocketManager CustomSaml NopCommerce WooCommerce Magento BigCommerce Shopify ShopifyCustom

PagedOfStorefrontUserDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items StorefrontUserDto[]

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 if the user is tracked as an anonymous.

CreateStorefrontUserDto

Operation parameters.

Name Type Notes
storefrontUserId string

Storefront user identifier.

isAnonymous boolean

Indicates if the user is tracked as an anonymous.

RegisterStorefrontUserInput

Operation parameters.

Name Type Notes
storefrontUserId string

Storefront user identifier.

MergeAnonymousUserDataInput

Operation parameters.

Name Type Notes
anonymousStorefrontUserId string

Anonymous storefront user identifier.

regularStorefrontUserId string

Regular storefront user identifier.

TenantApplicationsInfoDto

Dto class, containing information about tenant applications.

Name Type Notes
designEditorUrl string

An url to the 'Design Editor' tenant application.

uiFrameworkUrl string

An url to the 'UI Framework'.

simpleEditorUrl string

An url to the 'Simple editor'.

workflowElementsUrl string

An url to the 'Workflow Elements' web components library.

templateEditorUrl string

An url to the 'Template editor'.

preflightUrl string

An url to the 'Preflight' tenant application.

dynamicImageUrl string

An url to the 'Dynamic Image' tenant application.

tenantId integer (int32)

Tenant identifier

designEditorApiKey string

An ApiKey for the 'Design Editor' tenant application.

preflightApiKey string

An ApiKey for the 'Preflight' tenant application.

dynamicImageApiKey string

An ApiKey for the 'Dynamic Image' tenant application.

TenantInfoDto

Dto class, containing general information about tenant.

Name Type Notes
tenantId integer (int32)

Tenant identifier.

tenancyName string

Tenancy name.

tenantCreationTime string (date-time)

Tenant creation time.

isActive boolean

Tenant activeness status.

TenantMeasureUnitsInfoDto

Dto class, containing information about tenant measure units.

Name Type Notes
sizeMeasureUntis SizeMeasureUnitDto[]

A list of all 'size' measure units of the tenant.

SizeMeasureUnitDto

A list of all 'size' measure units of the tenant.

Name Type Notes
name string

Measure unit full name.

shortName string

Measure unit short name.

ratio number (float)

Measure unit ratio.

isDefault boolean

Indicates if measure unit should be used by default.

TenantUserInfoDto

Name Type Notes
tenantId integer (int32)

Tenant identifier.

userId integer (int64)

User identifier.

userName string

User name.

userSurname string

User surname.

isActive boolean

User status.

Was this page helpful?
Thanks for your feedback!
Back to top Copyright © 2001–2024 Aurigma, Inc. All rights reserved.
Loading...
    Thank for your vote
    Your opinion is important to us. To provide details, send feedback.
    Send feedback