MANAGEMENT API
/
PriceList PriceListType

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
Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Settings ApplicationCountry

Manage the ApplicationCountry entity, which

Operations

Settings ApplicationCulture

Manage application cultures

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Manage categories

Operations

CategoryParametric

Manage parametric categories

Operations

CategoryProductSortOrder

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

PriceList ClientPriceListType

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 Infos

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList PriceListType

Operations

List price list types

Request

Get a list of all price list 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/pricing/pricelisttype \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of price list types

Bodyapplication/jsonArray [
Idinteger(int32)

The system wide unique identifier of the price list type

Codestring or null[ 0 .. 50 ] characters

The client specific code of the price list type

Namestring or null[ 0 .. 50 ] characters

The name of the price list type

Descriptionstring or null[ 0 .. 500 ] characters

The description of the price list type

ApiEditableboolean or null

Indicates whether the price list type can be managed through the API. Falls back to the platform default when not set on the client type.

SortOrderinteger or null(int32)
IsActiveboolean

Indicates whether this price list type is active

Changedstring or null

The date and time the price list type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the price list type

]
Response
application/json
[
  {
    "Id": 0,
    "Code": "string",
    "Name": "string",
    "Description": "string",
    "ApiEditable": true,
    "SortOrder": 0,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }
]

Create a new price list type

Request

Create a new price list type for the client. The type id is assigned automatically.

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Preferstring

Set to return=representation to get the stored entity back instead of its id. The response then has the same shape as the corresponding GET and carries a Preference-Applied header.

Example: return=representation
Bodyapplication/jsonrequired

The price list type model

Idinteger(int32)

The system wide unique identifier of the price list type

Codestring or null[ 0 .. 50 ] characters

The client specific code of the price list type

Namestring or null[ 0 .. 50 ] characters

The name of the price list type

Descriptionstring or null[ 0 .. 500 ] characters

The description of the price list type

ApiEditableboolean or null

Indicates whether the price list type can be managed through the API. Falls back to the platform default when not set on the client type.

SortOrderinteger or null(int32)
IsActiveboolean

Indicates whether this price list type is active

Changedstring or null

The date and time the price list type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the price list type

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/pricelisttype \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Code": "string",
    "Name": "string",
    "Description": "string",
    "ApiEditable": true,
    "SortOrder": 0,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

The id of the created price list type, or the price list type itself when the request has Prefer: return=representation

Bodyapplication/json
One of:
integer(int32)
Response
application/json
0

Get a single price list type by id

Request

Path
idinteger(int32)required

The id of the price list type to get

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/pricing/pricelisttype/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the price list type

Bodyapplication/json
Idinteger(int32)

The system wide unique identifier of the price list type

Codestring or null[ 0 .. 50 ] characters

The client specific code of the price list type

Namestring or null[ 0 .. 50 ] characters

The name of the price list type

Descriptionstring or null[ 0 .. 500 ] characters

The description of the price list type

ApiEditableboolean or null

Indicates whether the price list type can be managed through the API. Falls back to the platform default when not set on the client type.

SortOrderinteger or null(int32)
IsActiveboolean

Indicates whether this price list type is active

Changedstring or null

The date and time the price list type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the price list type

Response
application/json
{
  "Id": 0,
  "Code": "string",
  "Name": "string",
  "Description": "string",
  "ApiEditable": true,
  "SortOrder": 0,
  "IsActive": true,
  "Changed": "string",
  "ChangedBy": "string"
}

Update a single price list type

Request

Update a single price list type by id. If the type does not exist, it will be created (upsert).

Path
idinteger(int32)required

The id of the price list type to update

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Preferstring

Set to return=representation to get the stored entity back instead of its id. The response then has the same shape as the corresponding GET and carries a Preference-Applied header.

Example: return=representation
Bodyapplication/jsonrequired

The price list type model

Idinteger(int32)

The system wide unique identifier of the price list type

Codestring or null[ 0 .. 50 ] characters

The client specific code of the price list type

Namestring or null[ 0 .. 50 ] characters

The name of the price list type

Descriptionstring or null[ 0 .. 500 ] characters

The description of the price list type

ApiEditableboolean or null

Indicates whether the price list type can be managed through the API. Falls back to the platform default when not set on the client type.

SortOrderinteger or null(int32)
IsActiveboolean

Indicates whether this price list type is active

Changedstring or null

The date and time the price list type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the price list type

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/pricelisttype/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Code": "string",
    "Name": "string",
    "Description": "string",
    "ApiEditable": true,
    "SortOrder": 0,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

The id of the updated or created price list type, or the price list type itself when the request has Prefer: return=representation

Bodyapplication/json
One of:
integer(int32)
Response
application/json
0

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

Schemas