Guidelines for Integrating Third-Party Algorithms on the Tracking Page?

1. Introduction

If you require refined operations and possess some development capabilities, 17TRACK supports you in using your own recommendation algorithm to achieve personalized product recommendations. We will request the API address you provide and display the product information in the product recommendation section of the tracking page. Below are the specific integration process guidelines.

2. Integration Steps

• Configure Tracking Page
• Provide the API address; you need to implement this API service using our integration method to return the required product information for recommendation.

3. API Integration

3.1 Basic Information

3.2 Authentication

You need to provide an API that supports anonymous access. If security is needed, please open a whitelist to support our access.

3.3 Interface Integration

We will call the API you provide. We have defined the request parameters and the desired response content. You need to integrate according to the defined request input and output.

3.3.1 Request Method

POST

3.3.2 Request Parameters

• Request Example

curl --location 'https://example.com' \
--header 'x-shopify-domian: example.myshopify.com' \
--header 'Content-Type: application/json' \
--data '{
    "shop_name": "example.myshopify.com",
    "limit": 10,
    "currency": "USD",
    "ids": ["323000"]
}'

{
    "shop_name": "example.myshopify.com",
    "limit": 10, //maximum of 10 items
    "currency": "USD",
    "ids": ["323000"]
}

• Description of the request

3.3.3 Response Parameters

• Response Example
• Normal Response

{
    "code": "200",
    "message": "",
    "data": [
        {
            "product_id": "7635574000000",
            "product_title": "17TRACK DEMO PRODUCT",
            "price": "120.00",
            "url": "https://17TRACK.com/products/a2568?variant=1001",
            "image": "https://cdn.shopify.com/s/foo.jpg",
            "currency": "USD",
            "currency_symbol": "$",
            "discount_type": "fixed_amount",
            "discount_value": "80",
            "discount_price": "96.00"
        }
    ]   
}

• Error Response

{
    "code": "500"
    "data": null
    "message": "request too fast"
}

• Response Description

3.3.4 Response Codes

• We will handle the response codes from the customer API accordingly.

Updated on: 27/06/2024