Get a single inbound

Get a single inbound

The inbound list endpoint is specifically for Fulfillment By Bol.com. This endpoint returns a single inbound which is matched on the inbound id that’s given in the URL.

GET /services/rest/inbounds/inbounds-id

Parameters

The inbound-id parameter is required to retrieve a single inbound.

Name Type Values Description
inbounds-id integer [0-9] There’s no default value for the inbound-id. To retrieve the inbounds-id you can use the inbounds list endpoint, see Inbound list

Example request

GET /services/rest/inbounds/1124284930

Example response

Status: 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Inbound xmlns="https://plazaapi.bol.com/services/xsd/v1/plazaapi.xsd">
  <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>
  <Products>
    <Product>
      <EAN>4034398404139</EAN>
      <BSKU>2950002126612</BSKU>
      <AnnouncedQuantity>6</AnnouncedQuantity>
      <ReceivedQuantity>6</ReceivedQuantity>
      <State>Announced</State>
  </Product>
  <Product>
      <EAN>4034398400902</EAN>
      <BSKU>2950002125622</BSKU>
      <AnnouncedQuantity>8</AnnouncedQuantity>
      <ReceivedQuantity>8</ReceivedQuantity>
      <State>Announced</State>
  </Product>
  <Product>
      <EAN>4034398209925</EAN>
      <BSKU>2950002126148</BSKU>
      <AnnouncedQuantity>3</AnnouncedQuantity>
      <ReceivedQuantity>3</ReceivedQuantity>
      <State>Announced</State>
  </Product>
  <Product>
      <EAN>4034398400964</EAN>
      <BSKU>2950002126896</BSKU>
      <AnnouncedQuantity>1</AnnouncedQuantity>
      <ReceivedQuantity>1</ReceivedQuantity>
      <State>Announced</State>
  </Products>
  <StateTransitions>
    <InboundState>
      <State>ArrivedAtWH</State>
      <StateDate>2017-07-28T09:26:23.371+02:00</StateDate>
    </InboundState>
    <InboundState>
      <State>PreAnnounced</State>
      <StateDate>2017-07-26T11:16:10.757+02:00</StateDate>
    </InboundState>
    <InboundState>
      <State>Draft</State>
      <StateDate>2017-07-26T10:58:17.925+02:00</StateDate>
    </InboundState>
  </StateTransitions>
  <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>

Response values explained

Name Type Description
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: Draft, PreAnnounced, ArrivedAtWH, Cancelled
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
Product > EAN Integer The EAN of the supplied product
Product > BSKU Integer The BSKU of the supplied product
Product > AnnouncedQuantity Integer The amount of stock that was given when the inbound was created
Product > ReceivedQuantity Integer The amount of stock at the time of arrival
Product > State String This field returns if the product was announced at the time the inbound was created. One of the following values will be returned: Announced, Unannounced
TimeSlot DateTime This field returns the timeslot you’ve used when this inbound was created
StateTransitions > InboundState > State String This field returns the state of the inbound at a certain point in time. One of the following values will be returned: Draft, PreAnnounced, ArrivedAtWH, Cancelled
StateTransitions > InboundState > StateDate DateTime This field returns the datetime notation at the time of that specific state
FbbTransporter String This field returns the specific FBB transporter you’ve used when this inbound was created