Sell Via App
API Reference

GENERAL

Customer

Document

Document Line

FAM 1

Fam 2

Orders

Orders Lines

Product

API Documentation - Product List

Endpoint

GET /product/list

Parameters

The following query parameters are supported in the request:

Parameter Type Description Required
fam1ID string A unique identifier of category No
fam2ID string A unique identifier of sub-category No
guid string A unique identifier for the session or user No
id_membre int The member ID Yes
from_other_page string Specifies the context from which the request is made. Possible values: IS_FAVORIS, IS_PROMOTION, IS_NOUVEAUTE No
megatech_ARCLEUNIK string Unique product identifier No
GPR_No string Group number. Defaults to "01" if not provided No
rechercher_mot_cle string Keyword for searching products No
champstraduit string Specifies the translated field to be used. Possible values: megatech_Titre_lib_web_fr, megatech_Titre_lib_web_nl, megatech_Titre_lib_web_en No
limit int The number of records to return No
page int The page number to start from No
tri_listing_article string Specifies the sorting order. Possible values: weborder, alpha No
data string Semi-colon separated string for filtering products by specific attributes (formatted as 'valueBefore_valueAfter') No

Response

The response is a JSON object containing the following fields:

{
    "success": true,
    "message": "Products list",
    "result": {
        "product": [
            {
                "id_product_mysql": 1,
                "arcleunik": "1234",
                "title": "Hammer",
                "productCode": "HMR001",
                "champsLangueAutiliser": "Hammer",
                "fam1ID": 2,
                "fam2ID": 3,
                "active": true,
                "qtyByBox": 10,
                "unite": "piece",
                "unite_full_name": "Piece",
                "tvaRate": 20.0,
                "weborder": 1,
                "promoPrice": 15.99,
                "promoPriceStart": "2024-01-01",
                "promoPriceEnd": "2024-12-31",
                "libWebLangue1": "Hammer",
                "libWebLangue2": "Hammer",
                "libWebLangue3": "Hammer",
                "isNew": false,
                "libWeb": "High-quality hammer",
                "langue_libweb_1": "Hammer description in language 1",
                "langue_libweb_2": "Hammer description in language 2",
                "langue_libweb_3": "Hammer description in language 3",
                "langue_libweb_4": "Hammer description in language 4",
                "photo1_base64": "base64encodedstring",
                "prix_vente_groupe": 20.99,
                "prix_en_promo": 15.99
            }
        ],
        "product_out_of_shop": [
            {
                "arcleunik": "5678",
                "productCode": "HMR002",
                "titre_produit": "Sledgehammer",
                "champsLangueAutiliser": "Sledgehammer",
                "fam1ID": 2,
                "fam2ID": 3
            }
        ]
    }
}

Example Request

GET /product/list?guid=12345&id_membre=678&from_other_page=IS_PROMOTION&rechercher_mot_cle=tools&limit=20&page=1&tri_listing_article=alpha

Example Response

{
    "success": true,
    "message": "Products list",
    "result": {
        "product": [
            {
                "id_product_mysql": 1,
                "arcleunik": "1234",
                "title": "Hammer",
                "productCode": "HMR001",
                "champsLangueAutiliser": "Hammer",
                "fam1ID": 2,
                "fam2ID": 3,
                "active": true,
                "qtyByBox": 10,
                "unite": "piece",
                "unite_full_name": "Piece",
                "tvaRate": 20.0,
                "weborder": 1,
                "promoPrice": 15.99,
                "promoPriceStart": "2024-01-01",
                "promoPriceEnd": "2024-12-31",
                "libWebLangue1": "Hammer",
                "libWebLangue2": "Hammer",
                "libWebLangue3": "Hammer",
                "isNew": false,
                "libWeb": "High-quality hammer",
                "langue_libweb_1": "Hammer description in language 1",
                "langue_libweb_2": "Hammer description in language 2",
                "langue_libweb_3": "Hammer description in language 3",
                "langue_libweb_4": "Hammer description in language 4",
                "photo1_base64": "base64encodedstring",
                "prix_vente_groupe": 20.99,
                "prix_en_promo": 15.99
            }
        ],
        "product_out_of_shop": [
            {
                "arcleunik": "5678",
                "productCode": "HMR002",
                "titre_produit": "Sledgehammer",
                "champsLangueAutiliser": "Sledgehammer",
                "fam1ID": 2,
                "fam2ID": 3
            }
        ]
    }
}