# /resolve/goods

`POST /api/resolve/goods`

Price: 35 credits

Every record our sources hold about one physical product, from its barcode (GTIN, UPC, EAN), its Amazon ASIN, a store's product id or a product page URL, with follow-up calls for its offers and reviews.

## How to use it

Use when you hold something that identifies one physical product: id with id_type gtin for a barcode, amazon_asin for an ASIN or a store's id type for its product id, or url for its page on a store. The input's own record is tied by that id (method input_id, or <store>_match with the page URL as evidence); every other record by a barcode or ASIN equal to one a tied record gives. Method variant_family marks a record listing several sizes, colours or pack counts, each with its own barcode; such a record never sets id or next. Returns each source's record whole, the product's identifiers and ready follow-up calls in next, whose params pass as-is.

## Working with /resolve

Use /resolve/companies when you hold a domain, a company URL or an identifier; use /resolve/companies/search when you hold only a name. Use /resolve/places when you hold a place page URL or a place identifier (a Google Maps feature_id); use /resolve/places/search when you hold a place name, optionally with its city or a point. Use /resolve/software when you hold a software product's page URL or directory id; use /resolve/software/search when you hold its name. Use /resolve/apps when you hold an app store URL, bundle id or package name; use /resolve/apps/search when you hold an app's name. Use /resolve/people when you hold a person's profile URL or handle; use /resolve/people/search when you hold a person's name. Use /resolve/goods when you hold a product page URL, a barcode (GTIN) or an ASIN. Use /resolve/tokens when you hold a token's page URL, its contract and network, or a token id. Each next entry is a ready call {endpoint, params}: source is the first path segment, category the second, endpoint all segments after source joined with _ (resolve/companies/search -> resolve, companies, companies_search; webparser/sitemap -> webparser, sitemap, sitemap); pass params as-is.

- name -> /resolve/companies/search -> the match with strong true -> its first next call (/resolve/companies)
- domain or company URL -> /resolve/companies -> the next calls the task needs
- place name (+ city) -> /resolve/places/search -> the first match -> its first next call (/resolve/places)
- place page URL or feature_id -> /resolve/places -> the next calls the task needs
- person name (+ company or city) -> /resolve/people/search -> the first match -> its first next call (/resolve/people)
- barcode, ASIN or product page URL -> /resolve/goods -> the next calls the task needs
- token contract + network, token page URL or token id -> /resolve/tokens -> the next calls the task needs
- app name -> /resolve/apps/search -> the first match -> its first next call (/resolve/apps)
- software name -> /resolve/software/search -> the first match -> its first next call (/resolve/software)

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `url` (string, nullable) — A product's page on a marketplace or store we look products up on: Amazon, Walmart, Best Buy, Target, eBay, bol, Coolblue, Jumbo, idealo, Decathlon and others. Amazon products are looked up on amazon.com, so an Amazon page is one on amazon.com (examples: "https://www.amazon.com/dp/B005PZY56K", "https://www.amazon.com/dp/B0062Q5V32")
- `id` (string, nullable) — Product identifier of the kind named by id_type; requires id_type (examples: "034000002405", "B0062Q5V32")
- `id_type` (string, nullable) — Kind of identifier given in id: gtin for a GTIN, UPC, EAN or ISBN-13 barcode, amazon_asin for an ASIN, looked up on amazon.com, or a store's own product id; requires id (one of: "acehardware_product", "ajio_product", "amazon_asin", "askul_product", "bestbuy_sku", "blibli_product", "bol_product", "bookoff_product", "cdiscount_product", "chewy_product", "coolblue_product", "decathlon_product", "decathlon_us_product", "decathlon_us_product_id", "discogs_release", "douban_book", "douban_music", "ebay_item", "ebay_product", "energystar_product", "faire_product", "fonq_product", "gamma_product", "goodreads_book", "gtin", "hepsiburada_product_group", "hepsiburada_sku", "hornbach_product", "idealo_product", "johnlewis_product", "jumbo_product", "karwei_product", "lohaco_product", "n11_product", "netaporter_product", "newegg_product", "nykaa_product", "paypayfleamarket_item", "paypayfleamarket_product", "pchome_product", "pckoubou_product", "petco_product", "petsplace_product", "praxis_product", "pult_article", "pult_product", "rebag_product", "ruten_item", "sofmap_product", "ssense_product", "target_product", "tractorsupply_product", "tsukumo_product", "walmart_item", "yahoo_shopping_product"; examples: "gtin", "amazon_asin")

## Response

### 200 — Successful Response

- `@type` (string) (default: "ResolvedGoods")
- `id` (string, nullable) — The product's barcode, else its ASIN, as type:value; the input as given when the tied records carry no barcode or ASIN, or two or more of the first of these they carry (examples: "gtin:00034000002405", "amazon_asin:B0062Q5V32")
- `links` (array) — Records tied to the product, strongest first (default: [])
  - `@type` (string) (default: "ResolvedGoodsLink")
  - `source` (string, required) — Platform the record comes from (examples: "upcitemdb")
  - `endpoint` (string, required) — Endpoint that returned the record, callable as it is (examples: "upcitemdb/products")
  - `record` (object, required) — The record exactly as that endpoint returns it
  - `confidence` (number, required) — Confidence that the record is this product, 0 to 1
  - `method` (string, required) — How the record was tied to the product: input_id (fetched by the given identifier), <identifier>_match (carries an identifier the product holds), hub_link (reached through a linked record's identifier), variant_family (a record listing several sizes, colours or pack counts, each with its own barcode, one of which is the product) (examples: "gtin_match")
  - `evidence` (string, required) — The field and value that tie the record to the product
  - `partial` (boolean) — The source stopped before it answered in full (default: false)
- `identifiers` (object) — Every identifier of the product found in the records, by type: the primary value, the platforms carrying it and the other values found (default: {})
  - `*` (object)
    - `@type` (string) (default: "ResolvedIdentifier")
    - `value` (string, required) — Identifier value (examples: "stripe.com")
    - `sources` (array, required) — Platforms whose records carry this value
    - `alternatives` (array) — Other values of the same identifier carried by the records, most carried first (default: [])
      - `@type` (string) (default: "IdentifierValue")
      - `value` (string, required) — Identifier value (examples: "stripe.com")
      - `sources` (array, required) — Platforms whose records carry this value
- `not_found` (object) — Endpoints checked that gave no record, grouped by why
  - `@type` (string) (default: "NotFound")
  - `no_record` (array) — Endpoints that answered without a record (default: [])
  - `error` (array) — Endpoints that failed to answer (default: [])
  - `timeout` (array) — Endpoints that ran out of their time budget (default: [])
  - `skipped` (array) — Endpoints that do not take the identifier they were given (default: [])
- `next` (array) — Follow-up calls for this product's offers, reviews and availability, each with its payload filled in (default: [])
  - `@type` (string) (default: "NextCall")
  - `endpoint` (string, required) — Endpoint to call next (examples: "webparser/render")
  - `params` (object, required) — Its payload, ready to send (examples: {"url":"https://stripe.com"})

## Errors

### 422 — Validation Error

Not exactly one of url, or id with id_type; the value is not of that kind; or url is a page of an Amazon marketplace other than amazon.com.

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

No source holds a record of this product.

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.