Affiliate

Affiliate

Rozšíření, které umožňuje napojení na affiliate programy. Více informací naleznete zde.

Toto rozšíření umožňuje přiřadit k objednávkám informace o affiliate partnerovi, který zprostředkoval daný nákup.

Uložení affiliate parametrů k objednávce je možné pomocí update košíku affiliateDataUpdate, viz dokumentace.

Lze přiřadit pouze parametry, které jsou definovány v konfiguračním souboru.

Konfigurační soubor se standardně nachází v adresáři:
config/module-edeeshop/features/third-party/affiliate.xml

Zkopírovat odkaz na sekciPříklad konfigurace

xml
1 <affiliate>2    <cj>3        <cid>123456</cid>4        <type>123456</type>5        <apiUrl>https://www.kdukvh.com/u</apiUrl>6        <includeUsedCreditInDiscount/>7    </cj>8    <ehub>9        <campaignId>123456</campaignId>10        <apiUrl>https://ehub.cz/system/scripts/sale.php</apiUrl>11        <debugMode>false</debugMode>12        <defaultProductCategoryCode>def</defaultProductCategoryCode>13        <productCategories>14            <category>CATEGORYA</category>15        </productCategories>16        <sendOrderItems>false</sendOrderItems>17        <validity>14d</validity>18        <zeroPricePayment>zdarma</zeroPricePayment>19    </ehub>20    <attemptCountLimit>5</attemptCountLimit>21    <avoidSending>5</avoidSending>22    <catalogSpecific>23        <catalogCode/>24        <cj>25            <cid>123456</cid>26            <type>123456</type>27            <apiUrl>https://www.kdukvh.com/u</apiUrl>28            <includeUsedCreditInDiscount/>29        </cj>30        <ehub>31            <campaignId>123456</campaignId>32            <apiUrl>https://ehub.cz/system/scripts/sale.php</apiUrl>33            <debugMode>false</debugMode>34            <defaultProductCategoryCode>def</defaultProductCategoryCode>35            <productCategories>36                <category>CATEGORYA</category>37            </productCategories>38            <sendOrderItems>false</sendOrderItems>39            <validity>14d</validity>40            <zeroPricePayment>zdarma</zeroPricePayment>41        </ehub>42        <avoidSending>5</avoidSending>43    </catalogSpecific>44</affiliate>

Zkopírovat odkaz na sekciPopis

Zkopírovat odkaz na sekciaffiliate

Konfigurace affiliate feature a zapnutí jednotlivých služeb, které lze v rámci affiliate feature použít.

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
cj

Konfigurace služby CJ.

Pozn.: Pro jeden katalog je možné definovat pouze jednu affiliate službu. Tedy není možné povolit CJ a další službu.

cj

-

-

ehub

Konfigurace služby eHub.

Pozn.: Pro jeden katalog je možné definovat pouze jednu affiliate službu. Tedy není možné povolit eHub a další službu.

ehub

-

-

attemptCountLimit

Počet pokusů o odeslání objednávky.

Nad tento počet pokusů se systém již znovu nepokouší objednávky odeslat.

Hodnota má globální charakter a nelze ji specifikovat pro konkrétní katalog.

Výchozí hodnota je 5.

Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde.

Integer

-

5

avoidSending

Umožňuje vypnout odesílání objednávek, slouží pro testovací a development prostředí.

Pozn.: Zpracované objednávky přejdou do stavu .

Výchozí hodnota je false, tedy objednávky se odesílají.

boolean

-

false

catalogSpecific

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

-

-

Zkopírovat odkaz na sekcicj

Konfigurace služby CJ.

Pozn.: Pro jeden katalog je možné definovat pouze jednu affiliate službu. Tedy není možné povolit CJ a další službu.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
cid

Identifikátor účtu v CJ, dodá klient.

Povinná hodnota.

String

-

-

type

ID akce asociované s určitým typem konverze, dodá klient.

Povinná hodnota.

String

-

-

apiUrl

URL api, kam se odesílají objednávky.

Výchozí hodnota je "https://www.kdukvh.com/u".

String

-

https://www.kdukvh.com/u

includeUsedCreditInDiscount

Nastavuje jestli se v rámci údaje DISCOUNT má do CJ odeslat i hodnota použitého kreditu.

boolean

-

false

Zkopírovat odkaz na sekciehub

Konfigurace služby eHub.

Pozn.: Pro jeden katalog je možné definovat pouze jednu affiliate službu. Tedy není možné povolit eHub a další službu.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
campaignId

Identifikátor kampaně v eHub, dodá klient.

Povinná hodnota.

String

-

-

apiUrl

URL webservisu kam se odesílají objednávky.

Výchozí hodnota je "https://ehub.cz/system/scripts/sale.php".

String

-

https://ehub.cz/system/scripts/sale.php

debugMode

Zapnutí debug mode, při kterém proti-strana vrací objekt s informacemi o výsledku zpracování a popis případné chyby.

Výchozí hodnota je 'false'.

boolean

-

false

defaultProductCategoryCode

Výchozí typ produktu pro eHub po produkty bez explicitního přiřazeného typu.

Výchozí hodnota je "def".

String

-

def

productCategories/category

Seznam kódů možných kategorií produktu pro eHub. Z tohoto seznamu je pak možné v administraci entit zvolit odpovídající kategorii. V AR se zobrazuje kód, které je ale možné lokalizovat pod klíčem affiliate.ehub.category.[kod_kategorie], tedy např. 'affiliate.ehub.category.CATEGORYA'.

Pokud entita nemá přiřazenou žádnou z těch kategorií, použije se hodnota z defaultProductCategoryCode.

V případě, že

List: String

-

-

sendOrderItems

Zapnutí odesílání rozkladu položek objednávky místo sum za jednotlivé kategorie produktů eHubu.

boolean

-

false

validity

Doba platnosti trackovacího kódu.

Výchozí hodnota je "14d".

TimeInterval

-

14d

zeroPricePayment

Hodnota ceny, která se v objednávce vyplní do platební metody, pokud je objednávka zdarma.

Výchozí hodnota je "zdarma".

String

-

zdarma

Zkopírovat odkaz na sekciJuan

Konfigurace jednotlivých affiliate programů způsobí změnu v juanConfig.

Ukázka části konfigurace pro affiliate program:

json
1 {2  "shop": {3    "affiliate": {4      "parameters": {5        "cjevent": {},6        "ehub": {7        }8      }9    }10  }11}