requestAmazonProductByURL

Arguments

input

required

An object containing the product’s URL.

Show properties

url

URL!

required

The URL of the product to be requested.

Returns

productId

The productId is the unique identifier for the requested product, which can be used in subsequent queries to fetch product information, e.g. with productByID.

Example

mutation RequestAmazonProductByURL {
  requestAmazonProductByURL(
    input: {
      url: "https://www.amazon.com/gp/product/B07S9NNCGQ/ref=ppx_yo_dt_b_search_asin_title?ie=UTF8&th=1"
    }
  ) {
    productId
  }
}

{
  "data": {
    "requestAmazonProductByURL": {
      "productId": "B07S9NNCGQ"
    }
  }
}

Errors

Invalid URL

If the provided URL is not a valid Amazon product URL then the following error is returned

JSON

{
  "errors": [
    {
      "message": "The provided `url` input (\"www.google.com\") is not a valid Amazon product URL.",
      "path": [
        "requestAmazonProductByURL"
      ]
    }
  ],
  "data": null
}

Product data not found

If the product data can’t be found, a PRODUCT_NOT_FOUND_ERROR is returned. This can happen for a variety of reasons:

The URL doesn’t point to a valid product page (for example, the provided URL returns a 404 status code)

JSON

{
  "errors": [
    {
      "message": "Product data not found - if the URL is valid, then the store may not be supported. See docs for more details",
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ],
      "path": [
        "requestAmazonProductByURL"
      ],
      "extensions": {
        "code": "PRODUCT_NOT_FOUND_ERROR"
      }
    }
  ],
  "data": null
}

Webhooks

Calling this mutation will subscribe your developer account to product webhooks for the requested product.

Universal Checkout API

Tools

Testing

Webhooks

API Reference

Help

requestAmazonProductByURL

Arguments

Returns

Example

Errors

Invalid URL

Product data not found

Webhooks

​Arguments

​Returns

​Example

​Errors

​Invalid URL

​Product data not found

​Webhooks

​Related mutations

Arguments

Returns

Example

Errors

Invalid URL

Product data not found

Webhooks

Related mutations