COMMERCE QUERY
/
Query API 3.0
/
Application
/
Gets all file info records.

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://norcecommerce.api-se.norce.tech/commerce/query/3.0/

Schemas

Application

Operations

Gets all product families.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Application/Families \
  -H 'ApplicationId: 0'

Responses

A queryable collection of product families.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the productfamily.

clientIdinteger(int32)

The client identifier.

codestring or null[ 0 .. 50 ] characters

The code of the product family.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the product family.

defaultDescriptionstring or null

The default description of the product family.

defaultImagePathstring or null[ 0 .. 255 ] characters

The default image path, not used anymore.

defaultThumbnailImagePathstring or null[ 0 .. 255 ] characters

The default thumbnail image path, not used anymore.

defaultCampaignImagePathstring or null[ 0 .. 255 ] characters

The default campaign image path, not used anymore.

defaultLargeImagePathstring or null[ 0 .. 255 ] characters

The default large image path, not used anymore.

isActiveboolean

Indicates whether the product family is active.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

imageKeystring or null(guid)

The image key.

culturesArray of objects or null(FamilyCulture)
productFamilyArray of objects or null(ProductFamily)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "code": "string",
    "defaultName": "string",
    "defaultDescription": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "imageKey": "string",
    "cultures": [ … ],
    "productFamily": [ … ]
  }
]

Gets all file info records.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Application/FileInfos \
  -H 'ApplicationId: 0'

Responses

A queryable collection of file info records and client-configured file and image types; these are called file types in the admin, Connect, and Commerce services.

Bodyapplication/jsonArray [
fileIdinteger(int32)

The file type identifier.

clientIdinteger(int32)

The client identifier.

codestring or null[ 0 .. 50 ] characters

The code of the file type.

sortOrderinteger or null(int32)

The sort order for display purposes.

updatedstring(date-time)

The date and time the record was last updated.

updatedByinteger(int32)

The identifier of the user who last updated the record.

]
Response
application/json
[
  {
    "fileId": 0,
    "clientId": 0,
    "code": "string",
    "sortOrder": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0
  }
]

Gets all parametric definitions.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Application/Parametrics \
  -H 'ApplicationId: 0'

Responses

A queryable collection of parametric definitions.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the parametric.

clientIdinteger(int32)

The client identifier.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the parametric in the default culture.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the parametric in the default culture.

defaultUomstring or null[ 0 .. 50 ] characters

The unit of measure in the default culture.

typeIdinteger(int32)

The type identifier, Text (1), Integer (2), Decimal (3), Boolean (4), HTML (5), Date (6).

hasListValuesboolean

Indicates whether the parametric has list values, is of type List and has at least one list item.

hasMultipleValuesboolean

Indicates whether the parametric has multiple values, is of type Multiple and has at least one multiple item.

isVariantTypeboolean

Indicates whether the parametric is used in at least one variant group (variant type). A parametric can be used in multiple variant groups.

isRequiredboolean

Indicates whether the parametric is required, can be overridden on the CategoryParametric setting.

isHiddenboolean

Indicates whether the parametric should be hidden in front end applications.

isActiveboolean

Indicates whether the parametric is active.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

codestring or null[ 0 .. 50 ] characters

The code of the parametric.

codeListKeystring or null[ 0 .. 50 ] characters

The code list key, commonly not used.

isReadOnlyboolean

Indicates whether the parametric is read only, disable edit in the admin tool.

editorstring or null[ 0 .. 16 ] characters

The editor, HTML or Text, used by the admin tool to allow for editing the parametric value.

isFavoriteboolean

Indicates whether the parametric is favorite, adds the parametric to the top header of the product page in the admin tool.

isPublicboolean

Indicates whether the parametric is public, similar to IsHidden, but not used anymore, shows same values as IsActive.

groupIdinteger or null(int32)

The parametric group identifier.

defaultIsVariantUniqueboolean

Indicates if the parametric should be set on variant level by default on products.

showOnTextTabboolean

Indicates whether show on text tab is enabled, moved the parametric to the text tab in the admin tool.

showInListboolean

Indicates whether show in list is enabled, makes the parametric available in listings from api calls in commerce service.

categoryParametricArray of objects or null(CategoryParametric)
group(ParametricGroup (object or null))
One of:
culturesArray of objects or null(ParametricCulture)
parametricListArray of objects or null(ParametricList)
parametricMultipleArray of objects or null(ParametricMultiple)
productParametricArray of objects or null(ProductParametric)
variantTypeArray of objects or null(VariantType)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "defaultUom": "string",
    "typeId": 0,
    "hasListValues": true,
    "hasMultipleValues": true,
    "isVariantType": true,
    "isRequired": true,
    "isHidden": true,
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "code": "string",
    "codeListKey": "string",
    "isReadOnly": true,
    "editor": "string",
    "isFavorite": true,
    "isPublic": true,
    "groupId": 0,
    "defaultIsVariantUnique": true,
    "showOnTextTab": true,
    "showInList": true,
    "categoryParametric": [ … ],
    "group": { … },
    "cultures": [ … ],
    "parametricList": [ … ],
    "parametricMultiple": [ … ],
    "productParametric": [ … ],
    "variantType": [ … ]
  }
]

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations