Back to Website
Show / Hide Table of Contents

Storefront API

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.

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

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&skip&take&sorting&search&tenantId]
Parameters
Name In Type Default Notes
productReference query

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

productSpecificationId query

Cusomer's Canvas product specification 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.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProductReferenceDto

Success

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

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

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

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

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 specification, 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

401

Unauthorized

403

Forbidden

GetProductConfig

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

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 string

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

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

Product reference - external reference to Customer's Canvas product product specification, 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

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

GetConfiguration

Returns a product personlization 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?storefrontId[&ownerId&productReference&status&datePeriod&skip&take&sorting&search&orderId&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.

*storefrontId query

Storefront identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 PagedOfProjectDto

Success

401

Unauthorized

403

Forbidden

Create

Creates a new project.

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

Storefront identifier.

tenantId query

Tenant identifier.

body body CreateProjectDto

Create operation parameters.

Responses
Status Code Type Description Samples
201 ProjectDto

Success

409 Microsoft.AspNetCore.Mvc.ProblemDetails

Conflict

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

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

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

409 Microsoft.AspNetCore.Mvc.ProblemDetails

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 ProjectTransitionConflictDto

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

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

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

401

Unauthorized

403

Forbidden

GetProjectPdfZip

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 string

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetProjectProcessingResults

Returns a project processing results.

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

Project identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
200 ProjectProcessingResultsDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

ResumeProjectProcessing

Resumes project processing.

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

Project identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
204

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

RestartProjectProcessing

Restarts a project processing routine.

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

Project identifier.

tenantId query

Tenant identifier.

Responses
Status Code Type Description Samples
204

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

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

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

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

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 Microsoft.AspNetCore.Mvc.ProblemDetails

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

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 Microsoft.AspNetCore.Mvc.ProblemDetails

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 Microsoft.AspNetCore.Mvc.ProblemDetails

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
201 string

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

409 Microsoft.AspNetCore.Mvc.ProblemDetails

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

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.

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 specification, e.g online store product identifier.

productSpecificationId integer (int32)

Customer's Canvas product specification identifier.

storefrontId integer (int32)

Storefront identifier.

tenantId integer (int32)

Tenant identifier.

created string (date-time)

Storefront product reference creation date and time.

CreateProductReferenceDto

Dto class, containing create operation parameters for storefront product reference.

Name Type Notes
productReference string

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

productSpecificationId integer (int32)

Customer's Canvas product specification identifier.

Microsoft.AspNetCore.Mvc.ProblemDetails

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

ProductSpecificationDto

Dto class, containing information about product specification.

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.

ProductAttributeDto

List of product attributes.

Name Type Notes
name string

Product attribute name.

type string

Product attribute type.

value

Product attribute value.

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.

PagedOfProductSpecificationDto

Paged list of items.

Name Type Notes
total integer (int64)

Items count.

items ProductSpecificationDto[]

Items list.

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

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

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

Line item identifier from external ecommerce system order.

orderLineItemIndex integer (int32)

Line item index from external ecommerce system 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.

ProjectItemDto

List of project items.

Name Type Notes
name string

Item name.

quantity integer (int32)

Item quantity information.

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

Available product resource types

ProjectItemResourceType

Available product resource types

Enum Values

General Preview Hires

CreateProjectDto

Dto class, containing create operation parameters for project entity.

Name Type Notes
productReference string

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

orderId string

Order identifier in ecommerce system.

orderUrl string

Order url in ecommerce system.

orderNumber integer (int32)

Order number in ecommerce system.

orderLineItemIndex integer (int32)

Line item index from ecommerce system order.

orderLineItemId string

Line Item identifier from ecommerce system 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 ProjectItemParametersDto[]

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.

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 ProjectItemResourceType

Available product resource types

CreateProjectByRenderHiResScenarioDto

Dto class, containing 'create' operation parameters for project entity.

Name Type Notes
ownerId string

Project owner identifier.

name string

Project name.

description string

Description of the project.

orderDetails OrderDetailsDto[]

Dto class, containing ecommerce order description.

scenario RenderHiResScenarioDto[]

Dto class, containing 'RenderHiRes' scenario paramters.

OrderDetailsDto

Dto class, containing ecommerce order description.

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.

orderLineItemIndex integer (int32)

Line item index from ecommerce system order.

orderLineItemId string

Line Item identifier from ecommerce system order.

customerId string

Customer identifier in ecommerce system.

customerName string

Customer name in ecommerce system.

RenderHiResScenarioDto

Dto class, containing 'RenderHiRes' scenario paramters.

Name Type Notes
designId string

Private design identifier.

name string

Output file name (without extension).

dpi integer (int32)

Output file DPI.

format RenderHiResScenarioOutputFormat
colorSpace RenderHiResScenarioOutputColorSpace
flipMode RenderHiResScenarioOutputFlipMode
anonymousAccess boolean

Output file access mode.

RenderHiResScenarioOutputFormat

Enum Values

Pdf Jpeg Png Tiff

RenderHiResScenarioOutputColorSpace

Enum Values

Rgb Grayscale Cmyk

RenderHiResScenarioOutputFlipMode

Enum Values

None Horizontal Vertical Both

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.

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.

ProjectStatusDto

Dto class, containing the information about project status.

Name Type Notes
code integer (int32)

Status code.

displayName string

Status display name.

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

Available project processing statuses.

statusDescription string

Project status description.

outputFileDetails ProjectOutputFileDetailsDto[]

Collection of project output file descriptions.

ProjectProcessingStatus

Available project processing statuses.

Enum Values

Pending InProgress Completed Failed

ProjectOutputFileDetailsDto

Collection of project output file descriptions.

Name Type Notes
url string

Project output file URL.

name string

Project output file name

format string

Project output file format

artifactId string

Project output file id withing artifacts storage.

anonymousAccess boolean

Project output file access strategy.

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 types.

created string (date-time)

Storefront entity creation date and time.

StorefrontType

Storefront types.

Enum Values

Custom ShopifyLegacy DocketManager CustomSaml NopCommerce WooCommerce Magento BigCommerce Shopify

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

Dto class, containing create operation parameters for storefront user.

Name Type Notes
storefrontUserId string

Storefront user identifier.

isAnonymous boolean

Indicates if the user is tracked as an anonymous.

RegisterStorefrontUserInput

Name Type Notes
storefrontUserId string

Storefront user identifier.

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.

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'.

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.

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–2022 Aurigma, Inc. All rights reserved.
Loading...
    Thank for your vote
    Your opinion is important to us. To provide details, send feedback.
    Send feedback