Skip to content
Download OpenAPI description
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Path
idinteger(int32)required

Price list id

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/pricelist/{id}'

Responses

OK

Body
Idinteger(int32)
Namestring
Descriptionstring
Codestring
ImageKeystring(uuid)
Example: "00000000-0000-0000-0000-000000000000"
ImageUrlstring
TypeIdinteger(int32)
TypeNamestring
PriceRuleNamestring
StartDatestring(date-time)
EndDatestring(date-time)
CurrencyIdinteger(int32)
CurrencyCodestring
CurrencyNamestring
SalesAreaIdinteger(int32)
SalesAreaNamestring
SalesAreaIdIsInheritedboolean
InheritedSalesAreaNamestring
DefaultPriceRuleIdinteger(int32)
DefaultPriceRuleValuenumber(double)
DefaultSupplementChargePercentagenumber(double)
DefaultSupplementChargenumber(double)
DefaultMinimumProductMarginPercentagenumber(double)
DefaultLimitToPriceRecommendedboolean
InheritStructureCalculationRuleinteger(int32)
ParentPriceListIdinteger(int32)
ParentPriceListNamestring
PopulationRuleIdinteger(int32)
PopulationRuleNamestring
ChosenWarehouseIdinteger(int32)
ChosenLocationIdinteger(int32)
IsPrimaryboolean
IsPublicboolean
IsNotStartedboolean
IsEndedboolean
IsVirtualboolean
IsLimitedToStockboolean
IsFavoriteboolean
IsActiveboolean
Changedstring
ChangedBystring
Response
{ "Id": 0, "Name": "string", "Description": "string", "Code": "string", "ImageKey": "00000000-0000-0000-0000-000000000000", "ImageUrl": "string", "TypeId": 0, "TypeName": "string", "PriceRuleName": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "CurrencyId": 0, "CurrencyCode": "string", "CurrencyName": "string", "SalesAreaId": 0, "SalesAreaName": "string", "SalesAreaIdIsInherited": true, "InheritedSalesAreaName": "string", "DefaultPriceRuleId": 0, "DefaultPriceRuleValue": 0.1, "DefaultSupplementChargePercentage": 0.1, "DefaultSupplementCharge": 0.1, "DefaultMinimumProductMarginPercentage": 0.1, "DefaultLimitToPriceRecommended": true, "InheritStructureCalculationRule": 0, "ParentPriceListId": 0, "ParentPriceListName": "string", "PopulationRuleId": 0, "PopulationRuleName": "string", "ChosenWarehouseId": 0, "ChosenLocationId": 0, "IsPrimary": true, "IsPublic": true, "IsNotStarted": true, "IsEnded": true, "IsVirtual": true, "IsLimitedToStock": true, "IsFavorite": true, "IsActive": true, "Changed": "string", "ChangedBy": "string" }

Request

Path
idinteger(int32)required

Price list id

Bodyrequired

Price list

Idinteger(int32)
Namestring
Descriptionstring
Codestring
ImageKeystring(uuid)
Example: "00000000-0000-0000-0000-000000000000"
ImageUrlstring
TypeIdinteger(int32)
TypeNamestring
PriceRuleNamestring
StartDatestring(date-time)
EndDatestring(date-time)
CurrencyIdinteger(int32)
CurrencyCodestring
CurrencyNamestring
SalesAreaIdinteger(int32)
SalesAreaNamestring
SalesAreaIdIsInheritedboolean
InheritedSalesAreaNamestring
DefaultPriceRuleIdinteger(int32)
DefaultPriceRuleValuenumber(double)
DefaultSupplementChargePercentagenumber(double)
DefaultSupplementChargenumber(double)
DefaultMinimumProductMarginPercentagenumber(double)
DefaultLimitToPriceRecommendedboolean
InheritStructureCalculationRuleinteger(int32)
ParentPriceListIdinteger(int32)
ParentPriceListNamestring
PopulationRuleIdinteger(int32)
PopulationRuleNamestring
ChosenWarehouseIdinteger(int32)
ChosenLocationIdinteger(int32)
IsPrimaryboolean
IsPublicboolean
IsNotStartedboolean
IsEndedboolean
IsVirtualboolean
IsLimitedToStockboolean
IsFavoriteboolean
IsActiveboolean
Changedstring
ChangedBystring
curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/pricelist/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "Code": "string",
    "ImageKey": "00000000-0000-0000-0000-000000000000",
    "ImageUrl": "string",
    "TypeId": 0,
    "TypeName": "string",
    "PriceRuleName": "string",
    "StartDate": "2019-08-24T14:15:22Z",
    "EndDate": "2019-08-24T14:15:22Z",
    "CurrencyId": 0,
    "CurrencyCode": "string",
    "CurrencyName": "string",
    "SalesAreaId": 0,
    "SalesAreaName": "string",
    "SalesAreaIdIsInherited": true,
    "InheritedSalesAreaName": "string",
    "DefaultPriceRuleId": 0,
    "DefaultPriceRuleValue": 0.1,
    "DefaultSupplementChargePercentage": 0.1,
    "DefaultSupplementCharge": 0.1,
    "DefaultMinimumProductMarginPercentage": 0.1,
    "DefaultLimitToPriceRecommended": true,
    "InheritStructureCalculationRule": 0,
    "ParentPriceListId": 0,
    "ParentPriceListName": "string",
    "PopulationRuleId": 0,
    "PopulationRuleName": "string",
    "ChosenWarehouseId": 0,
    "ChosenLocationId": 0,
    "IsPrimary": true,
    "IsPublic": true,
    "IsNotStarted": true,
    "IsEnded": true,
    "IsVirtual": true,
    "IsLimitedToStock": true,
    "IsFavorite": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

OK

Body
object
Response
{}

Request

Query
filterstring

"open" filters on active and coming price lists that has not ended. "active" filters on all active pricelists within start/end dates. "inactive" filters on inactive or ended price lists. Default is "open"

searchstring

Search for price lists on name or code

pageinteger(int32)

Sets the page to return. Default is null which will return all price lists

pageSizeinteger(int32)

Sets the page size when page is set

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/pricelist

Responses

OK

BodyArray [
Idinteger(int32)
Namestring
Descriptionstring
Codestring
ImageKeystring(uuid)
Example: "00000000-0000-0000-0000-000000000000"
ImageUrlstring
TypeIdinteger(int32)
TypeNamestring
PriceRuleNamestring
StartDatestring(date-time)
EndDatestring(date-time)
CurrencyIdinteger(int32)
CurrencyCodestring
CurrencyNamestring
SalesAreaIdinteger(int32)
SalesAreaNamestring
SalesAreaIdIsInheritedboolean
InheritedSalesAreaNamestring
DefaultPriceRuleIdinteger(int32)
DefaultPriceRuleValuenumber(double)
DefaultSupplementChargePercentagenumber(double)
DefaultSupplementChargenumber(double)
DefaultMinimumProductMarginPercentagenumber(double)
DefaultLimitToPriceRecommendedboolean
InheritStructureCalculationRuleinteger(int32)
ParentPriceListIdinteger(int32)
ParentPriceListNamestring
PopulationRuleIdinteger(int32)
PopulationRuleNamestring
ChosenWarehouseIdinteger(int32)
ChosenLocationIdinteger(int32)
IsPrimaryboolean
IsPublicboolean
IsNotStartedboolean
IsEndedboolean
IsVirtualboolean
IsLimitedToStockboolean
IsFavoriteboolean
IsActiveboolean
Changedstring
ChangedBystring
]
Response
[ { "Id": 0, "Name": "string", "Description": "string", "Code": "string", "ImageKey": "00000000-0000-0000-0000-000000000000", "ImageUrl": "string", "TypeId": 0, "TypeName": "string", "PriceRuleName": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "CurrencyId": 0, "CurrencyCode": "string", "CurrencyName": "string", "SalesAreaId": 0, "SalesAreaName": "string", "SalesAreaIdIsInherited": true, "InheritedSalesAreaName": "string", "DefaultPriceRuleId": 0, "DefaultPriceRuleValue": 0.1, "DefaultSupplementChargePercentage": 0.1, "DefaultSupplementCharge": 0.1, "DefaultMinimumProductMarginPercentage": 0.1, "DefaultLimitToPriceRecommended": true, "InheritStructureCalculationRule": 0, "ParentPriceListId": 0, "ParentPriceListName": "string", "PopulationRuleId": 0, "PopulationRuleName": "string", "ChosenWarehouseId": 0, "ChosenLocationId": 0, "IsPrimary": true, "IsPublic": true, "IsNotStarted": true, "IsEnded": true, "IsVirtual": true, "IsLimitedToStock": true, "IsFavorite": true, "IsActive": true, "Changed": "string", "ChangedBy": "string" } ]

Request

Bodyrequired

Price list

Idinteger(int32)
Namestring
Descriptionstring
Codestring
ImageKeystring(uuid)
Example: "00000000-0000-0000-0000-000000000000"
ImageUrlstring
TypeIdinteger(int32)
TypeNamestring
PriceRuleNamestring
StartDatestring(date-time)
EndDatestring(date-time)
CurrencyIdinteger(int32)
CurrencyCodestring
CurrencyNamestring
SalesAreaIdinteger(int32)
SalesAreaNamestring
SalesAreaIdIsInheritedboolean
InheritedSalesAreaNamestring
DefaultPriceRuleIdinteger(int32)
DefaultPriceRuleValuenumber(double)
DefaultSupplementChargePercentagenumber(double)
DefaultSupplementChargenumber(double)
DefaultMinimumProductMarginPercentagenumber(double)
DefaultLimitToPriceRecommendedboolean
InheritStructureCalculationRuleinteger(int32)
ParentPriceListIdinteger(int32)
ParentPriceListNamestring
PopulationRuleIdinteger(int32)
PopulationRuleNamestring
ChosenWarehouseIdinteger(int32)
ChosenLocationIdinteger(int32)
IsPrimaryboolean
IsPublicboolean
IsNotStartedboolean
IsEndedboolean
IsVirtualboolean
IsLimitedToStockboolean
IsFavoriteboolean
IsActiveboolean
Changedstring
ChangedBystring
curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/pricelist \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "Code": "string",
    "ImageKey": "00000000-0000-0000-0000-000000000000",
    "ImageUrl": "string",
    "TypeId": 0,
    "TypeName": "string",
    "PriceRuleName": "string",
    "StartDate": "2019-08-24T14:15:22Z",
    "EndDate": "2019-08-24T14:15:22Z",
    "CurrencyId": 0,
    "CurrencyCode": "string",
    "CurrencyName": "string",
    "SalesAreaId": 0,
    "SalesAreaName": "string",
    "SalesAreaIdIsInherited": true,
    "InheritedSalesAreaName": "string",
    "DefaultPriceRuleId": 0,
    "DefaultPriceRuleValue": 0.1,
    "DefaultSupplementChargePercentage": 0.1,
    "DefaultSupplementCharge": 0.1,
    "DefaultMinimumProductMarginPercentage": 0.1,
    "DefaultLimitToPriceRecommended": true,
    "InheritStructureCalculationRule": 0,
    "ParentPriceListId": 0,
    "ParentPriceListName": "string",
    "PopulationRuleId": 0,
    "PopulationRuleName": "string",
    "ChosenWarehouseId": 0,
    "ChosenLocationId": 0,
    "IsPrimary": true,
    "IsPublic": true,
    "IsNotStarted": true,
    "IsEnded": true,
    "IsVirtual": true,
    "IsLimitedToStock": true,
    "IsFavorite": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

OK

Body
object
Response
{}
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations