Rye home page
Search...
⌘K
Ask AI
Get Started
Get Started
Search...
Navigation
Objects
OrderReturn
API V1 Documentation
API V1 Reference
Changelog
Rye Console
Rye Status
See API V2 Documentation
Start Here
Authorization
Rate limits
Sync & Sell Anything API
Queries
Mutations
Input
Objects
Attribute
AmazonCategory
AmazonImage
AmazonProduct
AmazonProtectionPlan
AmazonDeliveryEstimateRange
AmazonSpecification
AmazonSubtitle
AmazonVariant
AmazonVariantDimension
AmazonVideo
IntegratedShopifyStore
ProductOption
RequestProductResponse
RequestStoreResponse
ShopifyImage
ShopifyImageURL
ShopifyProduct
ShopifyProductReview
ShopifyProductReviewEdge
ShopifyProductReviewsConnection
ShopifyProductShopifyCategories
ShopifyVariant
AmazonCartLine
AmazonOffer
AmazonStore
BuyerIdentity
Cart
CartCost
CartResponse
Checkout
DeletedCart
Order
OrderShipment
OrderReturn
OrderMetadata
AmazonOrderMetadata
ShopifyOrderMetadata
OrderCancelFailedOrderEvent
OrderCancelStartedOrderEvent
ReturnApprovedEvent
ReturnClosedEvent
AmazonReturnRequestedEventData
AmazonReturnLineItem
AmazonReturnLineItem
ShopifyLineItem
ShopifyReturnLineItem
ShopifyReturnRequestedEventData
AmazonReturnApprovedEventData
ShopifyReturnApprovedEventData
AmazonReturnClosedEventData
ShopifyReturnClosedEventData
OrderCancelSucceededOrderEvent
OrderFailedOrderEvent
OrderPlacedOrderEvent
OrderSubmissionStartedOrderEvent
OrderSubmissionSucceededOrderEvent
PaymentFailedOrderEvent
PaymentRefundedOrderEvent
PaymentSucceededOrderEvent
ProductsByIDsResponse
RefundCreatedOrderEvent
SelectedShippingOption
ShippingMethod
ShopifyCartLine
ShopifyOffer
ShopifyStore
SubmitCartData
SubmitCartResult
SubmitStoreResult
TrackingObtainedOrderEvent
ShopifyApp
ShopifyAppInstallationLink
ShopifyMerchantCommission
ShopifyMerchantCommissionProposal
ShopifyCollection
ShopifyCollectionsConnection
ShopifyCollectionEdge
ShopifyProductsConnection
ShopifyProductEdge
Entity errors
Experimental
GraphQL Types
Enums
Interfaces
Scalars
Unions
Objects
Root errors
Directives
On this page
Fields
Related types
Objects
OrderReturn
Represents return details of an order that a customer places for a product.
Fields
id
ID!
required
The return id generated when a return is requested.
orderId
ID!
required
The Rye order id associated with the return.
shippingLabelUrl
String
required
When a return has been apporved this represents the shipping label url that can be forwarded to the customer.
updatedAt
Time!
required
Date when return was last updated.
createdAt
Time!
required
Time return was first created.
marketplace
Marketplace!
required
Which marketplace the return was created on.
marketplaceOrderId
String!
required
Order id from the marketplace.
lineItems
[ReturnLineItem!]!
Line items associated with the return. See
ReturnLineItem
for more details.
Related types
Order
OrderShipment
OrderMetadata
Assistant
Responses are generated using AI and may contain mistakes.