v3 - Returns - Demo Endpoints

Handle return for order item 6107434013

Handle the return for order item 6107434013 with rmaId 86123452.

PUT /retailer-demo/returns/86123452

  • Request

  • Response

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

{
  "handlingResult" : "RETURN_RECEIVED",
  "quantityReturned" : 3
}

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

{
  "id" : 1,
  "entityId" : "86123452",
  "eventType" : "HANDLE_RETURN_ITEM",
  "description" : "Handle the return item with return number 86123452.",
  "status" : "PENDING",
  "createTimestamp" : "2020-10-26T10:21:55+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Handle return for order item 6107331383

Handle the return for order item 6107434013 with rmaId 86129741.

PUT /retailer-demo/returns/86129741

  • Request

  • Response

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

{
  "handlingResult" : "EXCHANGE_PRODUCT",
  "quantityReturned" : 1
}

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

{
  "id" : 1,
  "entityId" : "86129741",
  "eventType" : "HANDLE_RETURN_ITEM",
  "description" : "Handle the return item with return number 86129741.",
  "status" : "PENDING",
  "createTimestamp" : "2020-10-26T10:21:55+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Handle return for order item 6107432387

Handle the return for order item 6107434013 with rmaId 86126399.

PUT /retailer-demo/returns/86224896

  • Request

  • Response

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

{
  "handlingResult" : "RETURN_RECEIVED",
  "quantityReturned" : 3
}

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

{
  "id" : 1,
  "entityId" : "86224896",
  "eventType" : "HANDLE_RETURN_ITEM",
  "description" : "Handle the return item with return number 86224896.",
  "status" : "PENDING",
  "createTimestamp" : "2020-10-26T10:21:55+01:00",
  "links" : [ {
    "rel" : "self",
    "href" : "http://api.bol.com/retailer-demo/process-status/1",
    "method" : "GET"
  } ]
}

Retrieve a single unhandled return based on rmaId

This example shows a specific return (known by rmaId 86127131) that is not yet handled by a retailer.

GET /retailer-demo/returns/86127131

  • Request

  • Response

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

This endpoint has no request body.

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

{
  "rmaId" : 86127131,
  "orderId" : "7616247328",
  "ean" : "8718526069334",
  "title" : "Star Wars - Nappy Star wars T-shirt - XL",
  "quantity" : 1,
  "registrationDateTime" : "2018-04-27T19:55:12+02:00",
  "returnReason" : "Verkeerd besteld",
  "returnReasonComments" : "Ik wilde eigenlijk een groter formaat",
  "customerDetails" : {
    "salutationCode" : "01",
    "firstName" : "Chewbakka",
    "surname" : "Wookiee",
    "streetName" : "Kashyyykstraat",
    "houseNumber" : "100",
    "zipCode" : "3528BJ",
    "city" : "Utrecht",
    "countryCode" : "NL",
    "email" : "25whxgzlkmrvs47wsq2yohuwgfnwzk@verkopen.test2.bol.com"
  },
  "fulfilmentMethod" : "FBB",
  "handled" : false,
  "trackAndTrace" : "3SXOLD7654321"
}

Retrieve a single handled return based on rmaId for an FBR order

This example shows a specific return (known by rmaId 86123452) that is already handled by a retailer using an FBR order.

GET /retailer-demo/returns/86123452

  • Request

  • Response

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

This endpoint has no request body.

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

{
  "rmaId" : 86123452,
  "orderId" : "7616222250",
  "ean" : "8712626055150",
  "title" : "Star Wars - Original Trilogy",
  "quantity" : 3,
  "registrationDateTime" : "2018-04-27T10:18:33+02:00",
  "returnReason" : "Verkeerd besteld",
  "returnReasonComments" : "Ik wilde eigenlijk de extended version",
  "customerDetails" : {
    "salutationCode" : "01",
    "firstName" : "Anakin",
    "surname" : "Skywalker",
    "streetName" : "Tatooinestraat",
    "houseNumber" : "100",
    "houseNumberExtended" : "B",
    "zipCode" : "3528BJ",
    "city" : "Utrecht",
    "countryCode" : "NL",
    "email" : "25whxgzlkmrvs47wsq2yohuwgfnwzk@verkopen.test2.bol.com",
    "deliveryPhoneNumber" : "0612345678"
  },
  "fulfilmentMethod" : "FBR",
  "handled" : true,
  "handlingResult" : "RETURN_RECEIVED",
  "processingResult" : "ACCEPTED",
  "processingDateTime" : "2018-04-29T16:36:54+02:00"
}

Retrieve a single handled return based on rmaId for an FBR order

This example shows a specific return (known by rmaId 86129741) that is already handled by a retailer using an FBR order.

GET /retailer-demo/returns/86129741

  • Request

  • Response

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

This endpoint has no request body.

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

{
  "rmaId" : 86129741,
  "orderId" : "7616222700",
  "ean" : "8712626055143",
  "title" : "Star Wars Prequel Trilogy",
  "quantity" : 1,
  "registrationDateTime" : "2018-04-29T22:21:51+02:00",
  "returnReason" : "Anders, namelijk:",
  "returnReasonComments" : "Cadeau vonden ze niet leuk",
  "customerDetails" : {
    "salutationCode" : "02",
    "firstName" : "Leia",
    "surname" : "Organa",
    "streetName" : "Alderaanweg",
    "houseNumber" : "100",
    "zipCode" : "3528BJ",
    "city" : "Utrecht",
    "countryCode" : "NL",
    "email" : "25whxgzlkmrvs47wsq2yohuwgfnwzk@verkopen.test2.bol.com",
    "company" : "Senator.nl"
  },
  "fulfilmentMethod" : "FBR",
  "handled" : true,
  "handlingResult" : "EXCHANGE_PRODUCT",
  "processingResult" : "ACCEPTED",
  "processingDateTime" : "2018-05-04T07:28:11+02:00"
}

Retrieve a single handled return based on rmaId

This example shows a specific return (known by rmaId 86127199) that is already handled by a retailer.

GET /retailer-demo/returns/86127199

  • Request

  • Response

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

This endpoint has no request body.

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

{
  "rmaId" : 86127199,
  "orderId" : "7616247328",
  "ean" : "8718526069334",
  "title" : "Star Wars - Nappy Star wars T-shirt - XL",
  "quantity" : 1,
  "registrationDateTime" : "2018-04-27T19:55:12+02:00",
  "returnReason" : "Verkeerd besteld",
  "returnReasonComments" : "Ik wilde eigenlijk een groter formaat",
  "customerDetails" : {
    "salutationCode" : "01",
    "firstName" : "Chewbakka",
    "surname" : "Wookiee",
    "streetName" : "Kashyyykstraat",
    "houseNumber" : "100",
    "zipCode" : "3528BJ",
    "city" : "Utrecht",
    "countryCode" : "NL",
    "email" : "25whxgzlkmrvs47wsq2yohuwgfnwzk@verkopen.test2.bol.com"
  },
  "fulfilmentMethod" : "FBB",
  "handled" : true,
  "trackAndTrace" : "3SXOLD7654321",
  "handlingResult" : "RETURN_RECEIVED",
  "processingResult" : "ACCEPTED",
  "processingDateTime" : "2018-04-29T16:36:54+02:00"
}

Get all unhandled returns for FBB orders

Retrieves all open returns that were 'Fulfillment by bol.com', which are sorted by date in descending order. Note that the track and trace information is only returned when available.

GET /retailer-demo/returns?fulfilment-method=FBB

  • Request

  • Response

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

This endpoint has no request body.

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

{
  "returns" : [ {
    "rmaId" : 86127131,
    "orderId" : "7616247328",
    "ean" : "8718526069334",
    "quantity" : 1,
    "registrationDateTime" : "2018-04-27T19:55:12+02:00",
    "returnReason" : "Verkeerd besteld",
    "returnReasonComments" : "Ik wilde eigenlijk een groter formaat",
    "fulfilmentMethod" : "FBB",
    "handled" : false
  } ]
}

Get all unhandled returns

Retrieves all open returns, which are sorted by date in descending order. Note that track and trace information and delivery phone number elements are only returned when available.

GET /retailer-demo/returns

  • Request

  • Response

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

This endpoint has no request body.

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

{
  "returns" : [ {
    "rmaId" : 60283608,
    "orderId" : "1044796550",
    "ean" : "0634154562956",
    "quantity" : 1,
    "registrationDateTime" : "2019-06-03T17:06:12+02:00",
    "returnReason" : "Anders, namelijk:",
    "returnReasonComments" : "Cadeau vonden ze niet leuk",
    "fulfilmentMethod" : "FBR",
    "handled" : false
  } ]
}

Get all handled returns

Retrieves all handled returns, which are sorted by date of processing in descending order. Each return item shows the exact handling and processing result for each item.

GET /retailer-demo/returns?handled=true

  • Request

  • Response

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

This endpoint has no request body.

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

{
  "returns" : [ {
    "rmaId" : 60283607,
    "orderId" : "1044796550",
    "ean" : "0634154562079",
    "quantity" : 1,
    "registrationDateTime" : "2019-06-03T17:06:12+02:00",
    "returnReason" : "Verkeerde maat of formaat",
    "returnReasonComments" : "Verkeerde maat of formaat",
    "fulfilmentMethod" : "FBR",
    "handled" : true
  }, {
    "rmaId" : 60282944,
    "orderId" : "1043965710",
    "ean" : "0811571016532",
    "quantity" : 1,
    "registrationDateTime" : "2019-05-09T13:04:22+02:00",
    "returnReason" : "Verkeerd artikel ontvangen",
    "returnReasonComments" : "Verkeerd artikel ontvangen",
    "fulfilmentMethod" : "FBR",
    "handled" : true
  }, {
    "rmaId" : 60282945,
    "orderId" : "1044194100",
    "ean" : "3138520283072",
    "quantity" : 1,
    "registrationDateTime" : "2019-05-09T13:04:22+02:00",
    "returnReason" : "Artikel is defect/werkt niet",
    "returnReasonComments" : "Artikel is defect/werkt niet",
    "fulfilmentMethod" : "FBR",
    "handled" : true
  }, {
    "rmaId" : 60278123,
    "orderId" : "1020824520",
    "ean" : "5702015866736",
    "quantity" : 1,
    "registrationDateTime" : "2018-11-06T10:48:34+01:00",
    "returnReason" : "Geen reden",
    "returnReasonComments" : "Geen reden",
    "fulfilmentMethod" : "FBR",
    "handled" : true
  } ]
}

Get all handled returns for FBB orders

Retrieves all handled returns that were 'Fulfillment by bol.com', which are sorted by date of processing in descending order. Each return item shows the exact handling and processing result for the item.

GET /retailer-demo/returns?fulfilment-method=FBB&handled=true

  • Request

  • Response

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

This endpoint has no request body.

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

{
  "returns" : [ {
    "rmaId" : 86127199,
    "orderId" : "7616247328",
    "ean" : "8718526069334",
    "quantity" : 1,
    "registrationDateTime" : "2018-04-27T19:55:12+02:00",
    "returnReason" : "Verkeerd besteld",
    "returnReasonComments" : "Ik wilde eigenlijk een groter formaat",
    "fulfilmentMethod" : "FBB",
    "handled" : true,
    "handlingResult" : "RETURN_RECEIVED",
    "processingResult" : "ACCEPTED",
    "processingDateTime" : "2018-04-29T16:36:54+02:00"
  } ]
}