Vendor bonuses

Parameters

HTTP method	Access rights	URL	Parameters	Note
GET	vendor_tool	`https://api.admitad.com/vendor_tool/v1/vendor_tool/`	Parameter request list	Returns a list of vendor bonuses available to publisher*

* Returns the result in the JSON format.

Parameter request list

Name	Type	Allowed values	Note
advcampaign_id	comma-separated integers	Example: advcampaign_id=12,23,34	Returns a list of vendor bonuses for specified affiliate programs
limit	integer	limit, offset parameters
offset	integer	limit, offset parameters

Example of use

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token -X GET https://api.admitad.com/vendor_tool/v1/vendor_tool/

Example of the response from the API server in the JSON format:

{

  "id": 29,

  "conditions": [

    {

      "action": {

        "name": "vendor_action_eralala",

        "hold_size_days": 30,

        "tariffs": [

          {

            "name": "Тариф по умолчанию",

            "rates": [

              {

                "size": "5.00",

                "price_s": "0.00",

                "country": null,

                "date_s": "2020-08-20",

                "is_percentage": true

              },

              {

                "size": "7.00",

                "price_s": "0.00",

                "country": null,

                "date_s": "2020-12-17",

                "is_percentage": true

              }

            ]

          }

        ]

      },

      "advcampaign": {

        "id": 15939,

        "name": "beard-bookerae-alie1"

      },

      "price_from": null,

      "price_up_to": null,

      "category": "",

      "brand": "",

      "product": "1,23,3",

      "supplier": "",

      "additional_filter_name": "",

      "additional_filter_value": ""

    }

  ],

  "name": "qweqwe",

  "status": "active",

  "start_datetime": null,

  "stop_datetime": null,

  "allow_all_webmasters": true,

  "allowed_to_you": true,

  "vendor_campaign": {

    "id": 15932,

    "name": "HIDDEN VENDOR eraoelgoselRs"

  }

}

Description of API server response fields

Name	Type	Description
id	int	The vendor bonus identifier
name	char	The vendor bonus name
status	char	The current status of the vendor bonus
start_datetime	datetime	The vendor bonus start date in the %Y-%m-%dT%H:%M:%S format. Example: 2020-12-02T17:15:28
stop_datetime	datetime	The vendor bonus end date in the %Y-%m-%dT%H:%M:%S format. Example: 2020-12-02T17:15:28
allow_all_webmasters	bool	Determines whether the vendor bonus works for all publishers
allowed_to_you	bool	Determines whether the client who sent the request is allowed to work with this vendor bonus
conditions	json-list	The list of objects with the information on the use conditions

Parameters of the object in the conditions list

Name	Type	Description
advcampaign	json	An affiliate program to which the traffic is driven. Example: “advcampaign”: { “id”: 15939, “name”: “beard-bookerae-alie1” }
action	object	The object with the information on a potential reward for the target action
price_from	char	The minimum product cost
price_up_to	char	The maximum product cost
category	char	The requirement for a product’s belonging to a certain category
brand	char	The requirement for a product’s belonging to a certain brand
product	char	The requirement for selling specific products. If the bonus should be credited for specific products only, product_id’s are listed separated by commas
supplier	char	Requirements for the product supplier
additional_filter_name	char	The additional requirement for a product where additional_filter_name is a product key and additional_filter_value is a product value
additional_filter_value	char	The additional requirement for a product where additional_filter_name is a product key and additional_filter_value is a product value

Parameters of the action object

Name	Type	Description
hold_size_days	int	Hold time (days)
rates	json-list	The list of rates for this action

Every action object contains an array of tariffs objects which, in turn, contains information about reward commissions

Name	Type	Description
rates	json-list	The list of reward commissions for this rate
rates.size	char	Reward commission
rates.price_s	char	Minimum payment
rates.country	char	The order country code to apply this commission
is_percentage	bool	Determines whether the commission is an interest or a fixed amount (a share of the order amount or a fixed reward)