Create an offer export CSV file

Example request for requesting an offer export CSV file.

Request

POST - /retailer-demo/offers/export

Request headers

Accept:
application/vnd.retailer.v3+json
Content-Type:
application/vnd.retailer.v3+json
Authorization:
Bearer token (omitted)

Request body

{
  "format" : "CSV"
}

Response Headers

Content-Type:
application/vnd.retailer.v3+json
Status:
202 ACCEPTED

Response body

{
  "id" : 1,
  "eventType" : "CREATE_OFFER_EXPORT",
  "description" : "Create an offer export.",
  "status" : "PENDING",
  "createTimestamp" : "2020-07-06T14:54:47+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}
Back to top

Retrieve an offer export CSV file

Example request for retrieving an offer export CSV file.

Request

GET - /retailer-demo/offers/export/73985e00-d461-4461-80e7-d3fea8d23ef4

Request headers

Accept:
application/vnd.retailer.v3+csv
Content-Type:
N/A
Authorization:
Bearer token (omitted)

Request body

This endpoint has no request body.

Response Headers

Content-Type:
application/vnd.retailer.v3+csv
Status:
200 OK

Response body

offerId,ean,conditionName,conditionCategory,conditionComment,bundlePricesPrice,fulfilmentDeliveryCode,stockAmount,onHoldByRetailer,fulfilmentType,mutationDateTime
4ae7a221-65e7-a333-e620-3f8e1caab5c3,8785073983111,AS_NEW,SECONDHAND,,12.00,3-5d,1,false,FBR,2019-03-07 14:00:32.743 UTC
10a07134-4cfe-ff0f-db62-ef161caab5c3,8785085422042,AS_NEW,SECONDHAND,,6.99,1-8d,1,false,FBR,2019-03-07 14:00:32.743 UTC
4a6cba69-9a44-500a-f620-2c2f1caab5c3,8785070519503,GOOD,SECONDHAND,,19.00,3-5d,1,false,FBR,2019-03-07 14:00:32.743 UTC
3af57b89-4ad1-23db-6200-9e8a1caab5c3,8717418510749,NEW,NEW,,22.98,3-5d,1,false,FBR,2019-03-07 14:00:32.743 UTC
4fb681a1-3e92-679e-0620-27f91caab5c3,8785074815555,REASONABLE,SECONDHAND,kleine schade,40.00,3-5d,1,false,FBR,2019-03-07 14:00:32.743 UTC
25a6fdb1-cdba-e85b-8620-d6e51caab5c3,8785085426016,AS_NEW,SECONDHAND,,12.00,2-3d,1,false,FBR,2019-03-07 14:00:32.743 UTC
3bffef8b-edb3-ec1f-6200-70cf1caab5c3,8785060056857,NEW,NEW,,22.90,2-3d,1,false,FBR,2019-03-07 14:00:32.743 UTC
8ef22a4d-616e-39f1-7620-91ec1caab5c3,8785056370398,GOOD,SECONDHAND,,20.00,3-5d,1,false,FBR,2019-03-07 14:00:32.743 UTC
61924888-6b8c-8ebb-3620-9f0a1caab5c3,8785073140359,NEW,NEW,,30.90,3-5d,1,false,FBR,2019-03-07 14:00:32.743 UTC
Back to top

Retrieve an offer

Example request for retrieving an offer with id 13722de8-8182-d161-5422-4a0a1caab5c8

Request

GET - /retailer-demo/offers/13722de8-8182-d161-5422-4a0a1caab5c8

Request headers

Accept:
application/vnd.retailer.v3+json
Content-Type:
N/A
Authorization:
Bearer token (omitted)

Request body

This endpoint has no request body.

Response Headers

Content-Type:
application/vnd.retailer.v3+json
Status:
200 OK

Response body

{
  "offerId" : "13722de8-8182-d161-5422-4a0a1caab5c8",
  "ean" : "3165140085229",
  "referenceCode" : "02224499",
  "onHoldByRetailer" : false,
  "pricing" : {
    "bundlePrices" : [ {
      "quantity" : 1,
      "price" : 44.99
    }, {
      "quantity" : 6,
      "price" : 42.99
    }, {
      "quantity" : 12,
      "price" : 39.99
    } ]
  },
  "stock" : {
    "amount" : 3,
    "correctedStock" : 3,
    "managedByRetailer" : false
  },
  "fulfilment" : {
    "type" : "FBR",
    "deliveryCode" : "24uurs-15"
  },
  "store" : {
    "productTitle" : "Bosch Waterpomp voor boormachine 2500 L/M",
    "visible" : [ {
      "countryCode" : "BE"
    } ]
  },
  "condition" : {
    "name" : "NEW"
  }
}
Back to top

Create FBR offer for EAN 0045496420253 with condition MODERATE

This example will create an FBR offer using the condition name MODERATE. The current stock level is set to 1 and has a bundle price.

Request

POST - /retailer-demo/offers

Request headers

Accept:
application/vnd.retailer.v3+json
Content-Type:
application/vnd.retailer.v3+json
Authorization:
Bearer token (omitted)

Request body

{
  "ean" : "0045496420253",
  "condition" : {
    "name" : "MODERATE",
    "category" : "SECONDHAND",
    "comment" : "Description"
  },
  "referenceCode" : "RefCode",
  "onHoldByRetailer" : true,
  "unknownProductTitle" : "Title",
  "pricing" : {
    "bundlePrices" : [ {
      "quantity" : 1,
      "price" : 9.99
    }, {
      "quantity" : 6,
      "price" : 8.99
    }, {
      "quantity" : 12,
      "price" : 7.99
    } ]
  },
  "stock" : {
    "amount" : 1,
    "managedByRetailer" : false
  },
  "fulfilment" : {
    "type" : "FBR",
    "deliveryCode" : "24uurs-21"
  }
}

Response Headers

Content-Type:
application/vnd.retailer.v3+json
Status:
202 ACCEPTED

Response body

{
  "id" : 1,
  "eventType" : "CREATE_OFFER",
  "description" : "Create an offer with ean 0045496420253.",
  "status" : "PENDING",
  "createTimestamp" : "2020-07-06T14:54:51+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}
Back to top

Delete an already existing offer that is known with offerId 13722de8-8182-d161-5422-4a0a1caab5c8

This example will delete an already existing offer that exists within bol.com.

Request

DELETE - /retailer-demo/offers/13722de8-8182-d161-5422-4a0a1caab5c8

Request headers

Accept:
application/vnd.retailer.v3+json
Content-Type:
application/vnd.retailer.v3+json
Authorization:
Bearer token (omitted)

Request body

This endpoint has no request body.

Response Headers

Content-Type:
application/vnd.retailer.v3+json
Status:
202 ACCEPTED

Response body

{
  "id" : 1,
  "entityId" : "13722de8-8182-d161-5422-4a0a1caab5c8",
  "eventType" : "DELETE_OFFER",
  "description" : "Delete offer with id 13722de8-8182-d161-5422-4a0a1caab5c8.",
  "status" : "PENDING",
  "createTimestamp" : "2020-07-06T14:54:51+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}
Back to top

Update the price for a specific offer

This example sets the bundle price for offerId '13722de8-8182-d161-5422-4a0a1caab5c8'.

Request

PUT - /retailer-demo/offers/13722de8-8182-d161-5422-4a0a1caab5c8/price

Request headers

Accept:
application/vnd.retailer.v3+json
Content-Type:
application/vnd.retailer.v3+json
Authorization:
Bearer token (omitted)

Request body

{
  "pricing" : {
    "bundlePrices" : [ {
      "quantity" : 1,
      "price" : 49.99
    }, {
      "quantity" : 6,
      "price" : 44.99
    }, {
      "quantity" : 12,
      "price" : 39.99
    } ]
  }
}

Response Headers

Content-Type:
application/vnd.retailer.v3+json
Status:
202 ACCEPTED

Response body

{
  "id" : 1,
  "entityId" : "13722de8-8182-d161-5422-4a0a1caab5c8",
  "eventType" : "UPDATE_OFFER_PRICE",
  "description" : "Update price for offer with id 13722de8-8182-d161-5422-4a0a1caab5c8.",
  "status" : "PENDING",
  "createTimestamp" : "2020-07-06T14:54:51+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}
Back to top

Update the current stock level for offerId '13722de8-8182-d161-5422-4a0a1caab5c8'

This example sets the current stock level of the product to 25. The stockManagedByRetailer is set to false, indicating that the stock levels are managed by bol.com based on (new) sales orders.

Request

PUT - /retailer-demo/offers/13722de8-8182-d161-5422-4a0a1caab5c8/stock

Request headers

Accept:
application/vnd.retailer.v3+json
Content-Type:
application/vnd.retailer.v3+json
Authorization:
Bearer token (omitted)

Request body

{
  "amount" : 25,
  "managedByRetailer" : false
}

Response Headers

Content-Type:
application/vnd.retailer.v3+json
Status:
202 ACCEPTED

Response body

{
  "id" : 1,
  "entityId" : "13722de8-8182-d161-5422-4a0a1caab5c8",
  "eventType" : "UPDATE_OFFER_STOCK",
  "description" : "Update stock for offer with id 13722de8-8182-d161-5422-4a0a1caab5c8.",
  "status" : "PENDING",
  "createTimestamp" : "2020-07-06T14:54:51+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}
Back to top

Update of an already existing offer with offerId '13722de8-8182-d161-5422-4a0a1caab5c8'

This example shows how an offer is updated using a different deliveryCode. Also, the offer is (temporarily) put offline using the onHoldByRetailer indication.

Request

PUT - /retailer-demo/offers/13722de8-8182-d161-5422-4a0a1caab5c8

Request headers

Accept:
application/vnd.retailer.v3+json
Content-Type:
application/vnd.retailer.v3+json
Authorization:
Bearer token (omitted)

Request body

{
  "onHoldByRetailer" : true,
  "referenceCode" : "RefCode",
  "unknownProductTitle" : "Title",
  "fulfilment" : {
    "type" : "FBR",
    "deliveryCode" : "24uurs-21"
  }
}

Response Headers

Content-Type:
application/vnd.retailer.v3+json
Status:
202 ACCEPTED

Response body

{
  "id" : 1,
  "entityId" : "13722de8-8182-d161-5422-4a0a1caab5c8",
  "eventType" : "UPDATE_OFFER",
  "description" : "Update an offer with offerId 13722de8-8182-d161-5422-4a0a1caab5c8.",
  "status" : "PENDING",
  "createTimestamp" : "2020-07-06T14:54:51+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}
Back to top

Update of an already existing offer with offerId '13722de8-8182-d161-5422-4a0a1caab5c8'

This example shows how an offer is updated using a different deliveryCode. Also, the offer is (temporarily) put offline using the onHoldByRetailer indication.

Request

PUT - /retailer-demo/offers/13722de8-8182-d161-5422-4a0a1caab5c8

Request headers

Accept:
application/vnd.retailer.v3+json
Content-Type:
application/vnd.retailer.v3+json
Authorization:
Bearer token (omitted)

Request body

{
  "onHoldByRetailer" : true,
  "referenceCode" : "RefCode",
  "unknownProductTitle" : "Title",
  "fulfilment" : {
    "type" : "FBR",
    "deliveryCode" : "24uurs-21",
    "pickUpPoints" : [ {
      "code" : "PUP_AH_NL"
    } ]
  }
}

Response Headers

Content-Type:
application/vnd.retailer.v3+json
Status:
202 ACCEPTED

Response body

{
  "id" : 1,
  "entityId" : "13722de8-8182-d161-5422-4a0a1caab5c8",
  "eventType" : "UPDATE_OFFER",
  "description" : "Update an offer with offerId 13722de8-8182-d161-5422-4a0a1caab5c8.",
  "status" : "PENDING",
  "createTimestamp" : "2020-07-06T14:54:51+02:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}
Back to top