Create offer

All documentation below refers to the Offer-API-Version-1. in February 2017, Offer-API-Version-2 will be released.

Note : This is only a CREATE endpoint. You cannot update an offer by sending a new Create Request. Please use the Update Request to Update your existing offers

This interface allows for the creation of new offers for the authenticated seller.

The value for <offerID> is an identifier that the seller provides and that uniquely identifies this particular offer. It is used to update or delete offers and used within the overviews of the seller’s offers.

Note: Some of the parameters of this interface cannot be changed anymore unless the entire offer is deleted and created again.

XSD: https://plazaapi.bol.com/offers/xsd/api-1.0.xsd
URL structure: https://plazaapi.bol.com/offers/v1/<offerID>
HTTP Verb: POST
HTTP Headers:
Content-type: application/xml; charset=UTF-8
X-BOL-Date: Fri, 07 Oct 2011 13:24:01 GMT (See “Authentication” for more info)
X-BOL-Authorization: 0123456789abcdef:7ZHDSYabavdvIG0N4h1py//u3n/UNaqKdqblLhquMig= (See “Authentication” for more info)

Root element: OfferCreate
Sub elements (all fields are required although ReferenceCode and Description can go without value):

Element Max Length / Value Description
EAN * 13 The EAN code of the offer (Integer with leading 0’s)
Condition * N/A Whether the offer refers to a new or second hand product.
See Appendix B – Conditions (String)
Price 9999.99 The price of the product with a dot (.) as a decimal separator (Decimal)
DeliveryCode N/A The delivery promise that applies to this product.See Appendix C – Delivery Codes (String)
QuantityInStock 500 The amount of items in stock (Integer)
Publish N/A Boolean (true / false) determining whether the seller desires the product to be offered for sale on the bol.com website or not.Note 1: Even when set to true other factor may cause the offer not to end up being for sale.
Note 2: This field is identical to the “ForSale” field that exists in the FTP variant of offer management. (Boolean)
ReferenceCode 20 bytes ** A value that may help you identify this particular offer when receiving orders. Element can optionally be left empty.
Note that the offer ID is not (yet) passed along with the Open Offers API call (String)
Description 2000 bytes ** A description that is shown on the website only if the product is not new. Element can optionally be left empty.

*) Fields with an asterix cannot be changed by updating the offer. Only deleting the offer and then recreating it allows for an offerID change.

**) Fields that have maximum lengths in bytes are UTF-8 fields that can contain up to 2000 bytes in data.

 

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<OfferCreate xmlns="http://plazaapi.bol.com/offers/xsd/api-1.0.xsd">
<EAN>0619659077013</EAN>
<Condition>NEW</Condition>
<Price>10.00</Price>
<DeliveryCode>24uurs-16</DeliveryCode>
<QuantityInStock>1</QuantityInStock>
<Publish>true</Publish>
<ReferenceCode>1234567890</ReferenceCode>
<Description>This is a new product so this description is of no use.</Description>
</OfferCreate>

Errors

See Appendix D and Appendix E for error details

Nieuws via e-mail

Mochten we nieuws hebben, dan stellen we je via deze weg op de hoogte.
Helemaal onderin deze pagina vind je ook ons Twitter en Google+ kanaal.