Product VariantGroup
/
List active variant groups

Management API (v1)

The Norce Management API lets you manage configurations and metadata on a client.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Operations

CategoryParametric

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Customer FlagGroup

Operations

Customer Flag

Operations

Customer InfoType

Operations

Product Family

Operations

Product File

Operations

Product Manufacturer

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

Parametric

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

Shopping InfoType

Operations

Store Application

Operations

Store PriceList

Operations

Store

Operations

Store Warehouse

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations

Product VariantGroup

Operations

Get a variant group

Request

Get a specific variant group by its internal id

Path
idinteger(int32)required

Variant group id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/variant-group/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the Variant group

Bodyapplication/json
Idinteger(int32)

The variant group identifier

Namestring or null[ 0 .. 50 ] characters

The name of the variant group in the current culture

DefaultNamestring or null[ 0 .. 50 ] characters

The default name of the variant group

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null[ 0 .. 500 ] characters

The description of the variant group in the current culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the variant group

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

Codestring or null[ 0 .. 50 ] characters

The unique code identifier for the variant group

IsActiveboolean

Indicates whether the variant group is active

Changedstring or null

The date and time when the variant group was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the variant group

VariantTypesArray of objects(VariantTypeModel)

The list of variant types associated with this variant group

CulturesArray of objects(VariantGroupCultureModel)

The list of culture-specific translations for this variant group

Response
application/json
{
  "Id": 0,
  "Name": "string",
  "DefaultName": "string",
  "IsNameInherited": true,
  "Description": "string",
  "DefaultDescription": "string",
  "IsDescriptionInherited": true,
  "Code": "string",
  "IsActive": true,
  "Changed": "string",
  "ChangedBy": "string",
  "VariantTypes": [
    { … }
  ],
  "Cultures": [
    { … }
  ]
}

Update a variant group

Request

Update a specific variant group by its internal id

Path
idinteger(int32)required

Variant group id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Variant group

Idinteger(int32)

The variant group identifier

Namestring or null[ 0 .. 50 ] characters

The name of the variant group in the current culture

DefaultNamestring or null[ 0 .. 50 ] characters

The default name of the variant group

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null[ 0 .. 500 ] characters

The description of the variant group in the current culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the variant group

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

Codestring or null[ 0 .. 50 ] characters

The unique code identifier for the variant group

IsActiveboolean

Indicates whether the variant group is active

Changedstring or null

The date and time when the variant group was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the variant group

VariantTypesArray of objects(VariantTypeModel)

The list of variant types associated with this variant group

CulturesArray of objects(VariantGroupCultureModel)

The list of culture-specific translations for this variant group

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/variant-group/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Code": "string",
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "VariantTypes": [
      {
        "Id": 0,
        "Name": "string",
        "DefaultName": "string",
        "IsNameInherited": true,
        "Description": "string",
        "DefaultDescription": "string",
        "IsDescriptionInherited": true,
        "Code": "string",
        "SortOrder": 0,
        "IsActive": true,
        "ParametricId": 0,
        "ParametricName": "string",
        "ParametricDescription": "string",
        "Uom": "string",
        "Type": "string",
        "Changed": "string",
        "ChangedBy": "string",
        "Cultures": [
          {
            "CultureCode": "string",
            "IsTranslated": true,
            "Name": "string",
            "IsNameInherited": true,
            "Description": "string",
            "IsDescriptionInherited": true
          }
        ]
      }
    ],
    "Cultures": [
      {
        "CultureCode": "string",
        "IsTranslated": true,
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true
      }
    ]
  }'

Responses

If the variant group was successfully updated

Bodyapplication/json
integer(int32)
Response
application/json
0

List active variant groups

Request

Get a list of all active variant groups on the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/variant-group \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of active variant groups

Bodyapplication/jsonArray [
Idinteger(int32)

The variant group identifier

Namestring or null[ 0 .. 50 ] characters

The name of the variant group in the current culture

DefaultNamestring or null[ 0 .. 50 ] characters

The default name of the variant group

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null[ 0 .. 500 ] characters

The description of the variant group in the current culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the variant group

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

Codestring or null[ 0 .. 50 ] characters

The unique code identifier for the variant group

IsActiveboolean

Indicates whether the variant group is active

Changedstring or null

The date and time when the variant group was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the variant group

VariantTypesArray of objects(VariantTypeModel)

The list of variant types associated with this variant group

CulturesArray of objects(VariantGroupCultureModel)

The list of culture-specific translations for this variant group

]
Response
application/json
[
  {
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Code": "string",
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "VariantTypes": [ … ],
    "Cultures": [ … ]
  }
]

Add a variant group

Request

Add a new variant group to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Variant group

Idinteger(int32)

The variant group identifier

Namestring or null[ 0 .. 50 ] characters

The name of the variant group in the current culture

DefaultNamestring or null[ 0 .. 50 ] characters

The default name of the variant group

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null[ 0 .. 500 ] characters

The description of the variant group in the current culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the variant group

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

Codestring or null[ 0 .. 50 ] characters

The unique code identifier for the variant group

IsActiveboolean

Indicates whether the variant group is active

Changedstring or null

The date and time when the variant group was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the variant group

VariantTypesArray of objects(VariantTypeModel)

The list of variant types associated with this variant group

CulturesArray of objects(VariantGroupCultureModel)

The list of culture-specific translations for this variant group

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/variant-group \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Code": "string",
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "VariantTypes": [
      {
        "Id": 0,
        "Name": "string",
        "DefaultName": "string",
        "IsNameInherited": true,
        "Description": "string",
        "DefaultDescription": "string",
        "IsDescriptionInherited": true,
        "Code": "string",
        "SortOrder": 0,
        "IsActive": true,
        "ParametricId": 0,
        "ParametricName": "string",
        "ParametricDescription": "string",
        "Uom": "string",
        "Type": "string",
        "Changed": "string",
        "ChangedBy": "string",
        "Cultures": [
          {
            "CultureCode": "string",
            "IsTranslated": true,
            "Name": "string",
            "IsNameInherited": true,
            "Description": "string",
            "IsDescriptionInherited": true
          }
        ]
      }
    ],
    "Cultures": [
      {
        "CultureCode": "string",
        "IsTranslated": true,
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true
      }
    ]
  }'

Responses

If the variant group was successfully added

Bodyapplication/json
integer(int32)
Response
application/json
0

Product WarehouseLocation

Operations

Product Warehouse

Operations