Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

Sync API Documentation

Sync API Reference

See Universal Checkout API Documentation↗

/

Start Here

Rye-Shopper-IP
Where to find these headers

Sync & Sell Anything API

Arguments
Returns
Example - request
Example - response
Related queries

Arguments
Returns
Example - request
Example - response
Related mutations

productsByDomainV2

Arguments
Returns
Example - request
Example - response
Related queries

Arguments
Returns
Example - request
Example - response
Errors

checkoutByCartID

Arguments
Returns
Example - request
Example - response
Errors
Related queries

Arguments
Returns
Example - request
Example - response
Related queries

Arguments
Returns
Example - request
Example - query
Example - response
Related queries

Arguments
Returns
Example - request
Example - query
Example - response
Related queries

Arguments
Returns
Example - request
Example - response

Returns
Example
Notes

shopifyCollection

Arguments
Returns
Example - request
Example - response

integratedShopifyStore

Arguments
Returns
Example - request

requestAmazonProductByURL

Arguments
Returns
Example
Errors
Invalid URL
Product data not found
Webhooks
Related mutations

requestShopifyProductByURL

Arguments
Returns
Example
Errors
Invalid URL
Product data not found
Webhooks
Related mutations

requestStoreByURL

Arguments
Returns
Example - request
Example - response
Webhooks
Related mutations

Arguments
Returns
Example - request
Example - response
Errors
Related mutations

Arguments
Returns
Example - request
Example - response
Errors

deleteCartItems

Arguments
Returns
Example - request
Example - response
Errors
Related mutations

Arguments
Returns
Example - request
Example - response
Errors

setCartAttributes

Arguments
Returns
Example - request
Example - response
Related mutations

Requirements
Arguments
Returns
Example - request
Example - response
Errors
Expected cart behavior

updateCartItems

Arguments
Returns
Example - request
Example - response
Errors
Related mutations

updateCartBuyerIdentity

Arguments
Returns
Example - request

updateCartSelectedShippingOptions

Arguments
Returns
Example - request
Errors

proposeShopifyMerchantCommission

Arguments
Returns
Example - request
Example - response

requestProductByURL

Arguments
Returns
Example - request
Example - response
Errors
Invalid URL
Product data not found
Related mutations

Arguments
Returns
Example - request
Example - response
Errors

Arguments
Returns
Example - request
Example - response
Errors

Fields
Related types

ProductByIDInput

Fields
Related queries

ProductsByDomainInput

Fields
Related queries

RequestStoreByURLInput

Fields
Related mutations

RequestProductByURLInput

Fields
Related mutations

OffsetPaginationInput

Fields
Related queries
Related types

AmazonCartItemsInput

Fields
Mutations
Related types

AmazonProductIDInput

Fields
Mutations
Related types

BillingAddressInput

Fields
Mutations
Related types

BuyerIdentityInput

Fields
Mutations
Related types

CartBuyerIdentityUpdateInput

Fields
Mutations
Related types

CartCreateInput

Fields
Mutations
Related types

CartDeleteInput

Fields
Mutations
Related types

CartItemsAddInput

Fields
Mutations
Related types

CartItemsDeleteInput

Fields
Mutations
Related types

Fields
Mutations
Related types

CartItemsUpdateInput

Fields
Mutations
Related types

CartSettingsInput

Fields
Mutations

AmazonCartSettingsInput

Fields
Related types

CartSubmitInput

Fields
Mutations
Related types

StorePromoCodesInput

Fields
Mutations
Related types

DeleteCartLinesInput

Fields
Mutations
Related types

ReturnByIdInput

Fields
Queries

ShopifyCartItemsInput

Fields
Mutations
Related types

ShopifyVariantIDInput

Fields
Mutations
Related types

UpdateCartSelectedShippingOptionsInput

Fields
Mutations
Related types

ProposeShopifyMerchantCommissionInput

Fields
Related queries

PriceAdjustmentInput

Fields
Related types

Fields
Related types

Fields
Related types

Fields
Related types

Fields
Related types

AmazonProtectionPlan

Fields
Related types

AmazonDeliveryEstimateRange

Fields
Related types

AmazonSpecification

Fields
Related types

Fields
Related types

Fields
Related types

AmazonVariantDimension

Fields
Related types

Fields
Related types

IntegratedShopifyStore

Fields
Related queries

Fields
Related types

RequestProductResponse

Fields
Related mutations

RequestStoreResponse

Fields
Related mutations

Fields
Related types

ShopifyImageURL

Fields
Related types

Fields
Related types

ShopifyProductReview

Fields
Related types

ShopifyProductReviewEdge

Fields
Related types

ShopifyProductReviewsConnection

Fields
Related types

ShopifyProductShopifyCategories

Fields
Related types
Sample response

Fields
Related types

Fields
Related types

Fields
Related types

Fields
Related types

Fields
Mutations
Related types

Fields
Queries
Mutations
Note about expiration
Related types

Fields
Related types

Fields
Queries
Mutations

Fields
Mutations

Fields
Mutations

Fields
Related types

Fields
Related types

Fields
Related types

AmazonOrderMetadata

ShopifyOrderMetadata

OrderCancelFailedOrderEvent

Fields
Related types

OrderCancelStartedOrderEvent

Fields
Related types

ReturnApprovedEvent

ReturnClosedEvent

AmazonReturnRequestedEventData

AmazonReturnLineItem

AmazonReturnLineItem

ShopifyLineItem

ShopifyReturnLineItem

ShopifyReturnRequestedEventData

AmazonReturnApprovedEventData

ShopifyReturnApprovedEventData

AmazonReturnClosedEventData

ShopifyReturnClosedEventData

OrderCancelSucceededOrderEvent

Fields
Related types

OrderFailedOrderEvent

Fields
Related types

OrderPlacedOrderEvent

Fields
Related types

OrderSubmissionStartedOrderEvent

Fields
Related types

OrderSubmissionSucceededOrderEvent

Fields
Related types

PaymentFailedOrderEvent

Fields
Related types

PaymentRefundedOrderEvent

Fields
Related types

PaymentSucceededOrderEvent

Fields
Related types

ProductsByIDsResponse

Fields
Related queries

RefundCreatedOrderEvent

Fields
Related types

SelectedShippingOption

Fields
Related types

Fields
Related types

ShopifyCartLine

Fields
Related types

Shopifyofferobject

Fields
Related types

Fields
Related types

SubmitCartResult

Fields
Mutations

SubmitStoreResult

Fields
Related types

TrackingObtainedOrderEvent

Fields
Related types

Fields
Related queries

ShopifyAppInstallationLink

Arguments
Fields
Related queries

ShopifyMerchantCommission

Fields
Related types
Related queries

ShopifyMerchantCommissionProposal

Fields
Related queries

ShopifyCollection

ShopifyCollectionsConnection

Fields
Related types

ShopifyCollectionEdge

Fields
Related types

ShopifyProductsConnection

Fields
Related types

ShopifyProductEdge

Fields
Related types

ShopifyProductsConnection

Fields
Related types

Fields
Related types

Fields
Related types

Fields
Related types

AmazonOfferError

Fields
Related types

AmazonOfferErrorDetails

Fields
Related types

AmazonStoreError

Fields
Related types

AmazonStoreErrorDetails

Fields
Related types

Fields
Related types

Fields
Related types

ShopifyOfferError

Fields
Related types

ShopifyOfferErrorDetails

Fields
Related types

ShopifyStoreError

Fields
Related types

ShopifyStoreErrorDetails

Fields
Related types

SubmitCartResultError

Fields
Related types

SubmitStoreResultError

Fields
Related types

What should you expect from the experimental section?
Why use experimental features?
Getting started
Feedback

experimentalAffiliateMerchantsConnection

Arguments
Returns
Example - request
Example - response

experimentalAffiliateCommission

Arguments
Returns
Example - request
Example - response

ExperimentalAffiliateMerchantsFilterInput

ExperimentalAffiliateCommissionRateFixed

ExperimentalAffiliateCommissionRatePercentage

ExperimentalAffiliateMerchant

ExperimentalAffiliateMerchantDomain

ExperimentalAffiliateMerchantEdge

ExperimentalAffiliateMerchantsConnection

ExperimentalAffiliateProductCategory

ExperimentalAffiliateCommissionPending

ExperimentalAffiliateCommissionUnconfirmed

ExperimentalAffiliateCommissionConfirmed

ExperimentalAffiliateCommissionUpdated

ExperimentalAffiliateCommissionFinalized

ExperimentalAffiliateCommission

Fields
Implementations

ExperimentalAffiliateCommissionRate

GraphQL Types

Valid values
Related types

Valid values
Related types

Valid values
Related types

Valid values
Related types

OrderFailedReasonCode

Valid values
Related types

Valid values
Related types

ProductErrorCode

Valid values
Related types

ReturnOrderStatus

Valid values
Related types

Valid values
Related types

SubmitCartResultErrorCode

Valid values
Related types

SubmitStoreResultErrorCode

Valid values
Related types

SubmitStoreStatus

Valid values
Related types

Valid values
Related types

CancelOrderErrorCode

Valid values
Related types

ShippingMethodType

Valid values
Related types

Fields
Implementations

Fields
Implementations

Fields
Implementations

Fields
Examples
Related queries
Implementations

ProductConnection

Union Types
Queries

Union Types
Related Types

Fields
Related types

Fields

path nameString!required

The name of the dimension.

path valueString!required

The value of the dimension.

Related types

AmazonProduct

Powered byHolocron