MANAGEMENT API
/
Shopping InfoType

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

Get shopping info type by id

Request

Get a specific shopping info type by its internal Id

Path
itemIdinteger(int32)required

Info type id

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

Responses

Returns the ShoppingInfoType

Bodyapplication/json
Idinteger(int32)

The shopping info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, allowed values are: 1 = Quotation/Order, 2 = Quotation Item/Order Item

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type, needed to identify the info type in connect api imports.

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 language

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 language

DataTypestring or null[ 0 .. 50 ] characters

The data type specification for this info type. Deprecated "nvarchar(max)" is used for all types now.

SortOrderinteger(int32)

The sort order for displaying this info type. Used in lists.

IsActiveboolean

Indicates whether this info type is active.

Changedstring or null

The date and time when this shopping info type was last changed.

ChangedBystring or null

The identifier of the user who last changed this shopping info type.

CulturesArray of objects(ShoppingInfoTypeCultureModel)

The list of culture-specific translations for this shopping info type.

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

Update a shopping info type

Request

Update an existing shopping info type

Path
groupIdinteger(int32)required

The group identifier that categorizes the info type

itemIdinteger(int32)required

Info type id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Type to update

Idinteger(int32)

The shopping info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, allowed values are: 1 = Quotation/Order, 2 = Quotation Item/Order Item

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type, needed to identify the info type in connect api imports.

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 language

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 language

DataTypestring or null[ 0 .. 50 ] characters

The data type specification for this info type. Deprecated "nvarchar(max)" is used for all types now.

SortOrderinteger(int32)

The sort order for displaying this info type. Used in lists.

IsActiveboolean

Indicates whether this info type is active.

Changedstring or null

The date and time when this shopping info type was last changed.

ChangedBystring or null

The identifier of the user who last changed this shopping info type.

CulturesArray of objects(ShoppingInfoTypeCultureModel)

The list of culture-specific translations for this shopping info type.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/order/infotype/shopping/{groupId}/{itemId}' \
  -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,
    "DataType": "string",
    "SortOrder": 0,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "IsTranslated": true,
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true
      }
    ]
  }'

Responses

If the shopping info type was successfully updated

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

List active shopping info types by group

Request

Get a list of all active shopping info types for a specific group on the client

Path
groupIdinteger(int32)required

The group identifier that categorizes the info type, allowed values are: 1 = Quotation/Order, 2 = Quotation Item/Order Item

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

Responses

Returns the list of active shopping info types for the specified group, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The shopping info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, allowed values are: 1 = Quotation/Order, 2 = Quotation Item/Order Item

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type, needed to identify the info type in connect api imports.

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 language

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 language

DataTypestring or null[ 0 .. 50 ] characters

The data type specification for this info type. Deprecated "nvarchar(max)" is used for all types now.

SortOrderinteger(int32)

The sort order for displaying this info type. Used in lists.

IsActiveboolean

Indicates whether this info type is active.

Changedstring or null

The date and time when this shopping info type was last changed.

ChangedBystring or null

The identifier of the user who last changed this shopping info type.

CulturesArray of objects(ShoppingInfoTypeCultureModel)

The list of culture-specific translations for this shopping info type.

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

Add a shopping info type

Request

Add a new shopping info type to the client

Path
groupIdinteger(int32)required

The group identifier that categorizes the info type, allowed values are: 1 = Quotation/Order, 2 = Quotation Item/Order Item

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Shopping info type to add

Idinteger(int32)

The shopping info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, allowed values are: 1 = Quotation/Order, 2 = Quotation Item/Order Item

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type, needed to identify the info type in connect api imports.

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 language

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 language

DataTypestring or null[ 0 .. 50 ] characters

The data type specification for this info type. Deprecated "nvarchar(max)" is used for all types now.

SortOrderinteger(int32)

The sort order for displaying this info type. Used in lists.

IsActiveboolean

Indicates whether this info type is active.

Changedstring or null

The date and time when this shopping info type was last changed.

ChangedBystring or null

The identifier of the user who last changed this shopping info type.

CulturesArray of objects(ShoppingInfoTypeCultureModel)

The list of culture-specific translations for this shopping info type.

curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/order/infotype/shopping/{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,
    "DataType": "string",
    "SortOrder": 0,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "IsTranslated": true,
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true
      }
    ]
  }'

Responses

If the shopping info type was successfully added

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

List deleted shopping info types by group

Request

Get a list of all deleted shopping 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, allowed values are: 1 = Quotation/Order, 2 = Quotation Item/Order Item

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

Responses

Returns the list of deleted shopping info types for the specified group, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The shopping info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, allowed values are: 1 = Quotation/Order, 2 = Quotation Item/Order Item

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type, needed to identify the info type in connect api imports.

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 language

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 language

DataTypestring or null[ 0 .. 50 ] characters

The data type specification for this info type. Deprecated "nvarchar(max)" is used for all types now.

SortOrderinteger(int32)

The sort order for displaying this info type. Used in lists.

IsActiveboolean

Indicates whether this info type is active.

Changedstring or null

The date and time when this shopping info type was last changed.

ChangedBystring or null

The identifier of the user who last changed this shopping info type.

CulturesArray of objects(ShoppingInfoTypeCultureModel)

The list of culture-specific translations for this shopping info type.

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

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