Back to Website
Show / Hide Table of Contents

ProductReferences

These endpoints are used to manage storefront product references

GetAll

Gets all storefront product references relevant to specified query parameters

Request
GET /api/storefront/v1/product-references?storefrontId[&productReference&productSpecificationId&skip&take&sorting&search&tenantId&userId]
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 much consequent items of sorted result list should be taken)

sorting query

Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"

search query

Search string for partial match

*storefrontId query

Storefront identifier

tenantId query

Tenant identifier

userId query

User identifier

Responses
Status Code Type Description Samples
200 PagedOfProductReferenceDto

Success

401

Unauthorized

403

Forbidden

Create

Creates new storefront product reference

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

Storefront identifier

tenantId query

Tenant identifier

userId query

User 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

Gets storefront product reference

Request
GET /api/storefront/v1/product-references/{reference}?storefrontId[&tenantId&userId]
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

userId query

User identifier

Responses
Status Code Type Description Samples
200 ProductReferenceDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Delete

Deletes storefront product reference

Request
DELETE /api/storefront/v1/product-references/{reference}?storefrontId[&tenantId&userId]
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

userId query

User identifier

Responses
Status Code Type Description Samples
200 ProductReferenceDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetProductSpecification

Gets product specification by storefront product reference

Request
GET /api/storefront/v1/product-references/{reference}/product-specification?storefrontId[&tenantId&userId]
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

userId query

User identifier

Responses
Status Code Type Description Samples
200 ProductSpecificationDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

GetProductConfig

Gets product configuration information by storefront product reference

Request
GET /api/storefront/v1/product-references/{reference}/product-config?storefrontId[&tenantId&userId]
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

userId query

User identifier

Responses
Status Code Type Description Samples
200 ProductReferenceDto

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Definitions

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

These endpoints are used to manage storefront product references

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

ProductSpecificationDto

Product specification dto class

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

Back to top Copyright © 2001–2022 Aurigma, Inc. All rights reserved.
Loading...