Driffle Seller API

https://docs.driffle.com
Admin
Driffle Seller API is a REST API that enables merchants to manage sales, automate pricing and stock,...
Tokens:74,496
Snippets:274
Trust Score:9.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Driffle Seller API Guide: Getting Started

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/getting-started

This guide covers essential steps for using the Driffle Seller API, including setting up your environment, generating API keys, and understanding authorization.

```APIDOC
Getting Started:
  Recommended Tools:
    - Information on recommended tools for API interaction.

  Environments in Driffle API:
    - Details on different API environments (e.g., sandbox, production).

  Getting Access:
    - Steps to obtain access to the Driffle Seller API.

  1. Generating an API Key:
    - Instructions on how to generate API keys for authentication.

  2. Authorization:
    - Explanation of the authorization process, likely involving OAuth or token-based authentication.

  3. Using the access token:
    - Guidance on how to use the obtained access token in API requests.
```

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

### Example cURL Request for Products List

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/products/get-products-list

This snippet shows an example of how to make a GET request to the Driffle Products List API using cURL, including the necessary Host and Authorization headers.

```HTTP
GET /api/seller/legacy/products HTTP/1.1
Host: services.driffle.com
Authorization: text
Accept: */*
```

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

### Example Request - Get Product Competitions

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/monitoring-your-competition

Example cURL request to fetch competitor data for a product.

```HTTP
GET /api/seller/legacy/products/{pid}/competitions HTTP/1.1
Host: services.driffle.com
Authorization: Bearer <token>
Accept: */*
```

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

### JavaScript Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/manage-inventory-stock/fetch-a-single-key

Example of how to fetch a single key using JavaScript.

```JavaScript
fetch('https://services.driffle.com/api/seller/legacy/key', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  params: {
    'hash': 'your_hash_string'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

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

### JavaScript Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions/get-transactions-list

Example of a JavaScript fetch request to get the transactions list.

```JavaScript
fetch('https://services.driffle.com/api/seller/legacy/transactions/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_token>',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

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

### API Response Examples

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/manage-inventory-stock/fetch-a-single-key

Examples of successful and error responses from the fetch single key API endpoint.

```APIDOC
200 OK Response:
{
  "message": "text",
  "statusCode": 1,
  "data": {
    "type": "text",
    "key": "text"
  }
}

400 Bad Request Response:
{
    "message": "Bad Request. Wrong/Invalid params format.",
    "statusCode": 400 
}

401 Unauthorized Response:
{
    "message": "UnAuthorized request. Invalid/Expired token",
    "statusCode": 401
}

403 Forbidden Response:
{
    "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.", 
    "statusCode": 403
}

500 Server Error Response:
{
    "message": "Internal Server Error",
    "statusCode": 500
}
```

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

### cURL Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/manage-inventory-stock/fetch-a-single-key

Example of how to make a GET request to the fetch single key endpoint using cURL.

```cURL
GET /api/seller/legacy/key HTTP/1.1
Host: services.driffle.com
Authorization: text
Accept: */*
```

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

### HTTP Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions/get-transactions-list

Example of an HTTP GET request to the transactions list endpoint.

```HTTP
GET /api/seller/legacy/transactions/ HTTP/1.1
Host: services.driffle.com
Authorization: text
Accept: */*
```

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

### HTTP Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/manage-inventory-stock/fetch-a-single-key

Example of the HTTP request structure for fetching a single key.

```HTTP
GET /api/seller/legacy/key HTTP/1.1
Host: services.driffle.com
Authorization: text
Accept: */*
```

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

### Python Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/manage-inventory-stock/fetch-a-single-key

Example of how to fetch a single key using Python's requests library.

```Python
import requests

url = "https://services.driffle.com/api/seller/legacy/key"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
params = {
    "hash": "your_hash_string"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
```

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

### cURL Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions/get-transactions-list

Example of a cURL command to fetch the transactions list.

```cURL
curl -X GET "https://services.driffle.com/api/seller/legacy/transactions/" \
     -H "Authorization: Bearer <your_token>"
```

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

### API Response Examples

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/offers-auction/enable-disable-offers

Examples of successful and error responses from the Offer Toggle API.

```json
{
  "message": "text",
  "statusCode": 1
}
```

```json
{
  "message": "Bad Request. Wrong/Invalid params format.",
  "statusCode": 400
}
```

```json
{
    "message": "UnAuthorized request. Invalid/Expired token",
    "statusCode": 401
}
```

```json
{
    "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.", 
    "statusCode": 403
}
```

```json
{
    "message": "Internal Server Error",
    "statusCode": 500
}
```

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

### Example Response - 200 OK

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/monitoring-your-competition

Successful response containing competition data for a product.

```JSON
{
  "message": "Default Response",
  "statusCode": 200,
  "pid": 123,
  "competitions": {
    "totalCount": 10,
    "offers": [
      {
        "merchantName": "Merchant A",
        "isInStock": true,
        "canBePurchased": true,
        "belongsToYou": false,
        "price": {
          "amount": 29.99,
          "currency": "USD"
        }
      }
    ]
  }
}
```

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

### JavaScript Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions/get-a-single-transaction

Example of a JavaScript fetch request to get a single transaction.

```JavaScript
fetch('https://services.driffle.com/api/seller/legacy/transactions/{txnId}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_token>',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

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

### Offer Toggle API Request Examples

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/offers-auction/enable-disable-offers

Examples of how to call the Offer Toggle API using cURL, JavaScript, and Python.

```bash
PUT /api/seller/legacy/offer/toggle HTTP/1.1
Host: services.driffle.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "offerId": 1,
  "type": "disable"
}
```

```javascript
fetch("https://services.driffle.com/api/seller/legacy/offer/toggle", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
  },
  body: JSON.stringify({
    "offerId": 1,
    "type": "disable"
  })
})
.then(response => response.json())
.then(data => console.log(data));
```

```python
import requests

url = "https://services.driffle.com/api/seller/legacy/offer/toggle"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}
payload = {
    "offerId": 1,
    "type": "disable"
}

response = requests.put(url, headers=headers, json=payload)
print(response.json())
```

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

### Python Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions/get-transactions-list

Example of a Python requests call to retrieve the transactions list.

```Python
import requests

url = "https://services.driffle.com/api/seller/legacy/transactions/"
headers = {
    "Authorization": "Bearer <your_token>",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code} - {response.text}")
```

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

### HTTP Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions/get-a-single-transaction

Example of an HTTP GET request to retrieve a single transaction.

```HTTP
GET /api/seller/legacy/transactions/{txnId} HTTP/1.1
Host: services.driffle.com
Authorization: text
Accept: */*
```

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

### Driffle Seller API Legacy Token Generation

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/getting-started

Example requests to generate an access token for the Driffle Seller API Legacy using cURL, NodeJS, and PHP. These examples demonstrate how to make a POST request to the /api/seller/legacy/token endpoint with an API key.

```curl
curl -X POST https://services.driffle.com/api/seller/legacy/token \
--header 'Content-Type: application/json' \
--data '{ \
    "apiKey": "226c911a60d9eb4395782456b7488c44.b8e6204d08def735b5084ced36596986512a2578772b42b8998847276d0de9a6" \
}'
```

```javascript
const axios = require("axios")
const url = "https://services.driffle.com/api/seller/legacy/token"
const response = await axios.post(url, {
    apiKey: "226c911a60d9eb4395782456b7488c44.b8e6204d08def735b5084ced36596986512a2578772b42b8998847276d0de9a6",
})
const data = response.data
console.log(data)
```

```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://services.driffle.com/api/seller/legacy/token',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{ \
    "apiKey": "226c911a60d9eb4395782456b7488c44.b8e6204d08def735b5084ced36596986512a2578772b42b8998847276d0de9a6" \
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```

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

### cURL Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions/get-a-single-transaction

Example of a cURL command to fetch a single transaction.

```cURL
curl -X GET https://services.driffle.com/api/seller/legacy/transactions/{txnId} \
     -H "Authorization: Bearer <your_token>" \
     -H "Content-Type: application/json"
```

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

### API Response Examples

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions/get-transactions-list

Examples of different HTTP response codes and their JSON bodies for the transactions list API.

```APIDOC
200 OK Response:
{
  "message": "text",
  "statusCode": 200,
  "data": [
    {
      "created": "string",
      "txn_id": "string",
      "order_id": "string",
      "order_item_id": "number",
      "title": "string",
      "txn_type": "number",
      "country": "string",
      "amount_base": "number",
      "paid_amount": "number",
      "commission_base": "number",
      "related_to": "string",
      "reason": "string",
      "vatAmountBase": "number",
      "campaignFee": "number"
    }
  ],
  "total_pages": 0
}

400 Bad Request Response:
{
    "message": "Bad Request. Wrong/Invalid params format.",
    "statusCode": 400 
}

401 Unauthorized Response:
{
    "message": "UnAuthorized request. Invalid/Expired token",
    "statusCode": 401
}

403 Forbidden Response:
{
    "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.", 
    "statusCode": 403
}

500 Server Error Response:
{
    "message": "Internal Server Error",
    "statusCode": 500
}
```

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

### Update Offer cURL Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/offers-auction/update-offer

Example of how to update an offer using cURL, demonstrating the HTTP method, host, authorization header, content type, and the request body.

```curl
PATCH /api/seller/legacy/offer/update HTTP/1.1
Host: services.driffle.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 85
{
  "offerId": 1,
  "yourPrice": 1,
  "retailPrice": 1,
  "toggleOffer": "disable",
  "declaredStock": 1
}
```

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

### Update Offer Success Response Example (JSON)

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/offers-auction/update-offer

Example of a successful response (HTTP 200) from the offer update API, showing the structure of the JSON response with message, statusCode, and data fields.

```json
{
  "message": "text",
  "statusCode": 1,
  "data": null
}
```

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

### Example Response - 400 Bad Request

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/monitoring-your-competition

Response indicating a bad request due to invalid parameters.

```JSON
{
  "message": "Bad Request. Wrong/Invalid params format.",
  "statusCode": 400
}
```

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

### Driffle Seller API - Automate Stock with Declare Stock

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference

Detailed guide on automating stock management using the 'Declare Stock' feature. Includes sequence diagrams and reservation information.

```APIDOC
Automate Your Stock with "Declare Stock":

Important Notes:
  - This section details the process of automating stock management.

Enabling "Declared Stock" Feature:
  - Instructions on how to enable the 'Declared Stock' feature are provided.

Sequence Diagrams:
  - Provides sequence diagrams illustrating the workflow of stock declaration.

Reservation:
  - Information regarding stock reservation mechanisms within the system.
```

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

### Update Offer Request Body Example (JSON)

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/offers-auction/update-offer

A sample JSON payload for the offer update API, illustrating the structure and data types for offerId, yourPrice, retailPrice, toggleOffer, and declaredStock.

```json
{
  "offerId": 0,
  "yourPrice": 0,
  "retailPrice": 0,
  "toggleOffer": "disable",
  "declaredStock": 100000
}
```

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

### Driffle Seller API - Products

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference

Endpoints for retrieving product information. Includes methods to get a list of all products and details for a single product. Also provides information on product commissions.

```APIDOC
Products API:

Get Products List:
  GET /products
  Description: Retrieves a list of all products available.
  Parameters: None
  Returns: A list of product objects.

Get Single Product:
  GET /products/{productId}
  Description: Retrieves detailed information for a specific product.
  Parameters:
    - productId (string, required): The unique identifier of the product.
  Returns: A product object.

Get Product Commission:
  GET /products/{productId}/commission
  Description: Retrieves the commission details for a specific product.
  Parameters:
    - productId (string, required): The unique identifier of the product.
  Returns: Commission details for the product.
```

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

### Driffle Seller API - Products

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/offers-auction/offers-list

Provides endpoints for retrieving product information. Includes methods to get a list of all products and details for a single product, as well as product commission information.

```APIDOC
Products:
  Get Products List:
    Endpoint: /products
    Method: GET
    Description: Retrieves a paginated list of all products.
    Parameters:
      - page (int, optional): The page number for pagination.
      - limit (int, optional): The number of items per page.
    Returns:
      - List of products with their details.

  Get Single product:
    Endpoint: /products/{productId}
    Method: GET
    Description: Retrieves detailed information for a specific product.
    Parameters:
      - productId (string, required): The unique identifier of the product.
    Returns:
      - Product details.

  Get Product Commission:
    Endpoint: /products/{productId}/commission
    Method: GET
    Description: Retrieves the commission rate for a specific product.
    Parameters:
      - productId (string, required): The unique identifier of the product.
    Returns:
      - Commission rate for the product.
```

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

### Driffle Seller API - Competitions Endpoint

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/competition

This snippet details the GET request for retrieving competitions for a specific product. It includes path parameters, headers, and query parameters like 'name' and 'age'. It also provides example responses for success (200) and error scenarios (400, 401, 403, 500).

```APIDOC
GET /products/{pid}/competitions

**Headers**
Name: Content-Type
Value: `application/json`
Name: Authorization
Value: `Bearer <token>`

**Parameters**
Param: pid
Param type: path param
Type: Number
Required: Yes
Description: Driftle Product ID

Name: name
Type: string
Description: Name of the user

Name: age
Type: number
Description: Age of the user

**Responses**
**200 OK**
```json
{
"message":"Default Response",
"statusCode":200,
"pid":123,
"competitions": {
"totalCount":10,
"offers": [
      {
"merchantName":"Merchant A",
"isInStock":true,
"canBePurchased":true,
"belongsToYou":false,
"price": {
"amount":29.99,
"currency":"USD"
        }
      }
    ]
  }
}
```

**400 Bad Request**
```json
{
"message":"Bad Request. Wrong/Invalid params format.",
"statusCode":400}
```

**401 Unauthorized**
```json
{
    "message": "UnAuthorized request. Invalid/Expired token",
    "statusCode": 401
}
```

**403 Forbidden**
```json
{
    "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.", 
    "statusCode": 403
}
```

**500 Internal Server Error**
```json
{
    "message": "Internal Server Error",
    "statusCode": 500
}
```
```

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

### Driffle API Environments

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/getting-started

Details the available environments for the Driffle API, including production and sandbox URLs. Note that sandbox support is being discontinued.

```APIDOC
Production:
> https://services.driffle.com/api/seller/legacy

Sandbox:
> https://sandbox.driffle.com/api/seller
```

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

### Driffle Seller API Navigation

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference

Provides links for navigating between related API documentation sections, specifically for 'Automate Your Stock with "Declare Stock"' and 'Products'.

```APIDOC
Previous: Automate Your Stock with "Declare Stock" - https://docs.driffle.com/driffle-seller-api-legacy/reference/automate-your-stock-with-declare-stock
Next: Products - https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/products
```

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

### Python Request Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions/get-a-single-transaction

Example of a Python requests call to retrieve a single transaction.

```Python
import requests

txn_id = 'your_transaction_id'
auth_token = 'your_bearer_token'

url = f'https://services.driffle.com/api/seller/legacy/transactions/{txn_id}'
headers = {
    'Authorization': f'Bearer {auth_token}',
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
elif response.status_code == 400:
    print("Bad Request")
elif response.status_code == 401:
    print("Unauthorized")
elif response.status_code == 403:
    print("Forbidden")
else:
    print(f"Error: {response.status_code}")
```

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

### Driffle Seller API Reference

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/getting-started

This section details the various endpoints available in the Driffle Seller API, including methods for managing products, competition, offers, inventory, transactions, dashboard statistics, regions, and platforms.

```APIDOC
Products:
  GET /products
    - Retrieves a list of all products.
    - Returns: List of products.

  GET /products/{productId}
    - Retrieves details for a single product.
    - Parameters:
      - productId: The unique identifier of the product.
    - Returns: Product details.

  GET /products/{productId}/commission
    - Retrieves the commission details for a specific product.
    - Parameters:
      - productId: The unique identifier of the product.
    - Returns: Commission details.

Competition:
  GET /competition
    - Retrieves competition data.
    - Returns: Competition data.

Offers (Auction):
  GET /offers
    - Retrieves a list of offers.
    - Returns: List of offers.

  GET /offers/{offerId}
    - Retrieves details for a single offer.
    - Parameters:
      - offerId: The unique identifier of the offer.
    - Returns: Offer details.

  PUT /offers/{offerId}/price
    - Updates the price of an existing offer.
    - Parameters:
      - offerId: The unique identifier of the offer.
      - price: The new price for the offer.
    - Returns: Updated offer details.

  POST /offers/{offerId}/enable-disable
    - Enables or disables an offer.
    - Parameters:
      - offerId: The unique identifier of the offer.
      - status: 'enable' or 'disable'.
    - Returns: Status update confirmation.

  POST /offers
    - Creates a new offer.
    - Parameters: Offer details.
    - Returns: Details of the newly created offer.

  PUT /offers/{offerId}
    - Updates an existing offer.
    - Parameters:
      - offerId: The unique identifier of the offer.
      - offerDetails: Updated offer information.
    - Returns: Updated offer details.

  PUT /offers/bulk-update
    - Performs bulk updates on multiple offers.
    - Parameters: List of offers to update.
    - Returns: Bulk update status.

Manage Inventory/Stock:
  POST /inventory/declare
    - Declares stock for products.
    - Parameters: Stock declaration data.
    - Returns: Stock declaration status.

  POST /inventory/upload
    - Uploads stock information.
    - Parameters: Stock upload data.
    - Returns: Stock upload status.

  POST /inventory/actions
    - Performs inventory actions.
    - Parameters: Inventory action data.
    - Returns: Inventory action status.

  GET /inventory/{key}
    - Fetches a single inventory item by key.
    - Parameters:
      - key: The key of the inventory item.
    - Returns: Inventory item details.

Transactions:
  GET /transactions
    - Retrieves a list of transactions.
    - Returns: List of transactions.

  GET /transactions/{transactionId}
    - Retrieves details for a single transaction.
    - Parameters:
      - transactionId: The unique identifier of the transaction.
    - Returns: Transaction details.

Dashboard Stats:
  GET /dashboard/stats
    - Retrieves statistics for the dashboard.
    - Returns: Dashboard statistics.

Regions:
  GET /regions
    - Retrieves a list of available regions.
    - Returns: List of regions.

Platforms:
  GET /platforms
    - Retrieves a list of supported platforms.
    - Returns: List of platforms.
```

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

### Driffle Seller API Legacy - Product Commission JavaScript Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/products/get-product-commission

This snippet demonstrates how to make a POST request to the product commission endpoint using JavaScript's fetch API. It includes setting headers and the request body.

```JavaScript
fetch('https://services.driffle.com/api/seller/legacy/product/commission', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <token>'
  },
  body: JSON.stringify({
    productId: 1,
    sellingPrice: 1
  })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

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

### Driffle Seller API - Platforms

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/automate-your-stock-with-declare-stock

Provides information about supported platforms within the Driffle ecosystem.

```APIDOC
Platforms API:

Get Platforms List:
  Endpoint: /platforms
  Method: GET
  Description: Retrieves a list of supported platforms.
  Parameters: None.
  Returns: A list of platform objects.
```

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

### Driffle Seller API - Platforms

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/monitoring-your-competition

Endpoint for retrieving information about supported platforms.

```APIDOC
GET /platforms
  Description: Retrieves a list of supported platforms.
  Returns: A list of platform objects.
```

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

### Fetch Single Key - Parameters and Headers

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/manage-inventory-stock/fetch-a-single-key

Details on the parameters and headers required for the fetch single key API call.

```APIDOC
GET /key

Headers:
Name: Content-Type
Value: application/json
Name: Authorization
Value: Bearer <token>

Supported Params:
Param: hash
Param Type: query
Type: string
Required: Yes
Description: Hash of the Key
```

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

### Driffle Seller API Provision Endpoint

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/automate-your-stock-with-declare-stock

Handles the provision of reserved keys for an order. Includes request and response schemas and retry logic.

```APIDOC
Provision Endpoint:
  POST /provision
  Attempts: 3 with 5s interval, 60s timeout per attempt.

Request Body:
  {
    "orderId": "string"
  }

Response (HTTP 200):
  {
    "message": "string",
    "data": {
      "orderId": "string",
      "offers": [
        {
          "offerId": number,
          "keys": [
            {
              "type": "TEXT" | "IMAGE",
              "value": "string"
            }
          ]
        }
      ]
    }
  }

Response Data Fields:
  - orderId (string): Reservation Order Id for purchase.
  - offers (array): Array of offers with keys in order.
    - offerId (number): Driffle OfferId.
    - keys (array): A collection of keys.
      - type (enum): Either `TEXT` or `IMAGE`. Indicates the key format.
      - value (string): A plain-text or base64-encoded image.

Important Notes:
  - Image type keys must be of types: `jpg, jpeg, png`.
  - Only raw base64 is supported for images. Remove HTML/CSS attributes like `data:image/png;base64,`.
```

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

### Driffle Seller API - Platforms

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/manage-inventory-stock/inventory-actions

Endpoint for retrieving information about supported platforms.

```APIDOC
GET /platforms
  Description: Retrieves a list of supported platforms.
  Returns: Array of platform objects.
```

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

### Example Response - 500 Internal Server Error

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/monitoring-your-competition

Response indicating an internal server error.

```JSON
{
  "message": "Internal Server Error",
  "statusCode": 500
}
```

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

### Driffle Seller API - Products

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/monitoring-your-competition

Endpoints for retrieving product information, including lists of products and details for a single product. Also provides information on product commissions.

```APIDOC
GET /products
  Description: Retrieves a list of all products.
  Parameters: None
  Returns: A list of product objects.

GET /products/{productId}
  Description: Retrieves details for a single product.
  Parameters:
    - productId (string): The unique identifier of the product.
  Returns: A product object with detailed information.

GET /products/{productId}/commission
  Description: Retrieves the commission details for a specific product.
  Parameters:
    - productId (string): The unique identifier of the product.
  Returns: Commission details for the product.
```

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

### Example Response - 401 Unauthorized

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/monitoring-your-competition

Response indicating an unauthorized request due to an invalid or expired token.

```JSON
{
  "message": "UnAuthorized request. Invalid/Expired token",
  "statusCode": 401
}
```

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

### Driffle Seller API - Platforms

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/products/get-products-list

Endpoint for retrieving information about supported platforms.

```APIDOC
APIDOC:
  Platforms:
    GET /platforms
      Description: Retrieves a list of supported platforms.
```

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

### Example Response - 403 Forbidden

Source: https://docs.driffle.com/driffle-seller-api-legacy/guide/monitoring-your-competition

Response indicating a forbidden request due to disallowed actions or rate limits.

```JSON
{
  "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.",
  "statusCode": 403
}
```

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

### Driffle Seller API - Declared Stock Domain Configuration

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/automate-your-stock-with-declare-stock

Details the configuration steps for the "Declared Stock" feature, specifically focusing on adding and verifying domain ownership using either DNS TXT records or a hosted file.

```APIDOC
Seller Menu
  1. **Declared Stock Configuration**
     * **Step - 1: Add Your Domain & verify the ownership: **
Domain ownership can be proven in two ways:
    1. [DNS TXT record validation](https://docs.driffle.com/driffle-seller-api-legacy/reference/automate-your-stock-with-declare-stock#dns-txt-record-validation)
    2. [Hosted file validation](https://docs.driffle.com/driffle-seller-api-legacy/reference/automate-your-stock-with-declare-stock#hosted-file-validation)
**Constraints for the domain name field**
     * Must be the base domain of your service. e.g. - **callback.driffle.com**
     * Must not be IP address
     * Domain length must not be greater than 500 characters
     * Must not contain query strings
> **Valid Domains -**
> www.yourdomain.com yourdomain.com api.yourdomain.com
> **Invalid Domains -** http://www.yourdomain.com - ("http://" present) https://www.yourdomain.com - ("https://" present) https://0.0.0.0 - (is IP address and "https://" present) www.yourdomain.com?action=reservation - (contains query strings)
```

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

### Get Single Transaction API

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions/get-a-single-transaction

Fetches the details of a single transaction using its ID. Requires an Authorization header.

```APIDOC
GET /api/seller/legacy/transactions/{txnId}

Path parameters:
- txnId (string, Required): The ID of the transaction.

Header parameters:
- Authorization (string, Required): Authorization token in Bearer format. Example: Bearer dvakycjgw8liyd278y

Responses:
- 200 (OK): Successful retrieval of transaction details.
  Content: application/json
  Response Body:
    {
      "message": "string",
      "statusCode": 1,
      "data": {
        "txnId": "string",
        "orderId": "string",
        "orderItemId": "number",
        "txnType": "number",
        "product": {
          "id": "string",
          "title": "string"
        },
        "key": {
          "id": "string"
        },
        "county": "string",
        "amount": "number",
        "commission": "number",
        "campaignFee": "number",
        "vatAmount": "number",
        "txnDate": "string"
      }
    }
- 400 (Bad Request): Invalid parameters format.
  Content: application/json
  Response Body:
    {
      "message": "Bad Request. Wrong/Invalid params format.",
      "statusCode": 400
    }
- 401 (Unauthorized): Invalid or expired token.
  Content: application/json
  Response Body:
    {
      "message": "UnAuthorized request. Invalid/Expired token",
      "statusCode": 401
    }
- 403 (Forbidden): Action not allowed or rate limit exhausted.
  Content: application/json
  Response Body:
    {
      "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.",
      "statusCode": 403
    }
- 500 (Internal Server Error): Server error.
  Content: application/json
  Response Body:
    {
      "message": "Internal Server Error",
      "statusCode": 500
    }
```

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

### Get Single Offer API Endpoint

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/offers-auction/get-single-offer

Retrieves a single offer by its ID. Supports filtering and pagination through query parameters.

```APIDOC
GET /offers/{id}

**Headers**
Name | Value
---|---
Content-Type | `application/json`
Authorization | `Bearer <token>`

**Params**
Param | Param Type | Type | Required | Description
---|---|---|---|---
id | path | number | Yes | Id of the Offer
search | query | string | No | Search for a Key in this offer
page | query | number | No | Page number. Default value: `1`
limit | query | number | No | Number of items per page. Default value: `10`
filter | query | string | No | Filter keys. Supported values: `inactive`, `live`, `sold`, `def` - defective

**Responses**
200
```json
{
"message":"string",
"statusCode":200,
"data": {
"pages":0,
"offer": {
"offerId":0,
"slug":"string",
"title":"string",
"countryRestrictions":"string",
"languages":"string",
"description":"string",
"platform":"string",
"productImage":"string",
"yourPrice":"string",
"commission":0,
"createdAt":"string",
"updatedAt":"string",
"lastUpdate":"string",
"status":0,
"productStatus":0,
"productId":0,
"regionId":"string",
"storeId":0,
"productType":"string",
"minPrice":"string",
"totalInActive":0,
"totalAvailable":0,
"totalDeclaredStock":0,
"declaredStockReservedKeys":0,
"inventoryReservedKeys":0,
"totalSold":0,
"totalDefective":0
    },
"stock": {
"totalCount":0,
"keys": [
        {
"keyId":0,
"hash":"string",
"value":"string",
"status":0,
"created":"string",
"soldAt":"string",
"cogs":0,
"format":"text"
        }
      ]
    }
  }
}
```
400
```json
{
    "message": "Bad Request. Wrong/Invalid params format.",
    "statusCode": 400 
}
```
401
```json
{
    "message": "UnAuthorized request. Invalid/Expired token",
    "statusCode": 401
}
```
403
```json
{
    "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.", 
    "statusCode": 403
}
```
500
```json
{
    "message": "Internal Server Error",
    "statusCode": 500
}
```
```

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

### Driffle Seller API - Transactions

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference

Endpoints for retrieving transaction history. Includes methods to get a list of all transactions and details for a single transaction.

```APIDOC
Transactions API:

Get Transactions List:
  GET /transactions
  Description: Retrieves a list of all transactions.
  Parameters: None
  Returns: A list of transaction objects.

Get a Single Transaction:
  GET /transactions/{transactionId}
  Description: Retrieves detailed information for a specific transaction.
  Parameters:
    - transactionId (string, required): The unique identifier of the transaction.
  Returns: A transaction object.
```

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

### Driffle API: Create Offer

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/offers-auction/create-a-new-offer

Creates a new offer or auction on the Driffle platform. Requires product ID and either yourPrice or retailPrice. Supports optional fields for cost of goods, keys, declared stock, and pre-order specific quantities.

```APIDOC
POST /offer

Headers:
  Content-Type: application/json
  Authorization: Bearer <token>

Request Body Parameters:
  product (object, required): { productId: number } - The ID of the product for which the offer is created.
  yourPrice (number, optional): The selling price. Commission is applied to this price. Either yourPrice or retailPrice is required.
  retailPrice (number, optional): The retail price or Buy Box Price. Commission is subtracted from this price. Either yourPrice or retailPrice is required.
  cogs (number, optional): The cost of purchasing a single key.
  keys (array<KeyUploadType>, optional): A list of keys to be uploaded. See KeyUploadType for details.
  declaredStock (number, optional): The number of keys to sell through the declared stock feature. Either keys or declaredStock should be provided.
  auctionedKeys (number, required for pre-order): The number of pre-orders to sell. Declared stock is not available for pre-order products.
```

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

### Driffle Seller API - Platforms

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/offers-auction/bulk-update-offers

Endpoint for retrieving information about supported platforms.

```APIDOC
APIDOC:
  /platforms
    GET: Platforms List
      Description: Retrieves a list of supported platforms.
      Returns: Array of platform objects.
```

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

### Driffle Seller API - Transactions

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/offers-auction

Endpoints for retrieving transaction data. Includes methods to get a list of all transactions and details for a single transaction.

```APIDOC
Transactions:
  Get Transactions List:
    Endpoint: /transactions
    Method: GET
    Description: Retrieves a list of all transactions.
    Parameters: None
    Returns: A list of transaction objects.

  Get a Single Transaction:
    Endpoint: /transactions/{transactionId}
    Method: GET
    Description: Retrieves detailed information for a specific transaction.
    Parameters:
      - transactionId (string, required): The unique identifier of the transaction.
    Returns: A transaction object.
```

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

### Driffle Seller API - Transactions

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/transactions

Endpoints for retrieving transaction data. Includes methods to get a list of all transactions and details for a single transaction.

```APIDOC
GET /transactions
  Description: Retrieves a list of all transactions.
  Returns: Array of transaction objects.

GET /transactions/{transactionId}
  Description: Retrieves details for a single transaction.
  Parameters:
    - transactionId (string): The unique identifier for the transaction.
  Returns: A transaction object.
```

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

### Driffle Seller API Legacy - Product Commission cURL Example

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/products/get-product-commission

This snippet provides a cURL command to test the product commission endpoint. It includes the necessary HTTP method, host, headers, and a sample JSON body.

```HTTP
POST /api/seller/legacy/product/commission HTTP/1.1
Host: services.driffle.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "productId": 1,
  "sellingPrice": 1
}
```

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

### Driffle Seller API - Products

Source: https://docs.driffle.com/driffle-seller-api-legacy/faq/cannot-use-the-api-it-throws-401-403-404-errors

API endpoints for managing products, including retrieving a list of all products and fetching details for a single product. Also includes an endpoint to get product commission information.

```APIDOC
Products:
  GET /products
    Description: Retrieves a list of all products.
    Parameters: None
    Returns: A list of product objects.

  GET /products/{productId}
    Description: Retrieves details for a single product.
    Parameters:
      - productId (string): The unique identifier of the product.
    Returns: A product object.

  GET /products/{productId}/commission
    Description: Retrieves the commission information for a specific product.
    Parameters:
      - productId (string): The unique identifier of the product.
    Returns: Commission details for the product.
```

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

### Driffle Seller API - Transactions

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/manage-inventory-stock/inventory-actions

Endpoints for retrieving transaction history. Includes methods to get a list of all transactions and details for a single transaction.

```APIDOC
GET /transactions/get-transactions-list
  Description: Retrieves a list of all transactions.
  Returns: Array of transaction objects.

GET /transactions/get-a-single-transaction/{transactionId}
  Description: Retrieves details for a single transaction.
  Parameters:
    - transactionId (string): The unique identifier of the transaction.
  Returns: A single transaction object.
```

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

### Driffle Seller API - Transactions

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/api-reference/products

Provides endpoints for retrieving transaction history. Includes methods to get a list of all transactions and fetch details for a single transaction.

```APIDOC
APIDOC:
  Transactions:
    Get Transactions List:
      Endpoint: /reference/api-reference/transactions/get-transactions-list
      Description: Retrieves a list of all transactions.
      Method: GET
      Returns: A list of transaction objects.

    Get a Single Transaction:
      Endpoint: /reference/api-reference/transactions/get-a-single-transaction
      Description: Retrieves detailed information for a specific transaction.
      Method: GET
      Parameters:
        - transaction_id (string): The unique identifier for the transaction.
      Returns: A single transaction object.
```

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

### Driffle Seller API - Products

Source: https://docs.driffle.com/driffle-seller-api-legacy/reference/automate-your-stock-with-declare-stock

Provides endpoints for managing product information within the Driffle platform. Includes methods to retrieve a list of all products, fetch details for a single product, and get commission information for products.

```APIDOC
Products API:

Get Products List:
  Endpoint: /products
  Method: GET
  Description: Retrieves a list of all products available.
  Parameters: None
  Returns: A list of product objects.

Get Single Product:
  Endpoint: /products/{productId}
  Method: GET
  Description: Retrieves detailed information for a specific product.
  Parameters:
    - productId (string, required): The unique identifier of the product.
  Returns: A product object.

Get Product Commission:
  Endpoint: /products/{productId}/commission
  Method: GET
  Description: Retrieves the commission details for a specific product.
  Parameters:
    - productId (string, required): The unique identifier of the product.
  Returns: Commission details for the product.
```
Tokens:
Raw