COMMERCE SERVICES
/
Customer Service
/
PriceLists
/
Get a pricelist for company

Documentation CustomerService (1.1)

The Customers namespace has Entities and Operations concerned with Customer and Company management.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/customer/1.1/

Accounts

Operations

Address

Operations

Companies

Operations

Customers

Operations

Flags

Operations

InfoTypes

Operations

PriceLists

Operations

Delete pricelist from company

Request

Deletes a PriceList for the specified Company. If the PriceList is the last one on any company it will be inactivated. Note that only Reseller priceLists can be deleted. Any attempt to delete an other priceList type will render an Internal Server Error.

Query
companyIdinteger(int32)required

The internal id of the Company.

pricelistIdinteger(int32)required

The internal id of the priceList to delete for the Company.

updatedBystring

Account internal id of current user.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/DeleteCompanyPricelist?companyId=0&pricelistId=0'

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal pricelist id. Set to null when creating a new pricelist.

ParentIdinteger or null(int32)

The parent internal pricelist id. If any.

Namestring

The name of the pricelist. MaxLength: 50.

Descriptionstring

The description of the pricelist. MaxLength: max.

Agreementstring

The agreement code of the pricelist. Can be an external id of the priceList. MaxLength: 50.

Typeinteger(int32)

The type of the pricelist. 0 is default. Other values are application specific.

IsActiveboolean

Specifies if the pricelist is active or not. Set this to false before update if you want to delete the pricelist.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
PopulationRulesArray of objects(PricelistPopulationRule)(PricelistPopulationRule)

A list of population rules for this pricelist.

CurrencyIdinteger(int32)

The currencyId for this pricelist.

IsExclusiveboolean

Indicates if the pricelist should be used exclusively for this Company, or not. Exclusive pricelists are not used with any standard pricelists and only exclusive pricelists will be in scope if the Company has any.

]
Response
[
  {
    "Id": 0,
    "ParentId": 0,
    "Name": "string",
    "Description": "string",
    "Agreement": "string",
    "Type": 0,
    "IsActive": true,
    "PriceRule": { … },
    "PopulationRules": [ … ],
    "CurrencyId": 0,
    "IsExclusive": true
  }
]

Get a pricelist for company

Request

Gets a CompanyPriceList for the specified Company. Returns null if the PriceList does not exist.

Query
companyIdinteger(int32)required

The internal id of the Company for which the PriceList is fetched.

pricelistIdinteger(int32)required

The internal id of the PriceList to fetch.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/GetCompanyPricelist?companyId=0&pricelistId=0'

Responses

Success

Body
Idinteger or null(int32)

The internal pricelist id. Set to null when creating a new pricelist.

ParentIdinteger or null(int32)

The parent internal pricelist id. If any.

Namestring

The name of the pricelist. MaxLength: 50.

Descriptionstring

The description of the pricelist. MaxLength: max.

Agreementstring

The agreement code of the pricelist. Can be an external id of the priceList. MaxLength: 50.

Typeinteger(int32)

The type of the pricelist. 0 is default. Other values are application specific.

IsActiveboolean

Specifies if the pricelist is active or not. Set this to false before update if you want to delete the pricelist.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
PopulationRulesArray of objects(PricelistPopulationRule)(PricelistPopulationRule)

A list of population rules for this pricelist.

CurrencyIdinteger(int32)

The currencyId for this pricelist.

IsExclusiveboolean

Indicates if the pricelist should be used exclusively for this Company, or not. Exclusive pricelists are not used with any standard pricelists and only exclusive pricelists will be in scope if the Company has any.

Response
{
  "Id": 0,
  "ParentId": 0,
  "Name": "string",
  "Description": "string",
  "Agreement": "string",
  "Type": 0,
  "IsActive": true,
  "PriceRule": {
    "RuleId": 0,
    "Value": 0
  },
  "PopulationRules": [
    { … }
  ],
  "CurrencyId": 0,
  "IsExclusive": true
}

Get a pricelist item

Request

Gets a priceList item. Returns null if the PriceListItem does not exist. Prices are in the currency of the PriceList.

Query
partNostringrequired

The PartNo of the PriceListItem to fetch.

pricelistIdinteger(int32)required

The internal Id of the current PriceList for which the PriceListItem is fetched.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/GetPricelistItem?partNo=string&pricelistId=0'

Responses

Success

Body
PartNostring

PartNo of the SKU for this price item. MaxLength: 50.

PricelistIdinteger(int32)

The internal pricelist id.

Pricenumber(decimal)

The price. Read only. Currency is from the pricelist.

PriceRecommendednumber or null(decimal)

The price from inherited pricelist, if any.

IsActiveboolean

Specifies if the pricelist item is active or not. Ignored when inserting new pricelist items.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
Response
{
  "PartNo": "string",
  "PricelistId": 0,
  "Price": 0,
  "PriceRecommended": 0,
  "IsActive": true,
  "PriceRule": {
    "RuleId": 0,
    "Value": 0
  }
}

Insert pricelist for company (v2)

Request

Inserts a new PriceList for the specified Company. If the PriceList is an existing PriceList it will be connected to the Company. Otherwise it will be created.

Query
companyIdinteger(int32)required

The internal id of the Company.

createdBystring

Account internal id of current user.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

Body
required

The priceList to insert for the Company. The PriceRule for new PriceLists will be 'Use standard price (pct discount)' (id:7) if none is supplied.

Idinteger or null(int32)

The internal pricelist id. Set to null when creating a new pricelist.

ParentIdinteger or null(int32)

The parent internal pricelist id. If any.

Namestring

The name of the pricelist. MaxLength: 50.

Descriptionstring

The description of the pricelist. MaxLength: max.

Agreementstring

The agreement code of the pricelist. Can be an external id of the priceList. MaxLength: 50.

Typeinteger(int32)

The type of the pricelist. 0 is default. Other values are application specific.

IsActiveboolean

Specifies if the pricelist is active or not. Set this to false before update if you want to delete the pricelist.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
PopulationRulesArray of objects(PricelistPopulationRule)(PricelistPopulationRule)

A list of population rules for this pricelist.

CurrencyIdinteger(int32)

The currencyId for this pricelist.

IsExclusiveboolean

Indicates if the pricelist should be used exclusively for this Company, or not. Exclusive pricelists are not used with any standard pricelists and only exclusive pricelists will be in scope if the Company has any.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/InsertCompanyPricelist2?companyId=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "ParentId": 0,
    "Name": "string",
    "Description": "string",
    "Agreement": "string",
    "Type": 0,
    "IsActive": true,
    "PriceRule": {
      "RuleId": 0,
      "Value": 0
    },
    "PopulationRules": [
      {
        "RuleId": 0,
        "ManufacturerId": 0,
        "CategoryId": 0,
        "IsSupplierRequired": true,
        "IsInclusive": true
      }
    ],
    "CurrencyId": 0,
    "IsExclusive": true
  }'

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal pricelist id. Set to null when creating a new pricelist.

ParentIdinteger or null(int32)

The parent internal pricelist id. If any.

Namestring

The name of the pricelist. MaxLength: 50.

Descriptionstring

The description of the pricelist. MaxLength: max.

Agreementstring

The agreement code of the pricelist. Can be an external id of the priceList. MaxLength: 50.

Typeinteger(int32)

The type of the pricelist. 0 is default. Other values are application specific.

IsActiveboolean

Specifies if the pricelist is active or not. Set this to false before update if you want to delete the pricelist.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
PopulationRulesArray of objects(PricelistPopulationRule)(PricelistPopulationRule)

A list of population rules for this pricelist.

CurrencyIdinteger(int32)

The currencyId for this pricelist.

IsExclusiveboolean

Indicates if the pricelist should be used exclusively for this Company, or not. Exclusive pricelists are not used with any standard pricelists and only exclusive pricelists will be in scope if the Company has any.

]
Response
[
  {
    "Id": 0,
    "ParentId": 0,
    "Name": "string",
    "Description": "string",
    "Agreement": "string",
    "Type": 0,
    "IsActive": true,
    "PriceRule": { … },
    "PopulationRules": [ … ],
    "CurrencyId": 0,
    "IsExclusive": true
  }
]

Insert a pricelist item

Request

Inserts a new priceList item. If the PriceListItem already exists, an update is made.

Query
createdBystringrequired

The internal id of the current customer's account. If none is supplied, value is resolved from Application.

Body
required

The PriceListItem to insert. Prices should be in the currency of the PriceList.

PartNostring

PartNo of the SKU for this price item. MaxLength: 50.

PricelistIdinteger(int32)

The internal pricelist id.

Pricenumber(decimal)

The price. Read only. Currency is from the pricelist.

PriceRecommendednumber or null(decimal)

The price from inherited pricelist, if any.

IsActiveboolean

Specifies if the pricelist item is active or not. Ignored when inserting new pricelist items.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/InsertPricelistItem?createdBy=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "PartNo": "string",
    "PricelistId": 0,
    "Price": 0,
    "PriceRecommended": 0,
    "IsActive": true,
    "PriceRule": {
      "RuleId": 0,
      "Value": 0
    }
  }'

Responses

Success

Body
PartNostring

PartNo of the SKU for this price item. MaxLength: 50.

PricelistIdinteger(int32)

The internal pricelist id.

Pricenumber(decimal)

The price. Read only. Currency is from the pricelist.

PriceRecommendednumber or null(decimal)

The price from inherited pricelist, if any.

IsActiveboolean

Specifies if the pricelist item is active or not. Ignored when inserting new pricelist items.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
Response
{
  "PartNo": "string",
  "PricelistId": 0,
  "Price": 0,
  "PriceRecommended": 0,
  "IsActive": true,
  "PriceRule": {
    "RuleId": 0,
    "Value": 0
  }
}

List all pricelists for a company

Request

Returns a list of PriceLists for the specified Company.

Query
companyIdinteger(int32)required

The internal id of the Company for which the PriceLists are fetched.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/ListCompanyPricelists?companyId=0'

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal pricelist id. Set to null when creating a new pricelist.

ParentIdinteger or null(int32)

The parent internal pricelist id. If any.

Namestring

The name of the pricelist. MaxLength: 50.

Descriptionstring

The description of the pricelist. MaxLength: max.

Agreementstring

The agreement code of the pricelist. Can be an external id of the priceList. MaxLength: 50.

Typeinteger(int32)

The type of the pricelist. 0 is default. Other values are application specific.

IsActiveboolean

Specifies if the pricelist is active or not. Set this to false before update if you want to delete the pricelist.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
PopulationRulesArray of objects(PricelistPopulationRule)(PricelistPopulationRule)

A list of population rules for this pricelist.

CurrencyIdinteger(int32)

The currencyId for this pricelist.

IsExclusiveboolean

Indicates if the pricelist should be used exclusively for this Company, or not. Exclusive pricelists are not used with any standard pricelists and only exclusive pricelists will be in scope if the Company has any.

]
Response
[
  {
    "Id": 0,
    "ParentId": 0,
    "Name": "string",
    "Description": "string",
    "Agreement": "string",
    "Type": 0,
    "IsActive": true,
    "PriceRule": { … },
    "PopulationRules": [ … ],
    "CurrencyId": 0,
    "IsExclusive": true
  }
]

List price rules

Request

Lists the available price rules.

Query
cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/customer/1.1/ListPriceRules

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity.

Namestring

The Name of the Entity. MaxLength: 50.

Descriptionstring

The Description of the Entity. MaxLength: 500.

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Codestring

The Code of the Entity. MaxLength: 50.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImageKey": "string",
    "Code": "string"
  }
]

Update pricelist for company (v2)

Request

Updates a PriceList for the specified Company. If the PriceList is not an existingPriceList it will be created. Otherwise it will be updated. Note that only Reseller and Application specific priceLists can be updated. Any attempt to update an other priceList type will be ignored. If no PriceRule is specified, PriceRule 7, use standard price, with no discount will be used. To delete a Company PriceList use DeleteCompanyPricelist.

Query
companyIdinteger(int32)required

The internal id of the Company.

updatedBystring

Account internal id of current user.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

Body
required

The priceList to update for the Company. The PriceRule for updated PriceLists will be 'Use standard price (pct discount)' (id:7) if none is supplied.

Idinteger or null(int32)

The internal pricelist id. Set to null when creating a new pricelist.

ParentIdinteger or null(int32)

The parent internal pricelist id. If any.

Namestring

The name of the pricelist. MaxLength: 50.

Descriptionstring

The description of the pricelist. MaxLength: max.

Agreementstring

The agreement code of the pricelist. Can be an external id of the priceList. MaxLength: 50.

Typeinteger(int32)

The type of the pricelist. 0 is default. Other values are application specific.

IsActiveboolean

Specifies if the pricelist is active or not. Set this to false before update if you want to delete the pricelist.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
PopulationRulesArray of objects(PricelistPopulationRule)(PricelistPopulationRule)

A list of population rules for this pricelist.

CurrencyIdinteger(int32)

The currencyId for this pricelist.

IsExclusiveboolean

Indicates if the pricelist should be used exclusively for this Company, or not. Exclusive pricelists are not used with any standard pricelists and only exclusive pricelists will be in scope if the Company has any.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/UpdateCompanyPricelist2?companyId=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "ParentId": 0,
    "Name": "string",
    "Description": "string",
    "Agreement": "string",
    "Type": 0,
    "IsActive": true,
    "PriceRule": {
      "RuleId": 0,
      "Value": 0
    },
    "PopulationRules": [
      {
        "RuleId": 0,
        "ManufacturerId": 0,
        "CategoryId": 0,
        "IsSupplierRequired": true,
        "IsInclusive": true
      }
    ],
    "CurrencyId": 0,
    "IsExclusive": true
  }'

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal pricelist id. Set to null when creating a new pricelist.

ParentIdinteger or null(int32)

The parent internal pricelist id. If any.

Namestring

The name of the pricelist. MaxLength: 50.

Descriptionstring

The description of the pricelist. MaxLength: max.

Agreementstring

The agreement code of the pricelist. Can be an external id of the priceList. MaxLength: 50.

Typeinteger(int32)

The type of the pricelist. 0 is default. Other values are application specific.

IsActiveboolean

Specifies if the pricelist is active or not. Set this to false before update if you want to delete the pricelist.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
PopulationRulesArray of objects(PricelistPopulationRule)(PricelistPopulationRule)

A list of population rules for this pricelist.

CurrencyIdinteger(int32)

The currencyId for this pricelist.

IsExclusiveboolean

Indicates if the pricelist should be used exclusively for this Company, or not. Exclusive pricelists are not used with any standard pricelists and only exclusive pricelists will be in scope if the Company has any.

]
Response
[
  {
    "Id": 0,
    "ParentId": 0,
    "Name": "string",
    "Description": "string",
    "Agreement": "string",
    "Type": 0,
    "IsActive": true,
    "PriceRule": { … },
    "PopulationRules": [ … ],
    "CurrencyId": 0,
    "IsExclusive": true
  }
]

Update a pricelist item

Request

Updates a priceList item.

Query
updatedBystringrequired

The internal id of the current customer's account. If none is supplied, value is resolved from Application.

Body
required

The PriceListItem to update. Prices should be in the currency of the PriceList.

PartNostring

PartNo of the SKU for this price item. MaxLength: 50.

PricelistIdinteger(int32)

The internal pricelist id.

Pricenumber(decimal)

The price. Read only. Currency is from the pricelist.

PriceRecommendednumber or null(decimal)

The price from inherited pricelist, if any.

IsActiveboolean

Specifies if the pricelist item is active or not. Ignored when inserting new pricelist items.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/customer/1.1/UpdatePricelistItem?updatedBy=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "PartNo": "string",
    "PricelistId": 0,
    "Price": 0,
    "PriceRecommended": 0,
    "IsActive": true,
    "PriceRule": {
      "RuleId": 0,
      "Value": 0
    }
  }'

Responses

Success

Body
PartNostring

PartNo of the SKU for this price item. MaxLength: 50.

PricelistIdinteger(int32)

The internal pricelist id.

Pricenumber(decimal)

The price. Read only. Currency is from the pricelist.

PriceRecommendednumber or null(decimal)

The price from inherited pricelist, if any.

IsActiveboolean

Specifies if the pricelist item is active or not. Ignored when inserting new pricelist items.

PriceRuleobject(PricelistPriceRule)(PricelistPriceRule)
Response
{
  "PartNo": "string",
  "PricelistId": 0,
  "Price": 0,
  "PriceRecommended": 0,
  "IsActive": true,
  "PriceRule": {
    "RuleId": 0,
    "Value": 0
  }
}