> For the complete documentation index, see [llms.txt](https://help.daasity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.daasity.com/core-concepts/data-integrations/setup-guides/digital-integrations/shipbob/integration-specifications.md).

# Integration Specifications

## Integration Availability

This integration is available for:

* Enterprise
* Growth

## API Endpoints

This extractor is based on [the ShipBob Developer API](https://developer.shipbob.com/api-docs/). The following endpoints are used by Daasity to replicate data into Daasity:

* [Get Orders](https://developer.shipbob.com/api-docs/#tag/Orders/paths/~11.0~1order/get)

## Entity Relationship Diagram (ERD)

{% @lucid/lucid-component url="<https://lucid.app/lucidchart/2ce034e6-807c-4ffb-bd02-50ca8b061c87/view>" fullWidth="true" %}

## ShipBob Schema

The ShipBob extractor creates these tables using the endpoints and replication methods listed. The data is mapped from source API endpoint to the table based on the mapping logic outlined in each table.

* [Orders](#orders)
* [Shipment Products](#shipment-products)
* [Shipment Status Details](#shipment-status-details)
* [Shipments](#shipments)

### Orders

* Endpoint: [Get Orders](https://developer.shipbob.com/api-docs/#tag/Orders/paths/~11.0~1order/get)
* Update Method: UPSERT
* Table Name: \[`shipbob.orders`]

<table data-full-width="true"><thead><tr><th width="457">JSON Element</th><th>Column</th></tr></thead><tbody><tr><td>$.channel.id</td><td>channel__id</td></tr><tr><td>$.channel.name</td><td>channel__name</td></tr><tr><td>$.created_date</td><td>created_date</td></tr><tr><td>$.financials.total_price</td><td>financials__total_price</td></tr><tr><td>$.gift_message</td><td>gift_message</td></tr><tr><td>$.id</td><td>id</td></tr><tr><td>$.order_number</td><td>order_number</td></tr><tr><td>$.products</td><td>products</td></tr><tr><td>$.purchase_date</td><td>purchase_date</td></tr><tr><td>$.recipient.address.address1</td><td>recipient__address__address1</td></tr><tr><td>$.recipient.address.address2</td><td>recipient__address__address2</td></tr><tr><td>$.recipient.address.city</td><td>recipient__address__city</td></tr><tr><td>$.recipient.address.company_name</td><td>recipient__address__company_name</td></tr><tr><td>$.recipient.address.country</td><td>recipient__address__country</td></tr><tr><td>$.recipient.address.state</td><td>recipient__address__state</td></tr><tr><td>$.recipient.address.zip_code</td><td>recipient__address__zip_code</td></tr><tr><td>$.recipient.email</td><td>recipient__email</td></tr><tr><td>$.recipient.name</td><td>recipient__name</td></tr><tr><td>$.recipient.phone_number</td><td>recipient__phone_number</td></tr><tr><td>$.reference_id</td><td>reference_id</td></tr><tr><td>$.retailer_program_data.addresses</td><td>retailer_program_data__addresses</td></tr><tr><td>$.retailer_program_data.customer_ticket_number</td><td>retailer_program_data__customer_ticket_number</td></tr><tr><td>$.retailer_program_data.delivery_date</td><td>retailer_program_data__delivery_date</td></tr><tr><td>$.retailer_program_data.department</td><td>retailer_program_data__department</td></tr><tr><td>$.retailer_program_data.do_not_ship_before_date</td><td>retailer_program_data__do_not_ship_before_date</td></tr><tr><td>$.retailer_program_data.mark_for_store</td><td>retailer_program_data__mark_for_store</td></tr><tr><td>$.retailer_program_data.purchase_order_number</td><td>retailer_program_data__purchase_order_number</td></tr><tr><td>$.retailer_program_data.retailer_program_type</td><td>retailer_program_data__retailer_program_type</td></tr><tr><td>$.retailer_program_data.ship_by_date</td><td>retailer_program_data__ship_by_date</td></tr><tr><td>$.shipping_method</td><td>shipping_method</td></tr><tr><td>$.shipping_terms.carrier_type</td><td>shipping_terms__carrier_type</td></tr><tr><td>$.shipping_terms.payment_term</td><td>shipping_terms__payment_term</td></tr><tr><td>$.status</td><td>status</td></tr><tr><td>$.tags</td><td>tags</td></tr><tr><td>$.type</td><td>type</td></tr><tr><td>MD5($.id)</td><td>__sync_key</td></tr></tbody></table>

### Shipment Products

* Endpoint: [Get Orders](https://developer.shipbob.com/api-docs/#tag/Orders/paths/~11.0~1order/get)
* Update Method: UPSERT
* Table Name: \[`shipbob.shipment_products`]

<table data-full-width="true"><thead><tr><th>JSON Element</th><th>Column</th></tr></thead><tbody><tr><td>$.shipments[].products[].id</td><td>id</td></tr><tr><td>$.shipments[].products[].inventory_items</td><td>inventory_items</td></tr><tr><td>$.shipments[].products[].name</td><td>name</td></tr><tr><td>$.shipments[].products[].reference_id</td><td>reference_id</td></tr><tr><td>$.shipments[].products[].sku</td><td>sku</td></tr><tr><td>$.shipments[].id</td><td>shipment_id</td></tr><tr><td>MD5($.shipments[].products[].id + $.shipments[].id)</td><td>__sync_key</td></tr></tbody></table>

### Shipment Status Details

* Endpoint: [Get Orders](https://developer.shipbob.com/api-docs/#tag/Orders/paths/~11.0~1order/get)
* Update Method: UPSERT
* Table Name: \[`shipbob.shipment_status_details`]

<table data-full-width="true"><thead><tr><th>JSON Element</th><th>Column</th></tr></thead><tbody><tr><td>$.shipments[].status_details[].description</td><td>description</td></tr><tr><td>$.shipments[].status_details[].exception_fulfillment_center_id</td><td>exception_fulfillment_center_id</td></tr><tr><td>$.shipments[].status_details[].extra_information</td><td>extra_information</td></tr><tr><td>$.shipments[].status_details[].id</td><td>id</td></tr><tr><td>$.shipments[].status_details[].inventory_id</td><td>inventory_id</td></tr><tr><td>$.shipments[].status_details[].name</td><td>name</td></tr><tr><td>$.shipments[].id</td><td>shipment_id</td></tr><tr><td>MD5($.shipments[].status_details[].id)</td><td>__sync_key</td></tr></tbody></table>

### Shipments

* Endpoint: [Get Orders](https://developer.shipbob.com/api-docs/#tag/Orders/paths/~11.0~1order/get)
* Update Method: UPSERT
* Table Name: \[`shipbob.shipments`]

<table data-full-width="true"><thead><tr><th>JSON Element</th><th>Column</th></tr></thead><tbody><tr><td>$.shipments[].actual_fulfillment_date</td><td>actual_fulfillment_date</td></tr><tr><td>$.shipments[].created_date</td><td>created_date</td></tr><tr><td>$.shipments[].delivery_date</td><td>delivery_date</td></tr><tr><td>$.shipments[].estimated_fulfillment_date</td><td>estimated_fulfillment_date</td></tr><tr><td>$.shipments[].estimated_fulfillment_date_status</td><td>estimated_fulfillment_date_status</td></tr><tr><td>$.shipments[].gift_message</td><td>gift_message</td></tr><tr><td>$.shipments[].id</td><td>id</td></tr><tr><td>$.shipments[].insurance_value</td><td>insurance_value</td></tr><tr><td>$.shipments[].invoice_amount</td><td>invoice_amount</td></tr><tr><td>$.shipments[].invoice_currency_code</td><td>invoice_currency_code</td></tr><tr><td>$.shipments[].is_tracking_uploaded</td><td>is_tracking_uploaded</td></tr><tr><td>$.shipments[].last_tracking_update_at</td><td>last_tracking_update_at</td></tr><tr><td>$.shipments[].last_update_at</td><td>last_update_at</td></tr><tr><td>$.shipments[].location.id</td><td>location__id</td></tr><tr><td>$.shipments[].location.name</td><td>location__name</td></tr><tr><td>$.shipments[].measurements</td><td>measurements</td></tr><tr><td>$.shipments[].order_id</td><td>order_id</td></tr><tr><td>$.shipments[].package_material_type</td><td>package_material_type</td></tr><tr><td>$.shipments[].parent_cartons</td><td>parent_cartons</td></tr><tr><td>$.shipments[].recipient.address.address1</td><td>recipient__address__address1</td></tr><tr><td>$.shipments[].recipient.address.address2</td><td>recipient__address__address2</td></tr><tr><td>$.shipments[].recipient.address.city</td><td>recipient__address__city</td></tr><tr><td>$.shipments[].recipient.address.company_name</td><td>recipient__address__company_name</td></tr><tr><td>$.shipments[].recipient.address.country</td><td>recipient__address__country</td></tr><tr><td>$.shipments[].recipient.address.state</td><td>recipient__address__state</td></tr><tr><td>$.shipments[].recipient.address.zip_code</td><td>recipient__address__zip_code</td></tr><tr><td>$.shipments[].recipient.email</td><td>recipient__email</td></tr><tr><td>$.shipments[].recipient.full_name</td><td>recipient__full_name</td></tr><tr><td>$.shipments[].recipient.name</td><td>recipient__name</td></tr><tr><td>$.shipments[].recipient.phone_number</td><td>recipient__phone_number</td></tr><tr><td>$.shipments[].reference_id</td><td>reference_id</td></tr><tr><td>$.shipments[].require_signature</td><td>require_signature</td></tr><tr><td>$.shipments[].ship_option</td><td>ship_option</td></tr><tr><td>$.shipments[].status</td><td>status</td></tr><tr><td>$.shipments[].tracking</td><td>tracking</td></tr><tr><td>MD5($.shipments[].id)</td><td>__sync_key</td></tr></tbody></table>