MANAGEMENT API
/
PriceList ClientPriceListType
/
Get a single client price list type by id

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

List client price list types

Request

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

Responses

Returns the list of client price list types, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)required

The price list type identifier.

Codestring or null

The price list type code. Client specific.

Namestring or null[ 0 .. 50 ] characters

The localized and client specific name of the price list type.

DefaultNamestring or null[ 0 .. 50 ] characters

The default name of the price list type.

IsNameInheritedboolean

Indicates whether the name is inherited from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

The localized and client specific description of the price list type.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the price list type.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default description.

SortOrderinteger or null(int32)

The sort order of the price list type. Client specific.

Priorityinteger or null(int32)

The priority of the price list type. Client specific. Used to determine the precedence of price list types when multiple types apply.

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.

IsActiveboolean

Indicates whether the price list type is active on the client.

Changedstring or null

The date and time when the ClientPriceListType entity was last changed.

ChangedBystring or null

The name of the user who last changed the ClientPriceListType entity.

CulturesArray of objects(ClientPriceListTypeCultureModel)

The collection of culture-specific translations for this price list type.

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

Update a single client price list type

Request

Update a single client 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 client price list type model

Idinteger(int32)required

The price list type identifier.

Codestring or null

The price list type code. Client specific.

Namestring or null[ 0 .. 50 ] characters

The localized and client specific name of the price list type.

DefaultNamestring or null[ 0 .. 50 ] characters

The default name of the price list type.

IsNameInheritedboolean

Indicates whether the name is inherited from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

The localized and client specific description of the price list type.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the price list type.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default description.

SortOrderinteger or null(int32)

The sort order of the price list type. Client specific.

Priorityinteger or null(int32)

The priority of the price list type. Client specific. Used to determine the precedence of price list types when multiple types apply.

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.

IsActiveboolean

Indicates whether the price list type is active on the client.

Changedstring or null

The date and time when the ClientPriceListType entity was last changed.

ChangedBystring or null

The name of the user who last changed the ClientPriceListType entity.

CulturesArray of objects(ClientPriceListTypeCultureModel)

The collection of culture-specific translations for this price list type.

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

Responses

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

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

Get a single client price list type by id

Request

Get a single price list type enabled for the client

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

Responses

Returns the client price list type

Bodyapplication/json
Idinteger(int32)required

The price list type identifier.

Codestring or null

The price list type code. Client specific.

Namestring or null[ 0 .. 50 ] characters

The localized and client specific name of the price list type.

DefaultNamestring or null[ 0 .. 50 ] characters

The default name of the price list type.

IsNameInheritedboolean

Indicates whether the name is inherited from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

The localized and client specific description of the price list type.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the price list type.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default description.

SortOrderinteger or null(int32)

The sort order of the price list type. Client specific.

Priorityinteger or null(int32)

The priority of the price list type. Client specific. Used to determine the precedence of price list types when multiple types apply.

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.

IsActiveboolean

Indicates whether the price list type is active on the client.

Changedstring or null

The date and time when the ClientPriceListType entity was last changed.

ChangedBystring or null

The name of the user who last changed the ClientPriceListType entity.

CulturesArray of objects(ClientPriceListTypeCultureModel)

The collection of culture-specific translations for this price list type.

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

Update list of client price list types

Request

Update the complete list of price list types for the client. Items marked as inactive will be removed.

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

A list of client price list types

Array [
Idinteger(int32)required

The price list type identifier.

Codestring or null

The price list type code. Client specific.

Namestring or null[ 0 .. 50 ] characters

The localized and client specific name of the price list type.

DefaultNamestring or null[ 0 .. 50 ] characters

The default name of the price list type.

IsNameInheritedboolean

Indicates whether the name is inherited from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

The localized and client specific description of the price list type.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the price list type.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default description.

SortOrderinteger or null(int32)

The sort order of the price list type. Client specific.

Priorityinteger or null(int32)

The priority of the price list type. Client specific. Used to determine the precedence of price list types when multiple types apply.

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.

IsActiveboolean

Indicates whether the price list type is active on the client.

Changedstring or null

The date and time when the ClientPriceListType entity was last changed.

ChangedBystring or null

The name of the user who last changed the ClientPriceListType entity.

CulturesArray of objects(ClientPriceListTypeCultureModel)

The collection of culture-specific translations for this price list type.

]
curl -i -X PUT \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/clientpricelisttype/list \
  -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",
      "DefaultName": "string",
      "IsNameInherited": true,
      "Description": "string",
      "DefaultDescription": "string",
      "IsDescriptionInherited": true,
      "SortOrder": 0,
      "Priority": 0,
      "ApiEditable": true,
      "IsActive": true,
      "Changed": "string",
      "ChangedBy": "string",
      "Cultures": [
        {
          "CultureCode": "string",
          "IsTranslated": true,
          "Name": "string",
          "IsNameInherited": true,
          "Description": "string",
          "IsDescriptionInherited": true
        }
      ]
    }
  ]'

Responses

If the client price list types were successfully updated

Response
No content

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

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