Marketplace Seller API 2.0

https://sellerapi.kaufland.com/
Admin
The Marketplace Seller API is a REST API that enables Kaufland marketplace sellers to...
Tokens:136,362
Snippets:1,013
Trust Score:9.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Product by EAN Example

Source: https://sellerapi.kaufland.com/swagger.json

Example value for the EAN path parameter required to retrieve a specific product.

```json
"4010884503135"
```

--------------------------------

### Get Product List Search Example

Source: https://sellerapi.kaufland.com/swagger.json

Example value for the search query parameter 'q' used to find products.

```json
"Book"
```

--------------------------------

### Get Product List Response Example

Source: https://sellerapi.kaufland.com/swagger.json

Example response structure for the product search endpoint, including product data and pagination details.

```json
{
  "data": [
    {
      "id_product": 2,
      "storefront": "de",
      "title": "Ein unmoralisches Angebot",
      "eans": [
        "4010884503135"
      ],
      "id_category": 6201,
      "main_picture": "https://media.cdn.kaufland.de/product-images/original/668f121c18ec6e2a8eb0888c6e3c5447.jpg",
      "manufacturer": "",
      "url": "https://www.kaufland.de/product/2/",
      "age_rating": 12,
      "is_valid": true,
      "dangerous_goods_li_shipping": null,
      "danger_label_9A": null
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}
```

--------------------------------

### Get Return by ID Path Parameter Example

Source: https://sellerapi.kaufland.com/swagger.json

Example of the id_return path parameter used when retrieving return details.

```json
675849321
```

--------------------------------

### Get Offers Rankings Example Response

Source: https://sellerapi.kaufland.com/swagger.json

Example response for the buybox offers rankings endpoint, showing product data and unit details.

```json
{
  "data": {
    "id_product": 8475634,
    "storefront": "cz",
    "condition": "new",
    "num_units": 1,
    "units": [
      {
        "buybox_rank": 1,
        "seller": "Kaufland Seller",
        "price": 1999,
        "delivery_time_max": 4,
        "delivery_time_min": 3,
        "shipping_rate": 700,
        "fulfillment_type": "fulfilled_by_merchant",
        "condition": "NEW",
        "id_unit": 28374940,
        "id_offer": "SKU1342"
      }
    ]
  }
}
```

--------------------------------

### Example Response for GET /vouchers/{id_voucher}/products

Source: https://sellerapi.kaufland.com/?page=vouchers

The response contains a list of products with their associated performance metrics and a pagination object indicating the total count and current offset.

```json
{
    "data": [
        // each entry: id_product (item ID), acos (see Performance Metrics),
        // roas (see Performance Metrics), number_of_redeemed_vouchers (redemptions on this product only)
        { "id_product": 306215652, "acos": 0.8, "roas": 4.1, "number_of_redeemed_vouchers": 12 },
        { "id_product": 533036228, "acos": 0, "roas": 0, "number_of_redeemed_vouchers": 0 }
    ],
    // pagination cursor; total is the count of products attached to the voucher matching the filters
    "pagination": {
        "offset": 0,
        "limit": 30,
        "total": 2
    }
}
```

--------------------------------

### Example Response for GET /vouchers

Source: https://sellerapi.kaufland.com/?page=vouchers

A sample JSON response showing the structure of a voucher object, including status, discount details, and performance metrics, alongside pagination metadata.

```json
{
    "data": [
        {
            "id_voucher": 4,
            "title": "Christmas Sale",
            // lifecycle state: new | active | inactive | expired | consumed | deleted
            "status": "new",
            "storefront": "de",
            // PERCENTAGE or ABSOLUTE
            "discount_type": "PERCENTAGE",
            // for PERCENTAGE: integer 1–85. For ABSOLUTE: amount in cents
            "discount_amount": 10,
            "begin_at": "2025-12-16",
            "end_at": "2025-12-20",
            // server-set creation timestamp (YYYY-MM-DD)
            "created_at": "2025-12-16",
            "usage_limit": 100,
            "export_to_third_parties": false,
            // total redemptions across every product attached to this voucher
            "number_of_redeemed_vouchers": 0,
            // total fee paid by the seller for this voucher (in cents)
            "voucher_fee": 0,
            // total revenue generated through this voucher (in cents)
            "total_sales": 0,
            // see Performance Metrics
            "acos": 0,
            // see Performance Metrics
            "roas": 0,
            // number of products currently attached to the voucher
            "products_count": 2
        }
    ],
    // pagination cursor; total is the count of vouchers matching the filters, not the page size
    "pagination": {
        "offset": 0,
        "limit": 30,
        "total": 200
    }
}
```

--------------------------------

### Get Product Data Import Files Response

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for retrieving a list of product data import files, including status and pagination details.

```json
{"data":[{"id_import_file":123,"uri":"https://upload.wikimedia.org/wikipedia/commons/4/44/Kaufland_201x_logo.svg","status":"ABORTED","note":"Import aborted, no changes (2021-05-31 01:24:09)","total_lines":123,"current_line":123,"ts_created":"2021-05-31 01:06:05","ts_updated":"2021-05-31 01:06:05","ts_last_row_updated":null,"ts_completed":null,"error_count":0,"async_import_done":0}],"pagination":{"total":1,"limit":20,"offset":0}}
```

--------------------------------

### Initialize Return Request Example

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON body for initializing a return for one or more order units.

```json
[{"id_order_unit":314567898654242,"reason":"wrong_size","note":"A note"}]
```

--------------------------------

### GET /vouchers/{id_voucher} Example Response

Source: https://sellerapi.kaufland.com/?page=vouchers

The response body for a successful voucher retrieval request, containing metadata, discount details, and performance metrics.

```json
{
    "data": {
        "id_voucher": 4,
        "title": "Christmas Sale",
        // lifecycle state: new | active | inactive | expired | consumed | deleted
        "status": "new",
        "storefront": "de",
        // PERCENTAGE or ABSOLUTE
        "discount_type": "PERCENTAGE",
        // for PERCENTAGE: integer 1–85. For ABSOLUTE: amount in cents
        "discount_amount": 10,
        "begin_at": "2025-12-16",
        "end_at": "2025-12-20",
        // server-set creation timestamp (YYYY-MM-DD)
        "created_at": "2025-12-16",
        "usage_limit": 100,
        // total redemptions across every product attached to this voucher
        "number_of_redeemed_vouchers": 42,
        // total fee paid by the seller for this voucher (in cents)
        "voucher_fee": 5,
        // total revenue generated through this voucher (in cents)
        "total_sales": 1500,
        // see Performance Metrics
        "acos": 1.25,
        // see Performance Metrics
        "roas": 3.75,
        "export_to_third_parties": false
    }
}
```

--------------------------------

### Get Assortment Insight Example Response

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for the GetAssortmentInsight operation, showing product data including EAN, item name, pricing, and sales rank.

```json
{
  "data": [
    {
      "ean": "04062784153675",
      "item_name": "Joe Nimble Trail Addict WR",
      "brand": "Joe Nimble",
      "category": "Fashion & accessories",
      "category_2": "Shoes & accessories",
      "buybox_price_l_90_day": 1716,
      "buybox_price_l_60_day": 1724,
      "buybox_price_l_30_day": 1696,
      "buybox_price_current": 1556,
      "sales_rank": 61217,
      "external_rank": 12815,
      "external_demand_indicator": "Low",
      "benchmark_price_min": 1500,
      "benchmark_price_max": 1800,
      "external_bestseller_missed": false,
      "popular_product_bad_priced": false,
      "kaufland_bestseller": false,
      "currency": "EUR"
    },
    {
      "ean": "04067896931531",
      "item_name": "HJC Helm C10 Epik",
      "brand": null,
      "category": "Auto & Motorrad",
      "category_2": null,
      "buybox_price_l_90_day": null,
      "buybox_price_l_60_day": null,
      "buybox_price_l_30_day": null,
      "buybox_price_current": null,
      "sales_rank": null,
      "external_rank": 6291,
      "external_demand_indicator": "Very low",
      "benchmark_price_min": null,
      "benchmark_price_max": null,
      "external_bestseller_missed": false,
      "popular_product_bad_priced": false,
      "kaufland_bestseller": false,
      "currency": "EUR"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "total": 2
  }
}
```

--------------------------------

### GET /products/ean/{ean}

Source: https://sellerapi.kaufland.com/?page=endpoints

Get a product by EAN.

```APIDOC
## GET /products/ean/{ean}

### Description
Get a product by EAN.

### Method
GET

### Endpoint
/products/ean/{ean}

### Parameters
#### Path Parameters
- **ean** (string) - Required - The EAN of the product.
```

--------------------------------

### MARK_UNIT_CANCELLED command example

Source: https://sellerapi.kaufland.com/?page=order-files

Example of a line in a command file to cancel a unit due to inventory issues.

```text
MARK_UNIT_CANCELLED;56896348978;NoInventory
```

--------------------------------

### GET /import-files/order-command

Source: https://sellerapi.kaufland.com/swagger.json

Get a list of your order command import files.

```APIDOC
## GET /import-files/order-command

### Description
Get a list of your order command import files.

### Method
GET

### Endpoint
/import-files/order-command

### Parameters
#### Query Parameters
- **status** (ImportStatus) - Optional - File status filter
- **ts_created_iso** (string) - Optional - Filter by file creation timestamp (ISO-8601)
- **ts_updated_iso** (string) - Optional - Filter by file last-update timestamp (ISO-8601)
- **sort** (ImportFilesSortBy) - Optional - Sorting of result set
- **limit** (integer) - Optional - Desired size of result set
- **offset** (integer) - Optional - Offset applied to result set

### Response
#### Success Response (200)
- **CollectionApiResponse_ImportFileOrderCommand_** (object) - Success
```

--------------------------------

### Refund an order unit example

Source: https://sellerapi.kaufland.com/swagger.json

Example request body for sending a refund, specifying the amount in Eurocents and the reason.

```json
{"amount":1299,"reason":"delivery_delay"}
```

--------------------------------

### Create Product Data File Example Response

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for the CreateProductDataFile operation showing the structure of an import file object.

```json
{
  "data": {
    "id_import_file": 123,
    "uri": "https://upload.wikimedia.org/wikipedia/commons/4/44/Kaufland_201x_logo.svg",
    "status": "ABORTED",
    "note": "Import aborted, no changes (2021-05-31 01:24:09)",
    "total_lines": 123,
    "current_line": 123,
    "ts_created": "2021-05-31 01:06:05",
    "ts_updated": "2021-05-31 01:06:05",
    "ts_last_row_updated": null,
    "ts_completed": null,
    "error_count": 0,
    "async_import_done": 0
  }
}
```

--------------------------------

### Get category by ID response example

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for the GetCategory operation showing the structure of a category object.

```json
{
  "data": {
    "id_category": 1,
    "name": "test category",
    "id_parent_category": 1,
    "title_singular": "test category",
    "title_plural": "test categories",
    "level": 1,
    "url": "test category",
    "shipping_category": "D",
    "variable_fee": 1,
    "fixed_fee": 1,
    "vat": 19,
    "is_leaf": true
  }
}
```

--------------------------------

### Get attribute by ID response example

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for the GetAttribute operation, returning a single attribute object.

```json
{
  "data": {
    "id": 21,
    "name": "manufacturer",
    "is_multiple": false,
    "is_sharedset": true,
    "explanation": "Something about manufacturer",
    "seller_instructions": "Please use the simple Company name",
    "title": "Manufacturer",
    "type": "Company"
  }
}
```

--------------------------------

### GetSimilarProductsBuybox Example Response

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for the GetSimilarProductsBuybox endpoint, detailing competitor rankings for comparable products.

```json
{
  "data": [
    {
      "id_product": 8475634,
      "storefront": "cz",
      "condition": "new",
      "num_units": 1,
      "units": [
        {
          "buybox_rank": 1,
          "seller": "Kaufland Seller",
          "price": 1999,
          "delivery_time_max": 4,
          "delivery_time_min": 3,
          "shipping_rate": 700,
          "fulfillment_type": "fulfilled_by_merchant",
          "condition": "NEW",
          "id_unit": 28374940,
          "id_offer": "SKU1342"
        }
      ]
    }
  ]
}
```

--------------------------------

### Python Full Request Signing Example

Source: https://sellerapi.kaufland.com/?page=rest-api

A complete script demonstrating how to sign a POST request to the Kaufland Seller API in Python.

```python
#!/usr/bin/python

import hmac
import hashlib
import time

def sign_request(method, uri, body, timestamp, secret_key):
    plain_text = "\n".join([method, uri, body, str(timestamp)])

    digest_maker = hmac.new(secret_key.encode(), None, hashlib.sha256)
    digest_maker.update(plain_text.encode())
    return digest_maker.hexdigest()

method = "POST"
uri = "https://sellerapi.kaufland.com/v2/units/"
body = ""
timestamp = 1411055926 # time.time()
secret_key = "a7d0cb1da1ddbc86c96ee5fedd341b7d8ebfbb2f5c83cfe0909f4e57f05dd403"

print(sign_request(method, uri, body, timestamp, secret_key))
# da0b65f51c0716c1d3fa658b7eaf710583630a762a98c9af8e9b392bd9df2e2a
```

--------------------------------

### Get attributes by search term response example

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for the GetAttributeListBySearch operation, showing a collection of attributes.

```json
{
  "data": [
    {
      "id": 21,
      "name": "manufacturer",
      "title": "Manufacturer",
      "explanation": "Something about manufacturer",
      "is_multiple": false,
      "is_sharedset": true,
      "seller_instructions": "Please use the simple Company name",
      "type": "Company"
    },
    {
      "id": 31,
      "name": "title",
      "title": "Title",
      "explanation": "The title of product",
      "is_multiple": false,
      "is_sharedset": false,
      "seller_instructions": "Please use a specific format",
      "type": "ShortText"
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 20,
    "offset": 0
  }
}
```

--------------------------------

### Get Ticket Messages Example Response

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for the GetTicketMessages operation showing the structure of a ticket message collection.

```json
{
  "data": [
    {
      "id_ticket_message": 64123123,
      "id_ticket": "00110123123",
      "author": {
        "role": "seller",
        "name": "Kaufland"
      },
      "text": "Ticket message content here",
      "ts_created_iso": "2021-09-24T10:26:05Z"
    }
  ],
  "pagination": {
    "limit": 30,
    "offset": 0,
    "total": 1
  }
}
```

--------------------------------

### Adding a Unit (POST)

Source: https://sellerapi.kaufland.com/?page=code-examples

This example demonstrates how to add a new unit (offer) to a product using a POST request. It includes details on request parameters, headers, and expected success response.

```APIDOC
## POST /units/

### Description
Adds a new unit (offer) to a product. Requires a listing price greater than zero.

### Method
POST

### Endpoint
https://sellerapi.kaufland.com/v2/units/

### Parameters
#### Query Parameters
- **storefront** (string) - Required - The storefront to create the unit on (e.g., 'de').

#### Request Body
- **ean** (string) - Required - The EAN of the product.
- **condition** (string) - Required - The condition of the unit (e.g., 'NEW').
- **listing_price** (integer) - Required - The listing price in cents (must be greater than zero).
- **minimum_price** (integer) - Optional - The minimum price in cents.
- **amount** (integer) - Required - The available quantity of the unit.
- **note** (string) - Optional - A note for the unit.
- **id_shipping_group** (integer) - Required - The ID of the shipping group.
- **id_warehouse** (integer) - Required - The ID of the warehouse.
- **id_product** (integer) - Required - The ID of the product.
- **id_offer** (string) - Optional - A custom identifier for the offer.
- **handling_time** (integer) - Optional - The handling time in days.

### Request Example
```json
{
  "ean": "9780470527580",
  "condition": "NEW",
  "listing_price": 4550,
  "minimum_price": 3990,
  "amount": 9,
  "note": "My example note",
  "id_shipping_group": 1,
  "id_warehouse": 1,
  "id_product": 1,
  "id_offer": "My own unit identifier",
  "handling_time": 1
}
```

### Response
#### Success Response (201)
- **Location** (string) - The URL to the newly created unit.

#### Response Example
```
HTTP Response Code: 201
```
```

--------------------------------

### CreateVoucherRequest JSON Example

Source: https://sellerapi.kaufland.com/swagger.json

Example configuration for creating a new discount voucher. The export_to_third_parties flag is optional and defaults to false.

```json
{
  "title": "Christmas Sale",
  "storefront": "de",
  "discount_type": "PERCENTAGE",
  "discount_amount": 10,
  "begin_at": "2025-12-16",
  "end_at": "2025-12-20",
  "usage_limit": 100,
  "products": [545476015, 322791766],
  "export_to_third_parties": false
}
```

--------------------------------

### Get Shared Set List Example Response

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for the GetSharedSetListBySearchAndAttributeId operation, showing a collection of shared set labels and values with pagination metadata.

```json
{"data":[{"label":"Schwarz","value":"Schwarz"},{"label":"Braun","value":"Braun"},{"label":"Rot","value":"Rot"},{"label":"Hellbraun","value":"Hellbraun"},{"label":"Dunkelbraun","value":"Dunkelbraun"}],"pagination":{"offset":0,"limit":30,"total":5}}
```

--------------------------------

### Get Shared Set CSV URL Example Response

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for the GetSharedSetCsvFileByAttributeId operation, providing a signed URL to access the CSV file of shared set values.

```json
{"data":"https://storage.googleapis.com/dev-pds-bo-temp-bucket/shared-sets/141/de-DE.csv?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=shop-gcs-writer%40dev-db-real.iam.gserviceaccount.com%2F20240612%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240612T135959Z&X-Goog-Expires=518400&X-Goog-SignedHeaders=host&X-Goog-Signature=1a7ed075f85e121a"}
```

--------------------------------

### Retrieve Full Return Information

Source: https://sellerapi.kaufland.com/?page=returns

Example response for a GET request to /returns/{id_return} with embedded return_units and buyer data.

```json
{
	"data": {
		"id_return": 3800,
		"ts_created_iso": "2016-05-07T23:10:36Z",
		"ts_updated_iso": "2016-05-09T11:17:02Z",
		"storefront": "de"
		"tracking_provider": "DHL",
		"tracking_code": "00340434161221754211",
		"status": "label_generated",
		"return_units": {
			[
				{
					"id_return_unit": 4134,
					"id_return": 3800,
					"id_order_unit": 2312312451,
					"ts_created_iso": "2016-05-07T22:00:14Z",
					"status": "need_to_be_returned",
					"note": "Sadly not the right size.",
					"reason": "wrong_size",
					"storefront": "de"
				}
			]
		},
		"buyer": {
			"id_buyer": 3124124,
			"email": "john.doe@example.de"
		}
	}
}
```

--------------------------------

### Retrieve open tickets response

Source: https://sellerapi.kaufland.com/?page=tickets

Example JSON response when sending a GET request to the /tickets endpoint with the status=opened query parameter.

```json
{
  "data": [
    {
      "id_ticket": "0011234567",
      "ids_order_units": [
        123456789,
        987654321
      ],
      "id_buyer": 123456789,
      "ts_created_iso": "2021-07-24T19:26:05Z",
      "ts_updated_iso": "2021-07-24T19:26:05Z",
      "status": "opened",
      "open_reason": "product_not_as_described",
      "topic": "delivery_not_received",
      "is_seller_responsible": false,
      "fulfillment_type": "fulfilled_by_merchant"
    }
  ],
  "pagination": {
    "offset": 30,
    "limit": 10,
    "total": 200
  }
}
```

--------------------------------

### POST /units/

Source: https://sellerapi.kaufland.com/?page=inventory

Creates a new inventory unit for a product on the marketplace.

```APIDOC
## POST /units/

### Description
Adds inventory information for a single product to the marketplace.

### Method
POST

### Endpoint
/units/

### Request Body
- **id_product** (integer) - Optional - The internal Kaufland ID of the product. Required if ean is not provided.
- **ean** (string) - Optional - The EAN of the product. Required if id_product is not provided.
- **condition** (string) - Required - The condition of the product (e.g., "NEW").
- **listing_price** (integer) - Required - The selling price in integral cents.
- **minimum_price** (integer) - Optional - The minimum price for Smart Pricing.
- **amount** (integer) - Required - Stock quantity (max 99999).
- **note** (string) - Optional - Condition note for the customer (max 250 chars).
- **id_offer** (string) - Optional - Internal ID for the unit.
- **handling_time** (integer) - Required - Working days until handover to carrier (>=0).
- **id_warehouse** (string) - Optional - Warehouse ID.
- **id_shipping_group** (string) - Required - ID of the shipping group.
- **storefront** (string) - Required - Marketplace storefront code.
- **vat_indicator** (string) - Required - VAT rate indicator.
- **eco_participation** (integer) - Optional - Eco-Participation value in eurocents (>0).
- **battery_participation** (integer) - Optional - Battery-Participation value in eurocents (>0).
- **manufacturer_guarantee_years** (integer) - Optional - Duration of guarantee in years (>0, <=99).

### Request Example
{
	"id_product": 35903281,
	"ean": "4011905437873",
	"condition": "NEW",
	"listing_price": 5999,
	"minimum_price": 5100,
	"amount": 200,
	"note": "",
	"id_offer": "AB1234",
	"handling_time": 2,
	"id_warehouse": "1345",
	"id_shipping_group": "3457",
	"storefront": "de",
	"vat_indicator": "standard_rate",
	"eco_participation": 99,
	"battery_participation": 100,
	"manufacturer_guarantee_years": 2
}

### Response
#### Success Response (201)
- Unit created successfully.

#### Error Response
- **message** (string) - Error description.
```

--------------------------------

### Add a Unit (POST Request)

Source: https://sellerapi.kaufland.com/?page=code-examples

Use this PHP script to add a new unit (offer) to a product. Ensure the listing price is greater than zero. This example demonstrates a POST request with necessary authentication headers.

```php
<?php

function signRequest($method, $uri, $body, $timestamp, $secretKey)
{
	$string = implode("\n", [
		$method,
		$uri,
		$body,
		$timestamp,
	]);

	return hash_hmac('sha256', $string, $secretKey);
}

$baseUrl = 'https://sellerapi.kaufland.com/v2';

// Credentials for the API
$clientKey = '35f5dba43b471cd2ad28fd68e4825e2b';
$secretKey = 'b3575f222f7b768c25160b879699118b331c6883dd6010864b7ead130be77cd5';

// Define the POST data
$data = [
	"ean"           => "9780470527580",
	"condition"     => "NEW",
	"listing_price" => 4550,
	"minimum_price" => 3990,
	"amount"        => 9,
    "note" => "My example note",
    "id_shipping_group" => 1,
    "id_warehouse" => 1,
	"id_product" => 1,
    "id_offer" => "My own unit identifier",
    "handling_time" => 1
];

$jsonData = json_encode($data);

// We're adding a new unit
$uri = $baseUrl . '/units/';

// Need to specify the storefront the unit will be created on
$params = [
	'storefront' => 'de',
];

//The query parameters must be URL-encoded, but the "=" and "&" signs should not be encoded
$uri .= '?' . http_build_query($params);

// Current Unix timestamp in seconds
$timestamp = time();

// Define all the mandatory headers
$headers = [
    'Content-Type: application/json',
    'Accept: application/json',
    'Shop-Client-Key: ' . $clientKey,
    'Shop-Timestamp: ' . $timestamp,
    'Shop-Signature: ' . signRequest('POST', $uri, $jsonData, $timestamp, $secretKey),
    'User-Agent: test',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $uri);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLINFO_HEADER_OUT, 1);

$response = curl_exec($ch);
list($header, $body) = explode("\r\n\r\n", $response, 2);
print("$header\n\n");

$responseCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
print("HTTP Response Code: $responseCode\n");
curl_close($ch);


```

--------------------------------

### Java Full Request Signing Example

Source: https://sellerapi.kaufland.com/?page=rest-api

A complete Java class demonstrating how to sign a request. Note that the secret key must be treated as a string, not a hex value.

```java
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import javax.xml.bind.DatatypeConverter;
import java.security.NoSuchAlgorithmException;
import java.security.InvalidKeyException;

public class Hmac {

	public static void main(String[] args) {
		String method = "POST";
		String uri = "https://sellerapi.kaufland.com/v2/units/";
		String body = "";
		String secretKey = "a7d0cb1da1ddbc86c96ee5fedd341b7d8ebfbb2f5c83cfe0909f4e57f05dd403";
		long timestamp = 1411055926; // System.currentTimeMillis() / 1000L;

		try {
			String signature = signRequest(method, uri, body, timestamp, secretKey);
			System.out.println(signature); // da0b65f51c0716c1d3fa658b7eaf710583630a762a98c9af8e9b392bd9df2e2a
		} catch (Exception e) {
			System.out.println("Error signing request");
		}
	}

	public static String signRequest(String method, String uri, String body, long timestamp, String secretKey)
		throws NoSuchAlgorithmException, InvalidKeyException {

		String plainText = method + "\n" + uri + "\n" + body + "\n" + timestamp;

		Mac mac = Mac.getInstance("HmacSHA256");
		SecretKeySpec secretKeySpec = new SecretKeySpec(secretKey.getBytes(), "HmacSHA256");
		mac.init(secretKeySpec);

		byte[] rawHmac = mac.doFinal(plainText.getBytes());
		return DatatypeConverter.printHexBinary(rawHmac);
	}
}
```

--------------------------------

### Example HMAC Input Values

Source: https://sellerapi.kaufland.com/?page=rest-api

Example variables used to demonstrate the input parameters required for the signature generation process.

```php
$method = "POST";
$uri = "https://sellerapi.kaufland.com/v2/units/";
$body = "";
$timestamp = 1411055926;
$secretKey = "a7d0cb1da1ddbc86c96ee5fedd341b7d8ebfbb2f5c83cfe0909f4e57f05dd403";
```

--------------------------------

### GET /orders

Source: https://sellerapi.kaufland.com/?page=endpoints

Get a list of orders.

```APIDOC
## GET /orders

### Description
Get a list of orders.

### Method
GET

### Endpoint
/orders
```

--------------------------------

### GET /attributes

Source: https://sellerapi.kaufland.com/?page=endpoints

Get an attribute list.

```APIDOC
## GET /attributes

### Description
Get an attribute list.

### Method
GET

### Endpoint
/attributes
```

--------------------------------

### ListSimilarProductGroups Example Response

Source: https://sellerapi.kaufland.com/swagger.json

Example JSON response for the ListSimilarProductGroups endpoint, showing product similarity groups and competitor ladders.

```json
{
  "data": [
    {
      "group_id": "a1b2c3",
      "storefront": "de",
      "currency": "EUR",
      "group_demand": "high",
      "own_price_rank": 1,
      "own_sales_rank": 1,
      "own_share": "high",
      "gap_to_best_price": 149,
      "number_of_competitors": 4,
      "easy_win": true,
      "recommendation": "focus",
      "ladder": [
        {
          "price_rank": 1,
          "seller": "Example Seller GmbH",
          "id_product": 123456789,
          "product_name": "Example product",
          "ean": "1234567890123",
          "price": 1999,
          "shipping_cost": 299,
          "delivery_time_min": 1,
          "delivery_time_max": 3,
          "ratings_count": 128,
          "average_rating": 4.5,
          "manufacturer_name": "Example Manufacturer",
          "voucher": {
            "discount_amount": 10,
            "discount_type": "percent",
            "discounted_price": 1799
          },
          "is_excluded": false,
          "is_own_offer": false
        }
      ]
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 4
  }
}
```

--------------------------------

### GET /attributes/{name}

Source: https://sellerapi.kaufland.com/swagger.json

Get an attribute by its name.

```APIDOC
## GET /attributes/{name}

### Description
Get an attribute by its name.

### Method
GET

### Endpoint
/attributes/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the attribute

#### Query Parameters
- **storefront** (Storefront) - Required - Specifies the store by country
- **locale** (ProductDataLocale) - Optional - Allows clients to consume the data in languages that are different from the storefront-default locale
```

--------------------------------

### POST /product-data/import-file

Source: https://sellerapi.kaufland.com/?page=product-data

Initiates an asynchronous import of product data from a publicly accessible CSV file URL.

```APIDOC
## POST /product-data/import-file

### Description
Sends a URL to a publicly-accessible CSV file to the Kaufland marketplace for asynchronous processing and import.

### Method
POST

### Endpoint
/product-data/import-file

### Request Body
- **url** (string) - Required - The public URL of the CSV file to be imported.

### Request Example
{
	"url": "http://www.example.com/my_products.csv"
}
```

--------------------------------

### Sample response for similar-products/groups

Source: https://sellerapi.kaufland.com/?page=similar-products

This JSON object represents the structure of a successful response from the /v2/similar-products/groups endpoint, including group metadata, the seller's competitive standing, and a list of competing offers.

```json
{
    "data": [
        {
            "group_id": "a1b2c3",
            "storefront": "de",
            "currency": "EUR",
            "group_demand": "high",
            "own_price_rank": 1,
            "own_sales_rank": 1,
            "own_share": "high",
            "gap_to_best_price": 149,
            "number_of_competitors": 4,
            "easy_win": true,
            "recommendation": "focus",
            "ladder": [
                {
                    "price_rank": 1,
                    "seller": "Example Seller GmbH",
                    "id_product": 123456789,
                    "product_name": "Example product",
                    "ean": "1234567890123",
                    "price": 1999,
                    "shipping_cost": 299,
                    "delivery_time_min": 1,
                    "delivery_time_max": 3,
                    "ratings_count": 128,
                    "average_rating": 4.5,
                    "manufacturer_name": "Example Manufacturer",
                    "voucher": null,
                    "is_excluded": false,
                    "is_own_offer": false
                }
            ]
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 4
    }
}
```

--------------------------------

### GET /assortment-coverage/insights

Source: https://sellerapi.kaufland.com/?page=endpoints

Get assortment coverage insights.

```APIDOC
## GET /assortment-coverage/insights

### Description
Get assortment coverage insights.

### Method
GET

### Endpoint
/assortment-coverage/insights
```

--------------------------------

### GET /shipping-groups

Source: https://sellerapi.kaufland.com/swagger.json

Get the list of your predefined shipping groups.

```APIDOC
## GET /shipping-groups

### Description
Get the list of your predefined shipping groups.

### Method
GET

### Endpoint
/shipping-groups

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Desired size of result set
- **offset** (integer) - Optional - Offset applied to result set

### Response
#### Success Response (200)
- **CollectionApiResponse_ShippingGroup_** (object) - Success
```
Tokens:
Raw