# Bol Retail v2

### Snapshot

| Features                        | Details                                          |
| ------------------------------- | ------------------------------------------------ |
| Release Status                  | Released                                         |
| Source API Version              | V8                                               |
| Table Selection                 | Yes                                              |
| Column Selection                | Yes                                              |
| Edit Integration                | Yes                                              |
| Replication Type Selection      | No                                               |
| Authentication Parameters       | <p>Client ID<br>Client Secret</p>                |
| Replication Type                | <p>Full Replication<br>Key Based Incremental</p> |
| Replication Key                 | Date                                             |
| Suggested Replication Frequency | 1 hour                                           |

### Tables/APIs supported

<table data-header-hidden><thead><tr><th width="380">Tables/APIs Supported</th><th></th></tr></thead><tbody><tr><td>Inventory</td><td>Invoice</td></tr><tr><td>Orders</td><td>Replenishments</td></tr><tr><td>Returns</td><td>Shipments</td></tr><tr><td>Shipments Details</td><td>Invoice Line Items</td></tr></tbody></table>

### Integrate Bol Retail with Daton

1. Sign in to Daton&#x20;
2. Select BolRetail v2 from the list of Integrations&#x20;
3. Provide Integration Name, Replication Frequency, and History. Integration name would be used in creating tables for the integration and cannot be changed later&#x20;
4. Provide Client ID and Client Secret in the next step. Follow this [link](https://docs.sarasanalytics.com/faqs/api-keys/how-to-create-client-credentials-for-bol-retail) to get client credentials
5. Post successful authentication, you will be prompted to choose from the list of available tables
6. Then select all required fields for each table
7. Submit the integration

### Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

### Bol Retail Data

#### **Inventory**

Purpose: This API is used to fetch a list of all inventories

Source API Documentation <https://api.bol.com/retailer/public/redoc/v8/retailer.html#operation/get-inventory>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name         | Data Type |
| ------------ | --------- |
| ean          | STRING    |
| bsku         | STRING    |
| gradedStock  | NUMERIC   |
| regularStock | NUMERIC   |
| title        | STRING    |

#### **Invoice**

Purpose: This API is used to fetch a list of invoices

Source API Documentation <https://api.bol.com/retailer/public/redoc/v8/retailer.html#operation/get-invoices>

Replication: Key Based Incremental

Replication Key: period-start-date, period-end-date&#x20;

**Fields**

| Name                    | Data Type |
| ----------------------- | --------- |
| invoiceId               | STRING    |
| issueDate               | NUMERIC   |
| invoicePeriod           | RECORD    |
| invoiceType             | STRING    |
| legalMonetaryTotal      | RECORD    |
| invoiceMediaTypes       | RECORD    |
| specificationMediaTypes | RECORD    |
| openAmount              | NUMERIC   |

#### **Invoice Line Items**

Purpose: This API is used to fetch a list of all invoice line items

Source API Documentation <https://api.bol.com/retailer/public/redoc/v8/retailer.html#operation/get-invoice-specification>

Replication: Key Based Incremental

Replication Key: period-start-date, period-end-date&#x20;

| Name                | Data Type |
| ------------------- | --------- |
| invoiceId           | STRING    |
| id                  | STRING    |
| invoiceLineRef      | STRING    |
| invoicedQuantity    | RECORD    |
| item                | RECORD    |
| lineExtensionAmount | RECORD    |
| price               | RECORD    |
| taxTotal            | RECORD    |

#### Orders

Purpose: This API is used to fetch details of all orders for a retailer&#x20;

Source API Documentation <https://api.bol.com/retailer/public/redoc/v8/retailer.html#operation/get-orders>

Replication: Key Based Incremental

Replication Key: latest-change-date

**Fields**

| Name                | Data Type |
| ------------------- | --------- |
| orderId             | STRING    |
| pickupPoint         | BOOLEAN   |
| orderPlacedDateTime | TIMESTAMP |
| shipmentDetails     | RECORD    |
| billingDetails      | RECORD    |
| orderItems          | RECORD    |

#### Replenishments

Purpose: This API is used to fetch a list of replenishments

Source API Documentation <https://api.bol.com/retailer/public/redoc/v8/retailer.html#operation/get-replenishments>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name             | Data Type |
| ---------------- | --------- |
| replenishmentId  | STRING    |
| reference        | STRING    |
| creationDateTime | TIMESTAMP |
| lines            | RECORD    |

#### Returns

Purpose: This API is used to fetch details of all returns

Source API Documentation <https://api.bol.com/retailer/public/redoc/v8/retailer.html#operation/get-returns>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                 | Data Type |
| -------------------- | --------- |
| returnId             | STRING    |
| registrationDateTime | TIMESTAMP |
| fulfilmentMethod     | STRING    |
| returnItems          | RECORD    |

#### Shipments

Purpose: This API is used to all the shipments&#x20;

Source API Documentation <https://api.bol.com/retailer/public/redoc/v8/retailer.html#operation/get-shipments>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name              | Data Type |
| ----------------- | --------- |
| shipmentId        | STRING    |
| shipmentDateTime  | TIMESTAMP |
| shipmentReference | STRING    |
| order             | RECORD    |
| shipmentItems     | RECORD    |
| transport         | RECORD    |

#### Shipments **Details**

Purpose: This API is used to  fetch all shipment details

Source API Documentation <https://api.bol.com/retailer/public/redoc/v8/retailer.html#operation/get-shipment>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name              | Data Type |
| ----------------- | --------- |
| shipmentId        | STRING    |
| shipmentDateTime  | TIMESTAMP |
| shipmentReference | STRING    |
| pickupPoint       | BOOLEAN   |
| order             | RECORD    |
| shipmentDetails   | RECORD    |
| billingDetails    | RECORD    |
| shipmentItems     | RECORD    |
| transport         | RECORD    |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://daton-sarasanalytics.gitbook.io/daton/integrations/data-sources/ecommerce/bol-retail-v2.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.