Get Commission

Get Commission (single)

Retrieves commission information on a single offer

GET /commission/v2/parameters

Parameters

Name Type Description
EAN string Required. EAN number associated with this offer
condition string Condition of the offer. It is possible to have more conditons per EAN.

omitting the condition will default to Condition=NEW

price integer price you wish to sell the EAN for. If provided it will be used to calculate your exact commission.

If omitted, only commission rules wil be shown

Example request

When requesting commission by just sending an EAN.
This will show you the applicable commission rules. You can use these to calculate your own fee.

GET /commission/v2/8714469003084

Example response

Status: 202 Accepted

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Commission xmlns="https://plazaapi.bol.com/offers/xsd/api-2.0.xsd">
 <FixedAmount>0.99</FixedAmount>
 <Percentage>15</Percentage>
 <Reductions>
 <Reduction>
 <MaximumPrice>30.90</MaximumPrice>
 <CostReduction>2.81</CostReduction>
 <StartDate>2017-01-10</StartDate>
 <EndDate>2017-01-31</EndDate>
 </Reduction>
 </Reductions>
</Commission>

Example request

When requesting commission information and also providing your own price which does not meet the commission reduction criteria. This shows you the available rules and will also calculate the fee you’ll have to pay. In this example the given price is too high to benifit from a commission reducation because it does not meet the maximumprice criterium.

GET /commission/v2/8714469003084?condition=NEW&price=100

Example response

Status: 202 Accepted

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Commission xmlns="https://plazaapi.bol.com/offers/xsd/api-2.0.xsd">
 <FixedAmount>0.99</FixedAmount>
 <Percentage>15</Percentage>
 <TotalCost>15.99</TotalCost>
 <Reductions>
 <Reduction>
 <MaximumPrice>30.90</MaximumPrice>
 <CostReduction>2.81</CostReduction>
 <StartDate>2017-01-10</StartDate>
 <EndDate>2017-01-31</EndDate>
 </Reduction>
 </Reductions>
</Commission>

 

Example request

When requesting commission information and also providing your own price which does meet the commission reduction criteria.

GET /commission/v2/8714469003084?condition=NEW&price=20

Example response

This shows you the available rules and will also calculate the fee you’ll have to pay. In this example the given price is meets the maximumprice criterium. and will benifit from a commission reducation.

Status: 202 Accepted

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Commission xmlns="https://plazaapi.bol.com/offers/xsd/api-2.0.xsd">
 <FixedAmount>0.99</FixedAmount>
 <Percentage>15</Percentage>
 <TotalCost>1.18</TotalCost>
 <TotalCostWithoutReduction>3.99</TotalCostWithoutReduction>
 <Reductions>
 <Reduction>
 <MaximumPrice>30.90</MaximumPrice>
 <CostReduction>2.81</CostReduction>
 <StartDate>2017-01-10</StartDate>
 <EndDate>2017-01-31</EndDate>
 </Reduction>
 </Reductions>
</Commission>

 

Possible return values

Name Type Description
FixedAmount decimal fixed fee
Percentage int percentage of offer price. This percentage varies per productcategory.
TotalCost decimal Total applicable fee calculated based on the offerprice provided
TotalCostWithoutReduction decimal Total applicable fee calculated based on the offerprice provided which would be in effect if you do not meet the maxmum price criterium.
Reduction Lists all applicable commission reductions and their requirements
Maximumprice decimal  

Maximum offer price that can be used to still benefit from a commission reduction

CostReduction decimal Amount the will be deducted from the commission fee if the maximum price criterium is met.
StartDate date Date from which time this commission reduction is applicable
EndDate date Date at which time this commission reduction will end

Post Commission (Bulk)

In addition to the GET Commission request which returns commission information for a single EAN, it is also possibly to send us a query with multiple EANs with a maximum of 100 EANs.

POST /commission/v2/

Accept-header

In order to use this endpoint you do need to add a specific Acceptheader to your request.

application/vnd.commission-v2.1+xml

Input

Name Type Description
EAN string Required. EAN code for the product being added
Condition string Required. Whether the offer refers to a new or second hand product.
Available Conditions.
Price decimal The price of the product with a dot (.) as a decimal separator (Decimal).
Maximum value: 9999

Example request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CommissionRequest xmlns="https://plazaapi.bol.com/offers/xsd/api-2.1.xsd">
 <CommissionQuery>
   <EAN>8714469003084</EAN>
   <Condition>NEW</Condition>
   <Price>10</Price>
 </CommissionQuery>
 <CommissionQuery>
   <EAN>2750064078467</EAN>
   <Condition>NEW</Condition>
   <Price>1000</Price>
 </CommissionQuery>
</CommissionRequest>

Example response – succes

Status: 202 Accepted

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CommissionResponse xmlns="https://plazaapi.bol.com/offers/xsd/api-2.1.xsd">
 <Commission>
   <EAN>8714469003084</EAN>
   <Condition>NEW</Condition>
   <Price>10</Price>
   <FixedAmount>0.99</FixedAmount>
   <Percentage>15</Percentage>
   <TotalCost>2.49</TotalCost>
 </Commission>
 <Commission>
   <EAN>2750064078467</EAN>
   <Condition>NEW</Condition>
   <Price>1000</Price>
   <FixedAmount>0.99</FixedAmount>
   <Percentage>15</Percentage>
   <TotalCost>150.99</TotalCost>
 </Commission>
</CommissionResponse>