Bulk Service Request

Endpoint

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

πŸ”‘Headers

Header
Value
Description

api-key

Your API Key

Required for authentication.

Content-Type

application/json

Specifies the JSON data format.

πŸ“¦ Request Body (JSON)

A request is made as an array in JSON format. Each request object includes the following:

platform

string

Yes

Name of the platform (e.g., AMZ for Amazon).

operation

string

Yes

Type of operation: SEARCH, DETAIL, OFFER ...

domain

string

Yes

Destination domain (e.g., .ca, .com, .de).

payload

object

Yes

Contains the necessary data for the specified request type.

callback_url

string

Yes

The webhook URL where the results will be sent.

πŸ” 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 page.

  1. Payload

    1. urls: A list of Amazon search URLs. or

    2. keywords: A list of Amazon ASINs to retrieve details for.

{
  "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"
}

or

{
  "platform": "AMZ",
  "operation": "SEARCH",
  "domain": ".ca",
  "payload": {
    "keywords": [
      "portable charger",
      "winter gloves"
    ]
  },
  "callback_url": "https://example.com/webhook"
}
  • 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 page.

  1. Payload

    1. urls: A list of Amazon search URLs. or

    2. asins: A list of Amazon ASINs to retrieve details for.

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

or

{
  "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"
}
  • 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 page.

  1. Payload

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

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

πŸ“¦ Bulk Request Structure and Parameters

Key
Type
Required? (Request)
Required? (Payload)
Description

platform

string

βœ…

β€”

The platform on which the operation will be performed. Currently, only the value β€œAMZ” is supported.

operation

string

βœ…

β€”

The type of parse operation to be performed. For example: SEARCH, DETAIL, OFFER...

domain

string

βœ…

β€”

Specifies the country domain to be parsed. For example: .ca, .com, .de.

callback_url

string

βœ…

β€”

The callback (webhook) URL to receive the results.

address_id

string

❌

❌

The ID of the address defined and activated by the user on the EasyParser platform. Specifying this allows scanning to be performed at the desired location.

payload

object

βœ…

βœ…

Special parameters included based on the operation type. For example, urls or keywords for SEARCH, urls or asins for DETAIL, and asins for OFFER.

β†’ urls

array

β€”

βœ… (SEARCH, DETAIL)

A list of URLs to be parsed directly on Amazon.

β†’ keywords

array

β€”

βœ… (SEARCH)

A list of keywords to be searched on Amazon.

β†’ asins

array

β€”

βœ… (DETAIL,OFFER)

A list of ASIN values for Amazon product details.

β†’ page

integer

❌

❌

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.

β†’ exclude_sponsored

boolean

❌

❌

Exclude sponsored results? Default: false

β†’ sort_by

string

❌

❌

The sorting method for results. Possible values: 'featured', 'price-asc-rank', 'price-desc-rank', 'review-rank', 'date-desc-rank', 'exact-aware-popularity-rank'.

β†’ language

string

❌

❌

Specifies the language in which you want the results to be returned. Can be found on the https://app.easyparser.com/playground page.

β†’ include_html

boolean

❌

❌

Specifies whether to include raw HTML content in the returned results.

Last updated