Skip to main content

​
Ordering & Checkout

All Orders
  • Login or non-guest checkout flows are not supported.
  • Only physical products are supported at this time.
  • US-only ordering is supported.
    • Additional regions can be supported on request for enterprise use cases.
  • One product per checkout is required. Multiple quantities of the same product are supported, but multi-product carts are not supported yet.
  • Stores with advanced anti‑bot mechanisms (such as REI or Sephora) are not yet supported.
  • Product variants (such as size or color) are supported via the variantSelections field or by providing a variant-specific product URL. See the Variants guide for details.
  • Shipping options default to the first option returned (usually the lowest cost). You cannot yet select from multiple options.
  • Checkout intents cannot be updated once created. To change buyer details such as the shipping address, you need to create a new checkout intent with the updated information.
Merchant of Record & Payment Flows
  • Rye supports multiple payment providers. With Stripe, Rye is the merchant of record. With Basis Theory, the card is forwarded directly to the merchant’s payment vault (e.g., Shopify), so Rye is not the merchant of record for Shopify orders.
Variant Selection
  • Use the product lookup endpoint to retrieve available variant dimensions and values before placing an order.
  • The variantSelections field lets you specify which variant to purchase. Labels are fuzzy-matched (e.g., “Colour” matches “Color”), but values must match exactly (case-insensitive). If no variant matches, the API returns a variant_selections_invalid error.
  • Alternatively, if the productUrl already includes the variant identifier, you don’t need to include variantSelections. When both are provided, variantSelections takes precedence.
  • When using variantSelections, pass the exact option labels and values from the product data, not a variant ID. For example:
    [{ label: ‘Size’, value: ‘8.5’ }, { label: ‘Color’, value: ‘Blue’ }].

​
Post-Purchase

  • Orders placed agentically are not tracked post-purchase. Rye’s API places orders on the store website acting on behalf of the end-user. If the end-user has provided an email and/or phone number, they will directly receive tracking information.
  • Orders placed on supported marketplaces (Best Buy, Shopify) are tracked post-purchase. Updates can be retrieved either via API or by webhook.
  • Returns: Buyers would need to contact the merchant directly for returns. They can use the details from the order confirmation email to help the merchant find the order.