MANAGEMENT API
/
Product Family

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

Get product family

Request

Get a specific product family by its internal Id

Path
idinteger(int32)required

Family 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/family/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the Family

Bodyapplication/json
Idinteger(int32)

The unique identifier of the family

Codestring or null[ 0 .. 50 ] characters

The code identifier of the family

Namestring or null

The localized name of the family

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the family for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null

The localized description of the family

DefaultDescriptionstring or null

The description of the family for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

IsActiveboolean

Indicates whether the family is active

ImageKeystring or null(guid)

Unique blob identifier for an associated image.

Changedstring or null

The date and time the family was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the family

CulturesArray of objects(FamilyCultureModel)

The collection of culture-specific data for the family

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

Update a product family

Request

Update an existing product family

Path
idinteger(int32)required

Family id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Family to update

Idinteger(int32)

The unique identifier of the family

Codestring or null[ 0 .. 50 ] characters

The code identifier of the family

Namestring or null

The localized name of the family

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the family for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null

The localized description of the family

DefaultDescriptionstring or null

The description of the family for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

IsActiveboolean

Indicates whether the family is active

ImageKeystring or null(guid)

Unique blob identifier for an associated image.

Changedstring or null

The date and time the family was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the family

CulturesArray of objects(FamilyCultureModel)

The collection of culture-specific data for the family

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

Responses

If the product family was successfully updated

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

List active product families

Request

Get a list of all active product families 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/family \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of product families, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The unique identifier of the family

Codestring or null[ 0 .. 50 ] characters

The code identifier of the family

Namestring or null

The localized name of the family

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the family for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null

The localized description of the family

DefaultDescriptionstring or null

The description of the family for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

IsActiveboolean

Indicates whether the family is active

ImageKeystring or null(guid)

Unique blob identifier for an associated image.

Changedstring or null

The date and time the family was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the family

CulturesArray of objects(FamilyCultureModel)

The collection of culture-specific data for the family

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

Add a product family

Request

Add a new product family to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Family to add

Idinteger(int32)

The unique identifier of the family

Codestring or null[ 0 .. 50 ] characters

The code identifier of the family

Namestring or null

The localized name of the family

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the family for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null

The localized description of the family

DefaultDescriptionstring or null

The description of the family for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

IsActiveboolean

Indicates whether the family is active

ImageKeystring or null(guid)

Unique blob identifier for an associated image.

Changedstring or null

The date and time the family was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the family

CulturesArray of objects(FamilyCultureModel)

The collection of culture-specific data for the family

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

Responses

If the product family was successfully added

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

List deleted product families

Request

Get a list of all deleted product families on the client, update a deleted family with IsActive = true to activate it again

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/family/deleted \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of deleted product families, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The unique identifier of the family

Codestring or null[ 0 .. 50 ] characters

The code identifier of the family

Namestring or null

The localized name of the family

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the family for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null

The localized description of the family

DefaultDescriptionstring or null

The description of the family for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

IsActiveboolean

Indicates whether the family is active

ImageKeystring or null(guid)

Unique blob identifier for an associated image.

Changedstring or null

The date and time the family was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the family

CulturesArray of objects(FamilyCultureModel)

The collection of culture-specific data for the family

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

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

Product WarehouseLocation

Operations

Product Warehouse

Operations