BigCommerce Bulky Freight Ship Table

Bulky Freight Ship Table by MyIntegrator

This document outlines all of the information needed for the setup and usage of the BigCommerce Bulky Freight Ship Table.

Please visit our app page to install and use this app on your BigCommerce store.

Installation

This add-on is a one-click install. If you need help to style the app to your business needs, contact us for a quote.

General Settings

  • Store Hash
    • This is a technical field, used by us (MyIntegrator) to help identify your store should you need support.
  • Bulky Custom Field
    • This section is used as a way to identify what item is considered a bulky item. On default, it is set to “Bulky Item”, and you can change it to any other name you desire. The application will get a product’s variant metadata, if it is not found then it will go to product’s custom fields, find out whether the custom variant metadata / custom field name (“Bulky Item” by default) exists and then verify if it’s bulky when the value of the custom field is equal to “Yes”, if it is then it is a bulky item.
  • Bulky Shipping Method Name
    • This section is used to override the shipping method name that you want to display on your site for our application. This is shown when user’s tries to find out the shipping rate of their shopping cart. You can change it into any name you want for your store.
  • Always Return Quote
    • This setting is used if you want this application to be your default shipping carrier. When this option is enabled, then this app will guarantee a return of a quote even when there is no bulky item inside the cart. This is done by taking the Bulky Shipping Cost (either from the General Settings or from the Bulk Ranges setting) and then returning that as the shipping cost for customer when there are no bulky item inside. You can easily disable this if you want the option to only return a shipping method when there’s a bulky item inside a cart.
  • Bulky Item Fee
    • This section is used as a default setting for the “Bulky Item Fee”, which is used to calculate how much extra shipping cost is required for bulky item (Set default to 15). It is only used when cart total does not fit in any Bulk Ranges which you could find in the “Bulk Ranges Setting”. (Ex: 5 bulky items means there’s an additional 75 cost added to shipping (5 x 15))
  • Bulky Shipping Cost
    • This section is used as a default setting for the “Bulky Shipping Cost”, which is used to calculate how much is the base shipping cost required when at least one bulky item exists in cart (Set default to 30). It is only used when cart total does not fit in any Bulk Ranges which you could find in the “Bulk Ranges Setting”.

Do note that the ‘SKU Bulk CSV’ takes priority over ‘Bulky Custom Field’ for identifying a product as bulky or not. For example, if a product with an SKU of SKU-GR has a custom field ‘Bulky Item’ set to Yes, but in the ‘SKU Bulk CSV’ SKU-GR is not considered as a bulky item (from the is_bulk_item column), then our application will tag the product as a non-bulky item.

SKU CSV Setting

Import SKU for Bulky Items

In order to import SKU for which item is considered to be bulky item, you must upload a CSV file in the corresponding format.

Export SKU for Bulky Item

An export of all your SKU Bulky Item data can easily be created by clicking its corresponding button.

This is useful for cross checking data sent to our side, or backups.

Maintenance

Additionally, you can delete all SKU for Bulky Items. This does not delete any of your BigCommerce products. This simply removes the SKU Bulky Item list (that you imported) from our secure hosted server.

Do note that the ‘SKU Bulk CSV’ takes priority over ‘Bulky Custom Field’ for identifying a product as bulky or not. For example, if a product with an SKU of SKU-GR has a custom field ‘Bulky Item’ set to Yes, but in the ‘SKU Bulk CSV’ SKU-GR is not considered as a bulky item (from the is_bulk_item column), then our application will tag the product as a non-bulky item.

Bulk Range Settings

  • Table
    • The table allows you to see, create new bulk ranges and edit or delete existing bulk ranges. It will automatically update the table once you have set the change and you will see the notification of those changes.
  • Cart From
    • “Cart From” is the “start” range of the cart total, it is used in combination with “Cart To” value
  • Cart To
    • “Cart To” is the “end” range of the cart total, it is used in combination with “Cart From” value. With the two values, when a cart total has a value higher than “Cart From” and lower than “Cart To” then the “Shipping Cost” and “Bulk Item Fee” will be used to calculate the total shipping cost.
  • Shipping Cost
    • “Shipping Cost” is the base shipping cost when at least one bulky item is in the cart.
  • Bulk Item Fee
    • “Bulk Item Fee” is the additional shipping cost required for bulky item, calculated by number of bulky item in a cart.
  • Examples
    • When a customer has three bulky items with a cart total of 600$, and we also have set our bulk range to have a “Cart To” of 400$ and “Cart From” of 800$, with “Shipping Cost” at 30$ and “Bulk Item Fee” at 40$, here’s how it is calculated:It is in range of 400$ and 800$, therefore it will use the “Shipping Cost” and “Bulk Item Fee” values to calculate shipping cost.
      In total, the shipping cost will come to 150$: 30$ (“Shipping Cost”) + 3 (Number of bulky items) x 40$ (“Bulk Item Fee”)

Bulk Range Example

Once the add-on has been successfully initiated, there will be a new shipping method in your store’s shipping zone. Please ensure to enable this as it will allow our app to return shipping rates to customers.

Then please make sure to adjust your settings on our application (for example, you set up a default shipping price of 30$ and a default bulky item fee of 15$), this will then be considered in our application’s shipping rate.

In our application, there’s three ways to identify an item as a bulky item, which are (ordered by priority): SKU (‘Products Setting’), Product Custom Variant Metadata, Product Custom Field. The priority means that if on our database, an item’s SKU is considered a non-bulky item, then even if product custom variant metadata and product custom field indicates it as a bulky item, then it will still be considered as a non-bulky item.

To set prices, there are two ways to do so, one is by a specific range (‘Bulk Ranges Setting’) and by default (‘General Setting’), do note that Bulk Range settings takes priority over the default when a cart’s total is inside the range of one of the Bulk Range.

To put it into an example, if you have set:
General Setting: Bulky Item Fee: 15$, Bulky Shipping Cost: 20$
Bulk Range Setting: Cart From: 0$, Cart To: 3000$, Shipping Cost: 100$, Bulk Item Fee: 55$
Product is inside our SKU database as a bulky item and have a price of 700$, and user is purchasing 3 of the product (with 2100$ of cart total)

Then the total calculation will be 265$ (before tax), which is calculated like so:
Cart Total is between 0$ and 3000$, so it is in the bulk range, therefore shipping cost is 100$ with a bulk fee per item 55$
and since SKU in the application considers the item as a bulky item, then it is calculated: 100$ + (55$ * 3) = 265$

Advanced Settings

  • Disable App Completely
    • Self explanatory, disables the whole app. Useful when debugging issues to your store website.
  • Script Version
    • This is by default will always be set to the latest version. Changing the script version may have effects on the behaviour of the app, so it is best kept to the latest.
  • Restrict App To IP Address
    • You can restrict the app to only show for particular IP Addresses. This is useful when preparing to go live.
  • Store API Token Secret
    • This should be kept in secret. Required when communicating with our API.

Subscription

All prices are in U.S. dollars.

The first time you place your card details will establish the authorisation. There is a fixed fee that is charged monthly in order for you to use the add-on.

API

Preliminaries

Our API endpoint is https://bc-bulkyship.myintegrator.com.au/api/store/{store_code}

 There are no limitations as of now. It can take some time to push thousands of products.

Operations

Bulk Upsert (Insert or Update)

POST https://bc-bulkyship.myintegrator.com.au/api/store/{store_code}/skuBulks/bulk

Example Request:

Body

{
    "skuBulks": [
        {
            "sku": "TEST-123",
            "is_bulk_item": 1
        },
        {
            "sku": "TEST-456",
            "is_bulk_item": 1
        },
        {
            "sku": "TEST-789",
            "is_bulk_item": 0
        },
    ]
}

Response

{
    "data": {
        "records_affected": 3
    },
    "errors": {
        "skuBulks": []
    }
}

Bulk Delete

DELETE https://bc-bulkyship.myintegrator.com.au/api/store/{store_code}/skuBulks/bulk

Will delete all the SKU for bulky item data. Same behaviour as “Purge SKU Bulk Data” in the SKU CSV Settings tab.

Response

{
    "data": [],
    "message": "",
    "success": true
}

Support

Please send an email to [email protected] or call us on +61 (0) 3 9005 0823.