MANAGEMENT API
/
Customer InfoType
/
Update customer info 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

List customer info types by group

Request

Get a list of all active customer, company or store info types for a specific group on the client

Path
groupIdinteger(int32)required

The group identifier that categorizes the info type, see CustomerInfoTypeGroups enum

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/customer/infotype/{groupId}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of active customer, company or store info types for the specified group, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The customer info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, see CustomerInfoTypeGroups enum

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type

Namestring or null[ 0 .. 50 ] characters

The display name of the info type in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the info type for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null[ 0 .. 500 ] characters

The description of the info type in a specific language.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the info type for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

SortOrderinteger(int32)

The sort order for displaying the info type in lists

IsActiveboolean

Indicates whether the info type is active

Changedstring or null

The date and time the info type was last changed

ChangedBystring or null

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

CulturesArray of objects(CustomerInfoTypeCultureModel)

The culture-specific information for the info type

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

Add a customer info type

Request

Add a new customer, company or store info type to a specific group on the client

Path
groupIdinteger(int32)required

The group identifier that categorizes the info type, see CustomerInfoTypeGroups enum

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Model to add

Idinteger(int32)

The customer info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, see CustomerInfoTypeGroups enum

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type

Namestring or null[ 0 .. 50 ] characters

The display name of the info type in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the info type for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null[ 0 .. 500 ] characters

The description of the info type in a specific language.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the info type for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

SortOrderinteger(int32)

The sort order for displaying the info type in lists

IsActiveboolean

Indicates whether the info type is active

Changedstring or null

The date and time the info type was last changed

ChangedBystring or null

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

CulturesArray of objects(CustomerInfoTypeCultureModel)

The culture-specific information for the info type

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

Responses

If the customer info type was successfully added

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

List deleted customer info types by group

Request

Get a list of all deleted customer, company or store info types for a specific group on the client, update a deleted info type with IsActive = true to activate it again

Path
groupIdinteger(int32)required

The group identifier that categorizes the info type, see CustomerInfoTypeGroups enum

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/customer/infotype/{groupId}/deleted' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of deleted customer, company or store info types for the specified group, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The customer info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, see CustomerInfoTypeGroups enum

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type

Namestring or null[ 0 .. 50 ] characters

The display name of the info type in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the info type for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null[ 0 .. 500 ] characters

The description of the info type in a specific language.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the info type for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

SortOrderinteger(int32)

The sort order for displaying the info type in lists

IsActiveboolean

Indicates whether the info type is active

Changedstring or null

The date and time the info type was last changed

ChangedBystring or null

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

CulturesArray of objects(CustomerInfoTypeCultureModel)

The culture-specific information for the info type

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

Get customer info type by group and id

Request

Get a specific customer, company or store info type by its internal Id for a specific group

Path
groupIdinteger(int32)required

The group identifier that categorizes the info type, see CustomerInfoTypeGroups enum

idinteger(int32)required

Info 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/customer/infotype/{groupId}/item/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the CustomerInfoType

Bodyapplication/json
Idinteger(int32)

The customer info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, see CustomerInfoTypeGroups enum

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type

Namestring or null[ 0 .. 50 ] characters

The display name of the info type in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the info type for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null[ 0 .. 500 ] characters

The description of the info type in a specific language.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the info type for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

SortOrderinteger(int32)

The sort order for displaying the info type in lists

IsActiveboolean

Indicates whether the info type is active

Changedstring or null

The date and time the info type was last changed

ChangedBystring or null

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

CulturesArray of objects(CustomerInfoTypeCultureModel)

The culture-specific information for the info type

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

Update customer info type

Request

Update an existing customer, company or store info type for a specific group on the client

Path
groupIdinteger(int32)required

The group identifier that categorizes the info type, see CustomerInfoTypeGroups enum

idinteger(int32)required

Info type id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Model to update

Idinteger(int32)

The customer info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, see CustomerInfoTypeGroups enum

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type

Namestring or null[ 0 .. 50 ] characters

The display name of the info type in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the info type for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null[ 0 .. 500 ] characters

The description of the info type in a specific language.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the info type for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

SortOrderinteger(int32)

The sort order for displaying the info type in lists

IsActiveboolean

Indicates whether the info type is active

Changedstring or null

The date and time the info type was last changed

ChangedBystring or null

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

CulturesArray of objects(CustomerInfoTypeCultureModel)

The culture-specific information for the info type

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

Responses

If the customer info type was successfully updated

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

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

Product WarehouseLocation

Operations

Product Warehouse

Operations