Schema Information for ZenShows
Schema Information for ZenShows
In this article, we will look at the schema information of the supported APIs and tables for ZenShows.
Find the links to other articles related to ZenShows below:
Tables/APIs Supported
The tables and APIs associated with the ZenShows connector are as follows.
SalesData
Purpose: The Sales Data API provides access to detailed sales transactions across connected channels. It enables businesses to retrieve order-level information such as product sold, quantity, revenue, discounts, and customer details. This data is essential for generating sales reports, tracking performance metrics, analyzing customer behavior, and syncing with accounting or BI systems for better decision-making.
Source API Documentation: https://api.zenshows.com/
Replication Type: Key Based
| Field Name | Data Type | Description |
|---|---|---|
| ap_suffix | Integer | AP system suffix identifier (possibly internal reference) |
| ap_vendor | Integer | AP vendor ID |
| bba_suffix | Integer | BBA system suffix identifier (possibly internal reference) |
| bba_vendor | Integer | BBA vendor ID |
| color | String | Product color (if applicable) |
| data_priority | Integer | Data sync or processing priority level |
| department | Integer | Department or category code |
| description | String | General item description |
| extended_cost | Float | Total cost (unit cost × quantity) |
| extended_retail | Float | Total retail value of the item |
| gst | Float | GST (Goods and Services Tax) amount |
| hst | Float | HST (Harmonized Sales Tax) amount |
| invoice_num | Integer | Invoice number for the sales transaction |
| item | Integer | Unique item ID |
| item_description | String | Detailed item description |
| payment_summary | Date | Date when the payment was summarized or processed |
| po_number | Integer | Purchase Order number |
| qst | Float | QST (Quebec Sales Tax) amount |
| qty | Integer | Quantity sold (negative may indicate return) |
| retail_price | Float | Retail price per unit |
| retailer_id | Integer | Identifier for the retailer |
| sales_date | Date | Date when the sale occurred |
| show_id | Integer | Event or show identifier |
| size | String | Product size |
| title | String | Product category or title (e.g., “Cookware”) |
| unit_cost | Float | Cost per unit |
| vendor_description | String | Description from vendor |
| vendor_id | Integer | Vendor ID |
| vendor_stockid | String | Vendor’s internal product code/SKU |
| warehouse | Integer | Warehouse ID where the product was stored or fulfilled |
| wholesale_price | Float | Wholesale price of the product |
RMA
Purpose: The RMA API is designed to manage and track product return requests in an automated and structured manner. It allows businesses to create, update, and retrieve return authorizations, link them to original sales orders, capture return reasons, and monitor refund or replacement statuses. This API streamlines the return process, improves customer service, and ensures accurate inventory and financial reconciliation.
Source API Documentation:
Replication Type: Key Based
| Field Name | Data Type | Description |
|---|---|---|
| cases | Integer | Number of cases involved |
| comment | String | Additional comment or reference info (INMAR ID, RAR, BOL, etc.) |
| date | Date | Date of the deduction or return |
| deduction | String | Deduction reference number (e.g., RAR#) |
| ecomcharge | Float | E-commerce charge amount |
| gst | Float | GST (Goods and Services Tax) amount |
| hst | Float | HST (Harmonized Sales Tax) amount |
| inboundfreight | Float | Cost of inbound freight |
| locname | String | Location name (e.g., warehouse or return center) |
| logline | String | Logline or transaction tracking reference |
| misccharge | Float | Miscellaneous charge (e.g., restocking fee) |
| misccharge2 | Float | Additional miscellaneous charge |
| outboundfreight | Float | Cost of outbound freight |
| qst | Float | QST (Quebec Sales Tax) amount |
| retailer_id | Integer | Retailer identifier |
| retailer_statements | Null/Array | Retailer statement reference (if applicable) |
| rma | Integer | Return Merchandise Authorization number |
| total | Float | Total deduction amount |
| total_retail | Float | Total retail value of the returned items |
| tracking | String | Tracking number |
| tracking_code | String | Carrier code or tracking service provider |
| tracking_date | String | Date when tracking info was updated |
| weight | Float | Total shipment weight |
| wid | Integer | Warehouse or return location ID |
| items.description | String | Description of the returned item (one per line item) |
| items.extc | Float | Extended cost (unit cost × quantity) |
| items.extr | Float | Extended retail price |
| items.item | Integer | Unique item ID |
| items.line_id | Integer | Line number in the return/deduction transaction |
| items.nc | Float | Net cost per unit |
| items.original_extended_cost | Float | Original cost before return |
| items.original_qty | Integer | Originally sold quantity |
| items.stockid | Integer | Stock identifier (same as item) |
| items.units | Integer | Number of units returned (usually negative) |
Events
Purpose: The Zenshows Events API provides a chronological stream of key activities and operational changes across shows, orders, inventory, returns, and logistics. It allows businesses to track real-time updates—such as order status changes, deductions, product movements, or warehouse events—enabling timely decision-making, improved visibility, and automated downstream workflows across the Zenshows platform.
Source API Documentation:
Replication Type: Key Based
Fields
| Field Name | Data Type | Description |
|---|---|---|
| created_date | Date | Timestamp when the show entry was created |
| end_date | Date | End date of the show |
| nickname | String | Optional internal label or nickname for the show |
| region_name | String | Name of the sales region (e.g., Los Angeles) |
| retailer_id | Integer | Retailer identifier |
| retailer_name | String | Name of the retailer associated with the show |
| show_id | Integer | Unique identifier for the show |
| start_date | Date | Start date of the show |
| status | Integer | Status code of the show (e.g., scheduled, completed) |
| track_id | Integer | Identifier for the track/category of the show |
| track_name | String | Name of the track/category (e.g., "UNASSIGNED") |
| updated_date | DateTime | Last updated timestamp for the show entry |
| vendor_id | Integer | Identifier of the vendor participating in the show |
| warehouse_city | String | City where the show-related warehouse is located |
| warehouse_locname | String | Name of the warehouse or location |
| wid | Integer | Warehouse or location ID |
