feature-order 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.
Contexts6
OrderContext | The context OrderProvider fills.@evolve-storefront/feature-order/context |
useOrderContext | Read the injected auth/session/mode context. @evolve-storefront/feature-order/context |
useOrderScope | Derive the read scope from the injected mode. @evolve-storefront/feature-order/context |
orderDefaults | What the context holds without an OrderProvider: a signed-out consumer, gross prices.@evolve-storefront/feature-order/context |
OrderContextValue | Injected auth/session/mode seam for the order feature. @evolve-storefront/feature-order/context |
OrderMode | Consumer (personal history) vs business (company-scoped) — config, not a fork. @evolve-storefront/feature-order/context |
GraphQL documents17
GetBusinessOrder | One of a business unit's orders, by order number. @evolve-storefront/feature-order/queries |
GetBusinessOrderDeliveryPlan | The slot or pickup point chosen for one of a business unit's orders. @evolve-storefront/feature-order/queries |
GetBusinessOrderPaymentMethods | The payment methods a business unit's unpaid order can be paid with. @evolve-storefront/feature-order/queries |
GetBusinessOrders | A business unit's orders, paged, with search and status filters. @evolve-storefront/feature-order/queries |
GetBusinessOrderStatusCounts | How many of a business unit's orders each status holds, under a search and date range. @evolve-storefront/feature-order/queries |
GetCustomerOrder | One of the signed-in customer's orders, by order number. @evolve-storefront/feature-order/queries |
GetCustomerOrderDeliveryPlan | The slot or pickup point chosen for one of the buyer's own orders. @evolve-storefront/feature-order/queries |
GetCustomerOrderPaymentMethods | The payment methods offered for this order. @evolve-storefront/feature-order/queries |
GetCustomerOrders | The signed-in customer's orders, paged, with search and status filters. @evolve-storefront/feature-order/queries |
OrderConfirmationById | The order a thank-you page confirms, by its public id, and the session's business unit beside it in one round trip — Order names none, and the buyer reading the confirmation is the session that just placed it.@evolve-storefront/feature-order/queries |
OrderLookupById | The session's order by id: its own, or one of its business unit's. @evolve-storefront/feature-order/queries |
OrderLookupByNumber | The session's order by order number: its own, or one of its business unit's. @evolve-storefront/feature-order/queries |
OrderLookupByPublicId | Any order by its public id, which is its own id, without signing in. @evolve-storefront/feature-order/queries |
OrderLookupBySignedLink | The order a signed link names, such as the one in a confirmation mail. @evolve-storefront/feature-order/queries |
OrderPaymentCreate | Start a payment against an order that already exists — not a checkout. @evolve-storefront/feature-order/queries |
OrderPaymentMethodsByPublicId | The payment methods for any order by its public id, without signing in. @evolve-storefront/feature-order/queries |
OrderPaymentMethodsBySignedLink | The payment methods for the order a signed link names. @evolve-storefront/feature-order/queries |
Data and cache helpers8
invalidateOrders | Invalidate every list cache for a scope (all pages / searches). @evolve-storefront/feature-order |
isOrderRevisable | Whether this order can be put back into a basket. @evolve-storefront/feature-order |
negate | Negate an amount (refunds / deductions render as negative lines). @evolve-storefront/feature-order |
orderLinesToAdd | The lines to put an order in a cart again with: each line's SKU at its quantity, as feature-cart's CartAddLinesButton takes them.@evolve-storefront/feature-order |
paymentReturnUrls | The three return URLs, all one absolute arrival point: the provider picks one and the backend appends what happened, so one route reads one set of parameters. @evolve-storefront/feature-order |
resolvePaymentReturn | Resolve the query a provider return carries. @evolve-storefront/feature-order |
CURRENT_ORDER_STATUSES | The states of an order still on its way to the buyer: pass to useOrders({ status }) for an overview's current orders.@evolve-storefront/feature-order |
orderKeys | react-query key factory for the order history + detail caches. @evolve-storefront/feature-order |
Errors7
OrderCancelError | The gateway refused to close the order. @evolve-storefront/feature-order/hooks |
OrderPaymentError | The gateway refused to start the payment. @evolve-storefront/feature-order/hooks |
OrderPaymentNotConfiguredError | OrderProvider was given no returnUrls, so the provider has nowhere to send the buyer back to.@evolve-storefront/feature-order/hooks |
OrderPaymentOutcomeMissingError | The payment was created and the gateway said nothing about what happens next. @evolve-storefront/feature-order/hooks |
OrderReviseCartMissingError | orderRevise reported success and named no cart.@evolve-storefront/feature-order/hooks |
OrderReviseError | The gateway refused to reopen the order. @evolve-storefront/feature-order/hooks |
ProductReviewError | The gateway refused the review, such as a line already reviewed or not delivered. @evolve-storefront/feature-order/hooks |
Other functions and constants12
countsByStatus | [{ status, count }] as a record by status; null stays null.@evolve-storefront/feature-order/queries |
readOrder | Read one order without knowing its scope, on the server or in a hook. @evolve-storefront/feature-order/queries |
readOrderConfirmation | The order a thank-you page confirms, for a guest as much as a signed-in buyer: read by its id as a public id, with the session's business unit for a link into the company's history. @evolve-storefront/feature-order/queries |
readOrderPaymentMethods | The payment methods for an order a guest can name: by its public id, or by a signed link, which needs no session. @evolve-storefront/feature-order/queries |
followPayOrderResult | Run the option matching result; nothing without options.@evolve-storefront/feature-order/hooks |
readPayOrderResponse | Turn paymentCreate's response into an outcome or a throw.@evolve-storefront/feature-order/hooks |
readReviseOrderResponse | Turn orderRevise's response into a cart or a throw.@evolve-storefront/feature-order/hooks |
reviseFailure | Read the backend's refusal into a reason, so the page says why instead of guessing. @evolve-storefront/feature-order/hooks |
readProductReviewForm | The review form's values, or the fields that are wrong: the rating is required, from 1 to 5, the title and text have the server's length limits, and the photos are at most five images. @evolve-storefront/feature-order/order-detail |
orderDateRange | Turn the two calendar days a date input produces into the inclusive instants the query takes. @evolve-storefront/feature-order/order-history |
parseOrderHistoryParams | Read the history's filters from search params, rejecting what the query cannot take: a status outside statuses is dropped rather than sent, because an unknown enum value fails the whole request.@evolve-storefront/feature-order/order-history |
ORDER_HISTORY_STATUSES | The spine of an order's life, plus cancelled. @evolve-storefront/feature-order/order-history |
Types61
FoundOrder | An order readOrder found, with the session's business unit when the order was found through it — Order names no business unit of its own.@evolve-storefront/feature-order |
Incoterm | The delivery terms of an export (schema IncotermType), verbatim.@evolve-storefront/feature-order |
Money | Money (schema Money): minor units + ISO currency.@evolve-storefront/feature-order |
Order | Full order (schema Order) for the detail view.@evolve-storefront/feature-order |
OrderAddress | Address as displayed on an order (subset of schema Address).@evolve-storefront/feature-order |
OrderApprovalHold | The approval flow holding an order, when one is (schema OrderApproval).@evolve-storefront/feature-order |
OrderCarrier | Who delivers (schema Carrier).@evolve-storefront/feature-order |
OrderClientDevice | Which client is asking, since the offered methods differ by it (schema ClientDeviceType).@evolve-storefront/feature-order |
OrderDelivery | A shipment of (part of) an order (schema OrderDelivery).@evolve-storefront/feature-order |
OrderDeliveryItem | One line item's share of a delivery (schema OrderDeliveryItem).@evolve-storefront/feature-order |
OrderDeliveryPlan | How the buyer chose to receive the order: a slot, a pickup point, or neither. @evolve-storefront/feature-order |
OrderDeliverySlot | The delivery slot chosen in checkout, as it was when the order was placed. @evolve-storefront/feature-order |
OrderDeliveryStatus | @evolve-storefront/feature-order |
OrderDiscountCode | An applied discount code (schema OrderDiscountCode).@evolve-storefront/feature-order |
OrderLineItem | An order line item (schema OrderSingleLineItem).@evolve-storefront/feature-order |
OrderLineReview | One line of an order, as reviewing it goes (schema OrderLineReview).@evolve-storefront/feature-order |
OrderLookup | An order named without knowing whose it is: by id (what a payment provider hands back, and also its public id), by orderNumber, or by a signedLink token.@evolve-storefront/feature-order |
OrderPaymentMethod | A payment method offered for this order (schema PaymentMethod).@evolve-storefront/feature-order |
OrderPaymentMethodInput | The method to pay with (schema PaymentMethodInput).@evolve-storefront/feature-order |
OrderPaymentMethods | The payment methods offered for one order, with the order's id. @evolve-storefront/feature-order |
OrderPaymentMethodsLookup | An order named by something other than the session, for reading its payment methods: its public id, or a signedLink token from a mail.@evolve-storefront/feature-order |
OrderPaymentState | Whether the order has been paid, which is a separate axis from its status. @evolve-storefront/feature-order |
OrderPickupPoint | The pickup point chosen in checkout, as it was when the order was placed. @evolve-storefront/feature-order |
OrderResult | Paginated order list (schema OrderResult).@evolve-storefront/feature-order |
OrderReturnUrls | Where the payment provider returns the buyer. @evolve-storefront/feature-order |
OrderScope | Read scope — consumer (own history) vs business (company-scoped). @evolve-storefront/feature-order |
OrderStatus | Order lifecycle status — the schema's OrderStatusType, verbatim.@evolve-storefront/feature-order |
OrderStatusCount | The number of orders in one status (schema OrderStatusCount).@evolve-storefront/feature-order |
OrderSummary | Summary shape for the history list. @evolve-storefront/feature-order |
PaymentReturnDestination | Where a buyer back from a payment provider goes; the app maps each kind to a path. @evolve-storefront/feature-order |
PaymentReturnOrder | What a return route needs to know about the order a payment came back for. @evolve-storefront/feature-order |
ProductImage | Minimal product image (schema ProductImage).@evolve-storefront/feature-order |
ProductReviewFit | The schema's ProductReviewFitType, verbatim.@evolve-storefront/feature-order |
ProductReviewStatus | The schema's ProductReviewStatusType, verbatim.@evolve-storefront/feature-order |
ProductVariant | Minimal product variant on a line item (schema ProductVariant).@evolve-storefront/feature-order |
Refund | UNVERIFIED (target): a refund on the order. @evolve-storefront/feature-order |
RefundState | @evolve-storefront/feature-order |
Tax | A tax line (schema Tax): rate is 0..1, value the money amount.@evolve-storefront/feature-order |
TaxedPrice | A single-rate taxed price (schema TaxedPrice).@evolve-storefront/feature-order |
TaxedTotalPrice | A multi-rate taxed total (schema TaxedTotalPrice).@evolve-storefront/feature-order |
VatDisplay | Whether prices display net or gross. @evolve-storefront/feature-order |
VatOutcome | The VAT rule an order follows and the reason it applies. @evolve-storefront/feature-order |
VatReason | Why an order's VAT is applied the way it is (schema VatReasonType), verbatim.@evolve-storefront/feature-order |
VatTreatment | How VAT is applied to an order (schema VatTreatmentType), verbatim.@evolve-storefront/feature-order |
CancelOrderVariables | @evolve-storefront/feature-order/hooks |
CreateProductReviewVariables | @evolve-storefront/feature-order/hooks |
PayOrderResult | What the buyer does next, discriminated so a caller cannot forget one arm. @evolve-storefront/feature-order/hooks |
PayOrderVariables | @evolve-storefront/feature-order/hooks |
ReviseFailure | Why a revise failed, as the buyer needs to hear it. @evolve-storefront/feature-order/hooks |
ReviseOrderResult | @evolve-storefront/feature-order/hooks |
ReviseOrderVariables | @evolve-storefront/feature-order/hooks |
CarrierLogoNodes | @evolve-storefront/feature-order/order-detail |
CarrierLogos | Logo image URLs by Carrier.key, e.g.@evolve-storefront/feature-order/order-detail |
OrderLineItemRenderer | @evolve-storefront/feature-order/order-detail |
ProductReviewFormValues | A review as the form holds it once it validates: a rating, and what else the buyer added. @evolve-storefront/feature-order/order-detail |
OrderResumeActions | The two sections renderActions arranges.@evolve-storefront/feature-order/order-resume |
OrderHistoryFilterNames | The form field names, so they line up with whatever the page reads out of its search params. @evolve-storefront/feature-order/order-history |
OrderHistoryItemRenderer | Renders one order in the history list. @evolve-storefront/feature-order/order-history |
OrderHistoryParams | The order history's filters, read from the URL and safe to query with. @evolve-storefront/feature-order/order-history |
OrderHistorySearchParams | A page's search params as a framework hands them over. @evolve-storefront/feature-order/order-history |
OrderStatusLinkRenderer | Renders one state as a link. @evolve-storefront/feature-order/order-history |
Not listed: 34 props and options types. They appear as the tables on the pages of what they type.