Schema Information of Ohi
This topic provides a structured reference to assist you in working with Daton's Ohi connector and the associated fields and tables.
Schema Information of Ohi
This topic provides a structured reference to assist you in working with Daton's Ohi connector and the associated fields and tables.
Tables/APIs
The following is the list of tables or APIs associated with the Ohi connector:
Billable Items
Purpose: This API is used to fetch all billable items
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20billable-items
Replication: Key Based Incremental
Replication Key: updated_at_range_after, updated_at_range_before
Fields
Name |
Data Type |
---|---|
uuid |
STRING |
order_tracking_id |
STRING |
item_type |
STRING |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
source_datetime |
TIMESTAMP |
price_in_cents |
NUMERIC |
description |
STRING |
Deliveries
Purpose: This API is used to fetch all deliveries
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20deliveries
Replication: Key Based Incremental
Replication Key: created_at_range_after, created_at_range_before
Fields
Name |
Data Type |
---|---|
pickup_eta |
TIMESTAMP |
dropoff_eta |
TIMESTAMP |
verbose_status |
STRING |
tracking_id |
STRING |
direction |
STRING |
last_status |
STRING |
next_action |
STRING |
action_eta |
STRING |
created_at |
TIMESTAMP |
pod_urls |
RECORD |
vendor |
STRING |
courier_information |
RECORD |
vendor_remote_id |
STRING |
Inventories
Purpose: This API is used to fetch all the inventories
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20inventories
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
id |
NUMERIC |
warehouse |
RECORD |
product |
RECORD |
unordered |
NUMERIC |
ordered |
NUMERIC |
fulfilled |
NUMERIC |
lot_code |
RECORD |
stock_out_eta |
TIMESTAMP |
available_inventory_trigger_threshold |
NUMERIC |
suggested_available_inventory_trigger_threshold |
NUMERIC |
available_inventory_warning_disabled |
BOOLEAN |
preordered |
NUMERIC |
location |
RECORD |
Inventory Adjustment
Purpose: This API is to fetch all the inventory adjustments
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20inventory-adjustment
Replication: Key Based Incremental
Replication Key: created_at_range_after, created_at_range_before
Fields
Name |
Data Type |
---|---|
product_id |
STRING |
warehouse |
STRING |
product_title |
STRING |
product_sku |
STRING |
unordered_change |
NUMERIC |
ordered_change |
NUMERIC |
order_tracking_id |
STRING |
fulfilled_change |
NUMERIC |
reason |
STRING |
user |
STRING |
created_at |
TIMESTAMP |
comment |
STRING |
Notifications
Purpose: This API is used to get the list of all the notifications
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20notifications
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
uuid |
STRING |
display_text |
STRING |
display_type |
STRING |
display_data |
RECORD |
acknowledged_at |
TIMESTAMP |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
tag |
STRING |
Ohi Shipments
Purpose: This API is used to get the list of all the Ohi shipments for the logged-in user's client.
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20ohi-shipments
Replication: Key Based Incremental
Replication Key: updated_at_range_after, updated_at_range_before
Fields
Name |
Data Type |
---|---|
appointment_options |
RECORD |
received_at |
TIMESTAMP |
palletized |
BOOLEAN |
carrier_name |
STRING |
pallets_description |
STRING |
updated_at |
TIMESTAMP |
carrier_phone_number |
STRING |
expedited_receiving |
BOOLEAN |
tracking_code |
STRING |
can_schedule |
BOOLEAN |
status |
STRING |
po_number |
STRING |
receiving_centre |
RECORD |
ohi_shipment_id |
STRING |
created_at |
TIMESTAMP |
requested_receiving_time |
TIME |
carrier_tracking_number |
STRING |
requested_receiving_date |
DATE |
carrier_email_address |
STRING |
pallet_count |
NUMERIC |
note_for_site_manager |
STRING |
line_items |
RECORD |
Orders
Purpose: This API is used to get the list of all the orders.
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20orders
Replication: Key Based Incremental
Replication Key: updated_at_range_after, updated_at_range_before
Fields
Name |
Data Type |
---|---|
id |
STRING |
tracking_id |
STRING |
service_level_token |
STRING |
service_code |
STRING |
courier_last_mile |
STRING |
total_grams |
STRING |
shipping_address |
RECORD |
customer |
RECORD |
tracking |
RECORD |
line_items |
RECORD |
error_status |
STRING |
originator_order_id |
STRING |
target_customer_arrival_eta |
TIMESTAMP |
delivered_at |
TIMESTAMP |
created_at |
TIMESTAMP |
updated_at |
TIMESTAMP |
client_status |
STRING |
customer_arrival_eta |
TIMESTAMP |
tracking_urls |
STRING |
shipment_type |
STRING |
detailed_status |
STRING |
location |
STRING |
can_cancel |
BOOLEAN |
fulfilled_at |
TIMESTAMP |
picking_release_datetime |
TIMESTAMP |
warehouse_address |
RECORD |
is_reschedulable |
BOOLEAN |
can_split_shipment |
BOOLEAN |
processed |
BOOLEAN |
deliveries |
RECORD |
Products
Purpose: This API is used to get the list of all the products.
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20products
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
id |
NUMERIC |
sku |
STRING |
title |
STRING |
grams |
NUMERIC |
product_id |
STRING |
variant_id |
STRING |
image_url |
STRING |
disabled_at |
TIMESTAMP |
is_kit |
BOOLEAN |
Users
Purpose: This API is used to get the list of all the users.
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20users
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
email |
STRING |
password |
STRING |
first_name |
STRING |
last_name |
STRING |
username |
STRING |
Warehouse Address
Purpose: This API is used to get the list of all the warehouse addresses.
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20addresses
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
timezone |
STRING |
state |
STRING |
address_1 |
STRING |
address_2 |
STRING |
city |
STRING |
zip_code |
STRING |
latitude |
STRING |
longitude |
STRING |
short_code |
STRING |
location_type |
STRING |
Warehouses
Purpose: This API is used to get the list of all the warehouses
Source API Documentation: https://api.shipohi.com/api/v1/docs#operation/List%20warehouses
Replication: Full Replication
Replication Key: NA
Fields
Name |
Data Type |
---|---|
id |
NUMERIC |
name |
STRING |
description |
STRING |
city |
STRING |
address_1 |
STRING |
state |
STRING |
zip_code |
STRING |
weekday_same_day_confirmed |
STRING |
weekday_rush_confirmed |
STRING |
weekday_service_confirmed |
STRING |
timezone |
STRING |
warehouse_services |
RECORD |
rush_orders_accepted_start_time_local |
TIME |
rush_orders_accepted_end_time_local |
TIME |
weekday_window_service_confirmed |
STRING |