Creating an inbound
The create inbound endpoint is specifically for Fulfillment By Bol.com.
With this endpoint you can create an inbound which in turn will let us know when you’ll be sending a shipment to us with; a list of products, how much stock per product, which transporter you’ll use and if you’ll place the BSKU labels yourself or if you want to let us do the labelling.
POST /services/rest/inbounds
Input
Name | Type | Values | Description |
---|---|---|---|
Reference | String | string | This field is optional. You can fill in your own reference id if desired. The value of this field will be available after creation |
TimeSlot | String | You can use this endpoint to find out which values are accepted, see [delivery-window] | This indicates the estimated arrival of your inbound at our warehouse |
FbbTransporter | String | You can use this endpoint to find out which values are accepted, see [fbb-transporter] | This indicates which transporter is used for this inbound, which in turn informs us which transporter we can expect at our warehouse |
LabellingService | Boolean | True / False | True indicates that you want to use our labellingservice, which means we’ll place the BSKU labels on your products when they arrive. If you don’t want to use our labellingservice use False when you’re creating your inbound. |
Products > Product > EAN | Integer | [0-9] | The EAN for the product you’ll ship to us |
Products > Product > AnnouncedQuantity | Integer | [0-9] | The amount of stock for the product you’ll ship to us |
Example request
POST /services/rest/inventory
<InboundRequest xmlns="https://plazaapi.bol.com/services/xsd/v1/plazaapi.xsd">
<Reference>FBB20170408</Reference>
<TimeSlot>
<Start>2017-04-08T08:00:00+02:00</Start>
<End>2017-04-08T09:00:00+02:00</End>
</TimeSlot>
<FbbTransporter>
<Code>DHL</Code>
<Name>DHL</Name>
</FbbTransporter>
<LabellingService>false</LabellingService>
<Products>
<Product>
<EAN>5014437972231</EAN>
<AnnouncedQuantity>15</AnnouncedQuantity>
</Product>
</Products>
</InboundRequest>
Example response
Status: 201 Created
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns1:ProcessStatus xmlns:ns1="https://plazaapi.bol.com/services/xsd/v2/plazaapi.xsd">
<ns1:id>14404965</ns1:id>
<ns1:sellerId>123456</ns1:sellerId>
<ns1:eventType>CREATE_INBOUND</ns1:eventType>
<ns1:description>Create an inbound with reference FBB20170408</ns1:description>
<ns1:status>PENDING</ns1:status>
<ns1:createTimestamp>2017-08-14T13:44:45.000+02:00</ns1:createTimestamp>
<ns1:Links>
<ns1:link ns1:method="GET" ns1:href="https://plazaapi.bol.com/services/rest/process-status/v2/14404965" ns1:rel="self"/>
</ns1:Links>
</ns1:ProcessStatus>