Inbound list

Inbound list

The inbound list endpoint is specifically for Fulfillment By Bol.com. This endpoint returns a list of inbounds with a summary of each inbound. If you want a more detailed representation of a specific inbound you can use the following endpoint, [single inbound].

GET /services/rest/inbounds

Parameters

The optional page parameter can be used to traverse the endpoint. The other optional parameters can be applied to filter the list of inventory that’s given back from the API.

Name Type Values Description
Page integer [0-9] The default value is 1 if the parameter isn’t given

Example request

GET /services/rest/inventory?page=2

Example response

Status: 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Inbounds xmlns="https://plazaapi.bol.com/services/xsd/v1/plazaapi.xsd">
  <TotalCount>4</TotalCount>
  <TotalPageCount>1</TotalPageCount>
  <Inbound>
    <Id>1124284930</Id>
    <Reference>FBB20170726</Reference>
    <CreationDate>2017-07-26T10:58:17.079+02:00</CreationDate>
    <State>ArrivedAtWH</State>
    <LabellingService>false</LabellingService>
    <AnnouncedBSKUs>69</AnnouncedBSKUs>
    <AnnouncedQuantity>237</AnnouncedQuantity>
    <ReceivedBSKUs>69</ReceivedBSKUs>
    <ReceivedQuantity>240</ReceivedQuantity>
    <TimeSlot>
      <Start>2017-07-28T06:00:00.000+02:00</Start>
      <End>2017-07-28T19:00:00.000+02:00</End>
    </TimeSlot>
    <FbbTransporter>
      <Name>PostNL</Name>
      <Code>PostNL</Code>
    </FbbTransporter>
  </Inbound>
  <Inbound>
    <Id>1124284929</Id>
    <Reference>FBB20170712</Reference>
    <CreationDate>2017-07-12T21:08:02.433+02:00</CreationDate>
    <State>ArrivedAtWH</State>
    <LabellingService>false</LabellingService>
    <AnnouncedBSKUs>85</AnnouncedBSKUs>
    <AnnouncedQuantity>204</AnnouncedQuantity>
    <ReceivedBSKUs>90</ReceivedBSKUs>
    <ReceivedQuantity>203</ReceivedQuantity>
    <TimeSlot>
      <Start>2017-07-17T06:00:00.000+02:00</Start>
      <End>2017-07-17T19:00:00.000+02:00</End>
    </TimeSlot>
    <FbbTransporter>
      <Name>PostNL</Name>
      <Code>PostNL</Code>
    </FbbTransporter>
  </Inbound>
</Inbounds>

Response values explained

Name Type Description
TotalCount Integer The total amount of unique inbounds
TotalPageCount Integer The total amount of pages that can be requested
Reference String The value of this optional field is the same value you’ve supplied when this inbound was created
State String The current state of the inbound. This will be one of the following values: ArrivedAtWH
LabellingService Boolean This field returns a true or false value depending on what you chose earlier at the creation of the inbound
AnnouncedBSKUs Integer The amount of unique products that are part of this inbound when it was created
AnnouncedQuantity Integer The sum amount of products that are part of this inbound when it was created
ReceivedBSKUs Integer The amount of unique products that are part of this inbound at the time of arrival
ReceivedQuantity Integer The sum amount of products that are part of this inbound at the time of arrival
TimeSlot Datetime This field returns the timeslot you’ve used when this inbound was created
FbbTransporter String This field returns the specific FBB transporter you’ve used when this inbound was created