BigCommerce Multi Location Inventory

Multi Location Inventory by MyIntegrator

This document outlines all of the information needed for the setup and usage of the BigCommerce Product Availability Solution.

Installation

This add-on is a one-click install. However, depending on your BigCommerce store theme, you may need to style it accordingly. 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.
  • Enable Address Lookup
    • Assign a location based on a customer address if ‘Location Attribute’ value is empty. ‘Address Mapping’ must be filled in Locations Settings. Please see the Edit location section below.
  • Location Attribute Name
    • The customer attribute field name for location mapping.
  • Create Customer Attribute
    • Create ‘Customer Attribute’ with the entered name in the left column. The operation cannot be reverted.
  • Default Location
    • Used for customers not assigned any location value.

Customer attribute fields

Once the ‘Create Customer Attribute’ button is hit, you can see the ‘Location Attribute Name’ on the Customer Details page for each customer.

Here you can specify which ‘Location’ the customer is assigned to by the ‘Location Code’. See the Location section below.

Stock Availability Settings

  • Enable Inventory Control
    • Check and modify the shopping cart items’ quantities for the customer’s location to ensure a no-over ordering. For example, if the SKU A in the Location A has 10 stocks, but a customer who’s location is the Location A added 11 quantities of the SKU A to the cart, this function will adjust the cart item quantity for the SKU A to 10 instead of 11 to avoid over ordering. 
  • Out of Stock Threshold
    • The amount of inventory that is considered “out of stock”, for all products.
  • Out of Stock Label
    • The label to show if the amount of stock reaches the above “out of stock” threshold (default “Out Of Stock”).
  • Low Stock Threshold
    • The amount of inventory that is considered “low stock”, for all products.
  • Low Stock Label
    • The label to show if the amount of stock reaches the above “low stock” threshold (default “Low Stock, Contact Store”)
  • In Stock Label
    • The label to show if the product is in stock
  • Display Stock Quantity
    • Display stock quantity figures, instead of “in stock”, “low stock” or “out of stock”.
  • Hidden Products
    • Product SKU’s here will be considered unavailable to find in store (will not show the button to find in store).
  • Location Label
    • The label shown in the stock availability.

Stock Availability Samples

On the product page, the Stock Availability app is shown below the add to cart button. The customer’s location or default location is displayed with its stock availability.

Click ‘View more stores’ to open the detail modal window where the all locations’ stock availability and information.

Click & Collect Settings

  • Enable Click & Collect
    • Display the ‘Click & Collect’ feature on the checkout page.
  • Restrict to customer location
    • Display only the location where the customer is assigned to. Disable this to display the dropdown list which a customer can choose a pick up location from multiple choices.
  • Click & Collect Display Name
    • Enter the ‘Display name’ for the ‘Pickup In Store Options’ in the BigCommerce Store Shipping Setup. The Click & Collect app will be displayed on the shipping method.

Click & Collect Samples

On the checkout page, the ‘Click & Collect’ app is displayed under the Shipping Method.

When the ‘Restrict to customer location’ is on, the only one location is displayed where the customer is assigned to.

The dropdown list is displayed when the ‘Restrict to customer location’ is off. All locations are displayed, however, only locations where all cart item stocks are selectable.

The customer can see the Click & Collect location at the Thank you page and you can see the location on the order’s staff note.

Locations

Every single product must be linked to a location. This allows customers to see what locations have the product that they want, along with the location’ information.

  • Location Code
  • Location Name
    • Display name on the Stock Availability and Click & Collect apps.
  • Hidden
    • An option to hide/show the store, in case the store is closed or shut temporarily.

Edit location

You can edit the location information after inserting one by clicking the edit link to the side.

  • Location Address
    • Displayed on the Stock Availability and Click & Collect apps.
  • Location E-mail, Location Phone
    • For the location management purpose only.
  • Notes
    • Displayed below the Location Address on the Click & Collect app. Ideally used for a message or opening hours.
  • Address Mapping
    • The ‘Address Lookup’ must be enabled to use this function. See the General Settings section above.
    • This is used to match the location with the customer’s address information if there is no location code in the ‘Customer Attributes’.
    • The valid values are Postal code, City, State and Country.

Products

Import Products

In order to import products, you must upload a CSV file in the corresponding format.

Optionally, you can specify particular thresholds (no stock, low stock) for specific products in the 3rd and 4th field. These thresholds will override the global thresholds.

All products imported will insert OR update (if the SKU already exists). It may take up to a minute for several thousands of products.

Alternatively, you can import products using our API. See the API section below.

Export Products

An export of all your products 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 products. This does not delete your BigCommerce products. This simply removes the product inventory levels (that you imported) for the locations that are hosted on our secure servers.

Advanced

  • Disable App Completely
    • Self explanatory, disables the whole app. Useful when inventory preparing to go live or debugging issues to your store website.
  • Script Version
    • This 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 if you are preparing to go live.
  • Store API Token Secret
    • This should be kept in secret. Required when communicating with our API.
  • Custom Styling
    • You can insert CSS code here. Useful if you want to override default styling.
  • Custom Javascript
    • You can insert JS code here. Useful if you want to add google analytics tracking.

Subscription

All prices are in U.S. dollars. The app runs on a metered basis. The number of requests made will be charged against your account and automatically billed at the end of the month.

The first time you place your card details will establish the authorisation. There is no fixed fee.

You can track the usage and live in this section, and all your past invoices.

Pricing

Tiers

QUANTITY PRICE PER UNIT FLAT AMOUNT
If the total quantity is 1 to 75,000 US$0.00 US$200.00
If the total quantity is 75,001 to 199,999 US$0.0027 US$0.00
If the total quantity is 200,000 to 399,999 US$0.002 US$0.00
If the total quantity is 400,000 to 1,199,999 US$0.0015 US$0.00
If the total quantity is 1,200,000 or more US$0.001 US$0.00
  • Each unit is a request made to check the product availability of a product. 
  • At the end of each day, you are able to see how many requests are made.
  • Prices are as of 14 December 2020 and may be subject to change

API

Preliminaries

Our API endpoint is https://bc-wh.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-wh.myintegrator.com.au/api/store/{store_code}/products/bulk

Example Request:

Body

{
    "products": [
        {
            "sku": "ABC001",
            "stock": [
                {
                    "location_code": "MELBOURNE",
                    "quantity": 10
                },
                {
                    "location_code": "SYDNEY",
                    "quantity": 20
                }
            ]
        },
        {
            "sku": "BCE001",
            "stock": [
                {
                    "location_code": "TOKYO",
                    "quantity": 5
                }
            ]
        }
    ]
}

Response

{
    "data": {
        "records_affected": 1
    },
    "errors": {
        "products": [
            [
                "location_code.TOKYO not found"
            ]
        ]
    }
}

There are some additional fields for products that can be leveraged as below (although, optional to send across). 

  • “zero_threshold”  → the threshold in which the stock item is considered “Out of Stock” 
  • “low_threshold” (optional) → the threshold in which the stock item is considered “Low Stock, Contact Store”

Bulk Delete

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

Will delete all the product inventory data for all the products. Same behaviour has “Delete All Products” in the Products tab.

You can delete by specific location by specifying the store_code in the request.

Body

{
    "location_code": "PERTH"
}

Response

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

Support

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