Developer docs

POST /v1/product-information

Use this endpoint when an integration needs structured product information for one supported product page URL.

Product page URLhttps://shop.example/p/123
Product informationPOST /v1/product-information

Use product information when catalog, enrichment, onboarding, or content-quality workflows need structured details.

Request body
{
  "productUrl": "https://shop.example/p/123"
}
Response preview
{
  "productInformation": {
    "title": "Replacement water filter cartridge",
    "brand": "AquaPro",
    "images": [
      "https://cdn.example/products/water-filter-123/main.jpg"
    ],
    "attributes": {
      "capacity": "1 liter",
      "packSize": "2"
    },
    "ratings": {
      "average": 4.6,
      "reviewCount": 1284
    }
  },
  "creditsRemaining": 2480
}
titlebrandimagesattributesratings

Request shape and public routes.

Single requests send productUrl. Bulk requests send items[].productUrl. Bearer auth is required for product and usage routes.

Use caseEndpointRequest bodyReturns
Get product informationPOST /v1/product-information{ "productUrl": "https://shop.example/p/123" }Returns title, brand, images, attributes, ratings, category data, and other product details for one product page URL.

Run it with curl, Node.js, or Python.

Put your API token in PIA_API_TOKEN, replace the example URL with a product page from a supported store, and run the snippet. API tokens are in your account console.

Errors return error.code, error.message, error.requestId, and error.retryable. When retryable is true, wait for the Retry-After seconds, then send the request again. Only successful requests use credits.

The OpenAPI reference lists every field and status code.

POST /v1/product-information
Shell
curl -sS https://api.productinformationapi.com/v1/product-information \
  -H "Authorization: Bearer $PIA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"productUrl": "https://shop.example/p/123"}'
POST /v1/product-information/bulk
Shell
curl -sS https://api.productinformationapi.com/v1/product-information/bulk \
  -H "Authorization: Bearer $PIA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {"productUrl": "https://shop.example/p/123"},
      {"productUrl": "https://shop.example/p/456"}
    ]
  }'
Bulk response preview
{
  "requestId": "req_bulk_01HZX7",
  "total": 2,
  "succeeded": 2,
  "failed": 0,
  "retryable": 0,
  "results": [
    {
      "index": 0,
      "httpStatus": 200,
      "result": {
        "outcome": "OK",
        "productInformation": {
          "title": "Replacement water filter cartridge",
          "brand": "AquaPro"
        },
        "creditsRemaining": 2479
      }
    },
    {
      "index": 1,
      "httpStatus": 200,
      "result": {
        "outcome": "OK",
        "productInformation": {
          "title": "Replacement water filter cartridge, 4 pack",
          "brand": "AquaPro"
        },
        "creditsRemaining": 2478
      }
    }
  ]
}

Fields this workflow usually reads.

Exact fields depend on the endpoint, the product page, and the store's coverage.

productInformationtitlebrandimagesattributesbadgesratingscategoryRanks

Where this page fits.

Typical jobs teams build on these endpoints.

Catalog inspection

Review one product page URL and the structured fields it returns.

Attribute checks

Confirm title, brand, images, attributes, ratings, and category fields before scaling.

Parser validation

Compare returned product details with expected catalog requirements.

Coverage and operating boundaries.

Coverage is enabled by supported retailer, marketplace, and product page URL.

Polling cadence belongs to the client integration and is discussed during onboarding.

The API is not an official marketplace partner API and does not promise unlimited collection.

Short answers for evaluation.

Answers to the questions teams ask before they integrate.

Do callers provide marketplace IDs or supplier IDs?

No. Callers send productUrl for single requests or items[].productUrl for bulk requests. Internal identifiers are derived by the API when the URL is supported.

Which endpoint should I use first?

Use product-stock for availability and offers, and product-information for catalog details.

Can I use bulk requests?

Yes. Dedicated stock and information bulk endpoints accept arrays of product page URLs and return per-item results.

How is coverage confirmed?

Share target retailers or marketplaces, expected volume, required fields, and sample product URLs during onboarding.