# Admin API - Documentation

# Basket API Documentation

The Basket API is used for exporting and analyzing shopping cart data recorded via the partner program system. It allows you to retrieve detailed information on individual basket items in a structured CSV format for further processing.

The API can be accessed within the user interface under the **Data API** menu item.

---

### API Call

`https://<strong>www.domain.de</strong>/api//<strong>ACCESS-TOKEN</strong>/admin/<strong>ID</strong>/get-orders_baskets<strong>.csv</strong>`

<table data-path-to-node="7" id="bkmrk-value-description-ww"><thead><tr><td>**Value**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="7,1,0,0">**www.domain.de**</span></td><td><span data-path-to-node="7,1,1,0">Partner program system domain</span></td></tr><tr><td><span data-path-to-node="7,2,0,0">**ACCESS-TOKEN**</span></td><td><span data-path-to-node="7,2,1,0">User's Access Token</span></td></tr><tr><td><span data-path-to-node="7,3,0,0">**ID**</span></td><td><span data-path-to-node="7,3,1,0">User ID</span></td></tr><tr><td><span data-path-to-node="7,4,0,0">**.csv**</span></td><td><span data-path-to-node="7,4,1,0">Download file format</span></td></tr></tbody></table>

---

### Basket API Filtering

Various parameters can be used as filters for the Basket API. Below is an overview of all available parameters:

<table data-path-to-node="11" id="bkmrk-parameter-value-%2F-ex"><thead><tr><td>**Parameter**</td><td>**Value / Example**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="11,1,0,0">`condition[period][from]`</span></td><td><span data-path-to-node="11,1,1,0">01.01.2025</span></td><td><span data-path-to-node="11,1,2,0">Defines the **start date** of the time period</span></td></tr><tr><td><span data-path-to-node="11,2,0,0">`condition[period][to]`</span></td><td><span data-path-to-node="11,2,1,0">31.01.2025</span></td><td><span data-path-to-node="11,2,2,0">Defines the **end date** of the time period</span></td></tr><tr><td><span data-path-to-node="11,3,0,0">`condition[l:campaigns]`</span></td><td><span data-path-to-node="11,3,1,0">1</span></td><td><span data-path-to-node="11,3,2,0">Filters all baskets assigned to a specific campaign. Multiple values allowed.</span></td></tr><tr><td><span data-path-to-node="11,4,0,0">`condition[datemode]`</span></td><td>processing

  
payout

  
incoming

</td><td>Determines the type of date period:

  
• **processing**: Baskets validated within the period

  
• **payout**: Baskets paid out within the period

  
• **incoming**: Baskets recorded within the period (transaction date)

</td></tr></tbody></table>

**Example:**

`condition[period][from]=01.01.2025&condition[period][to]=31.01.2025&condition[datemode]=processing`

---

### Field Definitions in the Basket API

The downloaded transactions (e.g., as a `.csv` file) contain the following columns:

<table data-path-to-node="16" id="bkmrk-field-name-descripti"><thead><tr><td>**Field Name**</td><td>**Description**</td></tr></thead><tbody><tr><td>`<span data-path-to-node="16,1,0,0"><strong data-index-in-node="0" data-path-to-node="16,1,0,0">id</strong></span>`</td><td><span data-path-to-node="16,1,1,0">Unique ID of the basket item</span></td></tr><tr><td>`<span data-path-to-node="16,2,0,0"><strong data-index-in-node="0" data-path-to-node="16,2,0,0">orderid</strong></span>`</td><td><span data-path-to-node="16,2,1,0">Internal ID of the associated transaction</span></td></tr><tr><td>`<span data-path-to-node="16,3,0,0"><strong data-index-in-node="0" data-path-to-node="16,3,0,0">timestamp</strong></span>`</td><td><span data-path-to-node="16,3,1,0">Timestamp of the transaction</span></td></tr><tr><td>`<span data-path-to-node="16,4,0,0"><strong data-index-in-node="0" data-path-to-node="16,4,0,0">ordertoken</strong></span>`</td><td><span data-path-to-node="16,4,1,0">Order number of the transaction</span></td></tr><tr><td>`<span data-path-to-node="16,5,0,0"><strong data-index-in-node="0" data-path-to-node="16,5,0,0">trigger_id</strong></span>`</td><td><span data-path-to-node="16,5,1,0">ID of the trigger assigned to the transaction</span></td></tr><tr><td>`<span data-path-to-node="16,6,0,0"><strong data-index-in-node="0" data-path-to-node="16,6,0,0">is_basket</strong></span>`</td><td><span data-path-to-node="16,6,1,0">Indicates if it is a basket item (`true` / `false`)</span></td></tr><tr><td>`<span data-path-to-node="16,7,0,0"><strong data-index-in-node="0" data-path-to-node="16,7,0,0">basket_item_id</strong></span>`</td><td><span data-path-to-node="16,7,1,0">Unique ID of the basket item</span></td></tr><tr><td>`<span data-path-to-node="16,8,0,0"><strong data-index-in-node="0" data-path-to-node="16,8,0,0">category</strong></span>`</td><td><span data-path-to-node="16,8,1,0">Category provided by the shop</span></td></tr><tr><td>`<span data-path-to-node="16,9,0,0"><strong data-index-in-node="0" data-path-to-node="16,9,0,0">productid</strong></span>`</td><td><span data-path-to-node="16,9,1,0">Product ID in the shop</span></td></tr><tr><td>`<span data-path-to-node="16,10,0,0"><strong data-index-in-node="0" data-path-to-node="16,10,0,0">productname</strong></span>`</td><td><span data-path-to-node="16,10,1,0">Name of the product in the shop</span></td></tr><tr><td>`<span data-path-to-node="16,11,0,0"><strong data-index-in-node="0" data-path-to-node="16,11,0,0">amount</strong></span>`</td><td><span data-path-to-node="16,11,1,0">Number of products purchased</span></td></tr><tr><td>`<span data-path-to-node="16,12,0,0"><strong data-index-in-node="0" data-path-to-node="16,12,0,0">price</strong></span>`</td><td><span data-path-to-node="16,12,1,0">Unit price of the product</span></td></tr><tr><td>`<span data-path-to-node="16,13,0,0"><strong data-index-in-node="0" data-path-to-node="16,13,0,0">original_price</strong></span>`</td><td><span data-path-to-node="16,13,1,0">Original unit price before changes</span></td></tr><tr><td>`<span data-path-to-node="16,14,0,0"><strong data-index-in-node="0" data-path-to-node="16,14,0,0">status</strong></span>`</td><td><span data-path-to-node="16,14,1,0">Status of the basket item</span></td></tr><tr><td>`<span data-path-to-node="16,15,0,0"><strong data-index-in-node="0" data-path-to-node="16,15,0,0">total</strong></span>`</td><td><span data-path-to-node="16,15,1,0">Total price (Quantity × Price)</span></td></tr><tr><td>`<span data-path-to-node="16,16,0,0"><strong data-index-in-node="0" data-path-to-node="16,16,0,0">commission</strong></span>`</td><td><span data-path-to-node="16,16,1,0">Commission the publisher receives for the basket item</span></td></tr><tr><td>`<span data-path-to-node="16,17,0,0"><strong data-index-in-node="0" data-path-to-node="16,17,0,0">currency_rate</strong></span>`</td><td><span data-path-to-node="16,17,1,0">Conversion rate for foreign currencies</span></td></tr><tr><td>`<span data-path-to-node="16,18,0,0"><strong data-index-in-node="0" data-path-to-node="16,18,0,0">currency</strong></span>`</td><td><span data-path-to-node="16,18,1,0">Currency of the transaction</span></td></tr><tr><td>`<span data-path-to-node="16,19,0,0"><strong data-index-in-node="0" data-path-to-node="16,19,0,0">is_attributed</strong></span>`</td><td><span data-path-to-node="16,19,1,0">Indicates whether attribution applies (`true` / `false`)</span></td></tr><tr><td>`<span data-path-to-node="16,20,0,0"><strong data-index-in-node="0" data-path-to-node="16,20,0,0">attribution</strong></span>`</td><td><span data-path-to-node="16,20,1,0">Type of attribution per basket item</span></td></tr><tr><td>`<span data-path-to-node="16,21,0,0"><strong data-index-in-node="0" data-path-to-node="16,21,0,0">attributed_price</strong></span>`</td><td><span data-path-to-node="16,21,1,0">Attributed price per basket item</span></td></tr><tr><td>`<span data-path-to-node="16,22,0,0"><strong data-index-in-node="0" data-path-to-node="16,22,0,0">attributed_total</strong></span>`</td><td><span data-path-to-node="16,22,1,0">Attributed price × Quantity</span></td></tr><tr><td>`<span data-path-to-node="16,23,0,0"><strong data-index-in-node="0" data-path-to-node="16,23,0,0">trigger_value</strong></span>`</td><td><span data-path-to-node="16,23,1,0">Commission amount per basket item</span></td></tr><tr><td>`<span data-path-to-node="16,24,0,0"><strong data-index-in-node="0" data-path-to-node="16,24,0,0">original_turnover</strong></span>`</td><td><span data-path-to-node="16,24,1,0">Tracked revenue</span></td></tr><tr><td>`<span data-path-to-node="16,25,0,0"><strong data-index-in-node="0" data-path-to-node="16,25,0,0">price_brutto</strong></span>`</td><td><span data-path-to-node="16,25,1,0">Gross price of the basket item</span></td></tr></tbody></table>

# Transaction API Documentation

The Transaction API enables the structured export and analysis of transactions recorded within the partner program system. It provides detailed insights into individual transaction processes and assists with billing, performance measurement, and integration into internal or external systems.

The API can be accessed within the user interface under the **Data API** menu item.

---

### API Call

`https://<strong>www.domain.de</strong>/api//<strong>ACCESS-TOKEN</strong>/admin/<strong>ID</strong>/get-orders<strong>.csv</strong>`

<table data-path-to-node="7" id="bkmrk-value-description-ww"><thead><tr><td>**Value**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="7,1,0,0">**www.domain.de**</span></td><td><span data-path-to-node="7,1,1,0">System domain</span></td></tr><tr><td><span data-path-to-node="7,2,0,0">**ACCESS-TOKEN**</span></td><td><span data-path-to-node="7,2,1,0">User's Access Token</span></td></tr><tr><td><span data-path-to-node="7,3,0,0">**ID**</span></td><td><span data-path-to-node="7,3,1,0">User ID</span></td></tr><tr><td><span data-path-to-node="7,4,0,0">**.csv**</span></td><td><span data-path-to-node="7,4,1,0">Download file format</span></td></tr></tbody></table>

---

### Transaction API Filtering

Various parameters can be used as filters for the Transaction API. Below is an overview of all available parameters:

#### Transaction Status

<table data-path-to-node="12" id="bkmrk-parameter-value-exam"><thead><tr><td>**Parameter**</td><td>**Value**</td><td>**Example**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="12,1,0,0">`condition[l:status]`</span></td><td><span data-path-to-node="12,1,1,0">`open`</span></td><td><span data-path-to-node="12,1,2,0">`condition[l:status]=open`</span></td><td><span data-path-to-node="12,1,3,0">All transactions defined as "Open" in the system</span></td></tr><tr><td> </td><td><span data-path-to-node="12,2,1,0">`confirmed`</span></td><td><span data-path-to-node="12,2,2,0">`condition[l:status]=confirmed`</span></td><td><span data-path-to-node="12,2,3,0">All transactions defined as "Confirmed" in the system</span></td></tr><tr><td> </td><td><span data-path-to-node="12,3,1,0">`paid`</span></td><td><span data-path-to-node="12,3,2,0">`condition[l:status]=paid`</span></td><td><span data-path-to-node="12,3,3,0">All transactions defined as "Paid" in the system</span></td></tr><tr><td> </td><td><span data-path-to-node="12,4,1,0">`canceled`</span></td><td><span data-path-to-node="12,4,2,0">`condition[l:status]=canceled`</span></td><td><span data-path-to-node="12,4,3,0">All transactions defined as "Canceled" in the system</span></td></tr></tbody></table>

> **Note:** A combination of multiple statuses is possible. For example: `condition[l:status]=confirmed,paid`

#### General Filters

<table data-path-to-node="15" id="bkmrk-parameter-value-%2F-ex"><thead><tr><td>**Parameter**</td><td>**Value / Example**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="15,1,0,0">`condition[period][from]`</span></td><td><span data-path-to-node="15,1,1,0">01.01.2025</span></td><td><span data-path-to-node="15,1,2,0">Defines the **start date** of the time period</span></td></tr><tr><td><span data-path-to-node="15,2,0,0">`condition[period][to]`</span></td><td><span data-path-to-node="15,2,1,0">31.01.2025</span></td><td><span data-path-to-node="15,2,2,0">Defines the **end date** of the time period</span></td></tr><tr><td><span data-path-to-node="15,3,0,0">`condition[l:campaigns]`</span></td><td><span data-path-to-node="15,3,1,0">1</span></td><td><span data-path-to-node="15,3,2,0">Filters all baskets assigned to a specific **campaign**. Multiple values allowed.</span></td></tr><tr><td><span data-path-to-node="15,4,0,0">`condition[datemode]`</span></td><td>processing

  
payout

  
incoming

</td><td>Determines the type of date period:

  
• **processing**: Baskets **validated** within the period

  
• **payout**: Baskets **paid out** within the period

  
• **incoming**: Baskets **recorded** within the period (transaction date)

</td></tr></tbody></table>

**Example:**

`condition[period][from]=01.01.2025&condition[period][to]=31.01.2025&condition[datemode]=processing`

---

### Field Definitions in the Transaction API

The downloaded transactions (e.g., as a `.csv` file) contain the following columns:

<table data-path-to-node="20" id="bkmrk-field-name-descripti" style="width: 98.6905%; height: 1722.58px;"><thead><tr style="height: 29.7969px;"><td style="width: 32.1603%; height: 29.7969px;">**Field Name**</td><td style="width: 67.7021%; height: 29.7969px;">**Description**</td></tr></thead><tbody><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,1,0,0"><strong data-index-in-node="0" data-path-to-node="20,1,0,0">id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,1,1,0">Unique ID of the transaction</span></td></tr><tr style="height: 96.9844px;"><td style="width: 32.1603%; height: 96.9844px;">`<span data-path-to-node="20,2,0,0"><strong data-index-in-node="0" data-path-to-node="20,2,0,0">status</strong></span>`</td><td style="width: 67.7021%; height: 96.9844px;"><span data-path-to-node="20,2,1,0">Status of the transaction</span>

<span data-path-to-node="20,2,1,0">0 - open</span>

<span data-path-to-node="20,2,1,0">1 - confirmed</span>

<span data-path-to-node="20,2,1,0">2 - cancelled</span>

<span data-path-to-node="20,2,1,0">3 - paid</span>

</td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,3,0,0"><strong data-index-in-node="0" data-path-to-node="20,3,0,0">timestamp</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,3,1,0">Timestamp of the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,4,0,0"><strong data-index-in-node="0" data-path-to-node="20,4,0,0">campaign_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,4,1,0">Campaign to which the transaction was assigned</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,5,0,0"><strong data-index-in-node="0" data-path-to-node="20,5,0,0">attribution</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,5,1,0">Amount of the paid attribution</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,6,0,0"><strong data-index-in-node="0" data-path-to-node="20,6,0,0">delivered_tagcode_count</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,6,1,0">Number of executed tags</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,7,0,0"><strong data-index-in-node="0" data-path-to-node="20,7,0,0">delivered_tagcode_serversided_url</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,7,1,0">Transmitted server-side tracking call</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,8,0,0"><strong data-index-in-node="0" data-path-to-node="20,8,0,0">ordertoken</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,8,1,0">Order number transmitted by the advertiser</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,9,0,0"><strong data-index-in-node="0" data-path-to-node="20,9,0,0">source</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,9,1,0">Source of the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,10,0,0"><strong data-index-in-node="0" data-path-to-node="20,10,0,0">project_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,10,1,0">ID of the project to which the transaction was assigned</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,11,0,0"><strong data-index-in-node="0" data-path-to-node="20,11,0,0">admedia_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,11,1,0">Ad media ID through which the transaction was generated</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,12,0,0"><strong data-index-in-node="0" data-path-to-node="20,12,0,0">type</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,12,1,0">Type of transaction (e.g., *Sale*, *Lead*, *View*)</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,13,0,0"><strong data-index-in-node="0" data-path-to-node="20,13,0,0">commission</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,13,1,0">Commission assigned to the publisher (will be updated when the order is changed)</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,13,0,0"><strong data-index-in-node="0" data-path-to-node="20,13,0,0">source_commission</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;">First commission value assigned to the publisher (will not be updated)</td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,14,0,0"><strong data-index-in-node="0" data-path-to-node="20,14,0,0">commission_group_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,14,1,0">Commission group the publisher belonged to when the transaction was generated</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,15,0,0"><strong data-index-in-node="0" data-path-to-node="20,15,0,0">trigger_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,15,1,0">Trigger ID assigned to the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,16,0,0"><strong data-index-in-node="0" data-path-to-node="20,16,0,0">description</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,16,1,0">Description transmitted with the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,17,0,0"><strong data-index-in-node="0" data-path-to-node="20,17,0,0">trigger_value</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,17,1,0">Remuneration rate defined in the corresponding trigger ID at the time of the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,18,0,0"><strong data-index-in-node="0" data-path-to-node="20,18,0,0">trigger_type</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,18,1,0">Type of trigger (fixed remuneration or percentage remuneration)</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,19,0,0"><strong data-index-in-node="0" data-path-to-node="20,19,0,0">turnover</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,19,1,0">Commission-relevant order value</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;"><span data-path-to-node="20,19,0,0">**`attributed_turnover`** </span></td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,19,1,0">Attributed turnover (if attribution model is active)</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,20,0,0"><strong data-index-in-node="0" data-path-to-node="20,20,0,0">original_turnover</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,20,1,0">Order value in the advertiser's currency</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,21,0,0"><strong data-index-in-node="0" data-path-to-node="20,21,0,0">action_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,21,1,0">Action ID transmitted with the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,22,0,0"><strong data-index-in-node="0" data-path-to-node="20,22,0,0">salary_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,22,1,0">ID of the payout process in which the transaction was settled</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,23,0,0"><strong data-index-in-node="0" data-path-to-node="20,23,0,0">session_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,23,1,0">Session ID transmitted with the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,24,0,0"><strong data-index-in-node="0" data-path-to-node="20,24,0,0">order_currency</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,24,1,0">Currency of the order</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,25,0,0"><strong data-index-in-node="0" data-path-to-node="20,25,0,0">status_change_date</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,25,1,0">Date of the last status change</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,26,0,0"><strong data-index-in-node="0" data-path-to-node="20,26,0,0">cancel_reason</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,26,1,0">Reason for cancellation, if the transaction was canceled</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,27,0,0"><strong data-index-in-node="0" data-path-to-node="20,27,0,0">source_turnover</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,27,1,0">Order value transmitted by the advertiser (will not be updated) </span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,28,0,0"><strong data-index-in-node="0" data-path-to-node="20,28,0,0">last_change</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,28,1,0">Timestamp of the last change to the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,29,0,0"><strong data-index-in-node="0" data-path-to-node="20,29,0,0">user_agent</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,29,1,0">Client information of the user who triggered the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,30,0,0"><strong data-index-in-node="0" data-path-to-node="20,30,0,0">order_actions_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,30,1,0">Internal reference to the commission-relevant click or post-view</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,31,0,0"><strong data-index-in-node="0" data-path-to-node="20,31,0,0">bonus_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,31,1,0">ID of a bonus run</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,32,0,0"><strong data-index-in-node="0" data-path-to-node="20,32,0,0">customer_journey_status</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,32,1,0">Internal key figure for the customer journey</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,33,0,0"><strong data-index-in-node="0" data-path-to-node="20,33,0,0">ebestid</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,33,1,0">Hashed order number displayed to the publisher</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,34,0,0"><strong data-index-in-node="0" data-path-to-node="20,34,0,0">order_timestamp</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,34,1,0">Timestamp of the order call</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,35,0,0"><strong data-index-in-node="0" data-path-to-node="20,35,0,0">action_timestamp</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,35,1,0">Timestamp of the action that led to the order</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,36,0,0"><strong data-index-in-node="0" data-path-to-node="20,36,0,0">trigger_title</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,36,1,0">Name of the trigger</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,37,0,0"><strong data-index-in-node="0" data-path-to-node="20,37,0,0">payoutdate</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,37,1,0">Payout date</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,38,0,0"><strong data-index-in-node="0" data-path-to-node="20,38,0,0">campaign_group_title</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,38,1,0">Title of the commission group</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,39,0,0"><strong data-index-in-node="0" data-path-to-node="20,39,0,0">project_title</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,39,1,0">Name of the project to which the transaction was assigned</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,40,0,0"><strong data-index-in-node="0" data-path-to-node="20,40,0,0">campaign_title</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,40,1,0">Name of the campaign assigned to the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,41,0,0"><strong data-index-in-node="0" data-path-to-node="20,41,0,0">advertiser_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,41,1,0">ID of the advertiser to whom the transaction was assigned</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;"><span data-path-to-node="20,41,0,0">**`advertiser_title`** </span></td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,41,1,0">Name of the advertiser to whom the transaction was assigned</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,42,0,0"><strong data-index-in-node="0" data-path-to-node="20,42,0,0">publisher_id</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,42,1,0">ID of the publisher to whom the transaction was assigned</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,43,0,0"><strong data-index-in-node="0" data-path-to-node="20,43,0,0">referrer</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,43,1,0">Page where the click-triggering event occurred</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,44,0,0"><strong data-index-in-node="0" data-path-to-node="20,44,0,0">country</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,44,1,0">Country where the transaction was generated</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,45,0,0"><strong data-index-in-node="0" data-path-to-node="20,45,0,0">subid</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,45,1,0">Sub-ID transmitted with the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,46,0,0"><strong data-index-in-node="0" data-path-to-node="20,46,0,0">publisher_prename</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,46,1,0">First name of the publisher (from system data)</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,47,0,0"><strong data-index-in-node="0" data-path-to-node="20,47,0,0">publisher_surname</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,47,1,0">Last name of the publisher (from system data)</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,48,0,0"><strong data-index-in-node="0" data-path-to-node="20,48,0,0">publisher_searchtitle</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,48,1,0">Search title of the publisher (from system data)</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,49,0,0"><strong data-index-in-node="0" data-path-to-node="20,49,0,0">basket_items</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,49,1,0">Number of items in the shopping cart</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,50,0,0"><strong data-index-in-node="0" data-path-to-node="20,50,0,0">sub_status</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,50,1,0">Advertiser's internal status for managing the transaction</span></td></tr><tr style="height: 30.1094px;"><td style="width: 32.1603%; height: 30.1094px;">`<span data-path-to-node="20,51,0,0"><strong data-index-in-node="0" data-path-to-node="20,51,0,0">visibility</strong></span>`</td><td style="width: 67.7021%; height: 30.1094px;"><span data-path-to-node="20,51,1,0">Visibility for the publisher</span></td></tr><tr><td style="width: 32.1603%;"><span data-path-to-node="20,51,0,0">**`external_sources_entity_id`** </span></td><td style="width: 67.7021%;"><span data-path-to-node="20,51,1,0">(Account) Id of the external source</span></td></tr><tr><td style="width: 32.1603%;">`<span data-path-to-node="20,51,0,0"><strong data-index-in-node="0" data-path-to-node="20,51,0,0">external_sources_currency_code<br></br></strong></span>`</td><td style="width: 67.7021%;"><span data-path-to-node="20,51,1,0">Currency Code imported from the external source</span></td></tr><tr><td style="width: 32.1603%;">`<span data-path-to-node="20,51,0,0"><strong data-index-in-node="0" data-path-to-node="20,51,0,0">external_sources_currency_rate<br></br></strong></span>`</td><td style="width: 67.7021%;"><span data-path-to-node="20,51,1,0">Currency Rate according to the external sources currency code and internal currency code</span></td></tr><tr><td style="width: 32.1603%;">`<span data-path-to-node="20,51,0,0"><strong data-index-in-node="0" data-path-to-node="20,51,0,0">external_sources_turnover<br></br></strong></span>`</td><td style="width: 67.7021%;"><span data-path-to-node="20,51,1,0">Turnover imported from the external source</span></td></tr><tr><td style="width: 32.1603%;">`<span data-path-to-node="20,51,0,0"><strong data-index-in-node="0" data-path-to-node="20,51,0,0">source_project_id<br></br></strong></span>`</td><td style="width: 67.7021%;"><span data-path-to-node="20,51,1,0">Publisher/Project id imported from the external source</span></td></tr><tr><td style="width: 32.1603%;">`<span data-path-to-node="20,51,0,0"><strong data-index-in-node="0" data-path-to-node="20,51,0,0">source_project_title<br></br></strong></span>`</td><td style="width: 67.7021%;"><span data-path-to-node="20,51,1,0">Publisher/Project title imported from the external source</span></td></tr><tr><td style="width: 32.1603%;">`<span data-path-to-node="20,51,0,0"><strong data-index-in-node="0" data-path-to-node="20,51,0,0">turnover_brutto<br></br></strong></span>`</td><td style="width: 67.7021%;"><span data-path-to-node="20,51,1,0">Turnover including tax</span></td></tr></tbody></table>

# Statistics API Documentation

The Statistics API enables the export and evaluation of aggregated performance data within the partner program system. It provides different types of statistics, such as evaluations by day, campaign, project, or ad media, thereby supporting performance analysis and optimization.

All APIs can be accessed within the user interface under the **Data API** menu item.

---

### API Call

`https://<strong>www.domain.de</strong>/api//<strong>ACCESS-TOKEN</strong>/admin/<strong>ID</strong>/get-statistic_daily<strong>.csv</strong>`

<table data-path-to-node="7" id="bkmrk-value-description-ww"><thead><tr><td>**Value**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="7,1,0,0">**www.domain.de**</span></td><td><span data-path-to-node="7,1,1,0">Partner program system domain</span></td></tr><tr><td><span data-path-to-node="7,2,0,0">**ACCESS-TOKEN**</span></td><td><span data-path-to-node="7,2,1,0">User's Access Token</span></td></tr><tr><td><span data-path-to-node="7,3,0,0">**ID**</span></td><td><span data-path-to-node="7,3,1,0">User ID</span></td></tr><tr><td><span data-path-to-node="7,4,0,0">**get-statistic\_{Statistics-Type}**</span></td><td><span data-path-to-node="7,4,1,0">Type of statistics (e.g., daily-based, etc.)</span></td></tr><tr><td><span data-path-to-node="7,5,0,0">**.csv**</span></td><td><span data-path-to-node="7,5,1,0">Download file format</span></td></tr></tbody></table>

---

### Statistics API Filtering

Various parameters can be used as filters for the Statistics API. Below is an overview of all available parameters:

#### Statistics Types

<table data-path-to-node="12" id="bkmrk-statistics-type-para"><thead><tr><td>**Statistics Type**</td><td>**Parameter**</td></tr></thead><tbody><tr><td><span data-path-to-node="12,1,0,0">Statistics by day</span></td><td><span data-path-to-node="12,1,1,0">`get-statistic_daily`</span></td></tr><tr><td><span data-path-to-node="12,2,0,0">Statistics by advertiser</span></td><td><span data-path-to-node="12,2,1,0">`get-statistic_advertiser`</span></td></tr><tr><td><span data-path-to-node="12,3,0,0">Statistics by campaigns</span></td><td><span data-path-to-node="12,3,1,0">`get-statistic_campaign`</span></td></tr><tr><td><span data-path-to-node="12,4,0,0">Statistics by ad media</span></td><td><span data-path-to-node="12,4,1,0">`get-statistic_media`</span></td></tr><tr><td><span data-path-to-node="12,5,0,0">Statistics by publisher</span></td><td><span data-path-to-node="12,5,1,0">`get-statistic_publisher`</span></td></tr><tr><td><span data-path-to-node="12,6,0,0">Statistics by project</span></td><td><span data-path-to-node="12,6,1,0">`get-statistic_project`</span></td></tr><tr><td><span data-path-to-node="12,7,0,0">Statistics by SubID</span></td><td><span data-path-to-node="12,7,1,0">`get-statistic_subid`</span></td></tr><tr><td><span data-path-to-node="12,8,0,0">Statistics by referrer</span></td><td><span data-path-to-node="12,8,1,0">`get-statistic_referrer`</span></td></tr><tr><td><span data-path-to-node="12,9,0,0">Statistics by channel</span></td><td><span data-path-to-node="12,9,1,0">`get-statistic_channel`</span></td></tr><tr><td><span data-path-to-node="12,10,0,0">Statistics by commission group</span></td><td><span data-path-to-node="12,10,1,0">`get-statistic_provisionsgroup`</span></td></tr><tr><td><span data-path-to-node="12,11,0,0">Statistics by trigger</span></td><td><span data-path-to-node="12,11,1,0">`get-statistic_trigger`</span></td></tr><tr><td><span data-path-to-node="12,12,0,0">Statistics by journey</span></td><td><span data-path-to-node="12,12,1,0">`get-statistic_journey`</span></td></tr><tr><td><span data-path-to-node="12,13,0,0">Statistics by A/B test</span></td><td><span data-path-to-node="12,13,1,0">`get-statistic_abtest`</span></td></tr><tr><td><span data-path-to-node="12,14,0,0">Statistics by device type</span></td><td><span data-path-to-node="12,14,1,0">`get-statistic_devicetype`</span></td></tr><tr><td><span data-path-to-node="12,15,0,0">Statistics by device</span></td><td><span data-path-to-node="12,15,1,0">`get-statistic_device`</span></td></tr><tr><td><span data-path-to-node="12,16,0,0">Statistics by browser</span></td><td><span data-path-to-node="12,16,1,0">`get-statistic_browser`</span></td></tr><tr><td><span data-path-to-node="12,17,0,0">Statistics by operating system</span></td><td><span data-path-to-node="12,17,1,0">`get-statistic_os`</span></td></tr><tr><td><span data-path-to-node="12,18,0,0">Statistics by country</span></td><td><span data-path-to-node="12,18,1,0">`get-statistic_geocountry`</span></td></tr><tr><td><span data-path-to-node="12,19,0,0">Manual statistics</span></td><td><span data-path-to-node="12,19,1,0">`get-statistic_manualstatistics`</span></td></tr></tbody></table>

#### General Filter Parameters

<table data-path-to-node="14" id="bkmrk-parameter-value-%2F-ex"><thead><tr><td>**Parameter**</td><td>**Value / Example**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="14,1,0,0">`condition[period][from]`</span></td><td>`<span data-path-to-node="14,1,1,0">01.01.2025</span>`</td><td><span data-path-to-node="14,1,2,0">Start date of the statistics</span></td></tr><tr><td><span data-path-to-node="14,2,0,0">`condition[period][to]`</span></td><td>`<span data-path-to-node="14,2,1,0">31.01.2025</span>`</td><td><span data-path-to-node="14,2,2,0">End date of the statistics</span></td></tr><tr><td><span data-path-to-node="14,3,0,0">`condition[paymentstatus]`</span></td><td>`all` = all

  
`0` = unpaid

  
`1` = paid

</td><td><span data-path-to-node="14,3,2,0">Filters by payout status</span></td></tr><tr><td><span data-path-to-node="14,4,0,0">`condition[dynamicdate]`</span></td><td>`currentmonth` = current month

  
`lastmonth` = previous month

  
`currentweek` = current week

  
`last10d` = last 10 days

</td><td><span data-path-to-node="14,4,2,0">Dynamic time periods</span></td></tr><tr><td><span data-path-to-node="14,5,0,0">`condition[l:publisher]`</span></td><td>`<span data-path-to-node="14,5,1,0">1234,5678</span>`</td><td><span data-path-to-node="14,5,2,0">Filters by publisher IDs</span></td></tr><tr><td><span data-path-to-node="14,6,0,0">`condition[project_id]`</span></td><td>`<span data-path-to-node="14,6,1,0">12345</span>`</td><td><span data-path-to-node="14,6,2,0">Filters by project IDs</span></td></tr><tr><td><span data-path-to-node="14,7,0,0">`condition[bruttodata]`</span></td><td>`<span data-path-to-node="14,7,1,0">true</span>`</td><td><span data-path-to-node="14,7,2,0">Returns gross figures (e.g., clicks/views)</span></td></tr><tr><td><span data-path-to-node="14,8,0,0">`condition[l:mandant]`</span></td><td>`<span data-path-to-node="14,8,1,0">1</span>`</td><td><span data-path-to-node="14,8,2,0">Filters by client (tenant) IDs</span></td></tr><tr><td><span data-path-to-node="14,9,0,0">`condition[l:advertiser]`</span></td><td>`<span data-path-to-node="14,9,1,0">2,3</span>`</td><td><span data-path-to-node="14,9,2,0">Filters by advertiser IDs</span></td></tr><tr><td><span data-path-to-node="14,10,0,0">`condition[l:campaigns]`</span></td><td>`<span data-path-to-node="14,10,1,0">1,3</span>`</td><td><span data-path-to-node="14,10,2,0">Filters by campaign IDs</span></td></tr></tbody></table>

---

### Breakdown by Additional Criteria (Dynamic Statistics)

The statistics can additionally be **broken down (segmented)** by further criteria. The parameter `condition[l:criterions]` is used for this purpose.

<table data-path-to-node="18" id="bkmrk-parameter-value-desc"><thead><tr><td>**Parameter**</td><td>**Value**</td><td>**Description**</td><td>**Example**</td></tr></thead><tbody><tr><td><span data-path-to-node="18,1,0,0">`condition[l:criterions]`</span></td><td><span data-path-to-node="18,1,1,0">`day`</span></td><td><span data-path-to-node="18,1,2,0">Breakdown by day</span></td><td><span data-path-to-node="18,1,3,0">`condition[l:criterions]=day`</span></td></tr><tr><td> </td><td><span data-path-to-node="18,2,1,0">`publisher`</span></td><td><span data-path-to-node="18,2,2,0">Breakdown by publisher</span></td><td><span data-path-to-node="18,2,3,0">`condition[l:criterions]=publisher`</span></td></tr><tr><td> </td><td><span data-path-to-node="18,3,1,0">`media`</span></td><td><span data-path-to-node="18,3,2,0">Breakdown by ad media</span></td><td><span data-path-to-node="18,3,3,0">`condition[l:criterions]=media`</span></td></tr><tr><td> </td><td><span data-path-to-node="18,4,1,0">`advertiser`</span></td><td><span data-path-to-node="18,4,2,0">Breakdown by advertiser</span></td><td><span data-path-to-node="18,4,3,0">`condition[l:criterions]=advertiser`</span></td></tr><tr><td> </td><td><span data-path-to-node="18,5,1,0">`campaign`</span></td><td><span data-path-to-node="18,5,2,0">Breakdown by campaign name</span></td><td><span data-path-to-node="18,5,3,0">`condition[l:criterions]=campaign`</span></td></tr><tr><td> </td><td><span data-path-to-node="18,6,1,0">`campaign_id`</span></td><td><span data-path-to-node="18,6,2,0">Breakdown by campaign ID</span></td><td><span data-path-to-node="18,6,3,0">`condition[l:criterions]=campaign_id`</span></td></tr><tr><td><span data-path-to-node="18,7,1,0">**Combination**</span></td><td>e.g., `day,publisher,media`</td><td>Multi-dimensional breakdown

</td><td><span data-path-to-node="18,7,3,0">`condition[l:criterions]=day,publisher,media`</span></td></tr></tbody></table>

---

### Adding KPIs

You can add additional **Key Performance Indicators (KPIs)** to the statistics via the `condition[l:additional_parameters]` parameter.

<table data-path-to-node="22" id="bkmrk-parameter-value-desc-1"><thead><tr><td>**Parameter**</td><td>**Value**</td><td>**Description**</td><td>**Example**</td></tr></thead><tbody><tr><td><span data-path-to-node="22,1,0,0">`condition[l:additional_parameters]`</span></td><td><span data-path-to-node="22,1,1,0">`all`</span></td><td><span data-path-to-node="22,1,2,0">Adds all available KPIs</span></td><td><span data-path-to-node="22,1,3,0">`condition[l:additional_parameters]=all`</span></td></tr></tbody></table>

## Definition of Fields in the Statistics API

The column names of the downloaded file contain the following parameters:

<table data-layout="default" data-number-column="false" data-table-width="760" data-testid="renderer-table" id="bkmrk-feldname-beschreibun" style="width: 100%; height: 1006.02px;"><tbody><tr style="height: 29.7969px;"><th aria-sort="none" class="ak-renderer-tableHeader-sortable-column__wrapper" data-colwidth="340" style="width: 30.2819%; height: 29.7969px;">**fieldname**

</th><th aria-sort="none" class="ak-renderer-tableHeader-sortable-column__wrapper" data-colwidth="340" style="width: 69.7181%; height: 29.7969px;">**description**

</th></tr><tr style="height: 63.3906px;"><td data-colwidth="340" style="width: 30.2819%; height: 63.3906px;">`criterion`

</td><td data-colwidth="340" style="width: 69.7181%; height: 63.3906px;">The criterion selected for the statistics. For example, if the statistics are grouped by day, this field displays the respective days. If the statistics are grouped by campaign, the corresponding campaign IDs are displayed here. Generally, this field outputs the ID.

</td></tr><tr style="height: 46.5938px;"><td data-colwidth="340" style="width: 30.2819%; height: 46.5938px;">`title`

</td><td data-colwidth="340" style="width: 69.7181%; height: 46.5938px;">The name of the corresponding selected criterion (e.g., <span class="citation-1822 citation-1823 citation-1824 citation-end-1824">the name of the campaign or project).</span>

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`leads_open_count`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Number of open leads.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`leads_confirmed_count`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Number of confirmed leads.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`leads_canceled_count`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Number of canceled leads.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`sales_open_count`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Number of open sales.

</td></tr><tr style="height: 33.4531px;"><td data-colwidth="340" style="width: 30.2819%; height: 33.4531px;">`sales_confirmed_count`

</td><td data-colwidth="340" style="width: 69.7181%; height: 33.4531px;"><span data-path-to-node="6,7,0,0">**<span class="citation-1795 citation-1796 citation-end-1796"><sup class="superscript" data-turn-source-index="29"></sup></span><span class="citation-1795 citation-end-1795"><sup class="superscript" data-turn-source-index="30"></sup></span>**</span><span data-path-to-node="6,7,1,0"><span class="citation-1793 citation-1794 citation-end-1794">Number of confirmed sales.</span></span>

</td></tr><tr style="height: 33.4531px;"><td data-colwidth="340" style="width: 30.2819%; height: 33.4531px;">`sales_canceled_count`

</td><td data-colwidth="340" style="width: 69.7181%; height: 33.4531px;"><span class="citation-1789 citation-1790 citation-end-1790">Number of canceled sales<sup class="superscript" data-turn-source-index="35"></sup></span><span class="citation-1789 citation-end-1789">.</span>

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`all_open_count`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Total number of open leads and sales combined.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`all_confirmed_count`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Total number of confirmed leads and sales combined.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`all_canceled_count`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Total number of canceled leads and sales combined.

</td></tr><tr style="height: 30.1094px;"><td style="width: 30.2819%; height: 30.1094px;">`leads_open_provision`

</td><td style="width: 69.7181%; height: 30.1094px;">Commission total for open leads.

</td></tr><tr style="height: 30.1094px;"><td style="width: 30.2819%; height: 30.1094px;">`leads_confirmed_provision`

</td><td style="width: 69.7181%; height: 30.1094px;">Commission total for confirmed leads.

</td></tr><tr style="height: 30.1094px;"><td style="width: 30.2819%; height: 30.1094px;">`leads_canceled_provision`

</td><td style="width: 69.7181%; height: 30.1094px;">Commission total for canceled leads.

</td></tr><tr style="height: 30.1094px;"><td style="width: 30.2819%; height: 30.1094px;">`sales_open_provision`

</td><td style="width: 69.7181%; height: 30.1094px;">Commission total for open sales.

</td></tr><tr style="height: 30.1094px;"><td style="width: 30.2819%; height: 30.1094px;">`sales_confirmed_provision`

</td><td style="width: 69.7181%; height: 30.1094px;">Commission total for confirmed sales.

</td></tr><tr style="height: 30.1094px;"><td style="width: 30.2819%; height: 30.1094px;">`sales_canceled_provision`

</td><td style="width: 69.7181%; height: 30.1094px;">Commission total for canceled sales.

</td></tr><tr style="height: 30.1094px;"><td style="width: 30.2819%; height: 30.1094px;">`all_open_provision`

</td><td style="width: 69.7181%; height: 30.1094px;">Total commission for open leads and sales combined.

</td></tr><tr style="height: 30.1094px;"><td style="width: 30.2819%; height: 30.1094px;">`all_confirmed_provision`

</td><td style="width: 69.7181%; height: 30.1094px;">Total commission for confirmed leads and sales combined.

</td></tr><tr style="height: 30.1094px;"><td style="width: 30.2819%; height: 30.1094px;">`all_canceled_provision`

</td><td style="width: 69.7181%; height: 30.1094px;">Total commission for canceled leads and sales combined.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`views`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Number of views.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`clicks`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Number of clicks.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`epc`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">The calculated average earnings per click.

</td></tr><tr style="height: 46.5938px;"><td data-colwidth="340" style="width: 30.2819%; height: 46.5938px;">`ctr`

</td><td data-colwidth="340" style="width: 69.7181%; height: 46.5938px;">This value indicates how many users actually clicked on the advertising material after seeing it (Click-Through Rate).

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`leads_canceled_turnover`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Total shopping cart value of canceled leads.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`leads_open_turnover`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Total shopping cart value of open leads.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`leads_confirmed_turnover`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Total shopping cart value of confirmed leads.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`sales_canceled_turnover`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Total shopping cart value of canceled sales.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`sales_open_turnover`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Total shopping cart value of open sales.

</td></tr><tr style="height: 30.1094px;"><td data-colwidth="340" style="width: 30.2819%; height: 30.1094px;">`sales_confirmed_turnover`

</td><td data-colwidth="340" style="width: 69.7181%; height: 30.1094px;">Total shopping cart value of confirmed sales.

</td></tr></tbody></table>

# Touchpoints / Customer Journey API Documentation

The Customer Journey Orders API is used for exporting and analyzing customer journey data recorded via the partner program system. It allows you to retrieve detailed information on individual touchpoints (actions) of an order in a structured CSV format, enabling precise tracking of user paths leading up to a conversion.

The API can be accessed within the user interface under the **Data API** menu item.

---

### API Call

`https://<strong>DOMAIN</strong>/api/<strong>ACCESS-TOKEN</strong>/admin/<strong>ID</strong>/get-customerjourney_orders<strong>.csv</strong>`

<table data-path-to-node="7" id="bkmrk-value-description-do"><thead><tr><td>**Value**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="7,1,0,0">**DOMAIN**</span></td><td><span data-path-to-node="7,1,1,0">Partner program system domain</span></td></tr><tr><td><span data-path-to-node="7,2,0,0">**ACCESS-TOKEN**</span></td><td><span data-path-to-node="7,2,1,0">User's Access Token</span></td></tr><tr><td><span data-path-to-node="7,3,0,0">**ID**</span></td><td><span data-path-to-node="7,3,1,0">User ID</span></td></tr><tr><td><span data-path-to-node="7,4,0,0">**.csv**</span></td><td><span data-path-to-node="7,4,1,0">Download file format</span></td></tr></tbody></table>

---

### Customer Journey API Filtering

Various parameters can be used as filters for the Customer Journey API. Below is an overview of the available parameters:

<table data-path-to-node="11" id="bkmrk-parameter-value-%2F-ex"><thead><tr><td>**Parameter**</td><td>**Value / Example**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="11,1,0,0">`condition[period][from]`</span></td><td><span data-path-to-node="11,1,1,0">2026-02-04</span></td><td><span data-path-to-node="11,1,2,0">Defines the start date of the time period (order date).</span></td></tr><tr><td><span data-path-to-node="11,2,0,0">`condition[period][to]`</span></td><td><span data-path-to-node="11,2,1,0">2026-02-04</span></td><td><span data-path-to-node="11,2,2,0">Defines the end date of the time period (order date).</span></td></tr><tr><td><span data-path-to-node="11,3,0,0">`condition[dynamicdate]`</span></td><td><span data-path-to-node="11,3,1,0">`currentmonth`, `lastmonth`, `last10d`, `currentweek`</span></td><td>Defines a dynamic time period.

  
**Note:** Cannot be used in conjunction with `period[from]` or `period[to]`.

</td></tr><tr><td><span data-path-to-node="11,4,0,0">`condition[l:campaigns]`</span></td><td><span data-path-to-node="11,4,1,0">1</span></td><td><span data-path-to-node="11,4,2,0">Filters all data assigned to a specific campaign. Multiple values allowed.</span></td></tr><tr><td><span data-path-to-node="11,5,0,0">`condition[l:projects]`</span></td><td><span data-path-to-node="11,5,1,0">1234</span></td><td><span data-path-to-node="11,5,2,0">Filters all transactions recorded under the corresponding project ID of the program. Multiple values allowed.</span></td></tr></tbody></table>

#### Examples of Filtered API Calls:

- **Fixed Time Period:** `condition[period][from]=2026-02-04&condition[period][to]=2026-02-04&condition[l:campaigns]=1`
- **Dynamic Time Period:** `condition[dynamicdate]=currentweek&condition[l:projects]=1234`

---

### Field Definitions (Columns)

The downloaded transactions contain the following columns:

<table data-path-to-node="17" id="bkmrk-field-name-descripti"><thead><tr><td>**Field Name**</td><td>**Description**</td></tr></thead><tbody><tr><td>`<span data-path-to-node="17,1,0,0"><strong data-index-in-node="0" data-path-to-node="17,1,0,0">order_id</strong></span>`</td><td><span data-path-to-node="17,1,1,0">Internal ID of the associated transaction / order</span></td></tr><tr><td>`<span data-path-to-node="17,2,0,0"><strong data-index-in-node="0" data-path-to-node="17,2,0,0">ordertoken</strong></span>`</td><td><span data-path-to-node="17,2,1,0">Order number of the transaction from the shop system</span></td></tr><tr><td>`<span data-path-to-node="17,3,0,0"><strong data-index-in-node="0" data-path-to-node="17,3,0,0">campaign_id</strong></span>`</td><td><span data-path-to-node="17,3,1,0">ID of the campaign to which the order is assigned</span></td></tr><tr><td>`<span data-path-to-node="17,4,0,0"><strong data-index-in-node="0" data-path-to-node="17,4,0,0">order_timestamp</strong></span>`</td><td><span data-path-to-node="17,4,1,0">Timestamp of the order receipt (Format: YYYY-MM-DD HH:MM:SS+TZ)</span></td></tr><tr><td>`<span data-path-to-node="17,5,0,0"><strong data-index-in-node="0" data-path-to-node="17,5,0,0">trigger_id</strong></span>`</td><td><span data-path-to-node="17,5,1,0">ID of the trigger assigned to the order</span></td></tr><tr><td>`<span data-path-to-node="17,6,0,0"><strong data-index-in-node="0" data-path-to-node="17,6,0,0">project_id</strong></span>`</td><td><span data-path-to-node="17,6,1,0">ID of the project (Attribution Target)</span></td></tr><tr><td>`<span data-path-to-node="17,7,0,0"><strong data-index-in-node="0" data-path-to-node="17,7,0,0">admedia_id</strong></span>`</td><td><span data-path-to-node="17,7,1,0">ID of the ad media used for the order</span></td></tr><tr><td>`<span data-path-to-node="17,8,0,0"><strong data-index-in-node="0" data-path-to-node="17,8,0,0">action_timestamp</strong></span>`</td><td><span data-path-to-node="17,8,1,0">Timestamp of the click or impression (Touchpoint)</span></td></tr><tr><td>`<span data-path-to-node="17,9,0,0"><strong data-index-in-node="0" data-path-to-node="17,9,0,0">type</strong></span>`</td><td><span data-path-to-node="17,9,1,0">Type of touchpoint (e.g., `click`)</span></td></tr><tr><td>`<span data-path-to-node="17,10,0,0"><strong data-index-in-node="0" data-path-to-node="17,10,0,0">action_campaign_id</strong></span>`</td><td><span data-path-to-node="17,10,1,0">Campaign ID of the specific touchpoint within the journey</span></td></tr><tr><td>`<span data-path-to-node="17,11,0,0"><strong data-index-in-node="0" data-path-to-node="17,11,0,0">action_project_id</strong></span>`</td><td><span data-path-to-node="17,11,1,0">Project ID of the specific touchpoint</span></td></tr><tr><td>`<span data-path-to-node="17,12,0,0"><strong data-index-in-node="0" data-path-to-node="17,12,0,0">action_admedia_id</strong></span>`</td><td><span data-path-to-node="17,12,1,0">Ad media ID of the specific touchpoint</span></td></tr><tr><td>`<span data-path-to-node="17,13,0,0"><strong data-index-in-node="0" data-path-to-node="17,13,0,0">referrer</strong></span>`</td><td><span data-path-to-node="17,13,1,0">The URL from which the user was redirected to the shop (including tracking parameters)</span></td></tr></tbody></table>

# Order Webservice

# Create / easy.affiliate REST-API (Orders)

### 📝 Introduction

A REST-compliant web service is available to automatically create new orders within the easy.affiliate system. New transactions can be transmitted using the HTTP **POST** method. For this purpose, each user receives an authentication token and a login ID, which can be viewed in the frontend.

---

### 🔐 Authentication

The following headers are required to access the API:

<table data-path-to-node="7" id="bkmrk-header-description-t"><thead><tr><td>**Header**</td><td>**Description**</td><td>**Type**</td></tr></thead><tbody><tr><td><span data-path-to-node="7,1,0,0">**Content-Type**</span></td><td><span data-path-to-node="7,1,1,0">Must be set to `application/json`</span></td><td><span data-path-to-node="7,1,2,0">String</span></td></tr><tr><td><span data-path-to-node="7,2,0,0">**X-Network-ID**</span></td><td><span data-path-to-node="7,2,1,0">Network ID: typically `-1` for cross-client (multi-tenant) API</span></td><td><span data-path-to-node="7,2,2,0">Integer</span></td></tr><tr><td><span data-path-to-node="7,3,0,0">**X-Auth-Token**</span></td><td><span data-path-to-node="7,3,1,0">Your API token (visible in the frontend)</span></td><td><span data-path-to-node="7,3,2,0">String</span></td></tr><tr><td><span data-path-to-node="7,4,0,0">**X-Auth-ID**</span></td><td><span data-path-to-node="7,4,1,0">Your login ID (visible in the frontend)</span></td><td><span data-path-to-node="7,4,2,0">Integer</span></td></tr></tbody></table>

---

### 📩 Endpoints

- **Admin:** `https://DOMAIN.de/ws/V6/admin/JSON/Orders`
- **Advertiser:** `https://DOMAIN.de/ws/V6/advertiser/JSON/Orders`

---

### 🧪 Example (cURL)

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-43 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_41c0f5ad5cc76f47","c_5229d7aaa2a28b5d",null,"rc_c10d37afb03bf2aa",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-43 ng-star-inserted"><span class="ng-tns-c1630465722-43">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-43 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-43 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-43 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-43"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-43"></div></div></div>```
curl -X POST \
  -H "Content-Type: application/json" \
  -H "X-Network-ID: -1" \
  -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" \
  -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" \
  -d '[{
    "ordertoken": "testorder001",
    "campaign_id": 1,
    "trigger_id": 2,
    "status": 1,
    "turnover": 199.99,
    "commission": 20.00
  }]' \
  https://SUBDOMAIN.de/ws/V6/admin/JSON/Orders

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-43 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--4" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_41c0f5ad5cc76f47","c_5229d7aaa2a28b5d",null,"rc_c10d37afb03bf2aa",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-43"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-43"></div></div></div>---

### 🧾 Body Parameters

<table data-path-to-node="13" id="bkmrk-parameter-descriptio"><thead><tr><td>**Parameter**</td><td>**Description**</td><td>**Data Type**</td><td>**Required**</td></tr></thead><tbody><tr><td>`<span data-path-to-node="13,1,0,0"><strong data-index-in-node="0" data-path-to-node="13,1,0,0">ordertoken</strong></span>`</td><td><span data-path-to-node="13,1,1,0">Unique identifier for the order. Must be system-wide unique.</span></td><td><span data-path-to-node="13,1,2,0">String</span></td><td><span data-path-to-node="13,1,3,0">✅ Yes</span></td></tr><tr><td>`<span data-path-to-node="13,2,0,0"><strong data-index-in-node="0" data-path-to-node="13,2,0,0">campaign_id</strong></span>`</td><td><span data-path-to-node="13,2,1,0">ID of the campaign to which the order is assigned.</span></td><td><span data-path-to-node="13,2,2,0">Integer</span></td><td><span data-path-to-node="13,2,3,0">✅ Yes</span></td></tr><tr><td>`<span data-path-to-node="13,3,0,0"><strong data-index-in-node="0" data-path-to-node="13,3,0,0">trigger_id</strong></span>`</td><td><span data-path-to-node="13,3,1,0">ID of the trigger, which is mandatory when using `ordertoken`.</span></td><td><span data-path-to-node="13,3,2,0">Integer</span></td><td><span data-path-to-node="13,3,3,0">✅ Yes</span></td></tr><tr><td>`<span data-path-to-node="13,4,0,0"><strong data-index-in-node="0" data-path-to-node="13,4,0,0">status</strong></span>`</td><td><span data-path-to-node="13,4,1,0">Status of the order: `0` = open, `1` = confirmed, `2` = canceled</span></td><td><span data-path-to-node="13,4,2,0">Integer</span></td><td><span data-path-to-node="13,4,3,0">✅ Yes</span></td></tr><tr><td>`<span data-path-to-node="13,5,0,0"><strong data-index-in-node="0" data-path-to-node="13,5,0,0">turnover</strong></span>`</td><td><span data-path-to-node="13,5,1,0">Order value in campaign currency</span></td><td><span data-path-to-node="13,5,2,0">Float</span></td><td><span data-path-to-node="13,5,3,0">✅ Yes</span></td></tr><tr><td>`<span data-path-to-node="13,6,0,0"><strong data-index-in-node="0" data-path-to-node="13,6,0,0">original_turnover</strong></span>`</td><td><span data-path-to-node="13,6,1,0">Order value in foreign currency</span></td><td><span data-path-to-node="13,6,2,0">Float</span></td><td><span data-path-to-node="13,6,3,0">No</span></td></tr><tr><td>`<span data-path-to-node="13,7,0,0"><strong data-index-in-node="0" data-path-to-node="13,7,0,0">commission</strong></span>`</td><td><span data-path-to-node="13,7,1,0">Commission value in campaign currency. Can be passed if calculated manually.</span></td><td><span data-path-to-node="13,7,2,0">Float</span></td><td><span data-path-to-node="13,7,3,0">No</span></td></tr><tr><td>`<span data-path-to-node="13,8,0,0"><strong data-index-in-node="0" data-path-to-node="13,8,0,0">cancel_reason</strong></span>`</td><td><span data-path-to-node="13,8,1,0">Specifies a reason for cancellation if status = `2` (canceled)</span></td><td><span data-path-to-node="13,8,2,0">String</span></td><td><span data-path-to-node="13,8,3,0">No</span></td></tr></tbody></table>

---

### 📘 Notes

Important implementation details:

- **ordertoken:** Must be **unique** – ideally a combination of a timestamp, shop ID, or external order number.
- **trigger\_id:** If you do not know this ID, check your campaign configuration in the frontend.
- **Bulk Actions:** You can also create multiple orders at once by sending them within a single array.
- **Updates:** If an order with the same `ordertoken` already exists in the system, a **PUT request** can be used to update it.

# Update / easy.affiliate REST-API (Orders)

### 📝 Introduction

To enable the automated processing of orders within the easy.affiliate system, easy Marketing GmbH provides a web service API. This allows you to modify existing orders after they have been created, as soon as they go through the validation process.

Each user has an **Authentication Token** and a **Login ID** available, which can be retrieved via the frontend.

- **User ID:** Where is the User ID stored? (See frontend profile)
- **Access Token:** Where is the Access Token stored? (See API settings)

---

## 📩 Endpoints

<table data-path-to-node="8" id="bkmrk-target-group-url-adm"><thead><tr><td>**Target Group**</td><td>**URL**</td></tr></thead><tbody><tr><td><span data-path-to-node="8,1,0,0">**Admin**</span></td><td><span data-path-to-node="8,1,1,0">`https://SUBDOMAIN.de/ws/V6/admin/JSON/Orders`</span></td></tr><tr><td><span data-path-to-node="8,2,0,0">**Advertiser**</span></td><td><span data-path-to-node="8,2,1,0">`https://SUBDOMAIN.de/ws/V6/advertiser/JSON/Orders`</span></td></tr></tbody></table>

---

## 🧪 Examples

#### Example with cURL

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-54 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_872effa7e5419502","c_5229d7aaa2a28b5d",null,"rc_21ce8472f4b004f5",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-54 ng-star-inserted"><span class="ng-tns-c1630465722-54">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-54 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-54 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-54 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-54"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-54"></div></div></div>```
curl -X PUT \
  -H "Content-Type: application/json" \
  -H "X-Network-ID: -1" \
  -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" \
  -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" \
  -d '[{ "campaign_id": 1, "id": 12345, "status": 1, "turnover":100.00, "commission":12.34 },{ "campaign_id": 1, "ordertoken":"123a456b", "status": 2, "turnover": 0.00 }]' \
  https://DOMAIN/ws/V6/admin/JSON/Orders

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-54 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--3" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_872effa7e5419502","c_5229d7aaa2a28b5d",null,"rc_21ce8472f4b004f5",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-54"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-54"></div></div></div>#### Code Example

Multiple orders can be updated at once using the following format. An example request looks like this:

**Headers:**

<table data-path-to-node="16" id="bkmrk-variable-value-%2F-mea"><thead><tr><td>**Variable**</td><td>**Value / Meaning**</td></tr></thead><tbody><tr><td><span data-path-to-node="16,1,0,0">**Content-Type**</span></td><td><span data-path-to-node="16,1,1,0">`application/json`</span></td></tr><tr><td><span data-path-to-node="16,2,0,0">**X-Network-ID**</span></td><td><span data-path-to-node="16,2,1,0">`-1`</span></td></tr><tr><td><span data-path-to-node="16,3,0,0">**X-Auth-Token**</span></td><td><span data-path-to-node="16,3,1,0">`ADMIN_APIUSER_TOKEN`</span></td></tr><tr><td><span data-path-to-node="16,4,0,0">**X-Auth-ID**</span></td><td><span data-path-to-node="16,4,1,0">`ADMIN_APIUSER_LOGIN_ID`</span></td></tr></tbody></table>

**Body:**

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-55 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-json" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_872effa7e5419502","c_5229d7aaa2a28b5d",null,"rc_21ce8472f4b004f5",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-55 ng-star-inserted"><span class="ng-tns-c1630465722-55">JSON</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-55 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-55 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-55 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-55"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-55"></div></div></div>```
[
    {
        "id": "12345",
        "campaign_id": 1,
        "status": 1,
        "turnover": 10.00,
        "commission": 0.99
    },
    {
        "ordertoken": "123a456b",
        "campaign_id": 1,
        "trigger_id": 1,              
        "status": 2,
        "turnover": 9.99,
        "cancel_reason": "Cancellation Reason"
    }
]

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-55 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--5" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_872effa7e5419502","c_5229d7aaa2a28b5d",null,"rc_21ce8472f4b004f5",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-55"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-55"></div></div></div>---

### 🧾 Parameter Explanations

#### Headers

<table data-path-to-node="22" id="bkmrk-variable-meaning-dat"><thead><tr><td>**Variable**</td><td>**Meaning**</td><td>**Data Type**</td></tr></thead><tbody><tr><td><span data-path-to-node="22,1,0,0">**Content-Type**</span></td><td><span data-path-to-node="22,1,1,0">The Content-Type of the request</span></td><td><span data-path-to-node="22,1,2,0">String</span></td></tr><tr><td><span data-path-to-node="22,2,0,0">**X-NETWORKID**</span></td><td><span data-path-to-node="22,2,1,0">The client (tenant) ID is entered here. If only one client exists or you are working across all clients, the value `-1` must be entered.</span></td><td><span data-path-to-node="22,2,2,0">Integer</span></td></tr><tr><td><span data-path-to-node="22,3,0,0">**X-AUTH-TOKEN**</span></td><td><span data-path-to-node="22,3,1,0">The API authentication token of the admin user is stored here.</span></td><td><span data-path-to-node="22,3,2,0">String</span></td></tr><tr><td><span data-path-to-node="22,4,0,0">**X-AUTH-ID**</span></td><td><span data-path-to-node="22,4,1,0">The ID of the admin user is stored here.</span></td><td><span data-path-to-node="22,4,2,0">Integer</span></td></tr></tbody></table>

#### Body

The standard parameters are listed below. However, it is possible to update any available parameter via the API.

<table data-path-to-node="25" id="bkmrk-parameter-explanatio"><thead><tr><td>**Parameter**</td><td>**Explanation**</td><td>**Data Type**</td><td>**Required**</td></tr></thead><tbody><tr><td><span data-path-to-node="25,1,0,0">**id**</span></td><td>The transaction ID.

  
Format: `"id":"ID"`

</td><td><span data-path-to-node="25,1,2,0">String</span></td><td><span data-path-to-node="25,1,3,0">Yes (or `ordertoken`)</span></td></tr><tr><td><span data-path-to-node="25,2,0,0">**ordertoken**</span></td><td>The order token.

  
Format: `"ordertoken":"ORDERTOKEN"`

</td><td><span data-path-to-node="25,2,2,0">String</span></td><td><span data-path-to-node="25,2,3,0">Yes (or `id`)\*</span></td></tr><tr><td><span data-path-to-node="25,3,0,0">**campaign\_id**</span></td><td>The campaign ID.

  
Format: `"campaign_id":CAMPAIGN_ID`

</td><td><span data-path-to-node="25,3,2,0">Integer</span></td><td><span data-path-to-node="25,3,3,0">Yes</span></td></tr><tr><td><span data-path-to-node="25,4,0,0">**trigger\_id**</span></td><td>The trigger ID.

  
Format: `"trigger_id":TRIGGER_ID`

</td><td><span data-path-to-node="25,4,2,0">Integer</span></td><td><span data-path-to-node="25,4,3,0">No, only if `ordertoken` is used.\*</span></td></tr><tr><td><span data-path-to-node="25,5,0,0">**status**</span></td><td>The status of the order.

  
Values: `-5` (pending inquiry), `0` (open), `1` (confirmed), `2` (canceled)

</td><td><span data-path-to-node="25,5,2,0">Integer</span></td><td><span data-path-to-node="25,5,3,0">No</span></td></tr><tr><td><span data-path-to-node="25,6,0,0">**turnover**</span></td><td>The order value of the transaction in campaign currency.

  
Format: `"turnover":TURNOVER`

</td><td><span data-path-to-node="25,6,2,0">Float</span></td><td><span data-path-to-node="25,6,3,0">No</span></td></tr><tr><td><span data-path-to-node="25,7,0,0">**original\_turnover**</span></td><td>The order value of the transaction in foreign currency.

  
Format: `"original_turnover":FOREIGN_CURRENCY_TURNOVER`

</td><td><span data-path-to-node="25,7,2,0">Float</span></td><td><span data-path-to-node="25,7,3,0">No</span></td></tr><tr><td><span data-path-to-node="25,8,0,0">**commission**</span></td><td><span data-path-to-node="25,8,1,0">The commission amount in campaign currency, if you prefer to calculate the commission yourself.</span></td><td><span data-path-to-node="25,8,2,0">Float</span></td><td><span data-path-to-node="25,8,3,0">No</span></td></tr><tr><td>---

<span data-path-to-node="25,9,0,0">**cancel\_reason**</span></td><td>Provide the reason for cancellation.

  
Format: `"cancel_reason":"Cancellation Reason"`

</td><td><span data-path-to-node="25,9,2,0">String</span></td><td><span data-path-to-node="25,9,3,0">No</span></td></tr></tbody></table>

> **\*) Note:** If the `ordertoken` is used, the `trigger_id` becomes a mandatory field in addition to the `campaign_id`.

# Publisher Webservice

# Project Management via the V6 REST-API

### Introduction

The V6 REST-API provides administrators with the ability to manage projects efficiently. Using the `/Projects` endpoint, projects can be created, retrieved, updated, and deleted. Additionally, projects can be filtered using various parameters.

### Endpoint

- **For Admins:** `https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects`

---

### Parameters &amp; Filters

#### Required Parameters (for POST and PUT)

<table data-path-to-node="10" id="bkmrk-parameter-type-descr"><thead><tr><td>**Parameter**</td><td>**Type**</td><td>**Description**</td></tr></thead><tbody><tr><td>`<span data-path-to-node="10,1,0,0"><strong data-index-in-node="0" data-path-to-node="10,1,0,0">title</strong></span>`</td><td><span data-path-to-node="10,1,1,0">String</span></td><td><span data-path-to-node="10,1,2,0">Title of the project (Mandatory)</span></td></tr><tr><td>`<span data-path-to-node="10,2,0,0"><strong data-index-in-node="0" data-path-to-node="10,2,0,0">status</strong></span>`</td><td><span data-path-to-node="10,2,1,0">Integer</span></td><td><span data-path-to-node="10,2,2,0">Status of the project (Mandatory)</span></td></tr><tr><td>`<span data-path-to-node="10,3,0,0"><strong data-index-in-node="0" data-path-to-node="10,3,0,0">url</strong></span>`</td><td><span data-path-to-node="10,3,1,0">String</span></td><td><span data-path-to-node="10,3,2,0">URL of the project (Mandatory)</span></td></tr></tbody></table>

#### Filter Options (for GET)

Filtering can be applied to any column in the `publisher.projects` table, such as:

- `id`
- `status`
- `publisher_id`
- `projecttype`
- `title`
- `url`
- `channel_id`
- `hidden`

**Example of a GET request with filters:**

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-77 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-77 ng-star-inserted"><span class="ng-tns-c1630465722-77">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-77 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-77 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-77 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-77"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-77"></div></div></div>```
curl -X GET -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" "https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects?status=1&publisher_id=10"

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-77 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--2" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-77"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-77"></div></div></div>---

### CRUD Operations

#### GET: Retrieve Projects

Retrieve a list of projects or a specific project by its `id`.

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-78 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash-1" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-78 ng-star-inserted"><span class="ng-tns-c1630465722-78">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-78 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-78 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-78 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-78"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-78"></div></div></div>```
curl -X GET -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" "https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects?id=5"

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-78 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--6" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-78"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-78"></div></div></div>#### POST: Create a New Project

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-79 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash-2" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-79 ng-star-inserted"><span class="ng-tns-c1630465722-79">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-79 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-79 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-79 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-79"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-79"></div></div></div>```
curl -X POST -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" -d '{
  "title": "New Project",
  "status": 1,
  "url": "https://example.com"
}' "https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects"

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-79 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--9" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-79"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-79"></div></div></div>#### PUT: Update an Existing Project

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-80 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash-3" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-80 ng-star-inserted"><span class="ng-tns-c1630465722-80">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-80 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-80 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-80 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-80"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-80"></div></div></div>```
curl -X PUT -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" -d '{
  "id": 5,
  "title": "Modified Project",
  "status": 2,
  "url": "https://updated-example.com"
}' "https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects"

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-80 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--12" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-80"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-80"></div></div></div>#### DELETE: Delete a Project

Delete a project by its `id`.

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-81 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash-4" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-81 ng-star-inserted"><span class="ng-tns-c1630465722-81">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-81 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-81 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-81 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-81"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-81"></div></div></div>```
curl -X DELETE -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" "https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects?id=5"

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-81 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--15" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-81"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-81"></div></div></div>---

### Responses

#### Successful Response

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-82 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-json" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-82 ng-star-inserted"><span class="ng-tns-c1630465722-82">JSON</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-82 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-82 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-82 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-82"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-82"></div></div></div>```
{
  "id": 5,
  "status": 1,
  "publisher_id": 10,
  "projecttype": "page",
  "title": "Project Example",
  "description": "Description of the project",
  "url": "https://example.com",
  "channel_id": 2,
  "project_identifier_string": "abc123",
  "reach": "1000",
  "statistic_type": "internal",
  "external_sources_entity_id": "-1",
  "trackingtemplate": "template",
  "kpi_whitelist": "kpi1,kpi2",
  "hidden": false,
  "login_type": "pub",
  "exclude_from_salary": 0,
  "default_project": false,
  "insert_timestamp": "2025-01-27T12:00:00"
}

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-82 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--19" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-82"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-82"></div></div></div>#### Bad Request

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-83 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-json-1" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-83 ng-star-inserted"><span class="ng-tns-c1630465722-83">JSON</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-83 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-83 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-83 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-83"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-83"></div></div></div>```
{
  "error": "Missing required field: title"
}

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-83 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--22" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_0cd486157c1bdb22","c_5229d7aaa2a28b5d",null,"rc_46956f5b43d8370f",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-83"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-83"></div></div></div>---

### 📘 Error Handling Notes

- If mandatory fields (`title`, `status`, `url`) are missing, an appropriate error message will be returned.
- An invalid or non-existent `id` during a **GET**, **PUT**, or **DELETE** request will result in an empty response or an error message.

# Publisher Management via the V6 REST-API

### Introduction

The V6 REST-API allows administrators to create publishers and retrieve their details. This functionality is currently limited to **CREATE** and **READ** operations.

### Endpoint

- **For Admins:** `https://SUBDOMAIN.de/ws/V6/admin/JSON/Publisher`

---

### CRUD Operations

#### POST: Create Publisher (CREATE)

Creates a new publisher and inserts the corresponding data into the `global.logins` and `global.login_settings` tables.

##### Required Parameters:

<table data-path-to-node="12" id="bkmrk-parameter-type-descr"><thead><tr><td>**Parameter**</td><td>**Type**</td><td>**Description**</td></tr></thead><tbody><tr><td>`<span data-path-to-node="12,1,0,0"><strong data-index-in-node="0" data-path-to-node="12,1,0,0">email</strong></span>`</td><td><span data-path-to-node="12,1,1,0">String</span></td><td><span data-path-to-node="12,1,2,0">Mandatory, max. 255 characters</span></td></tr><tr><td>`<span data-path-to-node="12,2,0,0"><strong data-index-in-node="0" data-path-to-node="12,2,0,0">salutation</strong></span>`</td><td><span data-path-to-node="12,2,1,0">String</span></td><td><span data-path-to-node="12,2,2,0">Mandatory, values: `mr` or `mrs`</span></td></tr><tr><td>`<span data-path-to-node="12,3,0,0"><strong data-index-in-node="0" data-path-to-node="12,3,0,0">prename</strong></span>`</td><td><span data-path-to-node="12,3,1,0">String</span></td><td><span data-path-to-node="12,3,2,0">Mandatory, max. 255 characters</span></td></tr><tr><td>`<span data-path-to-node="12,4,0,0"><strong data-index-in-node="0" data-path-to-node="12,4,0,0">surname</strong></span>`</td><td><span data-path-to-node="12,4,1,0">String</span></td><td><span data-path-to-node="12,4,2,0">Mandatory, max. 255 characters</span></td></tr></tbody></table>

- **Optional Parameters (Excerpt):** `company`, `street`, `zip`, `city`, `telephone`, `country` (ISO 3166 ALPHA-3), `billing_sepa_iban`, `companytype` (`un` for company or `priv` for private), `language_interface` (Default: `DEU`), etc.

##### Example Request:

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-108 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-108 ng-star-inserted"><span class="ng-tns-c1630465722-108">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-108 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-108 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-108 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-108"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-108"></div></div></div>```
curl -X POST -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" -d '{
  "email": "max.mustermann@example.com",
  "salutation": "mr",
  "prename": "Max",
  "surname": "Mustermann",
  "company": "Musterfirma",
  "street": "Musterstraße 1",
  "zip": "12345",
  "city": "Musterstadt",
  "country": "DEU",
  "billing_sepa_owner": "Max Mustermann",
  "billing_sepa_iban": "DE12345678901234567890",
  "billing_sepa_bic": "GENODEF1M01",
  "language_interface": "DEU",
  "billing_mode": 1,
  "billing_media": 1,
  "country_billing": "DEU",
  "country_publisher": "DEU",
  "billing_limit": 50
}' "https://SUBDOMAIN.de/ws/V6/admin/JSON/Publisher"

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-108 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--2" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-108"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-108"></div></div></div>##### Expected Response:

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-109 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-json" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-109 ng-star-inserted"><span class="ng-tns-c1630465722-109">JSON</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-109 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-109 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-109 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-109"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-109"></div></div></div>```
{
  "id": 123,
  "name": "Max Mustermann",
  "email": "max.mustermann@example.com"
}

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-109 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--5" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-109"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-109"></div></div></div>---

#### GET: Retrieve Publisher (READ)

Returns the details of a specific publisher or a list of publishers.

- **Filter Options:** All fields within the table can be used as filters (e.g., `email`, `status`, `prename`, `surname`).

##### Example Request (Specific ID):

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-110 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash-1" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-110 ng-star-inserted"><span class="ng-tns-c1630465722-110">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-110 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-110 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-110 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-110"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-110"></div></div></div>```
curl -X GET -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" "https://SUBDOMAIN.de/ws/V6/admin/JSON/Publisher?id=123"

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-110 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--9" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-110"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-110"></div></div></div>##### Example Request with Filters:

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-111 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash-2" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-111 ng-star-inserted"><span class="ng-tns-c1630465722-111">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-111 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-111 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-111 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-111"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-111"></div></div></div>```
curl -X GET -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" "https://SUBDOMAIN.de/ws/V6/admin/JSON/Publisher?status=1&prename=Max"

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-111 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--12" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-111"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-111"></div></div></div>---

### Error Handling

##### Missing Required Fields (POST):

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-112 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-json-1" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-112 ng-star-inserted"><span class="ng-tns-c1630465722-112">JSON</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-112 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-112 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-112 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-112"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-112"></div></div></div>```
{ 
  "error": "Missing required field: email" 
}

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-112 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--16" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-112"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-112"></div></div></div>##### Publisher Not Found (GET):

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-113 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-json-2" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_f981f1f2306930af","c_5229d7aaa2a28b5d",null,"rc_5a2a41ee6108b36c",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-113 ng-star-inserted"><span class="ng-tns-c1630465722-113">JSON</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-113 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-113 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-113 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-113"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-113"></div></div></div>```
{
  "error": "Publisher not found"
}
```

# Connecting an External API

It is possible to integrate an external API into the system for any external program. These APIs must be activated by our support team. To request activation, please send an email to **support@easy-m.de**. We will then verify whether the API is already available or if it can be newly integrated.

### Preparation

Before you can configure an API for a campaign, the campaign must first be created in the system.

### Execution

To assign an API to a campaign, navigate to the **Campaign Control Center**. From there, proceed to the **"mappings"** section:

[![image.png](https://docs-en.easy-m.de/uploads/images/gallery/2026-05/scaled-1680-/UI4image.png)](https://docs-en.easy-m.de/uploads/images/gallery/2026-05/UI4image.png)

All APIs currently available for the campaign will be displayed there.

[![image.png](https://docs-en.easy-m.de/uploads/images/gallery/2026-05/scaled-1680-/Tcvimage.png)](https://docs-en.easy-m.de/uploads/images/gallery/2026-05/Tcvimage.png)

Finally, click the **"create new mapping"** button to enter the credentials and data required for the API.

### External API Credentials

To communicate with the API of an external service provider, corresponding login or access credentials are required. Where to find these credentials within the provider's respective platforms is explained in the individual integration guides.

# Admedia Webservice

# Admedia API (V6) - POST (Create)

### Einleitung

To create ad media via an automated process rather than manually in the easy.affiliate system, easy Marketing GmbH provides a web service API. For this purpose, each user has an **Authentication Token** and a **Login ID** available, which are provided via the frontend.

- **User ID:** Where is the User ID stored? (See frontend profile)
- **Access Token:** Where is the Access Token stored? (See API settings)

### Endpoints

- **Endpoint for Admin:** `https://SUBDOMAIN.de/ws/V6/admin/JSON/Admedia`
- **Endpoint for Advertiser:** `https://SUBDOMAIN.de/ws/V6/advertiser/JSON/Admedia`

---

### Example with cURL

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-136 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_98fea8d792c99e53","c_5229d7aaa2a28b5d",null,"rc_d6ce4684816cf8e3",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-136 ng-star-inserted"><span class="ng-tns-c1630465722-136">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-136 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-136 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-136 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-136"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-136"></div></div></div>```
curl -X POST -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" -d "$EXAMPLE_JSON_DATA" https://DOMAIN/ws/V6/admin/JSON/Admedia

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-136 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--2" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_98fea8d792c99e53","c_5229d7aaa2a28b5d",null,"rc_d6ce4684816cf8e3",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-136"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-136"></div></div></div>### Code Example

Ad media can be created using the following format. An example request looks like this:

**Headers:**

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-137 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-http" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_98fea8d792c99e53","c_5229d7aaa2a28b5d",null,"rc_d6ce4684816cf8e3",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-137 ng-star-inserted"><span class="ng-tns-c1630465722-137">HTTP</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-137 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-137 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-137 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-137"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-137"></div></div></div>```
Content-Type: application/json
X-Network-ID: -1
X-Auth-Token: ADMIN_APIUSER_TOKEN
X-Auth-ID: ADMIN_APIUSER_LOGIN_ID

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-137 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--5" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_98fea8d792c99e53","c_5229d7aaa2a28b5d",null,"rc_d6ce4684816cf8e3",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-137"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-137"></div></div></div>**Body:**

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-138 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-json" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_98fea8d792c99e53","c_5229d7aaa2a28b5d",null,"rc_d6ce4684816cf8e3",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-138 ng-star-inserted"><span class="ng-tns-c1630465722-138">JSON</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-138 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-138 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-138 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-138"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-138"></div></div></div>```
{
    "campaign_id": 1,
    "project_ids": [50012],
    "title": "Ad Media Title",
    "deeplink": "https://example.de/link",
    "category_id": 5,
    "mediatype": "text",
    "linktext": "Click here",
    "status": 1
}

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-138 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--8" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_98fea8d792c99e53","c_5229d7aaa2a28b5d",null,"rc_d6ce4684816cf8e3",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-138"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-138"></div></div></div>---

### Parameter Explanations

#### Headers

<table data-path-to-node="20" id="bkmrk-variable-meaning-dat"><thead><tr><td>**Variable**</td><td>**Meaning**</td><td>**Data Type**</td></tr></thead><tbody><tr><td><span data-path-to-node="20,1,0,0">**Content-Type**</span></td><td><span data-path-to-node="20,1,1,0">The Content-Type of the request</span></td><td><span data-path-to-node="20,1,2,0">String</span></td></tr><tr><td><span data-path-to-node="20,2,0,0">**X-Network-ID**</span></td><td><span data-path-to-node="20,2,1,0">The client (tenant) ID or `-1`</span></td><td><span data-path-to-node="20,2,2,0">Integer</span></td></tr><tr><td><span data-path-to-node="20,3,0,0">**X-Auth-Token**</span></td><td><span data-path-to-node="20,3,1,0">The API authentication token of the admin user</span></td><td><span data-path-to-node="20,3,2,0">String</span></td></tr><tr><td><span data-path-to-node="20,4,0,0">**X-Auth-ID**</span></td><td><span data-path-to-node="20,4,1,0">The ID of the admin user</span></td><td><span data-path-to-node="20,4,2,0">Integer</span></td></tr></tbody></table>

#### Body

<table data-path-to-node="22" id="bkmrk-parameter-explanatio-1"><thead><tr><td>**Parameter**</td><td>**Explanation**</td><td>**Data Type**</td><td>**Required**</td></tr></thead><tbody><tr><td>`<span data-path-to-node="22,1,0,0"><strong data-index-in-node="0" data-path-to-node="22,1,0,0">campaign_id</strong></span>`</td><td><span data-path-to-node="22,1,1,0">ID of the campaign</span></td><td><span data-path-to-node="22,1,2,0">Integer</span></td><td><span data-path-to-node="22,1,3,0">Yes</span></td></tr><tr><td>`<span data-path-to-node="22,2,0,0"><strong data-index-in-node="0" data-path-to-node="22,2,0,0">project_ids</strong></span>`</td><td><span data-path-to-node="22,2,1,0">Whitelist of project IDs</span></td><td><span data-path-to-node="22,2,2,0">JSON Array</span></td><td><span data-path-to-node="22,2,3,0">No</span></td></tr><tr><td>`<span data-path-to-node="22,3,0,0"><strong data-index-in-node="0" data-path-to-node="22,3,0,0">title</strong></span>`</td><td><span data-path-to-node="22,3,1,0">Title of the ad media</span></td><td><span data-path-to-node="22,3,2,0">String</span></td><td><span data-path-to-node="22,3,3,0">Yes</span></td></tr><tr><td>`<span data-path-to-node="22,4,0,0"><strong data-index-in-node="0" data-path-to-node="22,4,0,0">deeplink</strong></span>`</td><td><span data-path-to-node="22,4,1,0">Deeplink of the ad media</span></td><td><span data-path-to-node="22,4,2,0">String</span></td><td><span data-path-to-node="22,4,3,0">Yes</span></td></tr><tr><td>`<span data-path-to-node="22,5,0,0"><strong data-index-in-node="0" data-path-to-node="22,5,0,0">category_id</strong></span>`</td><td><span data-path-to-node="22,5,1,0">ID of the category</span></td><td><span data-path-to-node="22,5,2,0">Integer</span></td><td><span data-path-to-node="22,5,3,0">Yes</span></td></tr><tr><td>`<span data-path-to-node="22,6,0,0"><strong data-index-in-node="0" data-path-to-node="22,6,0,0">click_tracking_getparameter</strong></span>`</td><td><span data-path-to-node="22,6,1,0">Click tracking parameters</span></td><td><span data-path-to-node="22,6,2,0">String</span></td><td><span data-path-to-node="22,6,3,0">No</span></td></tr><tr><td>`<span data-path-to-node="22,7,0,0"><strong data-index-in-node="0" data-path-to-node="22,7,0,0">valid_from</strong></span>`</td><td><span data-path-to-node="22,7,1,0">"Valid from" date</span></td><td><span data-path-to-node="22,7,2,0">String</span></td><td><span data-path-to-node="22,7,3,0">No</span></td></tr><tr><td>`<span data-path-to-node="22,8,0,0"><strong data-index-in-node="0" data-path-to-node="22,8,0,0">valid_until</strong></span>`</td><td><span data-path-to-node="22,8,1,0">"Valid until" date</span></td><td><span data-path-to-node="22,8,2,0">String</span></td><td><span data-path-to-node="22,8,3,0">No</span></td></tr><tr><td>`<span data-path-to-node="22,9,0,0"><strong data-index-in-node="0" data-path-to-node="22,9,0,0">mediatype</strong></span>`</td><td><span data-path-to-node="22,9,1,0">Type of ad media (e.g., `text`, `banner`)</span></td><td><span data-path-to-node="22,9,2,0">String</span></td><td><span data-path-to-node="22,9,3,0">Yes</span></td></tr><tr><td>`<span data-path-to-node="22,10,0,0"><strong data-index-in-node="0" data-path-to-node="22,10,0,0">linktext</strong></span>`</td><td><span data-path-to-node="22,10,1,0">Link text</span></td><td><span data-path-to-node="22,10,2,0">String</span></td><td><span data-path-to-node="22,10,3,0">Yes, if type is `text`</span></td></tr><tr><td>`<span data-path-to-node="22,11,0,0"><strong data-index-in-node="0" data-path-to-node="22,11,0,0">imageurl</strong></span>`</td><td><span data-path-to-node="22,11,1,0">Image URL</span></td><td><span data-path-to-node="22,11,2,0">String</span></td><td><span data-path-to-node="22,11,3,0">Yes, if type is `banner`</span></td></tr><tr><td>`<span data-path-to-node="22,12,0,0"><strong data-index-in-node="0" data-path-to-node="22,12,0,0">size_width</strong></span>`</td><td><span data-path-to-node="22,12,1,0">Width of the banner</span></td><td><span data-path-to-node="22,12,2,0">String</span></td><td><span data-path-to-node="22,12,3,0">Yes, if type is `banner`</span></td></tr><tr><td>`<span data-path-to-node="22,13,0,0"><strong data-index-in-node="0" data-path-to-node="22,13,0,0">size_height</strong></span>`</td><td><span data-path-to-node="22,13,1,0">Height of the banner</span></td><td><span data-path-to-node="22,13,2,0">String</span></td><td><span data-path-to-node="22,13,3,0">Yes, if type is `banner`</span></td></tr><tr><td>`<span data-path-to-node="22,14,0,0"><strong data-index-in-node="0" data-path-to-node="22,14,0,0">status</strong></span>`</td><td><span data-path-to-node="22,14,1,0">Status of the ad media</span></td><td><span data-path-to-node="22,14,2,0">Integer</span></td><td><span data-path-to-node="22,14,3,0">Yes</span></td></tr></tbody></table>

---

### Response

Upon successful creation, the API returns the following information as JSON:

- **Ad Media ID:** `Integer`
- **Ad Media Title:** `String`
- **Ad Media Category:** `String`
- **View Link:** `String`
- **Click Link:** `String`
- **View Link (Shortener):** `String`
- **Click Link (Shortener):** `String`
- **Adcode:** `String`

# Admedia API (V6) - GET (Read)

### Querying Generated Ad Media via the V6 REST-API

To ensure simple and efficient management of generated ad media, the V6 REST-API provides a query function. This feature allows users to retrieve relevant data regarding the ad media and their corresponding tracking links.

### Endpoint

- **For Admins:** `https://SUBDOMAIN.de/ws/V6/admin/JSON/Admedia`

### Required Parameters

- **campaign\_id:** ID of the respective campaign (**Mandatory**)
- **project\_id:** ID of the respective project (Optional)

---

### Example Request with cURL

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-149 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_065f91d4ef8af021","c_5229d7aaa2a28b5d",null,"rc_eaf189623487fc83",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-149 ng-star-inserted"><span class="ng-tns-c1630465722-149">Bash</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-149 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-149 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-149 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-149"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-149"></div></div></div>```
curl -X GET -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" https://DOMAIN/ws/V6/admin/JSON/Admedia?campaign_id=1&project_id=50001

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-149 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--2" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_065f91d4ef8af021","c_5229d7aaa2a28b5d",null,"rc_eaf189623487fc83",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-149"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-149"></div></div></div>---

### Expected Response

Upon a successful request, the API returns the following information about the ad media in JSON format:

- **id:** ID of the ad media (`Integer`)
- **title:** Title of the ad media (`String`)
- **campaign\_id:** ID of the assigned campaign (`Integer`)
- **project\_id:** ID of the assigned project (`Integer`, if provided)
- **clicklink:** Click link of the ad media (`String`)
- **viewlink:** View link of the ad media (`String`)
- **adcode:** JavaScript code / HTML code of the tracking link (`String`)

---

### 📘 Error Handling

- If the `campaign_id` is missing or invalid, an appropriate error message will be returned.
- If no data exists for the specified parameters, an empty dataset (array) will be returned.

# Basket Webservice / Update API

### 📝 Introduction

We offer a web service API for the automated processing of shopping carts. This allows for the subsequent adjustment of already existing baskets. For access, each user receives an Access Token and a User ID, which are provided via the frontend.

---

### 🔐 Authentication

The following headers are required to access the API:

<table data-path-to-node="7" id="bkmrk-header-description-t"><thead><tr><td>**Header**</td><td>**Description**</td><td>**Type**</td></tr></thead><tbody><tr><td><span data-path-to-node="7,1,0,0">**Content-Type**</span></td><td><span data-path-to-node="7,1,1,0">The Content-Type of the request</span></td><td><span data-path-to-node="7,1,2,0">String</span></td></tr><tr><td><span data-path-to-node="7,2,0,0">**X-Network-ID**</span></td><td><span data-path-to-node="7,2,1,0">Network ID: typically `-1` for cross-client (multi-tenant) API</span></td><td><span data-path-to-node="7,2,2,0">Integer</span></td></tr><tr><td><span data-path-to-node="7,3,0,0">**X-Auth-Token**</span></td><td><span data-path-to-node="7,3,1,0">Your Access Token (visible in the frontend)</span></td><td><span data-path-to-node="7,3,2,0">String</span></td></tr><tr><td><span data-path-to-node="7,4,0,0">**X-Auth-ID**</span></td><td><span data-path-to-node="7,4,1,0">Your User ID (visible in the frontend)</span></td><td><span data-path-to-node="7,4,2,0">Integer</span></td></tr></tbody></table>

---

### 📩 Endpoints

- **Admin:** `https://SUBDOMAIN.de/ws/V6/admin/JSON/Baskets`
- **Advertiser:** `https://SUBDOMAIN.de/ws/V6/advertiser/JSON/Baskets`

---

### 🧪 Example (cURL)

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-162 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-bash" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_a0358b217cddd7ed","c_5229d7aaa2a28b5d",null,"rc_b8bc6142e9f97b18",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-162 ng-star-inserted"></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-162"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-162"></div></div></div>```
curl -X PUT -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: AUTH-TOKEN" -H "X-Auth-ID: USER-ID" -d '[{"basket_item_id": 76041, "amount": 2, "status": "0", "additional": {"variable1": "text", "variable2": 1}}]' https://SUB.DOMAIN.DE/ws/V6/admin/JSON/Baskets

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-162 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--4" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_a0358b217cddd7ed","c_5229d7aaa2a28b5d",null,"rc_b8bc6142e9f97b18",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-162"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-162"></div></div></div>---

### 🧾 Body Parameters

<table data-path-to-node="13" id="bkmrk-parameter-descriptio"><thead><tr><td>**Parameter**</td><td>**Description**</td><td>**Data Type**</td><td>**Required**</td></tr></thead><tbody><tr><td><span data-path-to-node="13,1,0,0">**basket\_item\_id**</span></td><td><span data-path-to-node="13,1,1,0">Unique ID of the basket item</span></td><td><span data-path-to-node="13,1,2,0">Integer</span></td><td><span data-path-to-node="13,1,3,0">✅ Yes</span></td></tr><tr><td><span data-path-to-node="13,2,0,0">**amount**</span></td><td><span data-path-to-node="13,2,1,0">Quantity of the basket item</span></td><td><span data-path-to-node="13,2,2,0">Integer</span></td><td><span data-path-to-node="13,2,3,0">No</span></td></tr><tr><td><span data-path-to-node="13,3,0,0">**price**</span></td><td><span data-path-to-node="13,3,1,0">Net price of the basket item</span></td><td><span data-path-to-node="13,3,2,0">Float</span></td><td><span data-path-to-node="13,3,3,0">No</span></td></tr><tr><td><span data-path-to-node="13,4,0,0">**status**</span></td><td><span data-path-to-node="13,4,1,0">Status of the order: `0` = open, `1` = confirmed, `2` = canceled</span></td><td><span data-path-to-node="13,4,2,0">Integer</span></td><td><span data-path-to-node="13,4,3,0">✅ Yes</span></td></tr><tr><td><span data-path-to-node="13,5,0,0">**turnover**</span></td><td><span data-path-to-node="13,5,1,0">Order value in campaign currency</span></td><td><span data-path-to-node="13,5,2,0">Float</span></td><td><span data-path-to-node="13,5,3,0">✅ Yes</span></td></tr><tr><td><span data-path-to-node="13,6,0,0">**additional**</span></td><td><span data-path-to-node="13,6,1,0">Additional information regarding the basket item</span></td><td><span data-path-to-node="13,6,2,0">JSON</span></td><td><span data-path-to-node="13,6,3,0">No</span></td></tr></tbody></table>

---

### Example Request

**Headers:**

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-163 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-http" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_a0358b217cddd7ed","c_5229d7aaa2a28b5d",null,"rc_b8bc6142e9f97b18",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-163 ng-star-inserted"><span class="ng-tns-c1630465722-163">HTTP</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-163 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-163 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-163 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-163"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-163"></div></div></div>```
Content-Type: application/json
X-Network-ID: -1
X-Auth-Token: ACCESS-TOKEN
X-Auth-ID: USER-ID

```

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-163 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk--8" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_a0358b217cddd7ed","c_5229d7aaa2a28b5d",null,"rc_b8bc6142e9f97b18",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-163"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-163"></div></div></div>**Body:**

<div _ngcontent-ng-c1630465722="" class="code-block ng-tns-c1630465722-164 ng-animate-disabled ng-trigger ng-trigger-codeBlockRevealAnimation" id="bkmrk-json" jslog="223238;track:impression,attention;BardVeMetadataKey:[["r_a0358b217cddd7ed","c_5229d7aaa2a28b5d",null,"rc_b8bc6142e9f97b18",null,null,"en",null,1,null,null,1,0]]"><div _ngcontent-ng-c1630465722="" class="code-block-decoration header-formatted gds-title-s ng-tns-c1630465722-164 ng-star-inserted"><span class="ng-tns-c1630465722-164">JSON</span><div _ngcontent-ng-c1630465722="" class="buttons ng-tns-c1630465722-164 ng-star-inserted"><button aria-label="Code herunterladen" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger download-button ng-tns-c1630465722-164 mat-unthemed ng-star-inserted"></button><button aria-label="Code kopieren" class="mdc-icon-button mat-mdc-icon-button mat-mdc-button-base mat-mdc-tooltip-trigger copy-button ng-tns-c1630465722-164 mat-unthemed ng-star-inserted"></button></div></div><div _ngcontent-ng-c1630465722="" class="formatted-code-block-internal-container ng-tns-c1630465722-164"><div _ngcontent-ng-c1630465722="" class="animated-opacity ng-tns-c1630465722-164"></div></div></div>```
[
    {
        "basket_item_id": 76041, 
        "amount": 1, 
        "status": "1", 
        "additional": {
            "variable1": "text", 
            "variable2": 1
        }
    }
]
```