.saurabh-test-class {
  background: black;
}


Union Types

Represents metadata informaton about an order that a customer places from a specific marketplace. This type is a union of multiple types.

OrderMetadata

Rye helps you build or scale your eCommerce app/marketplace in hours, not months.

Introduction

Rye publishes an RSS feed that you can subscribe to in order to stay informed about API and product updates.

RSS updates

Get your API key and send your first Rye API request!

Quick start

Key concepts

Intro to GraphQL

Rye’s Sync API enables you to seamlessly collect commissions from your merchants.

Overview

Direct Shopify API Access

Some Sync API endpoints support localization for price value and currency. This guide will help you learn how to use localization in the Rye API.

Localization

Rye helps you instantly sell new products on your marketplace.

Marketplace

Let your creators to sell any products they promote in your app - earn on every sale whilst keeping users on your platform. No inventory or brand partnerships needed.

Creator and social

3D-S (3D-Secure) Challenge

As part of our commitment to provide a robust experience, we've enhanced our GraphQL API with input validation. This guide will help you understand how to handle input validation errors on the client side for smooth integration and error handling in your applications.

Handling GraphQL Input Validation Errors

In this tutorial, you'll understand how to use Rye's Sell Anything API to create a cart, add products to it, and submit it for checkout.

Sell Anything API

Use Spreedly to securely store payment method information for use in future transactions.

Tokenize a payment method

Enhance your app's security through the use of short-lived access tokens.

JWT Authentication

Webhooks allow you to receive real-time updates about changes in Rye's data.

Webhooks Overview & Setup

This page documents all webhooks sent by Rye.

Events

The following guide describes some best practices for working with webhooks.

Best practices

Guide on how to test your webhooks integration

Test webhooks integration

List of shipping carriers. This list is subject to change as we add more carriers.

Shipping carriers

Quick answers to common development questions.

FAQs

It is important to have certain HTTP headers as part of your Rye API requests.

Authorization

Rate limits

A list of possible errors that can be returned at the root level of the GraphQL API (meaning the errors aren't scoped to a particular entity in the response)

Root errors

A list of directives available in the Rye API to alter the behavior of queries and mutations.

Directives

The Rye SDK provides convenient access to the Rye API via the Rye client from which users can make queries and mutations easily.

Get started

2024

Changelog

2023

API Reference

Libraries

Rye Console

Rye Status

Get Started

Take the first step towards building an integration with Rye.

Account registration

Learn about our two separate API environments.

Environments

Selecting products

After adding your selected products to Rye's catalog, you'll want to keep your system in sync with that data.

Syncing products

Create a cart, and make adjustments to cart items in response to shopper requests.

Create a cart

Attaching shopper information will let you retrieve shipping options for a cart.

Attach shopper information

Cart expiration

Rye makes it easy to take payments and sell products from multiple merchants with a single API. This section covers the different ways to set up payments with Rye, and explains the lifecycle of a Rye order.

Learn how Rye submits orders to merchants

Order placement

Overview of how payments work across the various Rye use cases

Payment flows

Handling errors

Tracking shipments

Guidelines and conditions under which refunds are issued.

Refunds

Support customers returning products that they do not want.

Returns

Access complete details of an order post-purchase

Retrieving order details

Markups

Earn commissions through affiliate networks with a streamlined process.

Affiliate Commissions

Commissions

To test your Rye integration with your own store, you need to create a Shopify test store.

Create your own Shopify test store

Place a test order

Retrieve a Product by its ID. This includes some basic fields like title, and description. This is useful for displaying products on screens where you need to display products across marketplaces together. But, each product marketplace offers extra metadata and in order to expose that to developers, Rye uses GraphQL inline fragments to expose high-fidelity information about each item.

productByID

productsByIds

Returns an array of Products filtered by a given store domain. This query can be used for paging through a set of products from a domain from Shopify.

productsByDomainV2

Retrieve a Cart by its ID. This query can be used to retrieve information about an existing cart.

getCart

Returns a Checkout object by cart ID. This query can be used to retrieve information about the checkout status for an already submitted cart as well as order details for all orders associated with the checkout

checkoutByCartID

Returns an Order object by ID. This query can be used to retrieve information about the individual order.

orderByID

Returns a ReturnOrder object by ID. This query can be used to retrieve information about the individual return request.

returnByID

Returns information about the Rye's Shopify App.

shopifyApp

Returns information about Shopify Collection

shopifyCollection

Returns information about an integrated Shopify store

integratedShopifyStore

Returns environment token used by RyePay.

environmentToken

Requests an Amazon product to be tracked by Rye's API. Products will be refreshed on some interval. A product must be requested before it can be queried.

requestAmazonProductByURL

Requests a Shopify product to be tracked by Rye's API. Products will be refreshed on some interval. A product must be requested before it can be queried.

requestShopifyProductByURL

Requests a store to be tracked by Rye's API.

requestStoreByURL

Adds new items to an existing shopping cart. This mutation resets selected shipping method of updated stores, and user will need to select shipping method again

addCartItems

Creates a new shopping cart with the specified items from Amazon and/or Shopify stores. Allows users to add products (for Amazon) or product variants (for Shopify) along with their quantities to a new cart.

createCart

Deletes items from an existing shopping cart. This mutation resets selected shipping method of updated stores, and user will need to select shipping method again. If a cart becomes empty our API won't delete the cart itself. You can continue using it to add more items as needed.

deleteCartItems

Removes an existing shopping cart based on the provided cart ID. It allows users to remove a cart that is no longer needed or relevant.

removeCart

submitCart

Updates the quantity of existing products in a cart. This mutation resets selected shipping method of updated stores, and user will need to select shipping method again

updateCartItems

Updates the buyer's identity if it was not provided in the createCart mutation.

updateCartBuyerIdentity

Updates shipping methods for stores in the cart

updateCartSelectedShippingOptions

proposeShopifyMerchantCommission

AttributeInput

The input fields to represent the information required to fetch a product by its ID.

ProductByIDInput

The input fields to represent the information required to fetch products by a store's domain.

ProductsByDomainInput

The input fields to represent the information required to fetch a store by its URL.

RequestStoreByURLInput

The input fields to represent the information required to fetch a product by its URL.

RequestProductByURLInput

The input fields to represent pagination information

OffsetPaginationInput

The input fields to provide the necessary information to add or update Amazon products in the cart. It is included as a part of the CartItemsInput object, which allows the API to handle items from multiple platforms, including Amazon.

AmazonCartItemsInput

The input fields to specify a single Amazon product to be removed from the cart.

AmazonProductIDInput

BillingAddressInput

The input fields to provide or update the buyer's identity and contact information. By supplying this information, the API can ensure accurate billing and shipping information for the buyer's order and facilitate personalized communication and support.

BuyerIdentityInput

The input fields to provide the necessary information to update the buyer identity associated with a cart through the `updateCartBuyerIdentity` mutation. By providing the cart ID and the updated buyer identity information, the API can update the cart's buyer identity accordingly.

CartBuyerIdentityUpdateInput

CartCreateInput

The input fields to provide the necessary information to remove a cart through the `removeCart` mutation. By providing the cart ID, the API can identify and delete the specified cart.

CartDeleteInput

The input fields to provide the necessary information to add new items to a cart through the `addCartItems` mutation. By providing the cart ID and the list of items to be added, the API can update the cart with the new items.

CartItemsAddInput

The input fields to provide the necessary information to remove items from a cart through the `deleteCartItems` mutation. By providing the cart ID and the list of items to be removed, the API can update the cart by removing the specified items.

CartItemsDeleteInput

The input fields to gather and organize the items a buyer wants to add or update in their cart, taking into account the specific platform the products are from (Amazon or Shopify). By including both Amazon and Shopify items, this input object allows the Rye's Sell Anything API to handle products from different platforms within a single cart, enabling a more seamless and integrated shopping experience for the user.

CartItemsInput

The input fields to provide the necessary information to update the items in a cart through the `updateCartItems` mutation. By providing the cart ID and the updated list of items, the API can modify the cart according to the user's preferences.

CartItemsUpdateInput

CartSettingsInput

AmazonCartSettingsInput

The input fields to provide the necessary information to submit a cart for processing through the submitCart mutation. By providing the cart ID, tokenized payment information, and billing address, the API can process the payment and complete the purchase. Once the cart is submitted, the user's payment is processed, and the purchased items are prepared for shipping or digital delivery, as applicable.

CartSubmitInput

The input fields to provide information about promo codes applied to stores in the cart

StorePromoCodesInput

The input fields to specify the products that need to be removed from the cart.

DeleteCartLinesInput

ReturnByIdInput

The input fields to provide the necessary information to add or update Shopify product variants in the cart. It is included as a part of the CartItemsInput object, which allows the API to handle items from multiple platforms, including Shopify.

ShopifyCartItemsInput

The input fields to specify a single Shopify product variant to be removed from the cart.

ShopifyVariantIDInput

The input fields to provide the necessary information to update a shipping method associated with a specific store

UpdateCartSelectedShippingOptionsInput

Input type for proposing a new merchant commission rate for a Shopify store.

ProposeShopifyMerchantCommissionInput

Input that allows developers to specify a percentage to increase the price of a cart line item by.

PriceAdjustmentInput

Attribute

Represents a product category for an Amazon item. These categories can change over time.

AmazonCategory

Represents an image for an Amazon product.

AmazonImage

Represents products from the Amazon marketplace. It includes details such as the product's title, description, price, availability, images, and other attributes. These details help the API to handle products from Amazon in a way that's consistent with products from other sources, like Shopify, and to provide users with a seamless shopping experience across different platforms.

AmazonProduct

Represents product protection plans offered by the seller or manufacturer on Amazon. These protection plans can provide additional coverage, such as an extended warranty or accidental damage protection, for products purchased on Amazon.

AmazonProtectionPlan

Estimated range of dates that an amazon product will be delivered.

AmazonDeliveryEstimateRange

Represents a product specification for an Amazon item. These specifications provide more detailed information about the product.

AmazonSpecification

Represents a secondary title usually displayed below the main title of a product on Amazon.

AmazonSubtitle

Represents a variant of an Amazon product, which typically includes different colors or dimensions.

Start Here

Sync & Sell Anything API

GraphQL Types

OrderMetadata

Union Types

Start Here

Sync & Sell Anything API

GraphQL Types

​Union Types

Union Types