Articles on: Tracking page

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


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.

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.

API Integration

3.1 Basic Information

API AddressProvided by you, filled in the brand tracking page editorWe will perform a basic connectivity check on this address
Request FormatJSONCurrently, only JSON transmission is supported
Response FormatJSONCurrently, only JSON transmission is supported

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


3.3.2 Request Parameters

- Request Example

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

    "shop_name": "",
    "limit": 10, //maximum of 10 items
    "currency": "USD",
    "ids": ["323000"]

- Description of the request

shop_nameStore NameStringYesFull domain name of the Shopify store
limitReturn QuantityNumYesMaximum number of products to display, currently 10
currencyCurrencyStringYesCurrent currency code of the store
idsSKU IDString ArrayNoAll SKU IDs under the order

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": "",
            "image": "",
            "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

product_idProduct IDStringYesUnique Product ID in Shopify store7635574000000
product_titleProduct TitleStringYesProduct title17TRACK DEMO PRODUCT
priceSKU PriceStringYesProduct price (Shopify price)120
urlProduct URLStringYesProduct URL
imageMain ImageStringYesMain image of the product variant
currencyCurrency CodeStringYesCurrencyUSD
currency_symbolCurrency SymbolStringYesCurrency symbol$
discount_typeDiscount TypeStringNoShopify discount value_typefixed_amount / percentage
discount_valueDiscount ValueStringNoDiscount value. Will be concatenated with discount_type (e.g., if discount type is percentage and value is 88, it becomes 88%)fixed_amount: 80
discount_priceDiscounted PriceStringNoPrice after discount96

3.3.4 Response Codes
- We will handle the response codes from the customer API accordingly.

Response CodeDescriptionHandling Method
200Request successfulNormal display of request results
401UnauthorizedDo not display
403Access restrictedDo not display. Typically due to rate limiting
404Not foundDo not display
500Request failedDo not display
OthersRequest failedDo not display

Updated on: 27/06/2024

Was this article helpful?

Share your feedback


Thank you!