COMMERCE QUERY

Query API 3.0

Family

Commerce Query API (v3.0)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/query/3.0/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/query/3.0/

Production

https://{slug}.api-se.norce.tech/commerce/query/3.0/

Schemas

ProductFamily

productIdinteger(int32)

The product identifier.

familyIdinteger(int32)

The family identifier.

isPrimaryboolean

Indicates whether the product family is primary.

sortOrderinteger or null(int32)

The sort order for display purposes.

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.

{
  "productId": 0,
  "familyId": 0,
  "isPrimary": true,
  "sortOrder": 0,
  "isActive": true,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0
}

Family

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)

{
  "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": [
    { … }
  ]
}

FamilyCulture

familyIdinteger(int32)

The product family identifier.

cultureCodestring or null[ 0 .. 16 ] characters

The culture code (e.g. en-US).

namestring or null[ 0 .. 50 ] characters

The culture specific name of the product family.

descriptionstring or null

The culture specific description of the product family.

imagePathstring or null[ 0 .. 255 ] characters

The image path, not used anymore.

thumbnailImagePathstring or null[ 0 .. 255 ] characters

The thumbnail image path, not used anymore.

campaignImagePathstring or null[ 0 .. 255 ] characters

The campaign image path, not used anymore.

largeImagePathstring or null[ 0 .. 255 ] characters

The large image path, not used anymore.

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.

clientIdinteger or null(int32)

The client identifier.

{
  "familyId": 0,
  "cultureCode": "string",
  "name": "string",
  "description": "string",
  "imagePath": "string",
  "thumbnailImagePath": "string",
  "campaignImagePath": "string",
  "largeImagePath": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "imageKey": "string",
  "clientId": 0
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations