Shift logo

Supplier resources ›

WooCommerce

On this page

The Shift WooCommerce plugin allows you to offer customers Shift in your WooCommerce store. You need to be a Shift customer to enable the plugin for your eCommerce platform.

Prerequisites

WordPress Version

The WordPress version must be 5.8.0 or greater to integrate with Shift.

WooCommerce Version

The WooCommerce version must be 5.9 or greater to integrate with Shift.

Currency

Shift supports Australian Dollar only.

Access credentials

Please contact your Shift Account Manager or Partnership Manager to discuss your eCommerce requirements and access the plugins, and API Test and Live credentials.

Installation steps

  1. Download the .zip file received from Shift
  2. The WordPress admin panel will open. Go to Plugins
  3. Click Add New
  4. Upload the .zip file as per the instructions on the screen
  5. When successful installation is confirmed, activate the plugin
  6. Configure settings

Configuration

  1. Navigate to WooCommerce tab on the left side menu
  2. Select > Settings
  3. Select > Payments
  4. Scroll down to the Shift option
  5. Select > Manage
  6. Add the Shift credential fields (Contact your Shift Account Manager or Partnership Manager for your API keys and add to the Shift credential fields)
Name
Description
Enable/Disable
Enables or disables the plugin on the merchant store.
API Key

The API Key that will be used to call the Shift API.

This will be generated by Shift and will be provided by your Shift Account Manager or Partnership Manager.

Merchant ABN
The Australian Business Number of the merchant.
Test Mode
Enables whether the plugin will be used for testing or production environment.
Checkout Method
Controls whether the plugin will use the widget or redirect for the checkout confirmation experience.
Product Code

The Shift Product Code to be used for checkouts. The following products are predefined in the plugin:

  • Equipment Line
  • Shift Trade
Webhook Secret

The secret that will be used for verifying the webhook event signature.

Webhook Timestamp
Tolerance

Use this value for tolerance validation in seconds. Default to 180 seconds.

Send Exception
Logs to Shift
Sends exception logs to Shift email automatically when an error has occurred with the payment.

How to determine the Webhook URL of the Shift Plugin

  1. To determine the webhook URL of the plugin, you need to know the base store URL. You can find the base URL by navigating to Magento Admin Dashboard > Stores > Configuration > General > Web > Base URLs.
  2. Once you know the base store URL, you can append /wp-json/gateway/v1/shift-callback/confirm
Examples:
Store URL
Webhook URL
https://shift-wp-sandbox.azurewebsites.net
https://shift-wp-sandbox.azurewebsites.net/wp-json/gateway/v1/shift-callback/confirm
https://abc.com/my-store
https://abc.com/my-store/V1/shift-callback/confirm

Configuration Credentials

Don't have your configuration details yet? Please contact your Shift Account Manager or Partnership Manager. Shift will require your Test environment URL and the details of the individuals (name, email, mobile phone) who will be accessing both Test and Production environments.
Shift will then provide the following Test credentials:
  • Test API keys,
  • Test login instructions.

Go live

Once tests have been run in Test mode to trial the API keys and the test results are successful, then Shift will provide the Live configuration credentials.

Switch to Live mode.
Start offering Shift to your customers.

chevron-down