sources:
- name: chord_chordoms
tables:
- name: orders
identifier: orders
description: "Each row represents an order from Chord OMS."
columns:
- name: id
description: "Unique key generated by Chord OMS that identifies an order."
- name: store_id
description: "ID of the store associated with this order."
- name: user_id
description: "ID of the user (customer) who placed the order."
- name: bill_address_id
description: "Unique key generated by Chord OMS that identifies a billing address."
- name: ship_address_id
description: "Unique key generated by Chord OMS that identifies a shipping address."
- name: subscription_id
description: "Unique key generated by ChordOMS that identifies a subscription."
- name: number
description: "Unique order number displayed to users."
- name: item_total
description: "Total cost of items before charges."
- name: total
description: "Total cost of the order."
- name: state
description: "Current state of the order."
- name: adjustment_total
description: "Total of all adjustments."
- name: completed_at
description: "Timestamp when the order was completed."
- name: payment_total
description: "Total amount paid."
- name: payment_state
description: "Current payment state of the order."
- name: shipment_state
description: "Current shipment state of the order."
- name: email
description: "Email address of the customer."
- name: currency
description: "Currency used in the order."
- name: shipment_total
description: "The sum of all the shipments associated with this order."
- name: additional_tax_total
description: "The sum of all the additional tax totals (sales tax) from this order's line items and shipments."
- name: promo_total
description: "The sum of all of the promo totals from this order's shipments, line items, and promotions."
- name: channel
description: "The channel from which the order is created. For example, if the order is created as a result of an active subscription, it will contain the value 'subscriptions'."
- name: created_at
description: "Timestamp when the order was created."
- name: updated_at
description: "Timestamp when the order was last updated."
- name: products
identifier: products
description: "Each row represents a product available in a store."
columns:
- name: id
description: "Unique product ID."
- name: store_id
description: "Unique key generated by ChordOMS that identifies a store."
- name: name
description: "Name of the product."
- name: description
description: "Product description."
- name: slug
description: "URL-friendly identifier."
- name: available_on
description: "Timestamp when the product becomes available."
- name: meta_title
description: "Meta SEO title."
- name: promotionable
description: "Is promotion applicable."
- name: sample
description: "Is a sample product."
- name: bundle
description: "Is a bundled product."
- name: created_at
description: "Creation timestamp."
- name: updated_at
description: "Last update timestamp."
- name: variants
identifier: variants
description: "Each row represents a product variant."
columns:
- name: id
description: "Variant ID."
- name: product_id
description: "Associated product ID."
- name: sku
description: "Stock keeping unit."
- name: price
description: "Variant price."
- name: weight
description: "Weight of variant."
- name: height
description: "Height of variant."
- name: width
description: "Width of variant."
- name: depth
description: "Depth of variant."
- name: cost_currency
description: "Currency of cost."
- name: cost_price
description: "Cost price."
- name: track_inventory
description: "Tracks inventory?"
- name: is_master
description: "Is master variant?"
- name: subscribable
description: "Is subscribable?"
- name: created_at
description: "Creation timestamp."
- name: updated_at
description: "Last update timestamp."
- name: users
identifier: users
description: "Each row represents a user."
columns:
- name: id
description: "User ID."
- name: name
description: "Full name of the user."
- name: email
description: "Email address."
- name: encrypted_password
description: "Encrypted password."
- name: reset_password_token
description: "Token for password reset."
- name: date_of_birth
description: "Date of birth."
- name: last_sign_in_ip
description: "Last login IP."
- name: deleted_at
description: "Timestamp at which the user's account was deleted."
- name: created_at
description: "Timestamp at which the users row was created."
- name: updated_at
description: "Timestamp at which the users row was last updated."
- name: payments
identifier: payments
description: "Each row represents a payment."
columns:
- name: id
description: "Payment ID."
- name: order_id
description: "Associated order."
- name: amount
description: "Amount paid."
- name: state
description: "Payment state."
- name: created_at
description: "Created at."
- name: updated_at
description: "Updated at."
- name: addresses
identifier: addresses
description: "Each row represents a billing or shipping address."
columns:
- name: id
description: "Unique key generated by Chord OMS that identifies an address."
- name: firstname
description: "First name of the customer."
- name: lastname
description: "Last name of the customer."
- name: address1
description: "Primary address field."
- name: address2
description: "Secondary address field."
- name: city
description: "City for the address."
- name: zipcode
description: "Postal code."
- name: phone
description: "Phone number."
- name: state_id
description: "The ID for the State associated with the customer's address."
- name: country_id
description: "The ID for the Country associated with the customer's address."
- name: company
description: "Company name."
- name: created_at
description: "Timestamp at which the address row was created."
- name: updated_at
description: "Timestamp at which the address row was updated."
- name: line_items
identifier: line_items
description: "Each row represents an item purchased in an order."
columns:
- name: id
description: "Unique ID for the line item."
- name: order_id
description: "ID of the associated order."
- name: variant_id
description: "ID of the variant being purchased."
- name: quantity
description: "Number of units of the variant ordered."
- name: price
description: "Price per unit of the variant."
- name: adjustment_total
description: "The sum of all adjustment for this line item."
- name: additional_tax_total
description: "The sum of all the additional tax totals (sales tax) from this line item."
- name: included_tax_total
description: "The sum of all the included tax totals (value-added tax) from this line item."
- name: promo_total
description: "The sum of all of the promo totals from this line item."
- name: created_at
description: "Timestamp when the line item was created."
- name: updated_at
description: "Timestamp when the line item was last updated."
- name: shipments
identifier: shipments
description: "Each row represents a shipment associated with an order."
columns:
- name: id
description: "Unique ID for the shipment."
- name: order_id
description: "ID of the order associated with this shipment."
- name: number
description: "Shipment number."
- name: cost
description: "Cost of the shipment."
- name: shipped_at
description: "Timestamp when the shipment was shipped."
- name: tracking
description: "Tracking number for the shipment."
- name: created_at
description: "Timestamp when the shipment was created."
- name: updated_at
description: "Timestamp when the shipment was last updated."
- name: subscriptions
identifier: subscriptions
description: "Each row represents a subscription record."
columns:
- name: id
description: "Unique ID for the subscription."
- name: user_id
description: "Unique key generated by Chord OMS that identifies a user."
- name: store_id
description: "Unique key generated by Chord OMS that identifies a store."
- name: billing_address_id
description: "Unique key generated by ChordOMS that identifies a billing address."
- name: shipping_address_id
description: "Unique key generated by ChordOMS that identifies a shipping address."
- name: payment_source_id
description: "Unique key generated by ChordOMS that identifies a payment source."
- name: payment_method_id
description: "Unique key generated by ChordOMS that identifies a payment method."
- name: guest_token
description: "Field that identifies a guest token."
- name: status
description: "Current status of the subscription."
- name: interval_length
description: "The interval's length of the subscription. Needs to be in the context of the interval_units field to get the complete picture of the subscription length."
- name: interval_units
description: "The unit that represents the interval length of the subscription."
- name: payment_source_type
description: "The current payment source type of the subscription."
- name: currency
description: "The currency for this subscription."
- name: notes
description: "The notes for this subscription."
- name: paused
description: "Whether this is a paused subscription or not."
- name: end_date
description: "Reflects when the subscription ended."
- name: created_at
description: "When the subscription was created."
- name: updated_at
description: "When the subscription was last updated."
- name: refunds
identifier: refunds
description: "Each row represents a refund issued to a customer."
columns:
- name: id
description: "Refund ID."
- name: payment_id
description: "Associated payment ID."
- name: amount
description: "Amount refunded."
- name: created_at
description: "When refund was created."
- name: updated_at
description: "When refund was last updated."
- name: return_items
identifier: return_items
description: "Each row represents an item returned by a customer."
columns:
- name: id
description: "Return item ID."
- name: inventory_unit_id
description: "Associated inventory unit."
- name: reimbursement_id
description: "Associated reimbursement."
- name: acceptance_status
description: "Status of the return."
- name: created_at
description: "Created timestamp."
- name: updated_at
description: "Updated timestamp."
- name: inventory_units
identifier: inventory_units
description: "Each row represents a unique inventory instance tied to a variant."
columns:
- name: id
description: "Inventory unit ID."
- name: order_id
description: "Associated order ID."
- name: variant_id
description: "Associated variant."
- name: shipment_id
description: "Associated shipment."
- name: state
description: "Inventory state (e.g., on_hand, backordered)."
- name: created_at
description: "Created timestamp."
- name: updated_at
description: "Updated timestamp."
- name: cartons
identifier: cartons
description: "Each row represents a physical shipping carton."
columns:
- name: id
description: "Carton ID."
- name: shipment_id
description: "Linked shipment ID."
- name: tracking
description: "Tracking number."
- name: weight
description: "Weight of carton."
- name: created_at
description: "Creation time."
- name: updated_at
description: "Last update time."
- name: stock_items
identifier: stock_items
description: "Each row represents a stockable item in a location."
columns:
- name: id
description: "Stock item ID."
- name: stock_location_id
description: "ID of the stock location."
- name: variant_id
description: "ID of the variant."
- name: count_on_hand
description: "Current available quantity."
- name: backorderable
description: "Whether item can be backordered."
- name: created_at
description: "Timestamp created."
- name: updated_at
description: "Timestamp updated."
- name: stock_requests
identifier: stock_requests
description: "Each row represents a request to stock or restock an item."
columns:
- name: id
description: "Stock request ID."
- name: variant_id
description: "Requested variant."
- name: quantity
description: "Quantity requested."
- name: state
description: "Current state of request."
- name: created_at
description: "Created timestamp."
- name: updated_at
description: "Updated timestamp."
- name: promotion_codes
identifier: promotion_codes
description: "Each row represents a unique promotion code."
columns:
- name: id
description: "Promotion code ID."
- name: promotion_id
description: "Associated promotion."
- name: value
description: "Code value."
- name: created_at
description: "Created at."
- name: updated_at
description: "Updated at."
- name: tags
identifier: tags
description: "Each row represents a tag for grouping data."
columns:
- name: id
description: "Tag ID."
- name: name
description: "Tag name."
- name: taggings_count
description: "Number of taggings."
- name: created_at
description: "Timestamp created."
- name: updated_at
description: "Timestamp updated."
- name: promotion_actions
identifier: promotion_actions
description: "Each row represents an action executed by a promotion."
columns:
- name: id
description: "Action ID."
- name: promotion_id
description: "Linked promotion ID."
- name: type
description: "Action type."
- name: position
description: "Position for ordering."
- name: created_at
description: "Creation timestamp."
- name: updated_at
description: "Last update timestamp."
- name: stores
identifier: stores
description: "Each row represents a store in the platform."
columns:
- name: id
description: "Store ID."
- name: name
description: "Name of the store."
- name: url
description: "Store URL."
- name: code
description: "Unique store code."
- name: mail_from_address
description: "Email address used in communications."
- name: created_at
description: "Created timestamp."
- name: updated_at
description: "Updated timestamp."
- name: states
identifier: states
description: "Each row represents a state or province."
columns:
- name: id
description: "State ID."
- name: name
description: "State name."
- name: abbr
description: "State abbreviation."
- name: country_id
description: "Linked country ID."
- name: created_at
description: "Created at."
- name: updated_at
description: "Updated at."
- name: countries
identifier: countries
description: "Each row represents a country."
columns:
- name: id
description: "Country ID."
- name: name
description: "Country name."
- name: iso
description: "ISO 2-letter code."
- name: iso3
description: "ISO 3-letter code."
- name: numcode
description: "Numeric country code."
- name: created_at
description: "Timestamp of creation."
- name: updated_at
description: "Timestamp of last update."
- name: promotion_categories
identifier: promotion_categories
description: "Each row represents a category for promotions."
columns:
- name: id
description: "Promotion category ID."
- name: name
description: "Category name."
- name: created_at
description: "Timestamp when created."
- name: updated_at
description: "Timestamp when updated."
- name: option_types
identifier: option_types
description: "Each row represents an option type for product variants."
columns:
- name: id
description: "Option type ID."
- name: name
description: "Name of the option type."
- name: presentation
description: "Label shown to users."
- name: created_at
description: "Timestamp created."
- name: updated_at
description: "Timestamp updated."
- name: option_values_variants
identifier: option_values_variants
description: "Join table between option values and variants."
columns:
- name: id
description: "Join ID."
- name: variant_id
description: "Associated variant."
- name: option_value_id
description: "Associated option value."
- name: created_at
description: "Created at."
- name: updated_at
description: "Updated at."
- name: taggings
identifier: taggings
description: "Each row represents a tagging linking a tag to a record."
columns:
- name: id
description: "Tagging ID."
- name: tag_id
description: "Associated tag."
- name: taggable_type
description: "Type of tagged record."
- name: taggable_id
description: "ID of tagged record."
- name: context
description: "Tagging context."
- name: created_at
description: "Created at."
- name: updated_at
description: "Updated at."
- name: promotion_rule_users
identifier: promotion_rule_users
description: "Each row links a promotion rule to a user."
columns:
- name: id
description: "Rule-user join ID."
- name: promotion_rule_id
description: "Associated rule."
- name: user_id
description: "Associated user."
- name: created_at
description: "Timestamp created."
- name: updated_at
description: "Timestamp updated."
- name: store_credits
identifier: store_credits
description: "Each row represents a store credit entry."
columns:
- name: id
description: "Store credit ID."
- name: user_id
description: "Associated user."
- name: amount
description: "Current credit amount."
- name: amount_used
description: "How much has been used."
- name: category_id
description: "Which category the credit belongs to."
- name: created_at
description: "When credit was created."
- name: updated_at
description: "When credit was last updated."
- name: store_credit_categories
identifier: store_credit_categories
description: "Each row represents a store credit category."
columns:
- name: id
description: "Category ID."
- name: name
description: "Name of this category."
- name: created_at
description: "When created."
- name: updated_at
description: "When updated."
- name: reimbursements
identifier: reimbursements
description: "Each row represents a reimbursement record."
columns:
- name: id
description: "Reimbursement ID."
- name: order_id
description: "Associated order."
- name: created_at
description: "When reimbursement was created."
- name: updated_at
description: "When reimbursement was last updated."
- name: reimbursement_types
identifier: reimbursement_types
description: "Each row represents a type of reimbursement."
columns:
- name: id
description: "Reimbursement type ID."
- name: name
description: "Type name."
- name: active
description: "Whether it’s active."
- name: created_at
description: "When created."
- name: updated_at
description: "When updated."
- name: promotions
identifier: promotions
description: "Each row represents a promotion."
columns:
- name: id
description: "Promotion ID."
- name: name
description: "Name of promotion."
- name: description
description: "Promotion description."
- name: starts_at
description: "When promotion starts."
- name: expires_at
description: "When promotion ends."
- name: created_at
description: "When created."
- name: updated_at
description: "When updated."
- name: promotion_rules
identifier: promotion_rules
description: "Each row represents a rule belonging to a promotion."
columns:
- name: id
description: "Promotion rule ID."
- name: promotion_id
description: "Associated promotion."
- name: type
description: "Rule type."
- name: created_at
description: "Created at."
- name: updated_at
description: "Updated at."
- name: adjustments
identifier: adjustments
description: "Each row represents an adjustment, such as shipping or promotional."
columns:
- name: id
description: "Adjustment ID."
- name: adjustable_id
description: "ID of the adjustable entity (order, line item, etc.)."
- name: adjustable_type
description: "Type of the adjustable entity."
- name: label
description: "Label for this adjustment."
- name: amount
description: "Adjustment amount."
- name: eligible
description: "If the adjustment is currently eligible."
- name: created_at
description: "Created at."
- name: updated_at
description: "Updated at."
- name: orders_promotions
identifier: orders_promotions
description: "Each row associates a promotion with an order."
columns:
- name: id
description: "Row ID."
- name: order_id
description: "Associated order."
- name: promotion_id
description: "Associated promotion."
- name: promotion_code_id
description: "Associated promotion code."
- name: created_at
description: "When created."
- name: updated_at
description: "When updated."