| Table of Contents | ||
|---|---|---|
|
1. Installation
The OneStock connector is available on the Shopify marketplace. To install the OneStock connector, you need a Shopify Plus shop.
...
You’ll be redirected on your shop admin and asked to install the connector.
...
2. Configuration
...
page
The configuration of the connector is done directly on the shop admin page.
2.1. General API configuration
Go to your configuration page and fill the mandatory fields:
site id : your OneStock site id
host : should be either
production : https://api.onestock-retail.com
qualification : https://api-qualif.onestock-retail.com
training : https://api-qualiftraining.onestock-retail.com
other : if your OneStock instance is hosted elsewhere, your project manager will inform you of the value to be used.
user id and password : the api user credentials that have been created for the project.
Synchronize order : check if your project needs order synchronization
...
Once your credential saved, you will have access to more configurations and also to two admin pages : Synchronization and Carrier services.
...
2.2 Order synchronization
If checked, the connector will listen to all orders created in shopify Shopify to create them in OneStock.
It will also subscribe create a webhook to listen to 3 webhookstopics in OneStock:
order_state_changed
parcel_state_changed
line_item_group_state_changed
Those 3 webhooks let the connector update the order on Shopify when a line item is removed or when a parcel is dispatched.
Extra configurations
...
Rulesets Mapping (optional)
Map your Shopify delivery rate to a OneStock ruleset chaining you want your order to be orchestrated with.
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
For example, you can have a standard and express rate on Shopify that you will map to the same ruleset on OneStock for all home deliveries. But you’ll create an international delivery rate that will be orchestrated with another ruleset chaining |
Sales channel (optional)
A dropdown will reveal available sales channel configured in OneStock. This value will be used for order creation but also for the delivery promise calls.
...
| Info |
|---|
You can only configure one sales channel for a shop if you are synchronizing your orders with the connector. |
2.3. Stock configuration (optional)
SFTP Configuration
This is where you have to configure the sftp for stock export from OneStock to Shopify.
The values to enter will be specified by the owner of the SFTP that you are using.
| Info |
|---|
You should have the same configuration than the one set on OneStock |
Location & Stock request mapping (optional)
...
Values to input here will be given by your OneStock Project managercontact.
...
Timezone (optional)
This is to configure the timezone you are using for your scheduled stock imports
Rulesets Mapping (optional)
You’ll have to map each Shopify delivery rate to an existing ruleset chaining in OneStock if you are synchronizing your orders through the connector. This is useful if you have multiple ruleset chainings configured in OneStock.
...
2.4. Delivery promise
Delivery promises Mapping (optional)
...
If click and collect is selected, we will display a store selection in your checkout with all stores having click and collect enabled with the delivery promise response.
...
| Info |
|---|
If you want a dynamic rate (e.g. only available depending on the items on the basket or on the delivery address) you should create a rate from our Carrier service instead of using Shopify delivery rates. |
Default location for Delivery Promise (demo, don’t use)
The connector is shipped with a theme block to display every delivery promise configured on the delivery promise mapping. This block is used to call the delivery promise with the country and zip code inputted here when the theme block is activated on the product and basket pages.
...
3. Synchronization page
This page allows you to trigger a product synchronization or to trigger a stock import (full or diff).
...
4. Carrier services page
This page allows you to create a new delivery option based on a delivery promise route method from OneStock.
The standard delivery rate from Shopify doesn’t allow the connector to “hide” the delivery option based on the delivery promise response.
Thus, if a delivery option should be available to your customer only if our delivery promise says so method is dynamic (e.g. click and collect expressonly available depending on the items on the basket or on the delivery address), you have to create the rate from this page.
...
4.1 Create a rate
First, you have to make sure that the delivery promise route is configured and exists in OneStock.
...
Default Service name : the name that your customers will see in the checkout page.
Translations : if your shop supports multiple langages, you can translate the delivery option name that will be displayed on the checkout page here
Code : required by Shopify, this will be the rate code that is saved in the Shopify Order
Is C&C : if set to true, a list of stores that can fulfill the order will be displayed
Cost : you can set a fixed cost here. If not filled, we will use the cost returned by the delivery promise
Currency : set the currency of the cost
Delivery Promise Route : select the delivery route that is configured in OneStock
Ruleset (optional) : the ruleset chaining that will be posted to OneStock with the order.
...
5. Translation page
The connector displays the delivery promise for two types of messages on the checkout page: click and collect and home delivery.
...
There is an helper on the top right that explains the variables you can use but also some text transformers to display the dates in different formats
...
6. Documentation page
This page explains the two proxy routes opened by the connector. This is used so that you system integrator can make a custom implementation of the delivery promise and do extra stock check before checkout.
...
7. Checkout extension and delivery promise
7.1. Display the delivery promise in the checkout
To display the delivery promise on your checkout page, you have to add our app block in your checkout page from the shopify admin.
...
On the bottom left click on
Add app block
...
Select the `delivery
delivery-promise`promiseapp
...
Don’t forget to save on the top right
...
| Info |
|---|
Previews from this page doesn’t work, so you have to test directly in your real checkout page |
...
delivery promise will be visible only in the checkout page of your online shop. |
8. Delivery promise data for
...
custom integration.
The connector populate populates an order metafield with the response we got in the checkout page.
...
You can use Shopify APIs to retrieve this information to correctly send it to OneStock in your own integrationcreate an order in OneStock if you are not using the order synchronization from the connector. This is to populate the delivery_promise parameter of the POST /orders API.