...

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

• Order identifier: set up Onestock order identifier (id of the order that will be saved in Onestock, it can be the shopify order id or the shopify order name)

...

Once your credential saved, you will have access to more configurations and also to two admin pages : Synchronization and Carrier services.

...

Those 3 webhooks let the connector update the order on Shopify when a line item is removed or when a parcel is dispatched.

parcel_state_changed:

The connector is listening to dispatched and collected states of a parcel. If the parcel is at one of those state, the connector create a fulfillment for the related line items. (A fulfillment order represents a group of one or more items in an order that will be fulfilled from the same location.)

order_state_changed:

The connector is listening to removed and fulfilled states of an order.

If the order is at one of those state, the connector checks if there are items that need to be hold. In case there are items that need to be hold, it applies a fulfillment hold on the related fulfillment order.

line_item_group_state_changed:

The connector is listening to removed state of a line item. If the line item group is at this state, it applies a fulfillment hold on the related fulfillment order.

Rulesets Mapping (optional)

...

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

...

3.1 Synchronize specific products

You can also use the products list or details pages on Shopify to filter the products you want to synchronize. A synchronize button is available on the more options button.

...

This synchronize button is also available on a specific product page

...

3.2 Synchronize orders

You can also force an order synchronization from the order list or an order detail page of Shopify through a more action button.

Image AddedImage Added

4. Carrier services page

This page allows you to create a new delivery option based on a delivery method from OneStock.

...

8.

...

Metafield data for custom integration.

The connector populates an order metafield with the response we got in the checkout page.

...

8.1. Delivery promise data

You can use Shopify APIs to retrieve this information to correctly create 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.

[
    {
        "carbon_footprint": 100,
        "cost": 1,
        "cutoff": 1722224700,
        "delivery_method": "my_delivery_method_name",
        "destination": {
            "location": {
                "country": "FR",
                "zip_code": "31400"
            }
        },
        "eta_end": 1722524401,
        "eta_start": 1722322800,
        "shipment_number": 1,
        "delivery_routes": [
            {
                "carrier": {
                    "name": "carrier name",
                    "option": "standard"
                },
                "items": [
                    {
                        "id": "my_item_id",
                        "quantity": 1
                    }
                ]
            }
        ],
        "status": "valid",
        "code": "Standard",
        "delivery_promise_message": "The delivery promise displayed to the customer"
    }
]

8.2. Click and Collect data for custom integration

The selected store for click and collect is also stored on the delivery_promise metafield.

You can retrieve the store value to be used for your integration in destination.endpoint_id

{
    "carbon_footprint": 100,
    "cost": 1,
    "cutoff": 1722224700,
    "delivery_method": "ckc",
    "destination": {
        "endpoint_id": "my_store_id"
    },
    "eta_end": 1722524401,
    "eta_start": 1722326400,
    "shipment_number": 1,
    "delivery_routes": [
        {
            "carrier": {
                "name": "carrier name",
                "option": "standard"
            },
            "items": [
                {
                    "id": "my_item_id",
                    "quantity": 1
                }
            ]
        }
    ],
    "status": "valid",
    "code": "ckc",
    "delivery_promise_message": "the delivery promise message"
}