Byrd
Byrd
Byrd ETL connector for data replication
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 | API Key API Secret |
Replication Type | Full Replication Key Based Incremental |
Replication Key | Date |
Suggested Replication Frequency | 1 hr |
Tables/APIs supported
Deliveries | Products |
Shipments |
Integrate Byrd with Daton
- Sign in to Daton
- Select Byrd from the list of Integrations
- Provide Integration Name, Replication Frequency, and History. Integration name would be used in creating tables for the integration and cannot be changed later
- Provide Byrd API Key and API Secret. Follow the link to get the credentials from Byrd
- Post successful authentication, you will be prompted to choose from the list of available tables
- Then select all required fields for each table
- Submit the integration
Workflow
- 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
- Users would be able to edit/pause/re-activate/delete integration anytime
- 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
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 |