Return-items v2

Get all open return-items

Retrieves all open return-items, return-items are sorted by date, descending.

GET /services/rest/return-items/v2/unhandled

Example response

Status: 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ReturnItems xmlns="https://plazaapi.bol.com/services/xsd/v2/plazaapi.xsd">
 <Item>
   <ReturnNumber>31234567</ReturnNumber>
    <OrderId>4012345678</OrderId>
    <ShipmentId>0</ShipmentId>
    <EAN>9789076174082</EAN>
    <Title>Harry Potter en de steen der wijzen</Title>
    <Quantity>1</Quantity>
    <ReturnDateAnnouncement>2016-11-14+01:00</ReturnDateAnnouncement>
    <ReturnReason>Niet naar verwachting</ReturnReason>
    <CustomerDetails>
       <SalutationCode>02</SalutationCode>
       <FirstName>Jane</FirstName>
       <Surname>Doe</Surname>
       <Streetname>Mainstreet</Streetname>
       <Housenumber>77</Housenumber>
       <HousenumberExtended>BIS</HousenumberExtended>
       <ZipCode>1234 AA</ZipCode>
       <City>AMSTERDAM</City>
       <CountryCode>NL</CountryCode>
       <Email>example@example.com</Email>
       <DeliveryPhoneNumber>0612345678</DeliveryPhoneNumber>
       <Company>ACME</Company>
    </CustomerDetails>
 </Item>
</ReturnItems>

Handle a return-item

Handle a specifc return-item. the value for :id in the URL is the value returned as ReturnNumber in the unhandled returns list. (described above)

PUT /services/rest/return-items/v2/:id/handle

Parameters

Name Type Description
ReturnNumber long Required. specifies which return-item is being handled.
PUT /services/rest/return-items/v2/34007720/handle

Input

Name Type Description
StatusReason string Required. Describes that state of the return process. Available statuses are listed in the XSD.
QuantityReturned string Required. amount of return-items received

Example request

<ReturnItemStatusUpdate xmlns="https://plazaapi.bol.com/services/xsd/v2/plazaapi.xsd">
 <StatusReason>PRODUCT_RECEIVED</StatusReason>
 <QuantityReturned>1</QuantityReturned>
</ReturnItemStatusUpdate>

Example response

Status: 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<ns1:ProcessStatus xmlns:ns1="https://plazaapi.bol.com/services/xsd/v2/plazaapi.xsd">
   <ns1:id> </ns1:id>
   <ns1:sellerId> </ns1:sellerId>
   <ns1:entityId> </ns1:entityId>
   <ns1:eventType>HANDLE_RETURN_ITEM</ns1:eventType>
   <ns1:description>Handle the return item with returnNumber 34007720</ns1:description>
   <ns1:status>PENDING</ns1:status>
   <ns1:createTimestamp>2016-02-10T16:17:28.000+01:00</ns1:createTimestamp>
   <ns1:Links>
      <ns1:link ns1:method="GET" ns1:href="https://plazaapi.bol.com/services/rest/process-status/v2/8" ns1:rel="self" />
   </ns1:Links>
</ns1:ProcessStatus>

More information on the process-status endpoint.

Endpoint XSD

returns-v2 https://plazaapi.bol.com/services/xsd/returns-v2.xsd

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.