Kinguin Developer Portal

https://www.kinguin.net/dev-portal
Admin
Kinguin Developer Portal is a comprehensive API platform for digital product sellers to manage...
Tokens:41,202
Snippets:240
Trust Score:9.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Wholesale Offers Response Sample

Source: https://www.kinguin.net/dev-portal/documentation

Example JSON array structure returned when retrieving wholesale offers for a specific product.

```json
[
  {
    "offerId": "string",
    "productId": "string",
    "sellerName": "string",
    "sellerId": 0,
    "buyableStock": "string",
    "maxDeliveryDate": "2019-08-24T14:15:22Z",
    "status": "string",
    "price": {
      "amount": 0,
      "currency": "string"
},
    "wholesale": {
      "name": "string",
      "enabled": true,
      "tiers": [
        {
          "discount": 0,
          "level": 0,
          "price": {
            "amount": 0,
            "currency": "string"
},
          "priceIWTR": {
            "amount": 0,
            "currency": "string"
}
}
]
},
    "name": "string",
    "productDetails": {
      "metacritic": 0,
      "region": {
        "id": 0,
        "name": "string"
},
      "platform": {
        "id": 0,
        "name": "string"
},
      "imageUrl": "string",
      "softwareMS": true,
      "productType": {
        "softwareMS": true,
        "prePaid": true,
        "skinsCSGO": true,
        "randomProduct": true,
        "indieValley": true,
        "nft": true,
        "businessStore": true
},
      "marketingProductType": "string"
},
    "minPossibleWholesalePrice": 0,
    "spaActive": true
}

]
```

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

### Stock Status Response Example

Source: https://www.kinguin.net/dev-portal/guide

Example of the JSON response received after successfully uploading stock.

```json
{
   "id":"f64e66d5-e26c-426a-ba8b-cfeb220972ff",
   "productId":"${PRODUCT_ID}",
   "offerId":"${OFFER_ID}",
   "sellerId":5005408,
   "status":"AVAILABLE"
 }
```

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

### Retrieve Offer Stock Response Structure

Source: https://www.kinguin.net/dev-portal/documentation

Example JSON response for a successful GET request to the offer stock endpoint.

```json
{
  "content": [
    {
      "id": "string",
      "productId": "string",
      "offerId": "string",
      "sellerId": 0,
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "dispatchedAt": "2019-08-24T14:15:22Z",
      "reservationId": "string",
      "ktcId": "string",
      "content": "string",
      "mimeType": "string",
      "externalName": "string",
      "externalVendor": "string",
      "externalPrice": {
        "amount": 0,
        "currency": "string"
},
      "hidden": true
}
],
  "metadata": {
    "page": 0,
    "size": 0,
    "totalElements": 0,
    "totalPages": 0
}

}
```

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

### Get Block Reasons Response

Source: https://www.kinguin.net/dev-portal/documentation

Example JSON response containing a list of block reasons and their associated counts.

```json
[
  {
    "blockReason": "ALLBLOCKED",
    "count": 0
  }
]
```

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

### GET /api/v1/wholesale/configuration

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves the current wholesale configuration settings.

```APIDOC
## GET /api/v1/wholesale/configuration

### Description
Retrieves the current wholesale configuration, including visibility settings and stock display limits.

### Method
GET

### Endpoint
/sales-manager-api/api/v1/wholesale/configuration

### Response
#### Success Response (200)
- **wholesaleVisibility** (string) - Visibility status of wholesale
- **maxWholesaleStockDisplay** (integer) - Maximum stock display limit

#### Response Example
{
  "wholesaleVisibility": "VISIBLE",
  "maxWholesaleStockDisplay": 0
}
```

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

### Perform API Request in Sandbox

Source: https://www.kinguin.net/dev-portal/guide

Example of a POST request to the sandbox gateway for sales management.

```bash
curl -X POST \
         -H "Authorization: Bearer ${TOKEN}" \
         -H "Content-Type: application/json" \
         -d '{"productId": "${PRODUCT_ID}", "price": {"amount": 2, "currency": "EUR"}}' \
    https://gateway.sandbox.kinguin.net/sales-manager-api/api/v1/offers
```

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

### Get Reservations Stats Response Sample

Source: https://www.kinguin.net/dev-portal/documentation

Example JSON structure returned by the reservations stats endpoint.

```json
{
  "property1": {
    "dateToString": "string",
    "price": 0,
    "bid": 0,
    "count": 0
},
  "property2": {
    "dateToString": "string",
    "price": 0,
    "bid": 0,
    "count": 0
}

}
```

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

### GET /api/v1/product/minimalPrice/{productId}

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves the minimal price for a Microsoft product by its ID.

```APIDOC
## GET /api/v1/product/minimalPrice/{productId}

### Description
Retrieves the minimal price for a Microsoft product by its ID.

### Method
GET

### Endpoint
/api/v1/product/minimalPrice/{productId}

### Parameters
#### Path Parameters
- **productId** (string) - Required

### Response
#### Success Response (200)
- OK

#### Response Example
{
  "id": "string",
  "price": {
    "amount": 0,
    "currency": "string"
  }
}
```

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

### Get Wholesale Configuration Response

Source: https://www.kinguin.net/dev-portal/documentation

Returns the current wholesale visibility and stock display settings.

```json
{
  * "wholesaleVisibility": "VISIBLE",
  * "maxWholesaleStockDisplay": 0

}
```

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

### GET /api/v1/offers/block-reasons

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves a list of reasons why offers might be blocked.

```APIDOC
## GET /api/v1/offers/block-reasons

### Description
Retrieves a list of block reasons and their associated counts.

### Method
GET

### Endpoint
/sales-manager-api/api/v1/offers/block-reasons

### Response
#### Success Response (200)
- **blockReason** (string) - The reason code for the block
- **count** (integer) - The number of occurrences

#### Response Example
[
  {
    "blockReason": "ALLBLOCKED",
    "count": 0
  }
]
```

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

### Wholesale offer response structure

Source: https://www.kinguin.net/dev-portal/guide

Example JSON response showing the wholesale configuration and calculated price tiers for an offer.

```json
{
    "id": "660691850f65d000010da229",
    [ ... ]
    "priceIWTR": {
        "amount": 200,
        "currency": "EUR"
    },
    "price": {
        "amount": 230,
        "currency": "EUR"
    },
    "wholesale": {
        "name": "custom",
        "enabled": true,
        "tiers": [
            {
                "discount": 3,
                "level": 1,
                "price": {
                    "amount": 206,
                    "currency": "EUR"
                },
                "priceIWTR": {
                    "amount": 194,
                    "currency": "EUR"
                }
            },
            {
                "discount": 4,
                "level": 2,
                "price": {
                    "amount": 196,
                    "currency": "EUR"
                },
                "priceIWTR": {
                    "amount": 192,
                    "currency": "EUR"
                }
            },
            {
                "discount": 5,
                "level": 3,
                "price": {
                    "amount": 192,
                    "currency": "EUR"
                },
                "priceIWTR": {
                    "amount": 190,
                    "currency": "EUR"
                }
            },
            {
                "discount": 7,
                "level": 4,
                "price": {
                    "amount": 186,
                    "currency": "EUR"
                },
                "priceIWTR": {
                    "amount": 186,
                    "currency": "EUR"
                }
            }
        ]
    },
   [ ... ]
}
```

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

### Get Microsoft Product Minimal Price Response

Source: https://www.kinguin.net/dev-portal/documentation

Returns the minimal price details for a specific product ID.

```json
{
  "id": "string",
  "price": {
    "amount": 0,
    "currency": "string"
  }
}
```

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

### Update Favorite Response Example

Source: https://www.kinguin.net/dev-portal/documentation

The structure of the successful response returned by the API.

```json
[
  {
    "id": "string",
    "productId": "string",
    "name": "string",
    "sellerId": 0,
    "sellerName": "string",
    "status": "string",
    "block": "string",
    "blockedAt": "2019-08-24T14:15:22Z",
    "unblockedAt": "2019-08-24T14:15:22Z",
    "priceIWTR": {
      "amount": 0,
      "currency": "string"
    },
    "price": {
      "amount": 0,
      "currency": "string"
    },
    "declaredStock": 0,
    "maxDeliveryDate": "2019-08-24T14:15:22Z",
    "declaredTextStock": 0,
    "reservedStock": 0,
    "reservedTextStock": 0,
    "availableStock": 0,
    "availableTextStock": 0,
    "buyableTextStock": 0,
    "buyableStock": 0,
    "updatedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "commissionRule": {
      "id": "string",
      "name": "string",
      "fixedAmount": 0,
      "percentValue": 0,
      "updatedAt": null
    },
    "wholesale": {
      "name": "string",
      "enabled": true,
      "tiers": [
        {
          "discount": 0,
          "level": 0,
          "price": {
            "amount": 0,
            "currency": "string"
          },
          "priceIWTR": {
            "amount": 0,
            "currency": "string"
          }
        }
      ]
    },
    "wholesaleCommission": {
      "level1": {
        "percentValue": 0.1,
        "fixedAmount": 0.1
      },
      "level2": {
        "percentValue": 0.1,
        "fixedAmount": 0.1
      },
      "level3": {
        "percentValue": 0.1,
        "fixedAmount": 0.1
      },
      "level4": {
        "percentValue": 0.1,
        "fixedAmount": 0.1
      }
    },
    "sold": 0,
    "sold1d": 0,
    "sold7d": 0,
    "sold30d": 0,
    "lowStock": {
      "outOfStockIn1day": true
    },
    "popularity": 0.1,
    "buyButtonScore": 0.1,
    "buyButtonProbability": 0.1,
    "buyButtonForced": true,
    "buyButtonBid": true,
    "buyButtonBidEnabled": true,
    "salesBoosterActivationDate": "2019-08-24T14:15:22Z",
    "nextRefreshSalesBoosterRules": "2019-08-24T14:15:22Z",
    "popularityBid": {
      "amount": 0,
      "currency": "string"
    },
    "salesBoosterRenewal": true,
    "position": 0,
    "productDetails": {
      "metacritic": 0,
      "region": {
        "id": 0,
        "name": "string"
      },
      "platform": {
        "id": 0,
        "name": "string"
      },
      "imageUrl": "string",
      "softwareMS": true,
      "productType": {
        "softwareMS": true,
        "prePaid": true,
        "skinsCSGO": true,
        "randomProduct": true,
        "indieValley": true,
        "nft": true,
        "businessStore": true
      },
      "marketingProductType": "string"
    },
    "marketDetails": {
      "id": "string",
      "sku": "string",
      "name": "string",
      "brand": "string",
      "price": 0,
      "rulePrice": 0,
      "newPrice": 0,
      "rules": "string",
      "position": "string",
      "percentile": 0,
      "leadCompetitor": "string",
      "leadingCompetitorPrice": 0,
      "withTaxes": true
    },
    "marketPriceDiff": 0,
    "marketPricePercent": 0.1,
    "broker": "string",
    "preOrder": true,
    "prePurchase": true,
    "kinguinOfferId": "string",
    "nextAutoRefreshSoldDate": "2019-08-24T14:15:22Z",
    "productType": "string",
    "merchantType": "string",
    "priceChangeCounter": 0,
    "lastPriceChangeResetDate": "2019-08-24T14:15:22Z",
    "minPossibleWholesalePrice": 0,
    "spaActive": true,
    "favorite": true,
    "description": "string",
    "minQuantity": 0,
    "deliveryTime": "string",
    "deliveryMethods": "EMAIL"
  }
]
```

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

### GET /api/v1/wholesale/product/{productId}/best

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves the best wholesale offer for a specific product identified by its ID.

```APIDOC
## GET /api/v1/wholesale/product/{productId}/best

### Description
Retrieves the best wholesale offer for a specific product identified by its ID.

### Method
GET

### Endpoint
/api/v1/wholesale/product/{productId}/best

### Parameters
#### Path Parameters
- **productId** (string) - Required - ID of the product to retrieve the best wholesale offer for

### Response
#### Success Response (200)
- **offerId** (string) - Unique identifier for the offer
- **productId** (string) - Unique identifier for the product
- **sellerName** (string) - Name of the seller
- **sellerId** (integer) - ID of the seller
- **buyableStock** (string) - Available stock quantity
- **maxDeliveryDate** (string) - Maximum delivery date
- **status** (string) - Current status of the offer
- **price** (object) - Price details including amount and currency
- **wholesale** (object) - Wholesale specific details including tiers
- **name** (string) - Product name
- **productDetails** (object) - Detailed product information
- **minPossibleWholesalePrice** (number) - Minimum possible wholesale price
- **spaActive** (boolean) - Indicates if SPA is active

#### Response Example
{
  "offerId": "string",
  "productId": "string",
  "sellerName": "string",
  "sellerId": 0,
  "buyableStock": "string",
  "maxDeliveryDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "price": {
    "amount": 0,
    "currency": "string"
  },
  "wholesale": {
    "name": "string",
    "enabled": true,
    "tiers": []
  },
  "name": "string",
  "productDetails": {},
  "minPossibleWholesalePrice": 0,
  "spaActive": true
}
```

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

### GET /api/v1/products/{productId}/defaultWholesaleTier

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves the default wholesale tier for a specific product.

```APIDOC
## GET /api/v1/products/{productId}/defaultWholesaleTier

### Description
Retrieves the default wholesale tier information for a given product ID.

### Method
GET

### Endpoint
/sales-manager-api/api/v1/products/{productId}/defaultWholesaleTier

### Parameters
#### Path Parameters
- **productId** (string) - Required - ID of the product to retrieve the default wholesale tier for

### Response
#### Success Response (200)
- **name** (string) - Tier name
- **enabled** (boolean) - Whether the tier is enabled
- **tiers** (array) - List of wholesale tiers

#### Response Example
{
  "name": "string",
  "enabled": true,
  "tiers": [
    {
      "discount": 0,
      "level": 0,
      "price": {
        "amount": 0,
        "currency": "string"
      },
      "priceIWTR": {
        "amount": 0,
        "currency": "string"
      }
    }
  ]
}
```

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

### Offer Response with Block Field

Source: https://www.kinguin.net/dev-portal/guide

Example JSON structure showing the block field within an offer object.

```json
{   "id": "65d36ed879c2842175958bb2",   "name": "XBOX Game Pass Core 3 Months Subscription Card",   "status": "ACTIVE",   "block": "MANUAL_VERIFICATION_PREPAID_PRODUCT",    ...  }
```

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

### GET /api/v1/wholesale/product/{productId}/offers

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves wholesale offers for a specific product identified by its ID.

```APIDOC
## GET /api/v1/wholesale/product/{productId}/offers

### Description
Retrieves wholesale offers for a specific product identified by its ID.

### Method
GET

### Endpoint
/sales-manager-api/api/v1/wholesale/product/{productId}/offers

### Parameters
#### Path Parameters
- **productId** (string) - Required - ID of the product to retrieve wholesale offers for

#### Query Parameters
- **outOfStock** (boolean) - Optional - Flag to include out of stock offers

### Response
#### Success Response (200)
- Successful

#### Response Example
[
  {
    "offerId": "string",
    "productId": "string",
    "sellerName": "string",
    "sellerId": 0,
    "buyableStock": "string",
    "maxDeliveryDate": "2019-08-24T14:15:22Z",
    "status": "string",
    "price": {
      "amount": 0,
      "currency": "string"
    },
    "wholesale": {
      "name": "string",
      "enabled": true,
      "tiers": [
        {
          "discount": 0,
          "level": 0,
          "price": {
            "amount": 0,
            "currency": "string"
          },
          "priceIWTR": {
            "amount": 0,
            "currency": "string"
          }
        }
      ]
    },
    "name": "string",
    "productDetails": {
      "metacritic": 0,
      "region": {
        "id": 0,
        "name": "string"
      },
      "platform": {
        "id": 0,
        "name": "string"
      },
      "imageUrl": "string",
      "softwareMS": true,
      "productType": {
        "softwareMS": true,
        "prePaid": true,
        "skinsCSGO": true,
        "randomProduct": true,
        "indieValley": true,
        "nft": true,
        "businessStore": true
      },
      "marketingProductType": "string"
    },
    "minPossibleWholesalePrice": 0,
    "spaActive": true
  }
]
```

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

### Define Product Element with Tokenized Data

Source: https://www.kinguin.net/dev-portal/guide

Example of a product element using the data-tokenizedData attribute to provide product-specific information.

```html
<div
  class="productCard"
  data-product="https://www.kinguin.net/category/12345"
  data-tokenizedData="p--RdR6ON9h-4LwJFsWDRwecmlQpXKx3mjgVK3CUm1DRAapbUwKpqBD5_52T0WCWCkA6xx--LuceUvunwyQJkdY3UM1ZoupuwW7VPr_ALRCVX9G8WI2CS7oYIHR0qZqEGZei1zjul2w3Ubaphf62rDbcfbWPodnYCx6JW4TNxTo1W2zJfq3c"
>
  Product 1
</div>
```

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

### window.kinguinCheckoutSDK.init

Source: https://www.kinguin.net/dev-portal/guide

Initializes the Kinguin Checkout SDK with auto-claim flow options enabled.

```APIDOC
## window.kinguinCheckoutSDK.init

### Description
Initializes the SDK with specific configuration for the auto-claim flow, allowing for automated order processing.

### Parameters
- **wrapperSelector** (string) - Required - CSS selector for the iframe wrapper.
- **currency** (string) - Optional - Currency code for the transaction.
- **discount** (string) - Optional - Discount code to apply.
- **autoClaimOptions** (object) - Optional - Configuration object for auto-claim.
    - **autoClaim** (boolean) - Required - Enables auto-claim flow.
    - **emailConfirmed** (boolean) - Required - Indicates if the customer's email is verified.
    - **tokenizedEmail** (string) - Required - Base64url encoded AES-256-GCM encrypted email.
    - **tokenizedData** (string) - Optional - Encrypted order processing details.
    - **tokenizedDataAttribute** (string) - Optional - Attribute name on product elements for product-specific data.

### Request Example
window.kinguinCheckoutSDK.init({
  wrapperSelector: '#myIframeWrapper',
  currency: 'EUR',
  discount: 'test123',
  autoClaimOptions: {
    autoClaim: true,
    emailConfirmed: true,
    tokenizedEmail: 'qtLHriIkq0KQdJgKlbHpQfuM1tFlJtCYXe-F2YitqQrh7UYF--77CxQ',
    tokenizedData: 'p--RdR6ON9h-4LwJFsWDRwecmlQpXKx3mjgVK3CUm1DRAapbUwKpqBD5_52T0WCWCkA6xx--LuceUvunwyQJkdY3UM1ZoupuwW7VPr_ALRCVX9G8WI2CS7oYIHR0qZqEGZei1zjul2w3Ubaphf62rDbcfbWPodnYCx6JW4TNxTo1W2zJfq3c'
  }
});
```

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

### Initialize the SDK

Source: https://www.kinguin.net/dev-portal/guide

Use the init function to attach click handlers to product elements. Ensure this is called only after product elements are present in the DOM.

```javascript
window.kinguinCheckoutSDK.init();
```

```html
<body>
  <script>
    document.addEventListener('DOMContentLoaded', function () {
      window.kinguinCheckoutSDK.init();
    });
  < /script>
</body>
```

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

### Initialize Kinguin Checkout SDK

Source: https://www.kinguin.net/dev-portal/guide

Include the SDK script in the document head and initialize it using a CSS selector for product elements.

```html
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Example HTML< /title>
    <script
      defer
      src="https://static.kinguin.net/checkout/sdk/sdk-1.4.0.min.js"
    >< /script>
  </head>
  <body>
    <div id="kinguinIframeWrapper"></div>
    <div
      class="productCard"
      data-product="https://www.kinguin.net/category/12345"
    >
      Product 1
    </div>
    <div
      class="productCard"
      data-product="https://www.kinguin.net/category/67890"
    >
      Product 2
    </div>
    <script>
      document.addEventListener('DOMContentLoaded', function () {
        window.kinguinCheckoutSDK.init({
          productsSelector: '.productCard',
        });
      });
    < /script>
  </body>
</html>
```

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

### Initialize Kinguin SDK with partial configuration

Source: https://www.kinguin.net/dev-portal/guide

Initializes the SDK using only a subset of available options, allowing the remaining settings to fall back to their default values.

```javascript
window.kinguinCheckoutSDK.init({
  wrapperSelector: '#myIframeWrapper',
  productsSelector: '.myProductElement',
  productUrlAttribute: 'data-product-url',
  currency: 'USD',
});
```

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

### window.kinguinCheckoutSDK.init(config)

Source: https://www.kinguin.net/dev-portal/guide

Initializes the Kinguin Checkout SDK with a configuration object. This method allows customization of the iframe injection, product selection, and checkout parameters.

```APIDOC
## window.kinguinCheckoutSDK.init(config)

### Description
Initializes the SDK with the provided configuration options. If an option is not provided, the SDK uses its default value.

### Parameters
#### Configuration Object
- **wrapperSelector** (string) - Optional - CSS selector for the wrapper element where the iframe will be injected. Default: "#kinguinIframeWrapper"
- **productsSelector** (string) - Optional - CSS selector for elements representing products that trigger the checkout flow. Default: ".productElement"
- **productUrlAttribute** (string) - Optional - Attribute name on product elements containing the product URL. Default: "data-product"
- **apmId** (string) - Optional - Payment method ID from Kinguin.
- **iframeId** (string) - Optional - ID attribute for the injected iframe. Default: "kinguinCheckoutIframe"
- **iframeWidth** (string) - Optional - Width of the iframe. Default: "100%"
- **iframeHeight** (string) - Optional - Height of the iframe. Default: "900px"
- **popupWidth** (number) - Optional - Width of the popup window in pixels. Default: 800
- **popupHeight** (number) - Optional - Height of the popup window in pixels. Default: 900
- **translations** (object) - Optional - Object containing messages for translation.
- **discount** (string) - Optional - Kinguin discount code.
- **language** (string) - Optional - Language code (en, pl, it, fr, de, pt, br, tr, es, cs, cn).
- **currency** (string) - Optional - ISO 4217 currency code.
- **email** (string) - Optional - Customer email address.
- **autoClaimOptions** (object) - Optional - Configuration object for auto-claim flow.

### Example
```javascript
window.kinguinCheckoutSDK.init({
  wrapperSelector: '#myIframeWrapper',
  productsSelector: '.myProductElement',
  productUrlAttribute: 'data-product-url',
  currency: 'USD',
  language: 'de'
});
```
```

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

### Create a wholesale offer via POST

Source: https://www.kinguin.net/dev-portal/guide

Enables wholesale for a product by defining tiers with specific level and discount values.

```bash
curl -X POST \
         -H "Authorization: Bearer ${TOKEN}" \
         -H "Content-Type: application/json" \
         -d '{
            "productId": "${PRODUCT_ID}", 
            "price": {"amount": 200, "currency": "EUR"},
            "wholesale": {
                "enabled": true,
                "name": "custom",
                "tiers": [
                    {"level": 1,"discount": 3},
                    {"level": 2,"discount": 4},
                    {"level": 3,"discount": 5},
                    {"level": 4,"discount": 7}
                ]
            }
        }' \
    https://gateway.kinguin.net/sales-manager-api/api/v1/offers
```

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

### GET /api/v1/merchants/findByName

Source: https://www.kinguin.net/dev-portal/documentation

Finds a merchant by their exact name.

```APIDOC
## GET /api/v1/merchants/findByName

### Description
Finds a merchant by their exact name.

### Method
GET

### Endpoint
/api/v1/merchants/findByName

### Parameters
#### Query Parameters
- **name** (string) - Required - Name of the merchant to find

### Response
#### Success Response (200)
- Successful

#### Error Response
- 401: Unauthorized
- 404: Merchant not found
```

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

### Initialize Kinguin SDK with custom configuration

Source: https://www.kinguin.net/dev-portal/guide

Initializes the SDK with a full set of custom configuration options to override default behavior.

```javascript
window.kinguinCheckoutSDK.init({
  wrapperSelector: '#myIframeWrapper',
  productsSelector: '.myProductElement',
  productUrlAttribute: 'data-product-url',
  iframeId: 'myCheckoutIframe',
  iframeWidth: '80%',
  iframeHeight: '700px',
  popupWidth: 900,
  popupHeight: 1000,
  translations: {
    popupOpenFail: 'Window could not be opened, please try again.',
  },
  discount: 'test123',
  language: 'de',
  currency: 'USD',
  email: 'test@test.com'
});
```

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

### GET /api/v1/merchants

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves information about the current seller.

```APIDOC
## GET /api/v1/merchants

### Description
Get Seller information.

### Method
GET

### Endpoint
/api/v1/merchants

### Response
#### Success Response (200)
- **type** (string) - Merchant type
- **status** (string) - Merchant status

#### Response Example
{
  "type": "C2C",
  "status": "string"
}
```

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

### GET /api/v1/merchants/findByNameLike

Source: https://www.kinguin.net/dev-portal/documentation

Finds merchants by a partial name match.

```APIDOC
## GET /api/v1/merchants/findByNameLike

### Description
Finds merchants by a partial name match.

### Method
GET

### Endpoint
/api/v1/merchants/findByNameLike

### Parameters
#### Query Parameters
- **name** (string) - Required - Name of the merchant to find (partial match)

### Response
#### Success Response (200)
- Successful

#### Response Example
[
  {
    "id": 0,
    "name": "string"
  }
]
```

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

### Initialize SDK with Auto-claim Flow

Source: https://www.kinguin.net/dev-portal/guide

Configures the SDK initialization object with autoClaimOptions enabled.

```javascript
window.kinguinCheckoutSDK.init({
  wrapperSelector: '#myIframeWrapper',
  currency: 'EUR',
  discount: 'test123',
  autoClaimOptions: {
    autoClaim: true,
    emailConfirmed: true,
    tokenizedEmail: 'qtLHriIkq0KQdJgKlbHpQfuM1tFlJtCYXe-F2YitqQrh7UYF--77CxQ',
    tokenizedData: 'p--RdR6ON9h-4LwJFsWDRwecmlQpXKx3mjgVK3CUm1DRAapbUwKpqBD5_52T0WCWCkA6xx--LuceUvunwyQJkdY3UM1ZoupuwW7VPr_ALRCVX9G8WI2CS7oYIHR0qZqEGZei1zjul2w3Ubaphf62rDbcfbWPodnYCx6JW4TNxTo1W2zJfq3c'
  }
});
```

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

### GET /api/v1/offers/{offerId}/position

Source: https://www.kinguin.net/dev-portal/documentation

Calculates the position for a specific offer.

```APIDOC
## GET /api/v1/offers/{offerId}/position

### Description
Calculates the position for a specific offer.

### Method
GET

### Endpoint
/api/v1/offers/{offerId}/position

### Parameters
#### Path Parameters
- **offerId** (string) - Required

#### Query Parameters
- **bid** (integer) - Optional
- **price** (integer) - Optional

### Response
#### Success Response (200)
- Successful

#### Error Response
- 401: Unauthorized
- 404: Not Found

#### Response Example
{
  "current": 0,
  "new": 0,
  "currentBuyButtonProbability": 0.1,
  "newBuyButtonProbability": 0.1,
  "buyButtonBidEnabled": true,
  "tier": {
    "from": 0,
    "maxDiff": 0.1,
    "entryFee": 0,
    "step": 0,
    "minBid": 0
  },
  "nextValidBid": 0
}
```

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

### Create an offer via cURL

Source: https://www.kinguin.net/dev-portal/guide

Use this endpoint to create a new offer by providing the productId and price. Ensure the Authorization header includes a valid Bearer token.

```bash
curl -X POST \
         -H "Authorization: Bearer ${TOKEN}" \
         -H "Content-Type: application/json" \
         -d '{"productId": "${PRODUCT_ID}", "price": {"amount": 2, "currency": "EUR"}}' \
    https://gateway.kinguin.net/sales-manager-api/api/v1/offers
```

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

### GET /api/v1/merchants/status

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves the status and detailed statistics for the authenticated merchant.

```APIDOC
## GET /api/v1/merchants/status

### Description
Retrieves the current status, stock configurations, and performance statistics for the authenticated merchant.

### Method
GET

### Endpoint
/api/v1/merchants/status

### Response
#### Success Response (200)
- **id** (integer) - Merchant ID
- **name** (string) - Merchant name
- **status** (string) - Current merchant status
- **maxDeclaredStock** (integer) - Maximum declared stock
- **maxPreOrderStock** (integer) - Maximum pre-order stock
- **statusStockOnReturn** (string) - Stock status on return
- **updatedAt** (string) - Last update timestamp
- **createdAt** (string) - Creation timestamp
- **testAccount** (boolean) - Indicates if it is a test account
- **wholesaler** (boolean) - Indicates if the merchant is a wholesaler
- **type** (string) - Merchant type (e.g., C2C)
- **email** (string) - Merchant email address

#### Response Example
{
  "id": 0,
  "name": "string",
  "status": "string",
  "maxDeclaredStock": 0,
  "maxPreOrderStock": 0,
  "statusStockOnReturn": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "testAccount": true,
  "wholesaler": true,
  "type": "C2C",
  "email": "string"
}
```

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

### GET /api/v1/alerts/{alertId}

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves the details of a specific alert by its ID.

```APIDOC
## GET /api/v1/alerts/{alertId}

### Description
Retrieves the details of a specific alert by its ID.

### Method
GET

### Endpoint
/api/v1/alerts/{alertId}

### Parameters
#### Path Parameters
- **alertId** (string) - Required - ID of the alert to retrieve

### Response
#### Success Response (200)
- **id** (string) - Alert ID
- **sellerId** (integer) - Seller ID
- **type** (string) - Alert type
- **status** (string) - Alert status
- **createdAt** (string) - Creation timestamp
- **lastStatusCheck** (string) - Last status check timestamp
- **nextStatusCheck** (string) - Next status check timestamp
- **source** (object) - Source details
- **emailCount** (integer) - Email count
- **ignored** (boolean) - Whether the alert is ignored

#### Response Example
{
  "id": "string",
  "sellerId": 0,
  "type": "STOCK_NOT_UPLOADED",
  "status": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastStatusCheck": "2019-08-24T14:15:22Z",
  "nextStatusCheck": "2019-08-24T14:15:22Z",
  "source": {},
  "emailCount": 0,
  "ignored": true
}
```

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

### Upload Upfront Stock via API

Source: https://www.kinguin.net/dev-portal/guide

Use this cURL request to upload a stock key to an existing offer. Ensure the offer ID is provided in the URL and the authorization token is set.

```bash
curl -X POST \
         -H "Authorization: Bearer ${TOKEN}" \
         -H "Content-Type: application/json" \
         -d '{"body": "key123", "mimeType": "text/plain"}' \
    https://gateway.kinguin.net/sales-manager-api/api/v1/offers/${OFFER_ID}/stock
```

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

### GET /api/v1/reservations/stats

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves statistics for reservations based on provided filter parameters.

```APIDOC
## GET /api/v1/reservations/stats

### Description
Retrieves statistics for reservations based on provided filter parameters.

### Method
GET

### Endpoint
/sales-manager-api/api/v1/reservations/stats

### Parameters
#### Query Parameters
- **filters** (object) - Optional - Filter parameters for reservations statistics

### Response
#### Success Response (200)
- **Map<String, Stats>** (object) - Successful, returns a map of statistics.

#### Response Example
{
  "property1": {
    "dateToString": "string",
    "price": 0,
    "bid": 0,
    "count": 0
  },
  "property2": {
    "dateToString": "string",
    "price": 0,
    "bid": 0,
    "count": 0
  }
}
```

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

### GET /api/v1/reservations

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves a paginated list of reservations based on provided filters.

```APIDOC
## GET /api/v1/reservations

### Description
Retrieves a list of reservations. This endpoint supports filtering and pagination.

### Method
GET

### Endpoint
/api/v1/reservations

### Parameters
#### Query Parameters
- **filters** (object) - Optional - Filter parameters for reservations (ReservationsFilter)
- **page** (object) - Optional - Page parameters (Pageable)

### Response
#### Success Response (200)
- **content** (array) - List of reservation objects
- **pageable** (object) - Pagination metadata
- **totalPages** (integer) - Total number of pages
- **totalElements** (integer) - Total number of elements

#### Response Example
{
  "content": [
    {
      "id": "string",
      "orderIncrementId": "string",
      "status": "string"
    }
  ],
  "totalPages": 0,
  "totalElements": 0
}
```

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

### GET /api/v1/offers/{offerId}

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves the details of a specific offer using its unique identifier.

```APIDOC
## GET /api/v1/offers/{offerId}

### Description
Retrieves the details of a specific offer using its unique identifier.

### Method
GET

### Endpoint
/api/v1/offers/{offerId}

### Parameters
#### Path Parameters
- **offerId** (string) - Required - ID of the offer to retrieve

### Response
#### Success Response (200)
- **id** (string) - Offer ID
- **productId** (string) - Product ID
- **name** (string) - Offer name
- **sellerId** (integer) - Seller ID
- **status** (string) - Offer status
- **price** (object) - Price details
- **availableStock** (integer) - Available stock count

#### Response Example
{
  "id": "string",
  "productId": "string",
  "name": "string",
  "sellerId": 0,
  "status": "string",
  "price": {
    "amount": 0,
    "currency": "string"
  }
}
```

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

### POST /sales-manager-api/api/v1/offers

Source: https://www.kinguin.net/dev-portal/guide

Creates a new offer with wholesale configuration enabled.

```APIDOC
## POST /sales-manager-api/api/v1/offers

### Description
Creates a new offer and configures wholesale settings including tiers and discounts.

### Method
POST

### Endpoint
https://gateway.kinguin.net/sales-manager-api/api/v1/offers

### Request Body
- **productId** (string) - Required - The ID of the product.
- **price** (object) - Required - The base price object containing amount and currency.
- **wholesale** (object) - Required - Wholesale configuration including enabled status, name, and tiers.

### Response
#### Success Response (200)
- **id** (string) - The ID of the created offer.
- **priceIWTR** (object) - The IWTR price details.
- **price** (object) - The base price details.
- **wholesale** (object) - The wholesale configuration details.
```

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

### Create an in-game offer

Source: https://www.kinguin.net/dev-portal/guide

Use this request to list a new in-game product offer. Requires an existing product ID and specific delivery parameters.

```curl
curl -X POST \
        -H "Authorization: Bearer ${TOKEN}" \
        -H "Content-Type: application/json" \
        -d '{
               "productId": "66d8320d77a097501e74a356",
                "price": {
                    "amount": 200, // price for the quantity specified in minQuantity
                    "currency": "EUR"
                },
                "declaredStock": 999999999,
                "status": "ACTIVE",
                "deliveryMethods": [
                    "FACE_TO_FACE"
                ],
                "minQuantity": 1000, // the price field corresponds to this quantity
                "description": "Short description.",
                "deliveryTime": "2h"
              }' \
   https://gateway.kinguin.net/sales-manager-api/api/v1/offers
```

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

### POST /sales-manager-api/api/v1/offers

Source: https://www.kinguin.net/dev-portal/guide

Creates a new in-game offer for a specific product.

```APIDOC
## POST /sales-manager-api/api/v1/offers

### Description
Creates a new in-game offer for a specified product with defined pricing, stock, and delivery methods.

### Method
POST

### Endpoint
https://gateway.kinguin.net/sales-manager-api/api/v1/offers

### Request Body
- **productId** (String) - Required - ID of an existing product.
- **price** (Object) - Required - Contains amount (Long, max 1000000) and currency ("EUR").
- **declaredStock** (Integer) - Required - Quantity available (max 999999999).
- **status** (String) - Required - "ACTIVE" or "INACTIVE".
- **deliveryMethods** (Array) - Required - List of methods: ["FACE_TO_FACE", "GUILD_BANK", "EMAIL", "AUCTION_HOUSE"].
- **minQuantity** (Integer) - Required - Minimum order amount.
- **description** (String) - Optional - Offer description (max 2000 chars).
- **deliveryTime** (String) - Required - Delivery time frame (e.g., "1h" to "12h").
```

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

### GET /api/v1/reservations/csv

Source: https://www.kinguin.net/dev-portal/documentation

Exports reservation data to a CSV format based on provided filters.

```APIDOC
## GET /api/v1/reservations/csv

### Description
Exports reservation data to a CSV format based on provided filters.

### Method
GET

### Endpoint
/sales-manager-api/api/v1/reservations/csv

### Parameters
#### Query Parameters
- **filters** (object) - Optional - Filter parameters for reservations to export

### Response
#### Success Response (200)
- Successful
```

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

### GET /api/v1/alerts

Source: https://www.kinguin.net/dev-portal/documentation

Retrieves a list of alerts based on provided filter and pagination parameters.

```APIDOC
## GET /api/v1/alerts

### Description
Retrieves a paginated list of alerts for the authenticated merchant.

### Method
GET

### Endpoint
/api/v1/alerts

### Parameters
#### Query Parameters
- **filter** (object) - Optional - Filter parameters for alerts (AlertsFilter)
- **page** (object) - Optional - Page parameters (Pageable)

### Response
#### Success Response (200)
- **content** (array) - List of alert objects
- **pageable** (object) - Pagination metadata
- **totalPages** (integer) - Total number of pages
- **totalElements** (integer) - Total number of elements

#### Response Example
{
  "content": [
    {
      "id": "string",
      "sellerId": 0,
      "type": "STOCK_NOT_UPLOADED",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "totalPages": 0,
  "totalElements": 0
}
```

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

### Create a pre-purchase offer via API

Source: https://www.kinguin.net/dev-portal/guide

Use this request to create a pre-purchase offer by specifying a maxDeliveryDate. This offer will appear in the Wholesale tab of the Merchant Panel.

```bash
curl -X POST \
         -H "Authorization: Bearer ${TOKEN}" \
         -H "Content-Type: application/json" \
         -d '{"productId": "${PRODUCT_ID}", "price": {"amount": 2, "currency": "EUR", "maxDeliveryDate":"2025-08-30"}}' \
    https://gateway.kinguin.net/sales-manager-api/api/v1/offers
```
Tokens:
Raw