RYrye-com
Products

Lookup product

Changed on

Lookup a product's information by URL.

get/api/v1/products/lookup

Request

  • Base URL
    https://staging.api.rye.com
  • URL
    https://staging.api.rye.com/api/v1/products/lookup
  • Auth
    API key in header Authorization

Query parameters

urlstring required

Response

Product information

isPurchasableboolean required
availability'in_stock' | 'out_of_stock' | 'preorder' | 'backorder' | 'unknown' required

The availability status of a product.

  • in_stock: Product is available for immediate purchase
  • out_of_stock: Product is currently unavailable
  • preorder: Product is available for pre-order before release
  • backorder: Product is temporarily out of stock but can be ordered
  • unknown: Availability could not be determined
descriptionstring nullable required
brandstring nullable required
namestring required
skustring nullable required
retailerstring nullable required
urlstring required
idstring required

Example response

{
  "variants": [
    {
      "images": [
        {
          "isFeatured": true,
          "url": "https://example.com/images/product-123.jpg"
        }
      ],
      "price": {
        "currencyCode": "USD",
        "amountSubunits": 1500
      },
      "dimensions": [
        {
          "label": "Size, Color, etc."
        }
      ]
    }
  ],
  "isPurchasable": true,
  "price": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  },
  "images": [
    {
      "isFeatured": true,
      "url": "https://example.com/images/product-123.jpg"
    }
  ],
  "description": "A high-quality widget designed for professionals.",
  "brand": "Acme",
  "name": "Widget Pro",
  "sku": "SKU-12345",
  "retailer": "Amazon",
  "url": "https://example.com/products/widget-pro",
  "id": "amazon.com:B0DFC9MT8Q"
}

Changes

  • 816719402097Revision changes
    • info

      the security scope products:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope checkout_intents:read was removed from the endpoint's security scheme bearerAuth

  • 0b28c67737d3Revision changes
    • info

      the security scope checkout_intents:read was added to the endpoint's security scheme bearerAuth