feature-return advanced
Everything else the package exports, for when you go beyond its components and hooks, such as your own queries or cache updates. Most projects never need these.
Contexts8
ReturnContext | The context ReturnProvider fills.@evolve-storefront/feature-return/context |
useCanCreateReturn | Whether the shopper may create a return. @evolve-storefront/feature-return/context |
useReturnContext | Read the injected auth/session/mode context. @evolve-storefront/feature-return/context |
useReturnScope | Derive the read scope from the injected mode. @evolve-storefront/feature-return/context |
returnDefaults | What the context holds without a ReturnProvider: a signed-out consumer, online returns.@evolve-storefront/feature-return/context |
ReturnContextValue | Injected auth/session/mode seam for the return feature, supplied by ReturnProvider so the feature stays decoupled from any specific auth package.@evolve-storefront/feature-return/context |
ReturnHandling | How returns are handled for this store. @evolve-storefront/feature-return/context |
ReturnMode | Consumer (own returns) vs business (company-scoped) — config, not a fork. @evolve-storefront/feature-return/context |
GraphQL documents13
GetBusinessReturn | One of a business unit's returns, by id. @evolve-storefront/feature-return/queries |
GetBusinessReturnableLines | The lines of one of a business unit's orders that can still be returned. @evolve-storefront/feature-return/queries |
GetBusinessReturns | A business unit's returns, paged. @evolve-storefront/feature-return/queries |
GetCustomerReturn | One of the signed-in customer's returns, by id. @evolve-storefront/feature-return/queries |
GetCustomerReturnableLines | The lines of one of the customer's orders that can still be returned. @evolve-storefront/feature-return/queries |
GetCustomerReturns | The signed-in customer's returns, paged. @evolve-storefront/feature-return/queries |
GetReturnEstimate | What a return of these lines would withhold, such as a restocking fee. @evolve-storefront/feature-return/queries |
GetReturnExchangeOptions | What a line of one of the customer's own orders can be exchanged for: other variants in stock, costing no more. @evolve-storefront/feature-return/queries |
GetReturnReasons | The reasons a buyer may give, with what each requires. @evolve-storefront/feature-return/queries |
GetReturnRefundMethods | How a consumer's return of one of their orders may be paid back. @evolve-storefront/feature-return/queries |
ReturnAttachmentUpload | Issues a signed URL to upload one attachment to. @evolve-storefront/feature-return/queries |
ReturnCancel | Withdraws a return that is still cancellable. @evolve-storefront/feature-return/queries |
ReturnCreate | Requests a return for delivered lines. @evolve-storefront/feature-return/queries |
Data and cache helpers2
invalidateReturns | Invalidate every list cache for a scope (all pages). @evolve-storefront/feature-return |
returnKeys | react-query key factory for the return caches. @evolve-storefront/feature-return |
Schemas1
ReturnRequestFormSchema | Return request form schema: the scalar fields. @evolve-storefront/feature-return/schemas |
Other functions and constants2
lineFieldNames | The form field names of a line's controls, which its validation errors are keyed by. @evolve-storefront/feature-return/return-items-picker |
emptyLineDraft | A line nothing has been chosen for yet. @evolve-storefront/feature-return/return-items-picker |
Types36
CreateReturnInput | Input for requesting a return (Mutation.returnCreate).@evolve-storefront/feature-return |
Money | An amount in minor units (schema Money).@evolve-storefront/feature-return |
Pagination | Where a page sits in the full list (schema Pagination).@evolve-storefront/feature-return |
ProductImage | Minimal product image. @evolve-storefront/feature-return |
Return | A return request, as the detail view shows it. @evolve-storefront/feature-return |
ReturnableLine | An order line that can still be returned (Order.returnableLines).@evolve-storefront/feature-return |
ReturnableOrder | A delivered order that still has lines to return. @evolve-storefront/feature-return |
ReturnableOrderResult | A page of returnable orders, filtered from a page of delivered orders. @evolve-storefront/feature-return |
ReturnAddress | A postal address, as a pickup or return destination (schema Address).@evolve-storefront/feature-return |
ReturnAttachment | A photo or document attached to a returned line. @evolve-storefront/feature-return |
ReturnCreditNote | The credit note that settles a credited return against its invoice. @evolve-storefront/feature-return |
ReturnEstimate | What a return of the chosen lines would withhold and pay back (Query.returnEstimate).@evolve-storefront/feature-return |
ReturnExchange | What a returned line is exchanged for, in the same quantity (ReturnExchange).@evolve-storefront/feature-return |
ReturnExchangeOption | A variant a line can be exchanged for (Query.returnExchangeOptions).@evolve-storefront/feature-return |
ReturnItem | A line on a requested return. @evolve-storefront/feature-return |
ReturnItemInput | One line to return (ReturnItemInput).@evolve-storefront/feature-return |
ReturnLineItem | The order line a returned or returnable line refers to. @evolve-storefront/feature-return |
ReturnOrder | An order a return covers. @evolve-storefront/feature-return |
ReturnReason | Why a line was returned: a code from the reason list, its label, and free text. @evolve-storefront/feature-return |
ReturnReasonInput | A reason as the request names it (ReturnReasonInput).@evolve-storefront/feature-return |
ReturnReasonOption | A reason a buyer may give, with what it requires (Query.returnReasons).@evolve-storefront/feature-return |
ReturnRefundMethod | How a consumer's return is paid back (ReturnRefundMethodType).@evolve-storefront/feature-return |
ReturnRequester | The associate who requested a return. @evolve-storefront/feature-return |
ReturnResolution | How a completed return was settled (ReturnResolutionType).@evolve-storefront/feature-return |
ReturnResult | A page of returns (ReturnResult).@evolve-storefront/feature-return |
ReturnScope | Read scope: the customer's own returns, or a business unit's. @evolve-storefront/feature-return |
ReturnShipping | @evolve-storefront/feature-return |
ReturnShippingInput | @evolve-storefront/feature-return |
ReturnShippingMethod | How the goods go back: collected by a carrier, or sent by the buyer. @evolve-storefront/feature-return |
ReturnStatus | Where a return is in the process (ReturnStatusType): REQUESTED → APPROVED → IN_TRANSIT → RECEIVED → COMPLETED, where a consumer's return skips APPROVED and an engine that cannot see IN_TRANSIT skips it.@evolve-storefront/feature-return |
ReturnSummary | A return as the list shows it. @evolve-storefront/feature-return |
ReturnRequestFormInput | @evolve-storefront/feature-return/schemas |
CreateReturnLine | A line to return, with the photos still to upload for it. @evolve-storefront/feature-return/hooks |
CreateReturnVariables | @evolve-storefront/feature-return/hooks |
ReturnableOrderRenderer | Renders one returnable order, usually a ReturnableOrderCard with a start-return action.@evolve-storefront/feature-return/returnable-orders |
ReturnLineDraft | What the buyer has filled in for one line. @evolve-storefront/feature-return/return-items-picker |
Not listed: 13 props and options types. They appear as the tables on the pages of what they type.