OneStock connector configuration

OneStock connector configuration

Configuration

Below you will find all the information required to configure your OneStock connector.

Configuration of the OneStock connector is done directly on the Shopify admin page.

General configuration

  • Site ID → Your OneStock site ID provided by your OneStock contact.

  • API configuration

    • Host

      • For OneStock qualification environnement

        • OVH

        • GCP → Amend the region code if needed.

      • For OneStock production environnement

        • OVH

        • GPC → Amend the region code if needed.

    • User ID → user API created for the project. Check our API user guide to learn how to create one. It is mandatory use the api_user role

    • Password → password associated

Order configuration

Synchronize order

  • Default value is not checked

  • If synchronize order is checked, the OneStock Connector listen to all orders created in Shopify to create them in OneStock. Please refer to this information to understand order integration and how it works.

image-20251201-103925.png

 

Order identifier

  • Default value is Shopify order id

  • “Shopify order id” → Unique identifier for an order to a unique Shopify store, e.g. in the screenshot below: 12281490276738

96fa4e0a-a811-4c16-a8ec-07c5862af7d6.png

 

  • “Shopify order name” → Identifier created with the merge of the number of order created and the Order ID prefix/suffix used. Can be configure in Shopify Back-office, General>Order ID, e.g. in the screenshot below: DEV2931

e296be0a-cb78-4dd1-811f-285366bf9869.png

 

Below is a summary of the various possible scenarios:

OneStock setup

Shopify setup

Order management

OneStock setup

Shopify setup

Order management

1 site ID

1 storefront

We recommend to use the Shopify order ID

1 site ID

storefront > 1

We recommend to use the Shopify order name. Please keep in mind that the prefix/suffix used must be unique between Shopify Instance to ensure unicity.

Multiple site ID

stores > 1

You can use both options

Metafield key

  • This key allows OneStock connector to retrieve the ID of the Shopify store pickup by the customer during the checkout. This metafield must equals endpoint_id in OneStock. This field is mandatory if you are using pickup in store delivery method from Shopify.

Notify customer

  • Default value is false

  • Notify customer on fulfillement creation feature allows you to send the email configured in Shopify if you activate it. The email is only sent when the fulfillment changes to fulfilled in Shopify.

Avalara configuration

  • Default value is false

  • OneStock commit avalara taxes, please refer to documentation.

Synchronize product

  • Turn on if you want product synchronization from Shopify to OneStock - products are updated on a timely basis or via the synchronize product button.

Do not activate this feature

Sales channel

  • One sales channel per Shopify storefront.

  • Sales channel must be created beforehand to allow their selection in this configuration.

STFP Configuration

  • SFTP host → provided by the IT team if OS owner

  • SFTP port → provided by the IT team if OS owner

  • SFTP public key → Available here if OS owner

  • SFTP user → provided by the IT team if OS

  • SFTP password → provided by the IT team if OS owner

  • SFTP root folder → /{internal/preprod/qualif/live}

  • SFTP name → sftp_[clientname]

  • Timezone to configure

Location & Stock request mapping

  • Full stock request name → Fill it with the given full given request

  • Full frequency : Every day at → Pick up an hour for full export → recommend to do it between 02:00am and 06:00am

  • Diff stock request name → Fill it with the given diff given request

  • Diff frequency : Start at/End at/Every → Pick up a time slot and rate for delta export

  • Turn on the enable cron for full and diff

  • Pick up the translator export_stock_unified

Timezone

  • Select the timezone that will define the scheduled stock import.

Rulesets Mapping

  • This allows Shopify rates (which do not include delivery promises) to be linked with the orchestration rules available in OneStock.

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.

Delivery Promises Mapping

  • If you have subscribed to OneStock delivery promise, you can display the delivery promise result on your checkout page under every each Shopify rate.

  • 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.

Default location for Delivery Promise

Do not activate this feature

Google API Key

  • Integrate the client's API key to enable Google in the checkout process and display available stores for BOPIS preparation.

Number of stores to display in click & collect

  • Number of stores displayed in BOPIS (C&C) delivery promise response

image-20260115-165111.png

 

Synchronization

  • This page allows you to trigger a product synchronization or to trigger a stock import manually (full or delta).

image-20240715-122502.png
image (2) (1).png
Product sync error alerts
When a product variant fails to sync (e.g. missing SKU), you’ll now see a clear error message directly in the connector, including the affected product and variant. This helps you identify and resolve issues before they impact operations.

Webhooks Management page

  • A dedicated page provides full visibility into all active webhooks from both Shopify and OneStock, along with their current status so you always know what’s connected and working.

image (1) (1).png

Carrier services

  • Click on shipping rate button

  • Fill-in the below fields

    • Default Service Name → Will be the delivery method display on your shopify website

    • Code → No impact in OneStock but has to be unique

    • Cost → Leave it empty

    • Currency → Currency of your shopify website

    • Delivery Promise Route → To have a route available, please note you need to configure in OneStock backoffice the delivery promise module. Route will be linked to one stock inventory.

    • Ruleset (optional) → To have a ruleset available, please note you need to configure in OneStock backoffice the orchestration rules.

In case of BOPIS (C&C) Mapping, the Code field must include “ONESTOCK_CKC”.

In case of BOPIS (C&C), the delivery promise will be on a stock location basis, it will check the delivery promise response of each store to display the associated list.

Please note that the stores shown are based on the country selected in the Shopify storefront. The list of countries selectable are based on the market fill in the Configuration>Markets tab.

add_shipping_dp_conf.gif
Carrier service configuration

Translation

Under this tab you wil find the current configuration of the translation, which encompass the pattern, of the different cases where the delivery promise will be display to the customer.

  • "click_and_collect_message" : Message displayed when the order type is Click and Collect on a standard delivery mode.

1d8530ec-d523-4eff-8426-7f29c3f53617.png

 

  • "delivery_promise_message" : Message displayed when the order type is Home delivery on a standard delivery mode.

 

  • "click_and_collect_message_same_day" : Message displayed when the order type is Click and Collect on an express same-day delivery mode.

  • "delivery_promise_message_same_day" : Message displayed when the order type is Home delivery on an express same-day delivery mode.

  • click_and_collect_dropdown_placeholder" : Placeholder message used on the dropdown list.

 

Documentation

  • This page explains the two proxy routes opened by the OneStock connector.

  • Integrators can make a custom implementation by using our proxy. Usage of those routes must be validated by your OneStock contact.

Delivery promise block integration

Mandatory step if you have contracted the delivery promise and intend to use it on the checkout page on your Shopify.

  • On your Shopify back-office, click on the “Online Store” tab

  • Click on the button “Customize” belonging to your current theme (the theme with the green label “Current theme”

  • On the top of the page, right in the middle, click on the “Home page” block and then choose the page “Checkout and customer accounts”

  • On the left, under the “Delivery” part, click on the “Add app block” highlighted in blue then select the module “delivery-promise”

  • You are all set, you can now save the change with the black button “Save” located on the top right of the page.

bc5491a7-c166-4658-b50c-3f62bb9f0e11.gif

 

Atlas block integration

  • Install Atlas app in your Shopify store.

  • Click on the Add pickup point selection app block in checkout.

image-20251127-111835.png

 

  • Click on the Add your first pickup point configuration and configure your carrier.

    • In this section, add your Shipping rates manually by writing down Default Service name. This information is available in the section Carrier Services from the OneStock Connector.

image-20251127-132015.png

 

  • OneStock connector put data from Atlas in the POST/orders to OneStock in the field order.information.shopify_metafields.atlas_pickup_point.

{ "provider": "CHRONOPOST", "code": "608AS", "details": { "name": "LA POSTE DE ST DENIS PLEYEL", "description1": "170 BOULEVARD ANATOLE FRANCE, ST DENIS", "description2": null }, "address": { "longitude": 2.343608, "latitude": 48.919984, "address1": "170 BOULEVARD ANATOLE FRANCE", "address2": null, "city": "ST DENIS", "zip": "93200", "province": null, "provinceCode": null, "countryCode": "FR" }, "attributes": [ { "key": "typeDePoint", "value": "P" } ], "rate": { "id": "a6b71de7-8d79-4c44-ba52-88992de0fa24" } }