Orders v2

Get all open orders

Retrieves all open orders. Orders are sorted by date, descending. Orders are made up out of one or more OrderItems. Every OrderItem has it’s own unique OrderItemID.

GET /services/rest/orders/v2

Example response

Status: 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<Orders xmlns="https://plazaapi.bol.com/services/xsd/v2/plazaapi.xsd">
<Order>
 <OrderId>4123456789</OrderId>
 <DateTimeCustomer>2017-02-09T12:39:48.000+01:00</DateTimeCustomer>
 <DateTimeDropShipper>2017-02-09T12:39:48.000+01:00</DateTimeDropShipper>
 <CustomerDetails>
   <ShipmentDetails>
     <SalutationCode>02</SalutationCode>
     <Firstname>Billie</Firstname>
     <Surname>Van der Bol.com</Surname>
     <Streetname>Dorpstraat</Streetname>
     <Housenumber>1</Housenumber>
     <HousenumberExtended>B</HousenumberExtended>
     <ZipCode>1111 ZZ</ZipCode>
     <City>Utrecht</City>
     <CountryCode>NL</CountryCode>
     <Email>2awq74td4z4mizmx6dcdbsdbdcna@verkopen.bol.com</Email>
     <Company>bol.com</Company>
   </ShipmentDetails>
   <BillingDetails>
     <SalutationCode>02</SalutationCode>
     <Firstname>Billie</Firstname>
     <Surname>van der Bol.com</Surname>
     <Streetname>Dorpstraat</Streetname>
     <Housenumber>1</Housenumber>
     <HousenumberExtended>B</HousenumberExtended>
     <ZipCode>1111 ZZ</ZipCode>
     <City>Utrecht</City>
     <CountryCode>NL</CountryCode>
     <Email>2awq74td4z4mizmx6dcdbsdbdcna@verkopen.bol.com</Email>
     <Company>bol.com</Company>
   </BillingDetails>
 </CustomerDetails>
 <OrderItems>
   <OrderItem>
     <OrderItemId>2012345678</OrderItemId>
     <EAN>5412810182312</EAN>
     <OfferReference>BOLCOM00123</OfferReference>
     <Title>Basicxl - Rijdende Wekker - Kunststof - 16x11cm - Zwart</Title>
     <Quantity>1</Quantity>
     <OfferPrice>27.95</OfferPrice>
     <TransactionFee>5.18</TransactionFee>
     <PromisedDeliveryDate>2017-02-10+01:00</PromisedDeliveryDate>
     <OfferCondition>NEW</OfferCondition>
     <CancelRequest>false</CancelRequest>
   </OrderItem>
 </OrderItems>
 </Order>
</Orders>

OrderItem Response values explained

Name Type Description
OrderItemId long ID for this item, 1 order can have multiple OrderItems
EAN string EAN of the sold product
OfferReference string Value provided by seller through Offer API as ‘ReferenceCode’
Title string Title of the product as shown on the webshop
Quantity int Amount of this OrderItem being ordered
OfferPrice decimal Price for this entire orderItem. This means the Item Price multiplied by the Quantity
PromisedDeliveryDate decimal Result of the date the order was placed combined with the delivery promise made by the seller.
OfferCondition custom Condition of the offer, see also Appendix B
CancelRequest boolean True or False. True only if the consumer has cancelled the order before the seller has shipped it.

Cancel an order item

Cancel a specific order item within an Order.

PUT /services/rest/order-items/v2/:id/cancellation

Parameters

Name Type Description
OrderItemId integer Mandatory. The article within an order that you wish to cancel. You can find the OrderItemId through the Order request.
PUT /services/rest/order-items/v2/206605326/cancellation

Input

Name Type Description
DateTime dateTime ISO 8601 Mandatory. Used to specify when this specific article within an Order was cancelled.
Formatt: YYYY-MM-DDThh:mm:ss.sTZD
ReasonCode string Mandatory. Used to specify the reason for cancellation. The XSD lists the available cancellation options.

Example request

<Cancellation xmlns="https://plazaapi.bol.com/services/xsd/v2/plazaapi.xsd">
  <DateTime>2016-02-12T03:35:22+01:00</DateTime>
  <ReasonCode>REQUESTED_BY_CUSTOMER</ReasonCode>
</Cancellation>

Example response

Status: 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<ns1:ProcessStatus xmlns:ns1="https://plazaapi.bol.com/services/xsd/v2/plazaapi.xsd">
 <ns1:id>1</ns1:id>
 <ns1:sellerId>187216</ns1:sellerId>
 <ns1:entityId>206605326</ns1:entityId>
 <ns1:eventType>CANCEL_ORDER</ns1:eventType>
 <ns1:description>Cancel order item with id 206605326.</ns1:description>
 <ns1:status>PENDING</ns1:status>
 <ns1:createTimestamp>2016-02-12T15:35:23.000+01:00</ns1:createTimestamp>
 <ns1:Links>
   <ns1:link ns1:method="GET" ns1:href="https://plazaapi.bol.com/services/rest/process-status/v2/1" ns1:rel="self" />
 </ns1:Links>
</ns1:ProcessStatus>

For more information on the process-status endpoint, please read: process-status-v2.

Endpoint XSD

orders-v2 https://plazaapi.bol.com/services/xsd/orders-v2.xsd
cancel-order-v2 https://plazaapi.bol.com/services/xsd/cancel-order-v2.xsd