v4 - Offers - Demo Endpoints

Create an offer export CSV file

Example request for requesting an offer export CSV file.

POST /retailer-demo/offers/export

  • Request

  • Response

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

{
  "format" : "CSV"
}

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

{
  "id" : 1,
  "eventType" : "CREATE_OFFER_EXPORT",
  "description" : "Create an offer export.",
  "status" : "PENDING",
  "createTimestamp" : "2020-10-26T10:21:59+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Create an unpublished offer report

Example request for requesting an unpublished offer report.

POST /retailer-demo/offers/unpublished

  • Request

  • Response

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

{
  "format" : "CSV"
}

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

{
  "id" : 1,
  "eventType" : "UNPUBLISHED_OFFER_REPORT",
  "description" : "Create unpublished offer report.",
  "status" : "PENDING",
  "createTimestamp" : "2020-10-26T10:21:59+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Retrieve an offer export CSV file

Example request for retrieving an offer export CSV file.

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

  • Request

  • Response

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

This endpoint has no request body.

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

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

Retrieve an offer

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

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

  • Request

  • Response

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

This endpoint has no request body.

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

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

Retrieve an unpublished offer report

Example request for retrieving an unpublished offer report.

GET /retailer-demo/offers/unpublished/3f2bb9f5-79dd-472c-aeb7-fef416b77928

  • Request

  • Response

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

This endpoint has no request body.

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

offerId,ean,notPublishableReason,notPublishableReasonDescription
a045ae2c-b69c-505a-6200-bff01caab5c3,2138339540459,INSUFFICIENT_PERMISSIONS,Not allowed to sell this product with this condition.
c31ff83c-16a2-dd7c-2620-185b1caab5c3,2028908942688,INSUFFICIENT_PERMISSIONS,Not allowed to sell this product with this condition.
5abf971c-7c56-6558-b620-c6a31caab5c3,2698878514545,INSUFFICIENT_PERMISSIONS,Not allowed to sell this product with this condition.
bdca2298-5848-3956-6200-9f0a1caab5c3,2223685193227,INSUFFICIENT_PERMISSIONS,Not allowed to sell this product with this condition.
4ec34c54-2170-264a-f620-bff01caab5c3,2799706308715,INSUFFICIENT_PERMISSIONS,Not allowed to sell this product with this condition.
1253a579-059a-7618-1662-9f5b1caab5c3,2968142026334,INSUFFICIENT_PERMISSIONS,Not allowed to sell this product with this condition.

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.

POST /retailer-demo/offers

  • Request

  • Response

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

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

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

{
  "id" : 1,
  "eventType" : "CREATE_OFFER",
  "description" : "Create an offer with ean 0045496420253.",
  "status" : "PENDING",
  "createTimestamp" : "2020-10-26T10:22:00+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

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.

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

  • Request

  • Response

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

This endpoint has no request body.

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

{
  "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-10-26T10:22:00+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Update the price for a specific offer

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

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

  • Request

  • Response

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

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

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

{
  "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-10-26T10:22:00+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

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.

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

  • Request

  • Response

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

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

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

{
  "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-10-26T10:22:00+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

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.

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

  • Request

  • Response

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

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

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

{
  "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-10-26T10:22:00+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

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.

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

  • Request

  • Response

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

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

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

{
  "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-10-26T10:22:00+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

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.

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

  • Request

  • Response

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

{
  "onHoldByRetailer" : true,
  "reference" : "RefCode",
  "unknownProductTitle" : "Title",
  "fulfilment" : {
    "method" : "FBR",
    "deliveryCode" : "VVB"
  }
}

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

{
  "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-10-26T10:22:00+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}