ModularMerchant
Knowledge Base
Shopping Cart Software Online Manual
ship_method DB Table
review_vote DB table ship_method_zone DB Table
Location Home > Developer's Guide > Database Structure

ship_method DB Table

this article last updated: July 1, 2009
Due to inevitable changes that will be made to the shopping cart software over time, the cart's variable and database structure may change from time to time without advanced notice. We will attempt to keep the information in this article up-to-date, but Modular Merchant makes no guarantee as to the accuracy of the information provided in this article. Use this information at your own risk.

This article outlines the database structure for the MMv4 ship_method database table. This table contains the default ship methods plus any custom ship methods that have been created.

  • id
    Primary Key of the table.
    int(10) | unsigned | auto increment | primary key | indexed
  • active
    If set to a value greater than zero, then the ship rate is inactive. Inactive ship rates are not displayed in the storefront.
    int(10) | unsigned | Values: 0/timestamp | Default: 1 | indexed
  • name
    This is the name of the shipping method that will be displayed in the storefront.
    varchar(255)

  • display_order
    Determines the order in which this shipping method is displayed in lists in relation to other shipping methods.
    int(10) | unsigned | indexed
  • type
    The provider of the shipping method. Examples include: FedEx, UPS, USPS, custom.
    varchar(255) | default: custom | indexed
  • remote
    Whether or not this
    shipping method is returned from a third-party service provider's server.
    char(1) | values: N,Y | default: N
  • code
    The ID code of the
    shipping method submitted to the third-party service provider to retrieve the rate information. Not used for custom rates.
    varchar(255)
  • surcharge
    The value entered in this field will be applied to the rate returned from the third-party service provider.
    double(16,2) | default: 0.00
  • surcharge_type
    Determines whether the surcharge is a dollar value or a percentage.
    char(1) | values: D,P | default: D
  • surcharge_calc
    If the surcharge is a percentage, this determines what the percentage is based on.
    char(1) | values: V,Q,W | default: V
  • max_value
    The maximum dollar value of the shipping method.
    double(16,2) | default: 0.00
  • min_value
    The minimum dollar value of the shipping method.
    double(16,2) | default: 0.00
  • base_value
    The value in this field will be added to the calculated value of the
    shipping method.
    double(16,2) | default: 0.00
  • base_type
    Determines whether the base value is a dollar value or a percentage.
    char(1) | values: D,P | default: D
  • base_calc
    If the base value is a percentage, this determines what the percentage is based on.
    char(1) | values: V,Q,W | default: V
  • free_quota
    The threshold at which the ship rate becomes free.
    double(16,2) | default: 0.00
  • free_calc
    Determines whether the free_quota is based on the order's product quantity, dollar value or weight.
    char(1) | values: V,Q,W | default: Q
  • item_value
    The value entered in this field is added to the
    shipping method once for every X products in the order.
    double(16,2) | default: 0.00
  • item_type
    Determines whether the item_value is a dollar value or percentage of the order's value.
    char(1) | values: D,P | default: D
  • item_calc
    Determines whether the item_value is based on the order's product quantity, dollar value or weight.
    char(1) | values: V,Q,W | default: Q
  • item_quota
    The item_value is applied to the ship rate once for the value of this field. Example, entering "3" in this field would apply the item_value to the ship rate once for every three products in the order.
    int(10) | unsigned | default: 0
  • use_zones
    Determines whether the
    shipping method is restricted to customers in the specified zip codes, states or countries.
    char(1) | values: N,Y | default: N
  • and_or
    Determines whether all or any of shipping method's zones must match the customer's geographic location.
    For example, if a ship rate uses the zones California and United States, setting it to "and" would only apply it to customers with California selected as their state and United States selected as their country. If set to "or", then it would be applied to customers with either California selected as their state or United States selected as their country.
    char(1) | values: O,A | default: O
  • lo_limit_value
    The low threshold at which the
    shipping method is no longer available in the storefront.
    double(16,2) | default: 0.00
  • lo_limit_calc
    Determines whether the lo_limit_value is based on the order's product quantity, dollar value or weight.
    char(1) | values: V,Q,W | default: W
  • hi_limit_value
    The high threshold at which the shipping method is no longer available in the storefront.
    double(16,2) | default: 0.00
  • hi_limit_calc
    Determines whether the hi_limit_value is based on the order's product quantity, dollar value or weight.
    char(1) | values: V,Q,W | default: W

 



— Last Edited - 07/1/2009 3:52pm PDT
Rank and add a comment to this article
Only logged in users may leave comments and rank articles. Log in to have your say!
  Knowledge Base Home

  QuickCode™ Tag Glossary

  Modular Merchant.com Homepage

Not Logged in.
Either Log in or create a User Account.

Other articles in this category...

account_activity DB Table

admin DB Table

admin_attr DB Table

admin_attr_data DB Table

admin_attr_node DB Table

admin_password DB Table

aff_commission DB Ttable

aff_default_target_url DB Table

aff_payment DB Table

aff_tid DB Table

aff_traffic DB table

ban_list DB Table

basket DB Table

basket_field_data DB table

category DB Table

category_attr DB Table

category_attr_assoc DB table

category_attr_data DB Table

category_attr_node DB Table

checkout_field DB table

checkout_field_node

customer DB Table

customer_attr DB Table

customer_attr_assoc DB table

customer_attr_data DB Table

customer_attr_node DB Table

customer_field DB Table

customer_field_data DB Table

customer_field_node DB Table

customer_group DB Table

customer_group_assoc DB table

customer_group_rule DB Table

customer_group_rule_node DB table

customer_ip DB Table

customer_pay_method DB Table

customer_ship_addr DB Table

custom_page DB Table

custom_quickcode DB Table

dec_orders DB table

dec_order_event_assoc DB table

dec_order_field_data DB table

dec_order_gateway_assoc DB table

dec_order_item DB table

dec_order_item_field_data DB table

dec_order_pay_method DB table

dec_order_shipment DB table

dec_order_tax_assoc DB table

dec_order_zone_fee_assoc DB table

digdel_fileserver DB table

digdel_ip DB Table

digdel_object DB table

digdel_object_zone DB table

digdel_order_item DB Table

dropship DB Table

dropship_report_hour_assoc DB Table

dropship_ship_method_assoc DB Table

em_attachment DB Table

em_history DB Table

em_link DB table

em_queue DB table

em_queue DB table

em_series DB table

em_series_step DB table

em_template DB table

event_ignore DB table

event_info DB table

event_tr DB table

event_tr_slot DB table

gift_cert DB table

inventory_object DB table

iptocountry DB Table

note DB table

orders DB Table

order_event_assoc DB Table

order_field DB Table

order_field_data DB table

order_field_node DB Table

order_gateway_assoc DB table

order_item DB Table

order_item_field_data DB table

order_item_report DB Table

order_item_royalty_assoc DB table

order_item_status DB Table

order_item_tracking_assoc DB Table

order_pay_method DB table

order_shipment DB Table

order_tax_assoc DB Table

order_zone_fee_assoc DB Table

ospg_orders DB table

ospg_order_event_assoc DB table

ospg_order_field_data DB table

ospg_order_gateway_assoc DB table

ospg_order_item DB table

ospg_order_item_field_data DB table

ospg_order_item_royalty_assoc DB

ospg_order_pay_method DB table

ospg_order_shipment DB table

ospg_order_tax_assoc DB table

ospg_order_zone_fee_assoc DB table

product DB Table

product_add_ship_assoc DB Table

product_attr DB Table

product_attr_assoc DB table

product_attr_data DB Table

product_attr_node DB Table

product_category_assoc DB Table

product_com_val DB Table

product_digobj_assoc DB Table

product_field DB Table

product_field_assoc DB Table

product_field_data DB Table

product_field_node DB Table

product_fulfillment_assoc DB Table

product_group DB Table

product_group_assoc DB Table

product_image DB Table

product_instance DB Table

product_royalty DB Table

product_ship_method_assoc DB Table

product_status DB Table

product_stock_assoc DB Table

product_vendor_assoc DB Table

product_zone_fee_assoc DB Table

ptcs DB Table

ptcs_item DB table

ptcs_item_use DB table

review DB table

review_ceriteria DB table

review_rank DB table

review_vote DB table

ship_method DB Table

ship_method_zone DB Table

ship_status DB Table

stock_level DB Table

subscription DB Table

subscription_item DB Table

system_settings DB Table

sys_email_us_english DB Table

sys_message_us_english

tax DB Table

tax_zone DB Table

tracking_id DB Table

vendor DB Table

vendor_attr DB Table

vendor_attr_data DB Table

vendor_attr_node DB Table

zone_fee DB Table

zone_fee_zone DB Table