# Schema Information

## Tables/APIs&#x20;

The following is the list of tables or APIs associated with the Ohi connector:

### Billable Items <a href="#billable-items" id="billable-items"></a>

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** <a href="#deliveries" id="deliveries"></a>

Purpose: This API is used to fetch all deliveries&#x20;

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** <a href="#inventories" id="inventories"></a>

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                                            | <p>RECORD<br></p> |

### **Inventory Adjustment** <a href="#inventory-adjustment" id="inventory-adjustment"></a>

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** <a href="#notifications" id="notifications"></a>

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** <a href="#ohi-shipments" id="ohi-shipments"></a>

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** <a href="#orders" id="orders"></a>

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    |

### &#x20;**Products** <a href="#products" id="products"></a>

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** <a href="#users" id="users"></a>

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** <a href="#warehouse-address" id="warehouse-address"></a>

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** <a href="#warehouse" id="warehouse"></a>

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    |


---

# 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/ohi/schema-information.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.
