Price classes list

Route: POST /priceClass/article/_search

Query Parameters

The following keywords are returned by default:                       

• priceClass.name
• priceClass.type
• businessCasePrice.businessCaselabel
• price.vatRate
• price.vatAmount
• price.rate
• price.amount
• price.type
• price.currency
• price.priority
• price.period
• price.discountable
• price.refund
• price.until
• price.from
• price.valid

The data of the following keywords can be queried with the query parameter ?keys[]=:

• price.comment
• price.promotion
• price.priceList
• price.priceChange

{
    "customer": {
        "group": "12345",
        "client": "customer"
    },

    "filters": [
        {
            "key": "price_class.name",
            "value": "DO*",
            "operator": "LIKE"
		}
	],
    "view": {
        "currency": "USD",
        "children": 1,
        "limit": 10
    },
    "orders": [
        {
            "key": "price_class.name",
            "type": "ASC"
	}
]
}

{
  "status" : {
    "code" : "S099925",
    "text" : "S099925",
    "type" : "SUCCESS"
  },
  "object" : {
    "type" : "",
    "summary" : 1
  },
  "data" : [ {
    "businessCasePrices" : [ {
      "businessCase" : "create",
      "prices" : [ {
        "amount" : 400.0,
        "type" : "NET",
        "currency" : "EUR",
        "priority" : "DEFAULT",
        "period" : {
          "unit" : "MONTH",
          "period" : 12
        },
        "discountable" : true,
        "refund" : 100,
        "vatRate" : "19.0",
        "vatAmount" : 0.0,
        "rate" : 1.0
      } ]
    } ],
    "priceClass" : {
      "type" : "NET",
      "name" : "DONUTS-AAA+"
    }
  } ]
}

Task code: 099925
Uses  Price Class object

Keywords

The following keywords are returned by default:

• price_class.name

• price_class.type
• business_case_price.business_case.label
• price.vat_rate
• price.vat_amount
• price.rate
• price.amount
• price.type
• price.currency
• price.priority
• price.period
• price.discountable
• price.refund
• price.until
• price.from
• price.valid

The data of the following keywords can be inquired with the keyword <key>:

• price.comment
• price.promotion
• price.priceList
• price.price_change

<request>
	<auth>
		<user>customer</user>
		<password>password</password>
		<context>4</context>
	</auth>
	<task>
		<code>099925</code>
		<price_classes>
            <customer>
                <group>12345</group>
                <client>customer</client>
            </customer>
        </price_classes>
		<view>
			<offset>0</offset>
			<limit>10</limit>
			<children>1</children>
		</view>
		<where>
			<key>price_class.name</key>
			<operator>like</operator>
			<value>DO*</value>
		</where>
		<order>
			<key>price_class.name</key>
			<mode>asc</mode>
		</order>    		
		<key>price_class.name</key>   
	</task>
</request>

<response>
	<result>
		<data>
			<summary>1</summary>
			<price_classes>
				<price_class>
					<name>DONUTS-AAA+</name>
					<type>net</type>
				</price_class>
				<business_case_price>
					<business_case>
						<label>create</label>
					</business_case>
					<price>
						<vat_rate>19.0</vat_rate>
						<vat_amount>0.0</vat_amount>
						<rate>1.0</rate>
						<amount>400.0</amount>
						<type>net</type>
						<currency>EUR</currency>
						<priority>DEFAULT</priority>
						<period>12m</period>
						<discountable>1</discountable>
						<refund>100</refund>
					</price>
				</business_case_price>
			</price_classes>
		</data>
		<status>
			<code>S099925</code>
			<type>success</type>
		</status>
	</result>
</response>