Back to Website
Show / Hide Table of Contents

ProductSpecifications

These endpoints are used to manage tenant product specifications

GetAll

Gets all product specifications relevant to specified query parameters

Request
GET /api/storefront/v1/product-specifications[?skip&take&sorting&search&tenantId&userId]
Parameters
Name In Type Default Notes
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

tenantId query

Tenant identifier

userId query

User identifier

Responses
Status Code Type Description Samples
200 PagedOfProductSpecificationDto

Success

401

Unauthorized

403

Forbidden

Get

Gets product specification by id

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

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

GetConfiguration

Gets product configuration description by product specification id

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

Product specification identifier

tenantId query

Tenant identifier

userId query

User identifier

Responses
Status Code Type Description Samples
200 string

Success

404 Microsoft.AspNetCore.Mvc.ProblemDetails

Not Found

401

Unauthorized

403

Forbidden

Definitions

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

ProductAttributeDto

List of product attributes

Name Type Notes
name string

Product attribute name

type string

Product attribute type

value

Product attribute value

Microsoft.AspNetCore.Mvc.ProblemDetails

These endpoints are used to manage tenant product specifications

Name Type Notes
type string
title string
status integer (int32)
detail string
instance string
Back to top Copyright © 2001–2022 Aurigma, Inc. All rights reserved.
Loading...