MANAGEMENT API
/
Product RelationType

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

Get a relation type by id

Request

Get a specific relation type by its internal id

Path
idinteger(int32)required

Relation type 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/relationtype/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the RelationType

Bodyapplication/json
Idinteger(int32)

The system internal identifier for the relation type

Codestring or null[ 0 .. 50 ] characters

The unique code identifier for the relation type

Namestring or null[ 0 .. 50 ] characters

The name of the relation type in a specific language

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

DefaultNamestring or null[ 0 .. 50 ] characters

The name for the relation type for the default language.

Descriptionstring or null[ 0 .. 500 ] characters

The description of the relation type in a specific language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The description for the relation type for the default language.

IsBidirectionalboolean

Indicates whether the relation type works in both directions

IsActiveboolean

Indicates whether the relation type is active

SortOrderinteger or null(int32)

The sort order for displaying the relation type, used in lists

Changedstring or null

The date and time the relation type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the relation type

CulturesArray of objects(RelationTypeCultureModel)

The list of culture-specific translations for this relation type

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

Update a relation type

Request

Update an existing relation type

Path
idinteger(int32)required

Relation type id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Relation type to update

Idinteger(int32)

The system internal identifier for the relation type

Codestring or null[ 0 .. 50 ] characters

The unique code identifier for the relation type

Namestring or null[ 0 .. 50 ] characters

The name of the relation type in a specific language

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

DefaultNamestring or null[ 0 .. 50 ] characters

The name for the relation type for the default language.

Descriptionstring or null[ 0 .. 500 ] characters

The description of the relation type in a specific language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The description for the relation type for the default language.

IsBidirectionalboolean

Indicates whether the relation type works in both directions

IsActiveboolean

Indicates whether the relation type is active

SortOrderinteger or null(int32)

The sort order for displaying the relation type, used in lists

Changedstring or null

The date and time the relation type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the relation type

CulturesArray of objects(RelationTypeCultureModel)

The list of culture-specific translations for this relation type

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

Responses

If the relation type was successfully updated

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

List relation types

Request

Get a list of all relation types

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

Responses

Returns the list of relation types, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The system internal identifier for the relation type

Codestring or null[ 0 .. 50 ] characters

The unique code identifier for the relation type

Namestring or null[ 0 .. 50 ] characters

The name of the relation type in a specific language

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

DefaultNamestring or null[ 0 .. 50 ] characters

The name for the relation type for the default language.

Descriptionstring or null[ 0 .. 500 ] characters

The description of the relation type in a specific language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The description for the relation type for the default language.

IsBidirectionalboolean

Indicates whether the relation type works in both directions

IsActiveboolean

Indicates whether the relation type is active

SortOrderinteger or null(int32)

The sort order for displaying the relation type, used in lists

Changedstring or null

The date and time the relation type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the relation type

CulturesArray of objects(RelationTypeCultureModel)

The list of culture-specific translations for this relation type

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

Add new relation type

Request

Add a new relation type

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Relation type to add

Idinteger(int32)

The system internal identifier for the relation type

Codestring or null[ 0 .. 50 ] characters

The unique code identifier for the relation type

Namestring or null[ 0 .. 50 ] characters

The name of the relation type in a specific language

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

DefaultNamestring or null[ 0 .. 50 ] characters

The name for the relation type for the default language.

Descriptionstring or null[ 0 .. 500 ] characters

The description of the relation type in a specific language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The description for the relation type for the default language.

IsBidirectionalboolean

Indicates whether the relation type works in both directions

IsActiveboolean

Indicates whether the relation type is active

SortOrderinteger or null(int32)

The sort order for displaying the relation type, used in lists

Changedstring or null

The date and time the relation type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the relation type

CulturesArray of objects(RelationTypeCultureModel)

The list of culture-specific translations for this relation type

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

Responses

If the relation type was successfully added

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

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