Single order

This endpoint retrieves a single open order. The order is made up out of one or more OrderItems and every OrderItem has it’s own unique OrderItemID.

What’s new in version 2.1

  • We had to change the OrderId and OrderItemId fields from a Long to a String in order to comply with changes in our landscape.
  • The field “FulfilmentMethod” has been added to the orderItem.
  • We’ve renamed the field “PromisedDeliveryDate” to “LatestDeliveryDate” in order to give the field a proper meaning. The word “Promised” made it feel like it was a promise between the customer and the retailer which isn’t the case

 

GET /services/rest/orders/v2/order-id

Accept-header

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

application/vnd.orders-v2.1+xml

Example request

GET /services/rest/orders/v2/order-id

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>
     <LatestDeliveryDate>2017-02-10+01:00</LatestDeliveryDate>
     <OfferCondition>NEW</OfferCondition>
     <CancelRequest>false</CancelRequest>
     <FulfilmentMethod>FBR</FulfilmentMethod>
   </OrderItem>
 </OrderItems>
 </Order>
</Orders>

OrderItem Response values explained

Name Type Description
OrderItemId string 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 integer Amount of this OrderItem being ordered
OfferPrice decimal Price for this entire orderItem. This means the Item Price multiplied by the Quantity
LatestDeliveryDate decimal This field has been renamed from “PromisedDeliveryDate”. Result of the date the order was placed combined with the delivery promise made by the seller.
OfferCondition string 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.