> For the complete documentation index, see [llms.txt](https://easyparser.gitbook.io/easyparser-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://easyparser.gitbook.io/easyparser-documentation/~/revisions/u2LgXrpZolvfuNVyA3bj/bulk-integration/bulk-service-request.md).

# Bulk Service Request

### 🧭 Overview

After successfully submitting a bulk request, you receive a response containing unique identifiers (IDs) for each accepted query. These IDs are not the final results themselves—they are references used to retrieve the parsed data once processing is complete.

To access the actual data output, you need to send a request to the **Data Service** endpoint using each ID provided in the response. This service gives you access to structured and ready-to-use information, such as product details, offers, or search result listings—depending on the operation type.

This section will walk you through how to make a proper request to the Data Service, including headers, endpoint usage, and example responses.

### 🧩Endpoint

```
POST https://bulk.easyparser.com/v1/bulk
```

### 🔑**Headers** <a href="#headerlar" id="headerlar"></a>

| Header       | Value            | Description                     |
| ------------ | ---------------- | ------------------------------- |
| api-key      | Your API Key     | Required for authentication.    |
| Content-Type | application/json | Specifies the JSON data format. |

### 👉Example Request&#x20;

{% tabs fullWidth="false" %}
{% tab title="cURL" %}
{% code overflow="wrap" %}

```bash
curl --location 'https://bulk.easyparser.com/v1/bulk' \
--header 'api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '[
    {
        "platform": "AMZ",
        "operation": "SEARCH",
        "domain": ".ca",
        "payload": {
            "urls": [
               "https://www.amazon.ca/s?k=electronics&crid=1CINN2KWI7D8L&sprefix=electronics%2Caps%2C120&ref=nb_sb_noss_1",
                "https://www.amazon.ca/s?k=smartphone&crid=1IX1CAAXNGZHH&sprefix=smartphone%2Caps%2C237&ref=nb_sb_noss_1"
            ],
            "address_id" : 872 ,
            "exclude_sponsored":"true" ,
            "sort_by":"price-asc-rank"
        },
        "callback_url": "https://example.com/webhook"
    }
]'
```

{% endcode %}
{% endtab %}

{% tab title="Python" %}
{% code overflow="wrap" %}

```python
import requests
import json

url = "https://bulk.easyparser.com/v1/bulk"

payload = json.dumps([
  {
    "platform": "AMZ",
    "operation": "SEARCH",
    "domain": ".ca",
    "payload": {
      "urls": [
        "https://www.amazon.ca/s?k=electronics&crid=1CINN2KWI7D8L&sprefix=electronics%2Caps%2C120&ref=nb_sb_noss_1",
        "https://www.amazon.ca/s?k=smartphone&crid=1IX1CAAXNGZHH&sprefix=smartphone%2Caps%2C237&ref=nb_sb_noss_1"
      ],
      "address_id": 872,
      "exclude_sponsored": "true",
      "sort_by": "price-asc-rank"
    },
    "callback_url": "https://example.com/webhook"
  }
])
headers = {
  'api-key': 'YOUR_API_KEY',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

```

{% endcode %}
{% endtab %}

{% tab title="Node.js" %}
{% code overflow="wrap" %}

```javascript
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://bulk.easyparser.com/v1/bulk',
  'headers': {
    'api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
    {
      "platform": "AMZ",
      "operation": "SEARCH",
      "domain": ".ca",
      "payload": {
        "urls": [
          "https://www.amazon.ca/s?k=electronics&crid=1CINN2KWI7D8L&sprefix=electronics%2Caps%2C120&ref=nb_sb_noss_1",
          "https://www.amazon.ca/s?k=smartphone&crid=1IX1CAAXNGZHH&sprefix=smartphone%2Caps%2C237&ref=nb_sb_noss_1"
        ],
        "address_id": 872,
        "exclude_sponsored": "true",
        "sort_by": "price-asc-rank"
      },
      "callback_url": "https://example.com/webhook"
    }
  ])

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

```

{% endcode %}
{% endtab %}

{% tab title="HTTP" %}
{% code overflow="wrap" %}

```http
POST /v1/bulk HTTP/1.1
Host: bulk.easyparser.com
api-key: YOUR_API_KEY
Content-Type: application/json
Content-Length: 631

[
    {
        "platform": "AMZ",
        "operation": "SEARCH",
        "domain": ".ca",
        "payload": {
            "urls": [
               "https://www.amazon.ca/s?k=electronics&crid=1CINN2KWI7D8L&sprefix=electronics%2Caps%2C120&ref=nb_sb_noss_1",
                "https://www.amazon.ca/s?k=smartphone&crid=1IX1CAAXNGZHH&sprefix=smartphone%2Caps%2C237&ref=nb_sb_noss_1"
            ],
            "address_id" : 872 ,
            "exclude_sponsored":"true" ,
            "sort_by":"price-asc-rank"
        },
        "callback_url": "https://example.com/webhook"
    }
]
```

{% endcode %}
{% endtab %}

{% tab title="PHP" %}
{% code overflow="wrap" %}

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://bulk.easyparser.com/v1/bulk',
  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 =>'[
    {
        "platform": "AMZ",
        "operation": "SEARCH",
        "domain": ".ca",
        "payload": {
            "urls": [
               "https://www.amazon.ca/s?k=electronics&crid=1CINN2KWI7D8L&sprefix=electronics%2Caps%2C120&ref=nb_sb_noss_1",
                "https://www.amazon.ca/s?k=smartphone&crid=1IX1CAAXNGZHH&sprefix=smartphone%2Caps%2C237&ref=nb_sb_noss_1"
            ],
            "address_id" : 872 ,
            "exclude_sponsored":"true" ,
            "sort_by":"price-asc-rank"
        },
        "callback_url": "https://example.com/webhook"
    }
]',
  CURLOPT_HTTPHEADER => array(
    'api-key: YOUR_API_KEY',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

```

{% endcode %}
{% endtab %}

{% tab title="GO" %}
{% code overflow="wrap" %}

```go
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://bulk.easyparser.com/v1/bulk"
  method := "POST"

  payload := strings.NewReader(`[
    {
        "platform": "AMZ",
        "operation": "SEARCH",
        "domain": ".ca",
        "payload": {
            "urls": [
               "https://www.amazon.ca/s?k=electronics&crid=1CINN2KWI7D8L&sprefix=electronics%2Caps%2C120&ref=nb_sb_noss_1",
                "https://www.amazon.ca/s?k=smartphone&crid=1IX1CAAXNGZHH&sprefix=smartphone%2Caps%2C237&ref=nb_sb_noss_1"
            ],
            "address_id" : 872 ,
            "exclude_sponsored":"true" ,
            "sort_by":"price-asc-rank"
        },
        "callback_url": "https://example.com/webhook"
    }
]`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("api-key", "YOUR_API_KEY")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
```

{% endcode %}
{% endtab %}

{% tab title="C#" %}
{% code overflow="wrap" %}

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://bulk.easyparser.com/v1/bulk");
request.Headers.Add("api-key", "YOUR_API_KEY");
var content = new StringContent("[\n    {\n        \"platform\": \"AMZ\",\n        \"operation\": \"SEARCH\",\n        \"domain\": \".ca\",\n        \"payload\": {\n            \"urls\": [\n                \"https://www.amazon.ca/s?k=electronics&crid=1CINN2KWI7D8L&sprefix=electronics%2Caps%2C120&ref=nb_sb_noss_1\",\n                \"https://www.amazon.ca/s?k=smartphone&crid=1IX1CAAXNGZHH&sprefix=smartphone%2Caps%2C237&ref=nb_sb_noss_1\"\n            ],\n            \"address_id\": 872,\n            \"exclude_sponsored\": \"true\",\n            \"sort_by\": \"price-asc-rank\"\n        },\n        \"callback_url\": \"https://example.com/webhook\"\n    }\n]", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

```

{% endcode %}
{% endtab %}

{% tab title="Java" %}
{% code overflow="wrap" %}

```java
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n    {\n        \"platform\": \"AMZ\",\n        \"operation\": \"SEARCH\",\n        \"domain\": \".ca\",\n        \"payload\": {\n            \"urls\": [\n                \"https://www.amazon.ca/s?k=electronics&crid=1CINN2KWI7D8L&sprefix=electronics%2Caps%2C120&ref=nb_sb_noss_1\",\n                \"https://www.amazon.ca/s?k=smartphone&crid=1IX1CAAXNGZHH&sprefix=smartphone%2Caps%2C237&ref=nb_sb_noss_1\"\n            ],\n            \"address_id\": 872,\n            \"exclude_sponsored\": \"true\",\n            \"sort_by\": \"price-asc-rank\"\n        },\n        \"callback_url\": \"https://example.com/webhook\"\n    }\n]");
Request request = new Request.Builder()
  .url("https://bulk.easyparser.com/v1/bulk")
  .method("POST", body)
  .addHeader("api-key", "YOUR_API_KEY")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
```

{% endcode %}
{% endtab %}
{% endtabs %}

### **📦 Bulk Request Structure and Parameters**

<table data-full-width="true"><thead><tr><th width="122" align="center">Key</th><th width="113" align="center">Type</th><th width="178" align="center">Required? (Request)</th><th width="195" align="center">Required? (Payload)</th><th width="367">Description</th></tr></thead><tbody><tr><td align="center">platform</td><td align="center">string</td><td align="center">✅</td><td align="center">—</td><td>The platform on which the operation will be performed. Currently, only the value “AMZ” is supported.</td></tr><tr><td align="center">operation</td><td align="center">string</td><td align="center">✅</td><td align="center">—</td><td>The type of parse operation to be performed. For example: SEARCH, DETAIL, OFFER...</td></tr><tr><td align="center">domain</td><td align="center">string</td><td align="center">✅</td><td align="center">—</td><td>Specifies the country domain to be parsed. For example: .ca, .com, .de.</td></tr><tr><td align="center">callback_url</td><td align="center">string</td><td align="center">✅</td><td align="center">—</td><td>The callback (webhook) URL to receive the results.</td></tr><tr><td align="center">address_id</td><td align="center">string</td><td align="center">❌</td><td align="center">❌</td><td>The ID of the address defined and activated by the user on the <a href="https://app.easyparser.com/addresses">EasyParser platform</a>. Specifying this allows scanning to be performed at the desired location.</td></tr><tr><td align="center">payload</td><td align="center">object</td><td align="center">✅</td><td align="center">✅</td><td>Special parameters included based on the operation type. For example, urls or keywords for SEARCH, urls or asins for DETAIL, and asins for OFFER.</td></tr><tr><td align="center">→ urls</td><td align="center">array</td><td align="center">—</td><td align="center">✅ (SEARCH, DETAIL)</td><td>A list of URLs to be parsed directly on Amazon.</td></tr><tr><td align="center">→ keywords</td><td align="center">array</td><td align="center">—</td><td align="center">✅ (SEARCH)</td><td>A list of keywords to be searched on Amazon.</td></tr><tr><td align="center">→ asins</td><td align="center">array</td><td align="center">—</td><td align="center">✅ (DETAIL,OFFER)</td><td>A list of ASIN values for Amazon product details.</td></tr><tr><td align="center">→ page</td><td align="center">integer</td><td align="center">❌</td><td align="center">❌</td><td>Specifies which page to parse. If a page parameter is present in the URL but not in the payload, the value from the URL will be used.</td></tr><tr><td align="center">→ exclude_sponsored</td><td align="center">boolean</td><td align="center">❌</td><td align="center">❌</td><td>Exclude sponsored results?<br>Default: false</td></tr><tr><td align="center">→ sort_by</td><td align="center">string</td><td align="center">❌</td><td align="center">❌</td><td>The sorting method for results. <br>Possible values: 'featured', 'price-asc-rank', 'price-desc-rank', 'review-rank', 'date-desc-rank', 'exact-aware-popularity-rank'.</td></tr><tr><td align="center">→ language</td><td align="center">string</td><td align="center">❌</td><td align="center">❌</td><td>Specifies the language in which you want the results to be returned. Can be found on the https://app.easyparser.com/playground page.</td></tr><tr><td align="center">→ include_html</td><td align="center">boolean</td><td align="center">❌</td><td align="center">❌</td><td>Specifies whether to include raw HTML content in the returned results.</td></tr></tbody></table>

### 🔍 Operation Types and Payload Examples

* **SEARCH**\
  The `Search` operation is used to perform a keyword or URL-based search on Amazon and retrieve a list of products that appear in the results. This mimics what a user would see when they type a query into Amazon's search bar or visit a search result page.

For more information, you can visit the [SEARCH](https://easyparser.gitbook.io/easyparser-documentation/amazon/search) page.

1. **Payload**
   1. **`urls`:** A list of Amazon search URLs.\
      \&#xNAN;*or*
   2. `keywords`: A list of Amazon ASINs to retrieve details for.

{% code overflow="wrap" %}

```json
{
  "platform": "AMZ",
  "operation": "SEARCH",
  "domain": ".ca",
  "payload": {
    "urls": [
      "https://www.amazon.ca/s?k=mouse&crid=O8PU9UY8P6WO&sprefix=mous%2Caps%2C268&ref=nb_sb_noss_2",
      "https://www.amazon.ca/s?k=table+tennis&crid=7QYJP4BMVUYZ&sprefix=table+tenni%2Caps%2C234&ref=nb_sb_noss_2"
    ]
  },
  "callback_url": "https://example.com/webhook"
}
```

{% endcode %}

*or*

{% code overflow="wrap" %}

```json
{
  "platform": "AMZ",
  "operation": "SEARCH",
  "domain": ".ca",
  "payload": {
    "keywords": [
      "portable charger",
      "winter gloves"
    ]
  },
  "callback_url": "https://example.com/webhook"
}

```

{% endcode %}

* **DETAIL**

The `Detail` operation is used to retrieve detailed information about a specific product on Amazon. This operation can be called using either the ASIN (Amazon Standard Identification Number) or a direct product URL.

For more information, you can visit the [DETAIL](https://easyparser.gitbook.io/easyparser-documentation/amazon/detail) page.

1. **Payload**
   1. **`urls`:** A list of Amazon search URLs.\
      \&#xNAN;*or*
   2. `asins`: A list of Amazon ASINs to retrieve details for.

{% code overflow="wrap" %}

```json
{
  "platform": "AMZ",
  "operation": "DETAIL",
  "domain": ".com",
  "payload": {
    "asins": [
      "B0DQY6J9TL",
      "B0CF3VGQFL"
    ]
  },
  "callback_url": "https://example.com/webhook"
}
```

{% endcode %}

*or*

{% code overflow="wrap" %}

```json
{
  "platform": "AMZ",
  "operation": "DETAIL",
  "domain": ".com",
  "payload": {
    "urls": [
      "https://www.amazon.com/dp/B08CMTKNDC",
      "https://www.amazon.com/dp/B0C88YW1ZR"
    ]
  },
  "callback_url": "https://example.com/webhook"
}
```

{% endcode %}

* **OFFER**

The `Offer` operation is used to retrieve offer-level data for a specific product on Amazon. It provides a list of all available seller offers for a product, including pricing, condition, fulfillment method, and Buy Box information.

For more information, you can visit the [OFFER](https://easyparser.gitbook.io/easyparser-documentation/amazon/offer) page.

1. **Payload**
   1. `asins`: A list of Amazon ASINs to retrieve details for.

```json
  "platform": "AMZ",
  "operation": "OFFER",
  "domain": ".de",
  "payload": {
    "asins": [
      "B0CMGMCWYG",
      "B0CDGGFCM8"
    ]
  },
  "callback_url": "https://example.com/webhook"
}
```

### 📩 What Happens After You Send the Request?

Once your bulk request is successfully submitted, the system will process your queries asynchronously.\
You will immediately receive a response containing metadata and a list of accepted queries with their unique IDs.

👉 To understand the structure of this response and what each field means, proceed to the [**Bulk Service Response**](https://easyparser.gitbook.io/easyparser-documentation/~/revisions/83dvVwXnSzIuEKJPMzuI/bulk-integration/bulk-service-response) section.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://easyparser.gitbook.io/easyparser-documentation/~/revisions/u2LgXrpZolvfuNVyA3bj/bulk-integration/bulk-service-request.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
