# Byrd

## Snapshot

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

## Tables/APIs supported

| Deliveries | Products |
| ---------- | -------- |
| Shipments  |          |

## Integrate Byrd with Daton

1. Sign in to Daton&#x20;
2. Select Byrd 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 Byrd API Key and API Secret. Follow the [link](https://developers.getbyrd.com/docs/obtaining-api-credentials) to get the credentials from Byrd
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

## Byrd Data

### Deliveries <a href="#deliveries" id="deliveries"></a>

Purpose: This API is used to fetch all deliveries

Source API Documentation: <https://developers.getbyrd.com/reference/deliveriesapi_get>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                       | Data Type |
| -------------------------- | --------- |
| acceptanceFee              | RECORD    |
| putawayFee                 | RECORD    |
| deviation                  | BOOLEAN   |
| userID                     | STRING    |
| warehouse                  | RECORD    |
| identifier                 | STRING    |
| expectedDeliveryDateFrom   | STRING    |
| deleted                    | BOOLEAN   |
| deliveryNotes              | STRING    |
| createdAt                  | TIMESTAMP |
| inboundedDateTime          | STRING    |
| statusUpdatedAt            | STRING    |
| inProcessingDateTime       | STRING    |
| customsPaid                | RECORD    |
| deliveryContainers         | RECORD    |
| expressInbounding          | BOOLEAN   |
| sortedItemsCount           | NUMERIC   |
| damages                    | STRING    |
| deliveryCostsPaid          | RECORD    |
| requiresCounting           | BOOLEAN   |
| standardsCompliance        | STRING    |
| meetsEUOrganicRequirements | BOOLEAN   |
| deliveredBoxes             | NUMERIC   |
| inboundingDeadline         | RECORD    |
| referenceNumber            | STRING    |
| updatedAt                  | TIMESTAMP |
| id                         | STRING    |
| senderName                 | STRING    |
| status                     | STRING    |
| unmixedDelivery            | BOOLEAN   |
| deliveryStandards          | RECORD    |
| deletedDate                | STRING    |
| deliveredPallets           | NUMERIC   |
| type                       | STRING    |
| senderAddress              | STRING    |
| stocktaking                | BOOLEAN   |
| deliverDate                | TIMESTAMP |
| atWarehouseDateTime        | STRING    |
| deliveryItems              | RECORD    |
| expectedDeliveryDateTo     | STRING    |
| description                | STRING    |
| sortedBoxesCount           | NUMERIC   |

### Products

Purpose: This API is used to fetch all products

Source API Documentation: <https://developers.getbyrd.com/reference/productsapi_get>

Replication: Full Replication

Replication Key: NA

**Fields**

| organic              | BOOLEAN   |
| -------------------- | --------- |
| sku                  | STRING    |
| deleted              | BOOLEAN   |
| bsku                 | STRING    |
| customstariffnumber  | STRING    |
| reorderpoint         | NUMERIC   |
| barcodetype          | STRING    |
| active               | BOOLEAN   |
| packagingunitenabled | BOOLEAN   |
| user                 | RECORD    |
| lotsenabled          | BOOLEAN   |
| producttype          | STRING    |
| serialnumberenabled  | BOOLEAN   |
| id                   | STRING    |
| userid               | STRING    |
| unavailablestock     | NUMERIC   |
| availablestock       | NUMERIC   |
| dimensions           | RECORD    |
| name                 | STRING    |
| updatedat            | TIMESTAMP |
| reservedstock        | NUMERIC   |
| origincountrycode    | STRING    |
| isdangerousgoods     | BOOLEAN   |
| physicalstock        | NUMERIC   |
| skipbarcodepick      | BOOLEAN   |
| fragile              | BOOLEAN   |
| createdat            | TIMESTAMP |
| purchaseprice        | RECORD    |

### Shipments

Purpose: This API is used to fetch all Shipments

Source API Documentation: <https://developers.getbyrd.com/reference/shipmentlistapiv3_get>

Replication: Key Based Incremental

Replication Key: date\_from, date\_to

**Fields**

| customs              | RECORD    |
| -------------------- | --------- |
| checkpoints          | RECORD    |
| id                   | STRING    |
| created\_at          | TIMESTAMP |
| updated\_at          | TIMESTAMP |
| return\_address      | RECORD    |
| user                 | RECORD    |
| status               | STRING    |
| shop                 | RECORD    |
| dangerous\_goods     | RECORD    |
| destination\_address | RECORD    |
| options              | RECORD    |
| units                | RECORD    |
| items                | RECORD    |
| metrics              | RECORD    |
| service              | STRING    |
| warehouse            | RECORD    |
| byrd\_id             | STRING    |
| priority             | NUMERIC   |


---

# 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/shipping-platforms/byrd.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.