Developer docs

POST /v1/product-stock

Use this endpoint when an integration needs availability, offer, price, seller, fulfilment, and delivery signals for one product page URL.

Product page URL https://shop.example/p/123
Stock POST /v1/product-stock

Use stock when availability, offers, price, seller, and delivery signals drive the workflow.

Request body
{
  "productUrl": "https://shop.example/p/123"
}
Response preview
{
  "externalId": "B0EXAMPLE1",
  "source": "amazon_gb",
  "method": "checkStock",
  "outcome": "OK",
  "inStock": true,
  "offerCount": 2,
  "offers": [
    {
      "price": 49.95,
      "currency": "GBP",
      "seller": "AquaPro",
      "fulfilment": "FBA",
      "deliveryDays": 2
    },
    {
      "price": 54.99,
      "currency": "GBP",
      "seller": "PartsHub",
      "fulfilment": "FBM",
      "deliveryDays": 4
    }
  ],
  "cacheStatus": "live",
  "creditsRemaining": 4871
}
inStockofferCountpricesellerdeliveryDays

Request shape and public routes.

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

Use case Endpoint Request body Returns
Check stock POST /v1/product-stock { "productUrl": "https://shop.example/p/123" } Returns availability, offer count, price, currency, seller, fulfilment, and delivery fields for one product page URL.

Readable JSON before code snippets.

Use this page’s example to confirm the body shape, expected response fields, and endpoint mapping before copying language-specific code from the OpenAPI reference.

Request body
{
  "productUrl": "https://shop.example/p/123"
}
Response preview
{
  "externalId": "B0EXAMPLE1",
  "source": "amazon_gb",
  "method": "checkStock",
  "outcome": "OK",
  "inStock": true,
  "offerCount": 2,
  "offers": [
    {
      "price": 49.95,
      "currency": "GBP",
      "seller": "AquaPro",
      "fulfilment": "FBA",
      "deliveryDays": 2
    },
    {
      "price": 54.99,
      "currency": "GBP",
      "seller": "PartsHub",
      "fulfilment": "FBM",
      "deliveryDays": 4
    }
  ],
  "cacheStatus": "live",
  "creditsRemaining": 4871
}

Fields this workflow usually reads.

Exact fields depend on endpoint, product page URL, and enabled coverage, but these are the fields this page is designed around.

inStockofferCountoffers[]pricecurrencysellerdeliveryDayscreditsRemaining

Where this page fits.

Each page targets a distinct workflow, field set, or buying question.

Single URL checks

Confirm one product page URL returns the stock fields your integration needs.

Offer debugging

Inspect seller, price, currency, fulfilment, and delivery fields in one response.

Implementation smoke tests

Validate bearer auth, request shape, response parsing, and credit consumption.

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.

Visible answers are mirrored in structured data for eligible generated pages.

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.