MANAGEMENT API
/
Product Type

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

Get a product type

Request

Get a specific product type by its internal Id

Path
idinteger(int32)required

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

Responses

Returns the ProductType

Bodyapplication/json
Idinteger(int32)

The product type identifier

Namestring or null[ 0 .. 50 ] characters

The display name of the product type in a specific language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the product type for the default language

Descriptionstring or null[ 0 .. 500 ] characters

The description of the product type in a specific language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the product type for the default language

GroupNamestring or null

The group name that categorizes the product type

SortOrderinteger(int32)

The sort order for displaying the product type in lists

Changedstring or null

The date and time the product type was last changed

ChangedBystring or null

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

CulturesArray of objects(ProductTypeCultureModel)

The culture-specific information for the product type

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

Update a product type

Request

Update an existing product type

Path
idinteger(int32)required

Product type id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Type to update

Idinteger(int32)

The product type identifier

Namestring or null[ 0 .. 50 ] characters

The display name of the product type in a specific language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the product type for the default language

Descriptionstring or null[ 0 .. 500 ] characters

The description of the product type in a specific language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the product type for the default language

GroupNamestring or null

The group name that categorizes the product type

SortOrderinteger(int32)

The sort order for displaying the product type in lists

Changedstring or null

The date and time the product type was last changed

ChangedBystring or null

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

CulturesArray of objects(ProductTypeCultureModel)

The culture-specific information for the product type

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

Responses

If the product type was successfully updated

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

List product types

Request

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

Responses

Returns the list of product types, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The product type identifier

Namestring or null[ 0 .. 50 ] characters

The display name of the product type in a specific language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the product type for the default language

Descriptionstring or null[ 0 .. 500 ] characters

The description of the product type in a specific language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the product type for the default language

GroupNamestring or null

The group name that categorizes the product type

SortOrderinteger(int32)

The sort order for displaying the product type in lists

Changedstring or null

The date and time the product type was last changed

ChangedBystring or null

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

CulturesArray of objects(ProductTypeCultureModel)

The culture-specific information for the product type

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

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