() => OrderProcessState[]Returns an array of all the configured states and transitions of the order process. This is
based on the default order process plus all configured OrderProcess objects
defined in the OrderOptions process array.
(ctx: RequestContext, options?: OrderListOptions, relations?: RelationPaths<Order>) => Promise<PaginatedList<Order>>(ctx: RequestContext, orderId: ID, relations?: RelationPaths<Order>) => Promise<Order | undefined>(ctx: RequestContext, orderCode: string, relations?: RelationPaths<Order>) => Promise<Order | undefined>(ctx: RequestContext, orderLineId: ID, relations?: RelationPaths<Order>) => Promise<Order | undefined>(ctx: RequestContext, customerId: ID, options?: ListQueryOptions<Order>, relations?: RelationPaths<Order>) => Promise<PaginatedList<Order>>(ctx: RequestContext, orderId: ID) => Promise<Payment[]>Returns all Payment entities associated with the Order.
(ctx: RequestContext, orderId: ID) => Promise<OrderModification[]>Returns an array of any OrderModification entities associated with the Order.
(ctx: RequestContext, paymentId: ID) => Promise<Refund[]>Returns any Refunds associated with a Payment.
(ctx: RequestContext, order: Order) => Promise<Order[]>(ctx: RequestContext, order: Order) => Promise<Order | undefined>(ctx: RequestContext, order: Order) => Promise<Channel[]>(ctx: RequestContext, userId: ID) => Promise<Order | undefined>Returns any Order associated with the specified User's Customer account
that is still in the active state.
(ctx: RequestContext, userId?: ID) => Promise<Order>Creates a new, empty Order. If a userId is passed, the Order will get associated with that
User's Customer account.
(ctx: RequestContext) => (ctx: RequestContext, orderId: ID, customFields: any) => Updates the custom fields of an Order.
Updates the Customer which is assigned to a given Order. The target Customer must be assigned to the same Channels as the Order, otherwise an error will be thrown.
(ctx: RequestContext, orderId: ID, currencyCode: CurrencyCode, relations?: RelationPaths<Order>) => Promise<ErrorResultUnion<UpdateOrderItemsResult, Order>>v3.3.0Updates the currency code of an Order. This will recalculate all prices
in the new currency using applyPriceAdjustments.
(ctx: RequestContext, orderId: ID, productVariantId: ID, quantity: number, customFields?: { [key: string]: any }, relations?: RelationPaths<Order>) => Promise<ErrorResultUnion<UpdateOrderItemsResult, Order>>Adds an item to the Order, either creating a new OrderLine or incrementing an existing one.
If you need to add multiple items to an Order, use addItemsToOrder() instead.
(ctx: RequestContext, orderId: ID, items: Array<{ productVariantId: ID; quantity: number; customFields?: { [key: string]: any }; }>, relations?: RelationPaths<Order>) => Promise<{ order: Order; errorResults: Array<JustErrorResults<UpdateOrderItemsResult>> }>v3.1.0Adds multiple items to an Order. This method is more efficient than calling addItemToOrder
multiple times, as it only needs to fetch the entire Order once, and only performs
price adjustments once at the end.
Since this method can return multiple error results, it is recommended to check the errorResults
array to determine if any errors occurred.
(ctx: RequestContext, orderId: ID, orderLineId: ID, quantity: number, customFields?: { [key: string]: any }, relations?: RelationPaths<Order>) => Promise<ErrorResultUnion<UpdateOrderItemsResult, Order>>Adjusts the quantity and/or custom field values of an existing OrderLine.
If you need to adjust multiple OrderLines, use adjustOrderLines() instead.
(ctx: RequestContext, orderId: ID, lines: Array<{ orderLineId: ID; quantity: number; customFields?: { [key: string]: any } }>, relations?: RelationPaths<Order>) => Promise<{ order: Order; errorResults: Array<JustErrorResults<UpdateOrderItemsResult>> }>v3.1.0Adjusts the quantity and/or custom field values of existing OrderLines.
This method is more efficient than calling adjustOrderLine multiple times, as it only needs to fetch
the entire Order once, and only performs price adjustments once at the end.
Since this method can return multiple error results, it is recommended to check the errorResults
array to determine if any errors occurred.
(ctx: RequestContext, orderId: ID, orderLineId: ID) => Promise<ErrorResultUnion<RemoveOrderItemsResult, Order>>Removes the specified OrderLine from the Order.
If you need to remove multiple OrderLines, use removeItemsFromOrder() instead.
(ctx: RequestContext, orderId: ID, orderLineIds: ID[]) => Promise<ErrorResultUnion<RemoveOrderItemsResult, Order>>v3.1.0Removes the specified OrderLines from the Order.
This method is more efficient than calling removeItemFromOrder multiple times, as it only needs to fetch
the entire Order once, and only performs price adjustments once at the end.
(ctx: RequestContext, orderId: ID) => Promise<ErrorResultUnion<RemoveOrderItemsResult, Order>>Removes all OrderLines from the Order.
(ctx: RequestContext, orderId: ID, surchargeInput: Partial<Omit<Surcharge, 'id' | 'createdAt' | 'updatedAt' | 'order'>>) => Promise<Order>Adds a Surcharge to the Order.
(ctx: RequestContext, orderId: ID, surchargeId: ID) => Promise<Order>Removes a Surcharge from the Order.
(ctx: RequestContext, orderId: ID, couponCode: string) => Promise<ErrorResultUnion<ApplyCouponCodeResult, Order>>Applies a coupon code to the Order, which should be a valid coupon code as specified in the configuration of an active Promotion.
(ctx: RequestContext, orderId: ID, couponCode: string) => Removes a coupon code from the Order.
(ctx: RequestContext, orderId: ID) => Promise<Promotion[]>Returns all Promotions associated with an Order.
(order: Order) => readonly OrderState[]Returns the next possible states that the Order may transition to.
(ctx: RequestContext, orderId: ID, input: CreateAddressInput) => Promise<Order>Sets the shipping address for the Order.
(ctx: RequestContext, orderId: ID, input: CreateAddressInput) => Promise<Order>Sets the billing address for the Order.
Unsets the shipping address for the Order.
Unsets the billing address for the Order.
(ctx: RequestContext, orderId: ID) => Promise<ShippingMethodQuote[]>Returns an array of quotes stating which ShippingMethods may be applied to this Order. This is determined by the configured ShippingEligibilityChecker of each ShippingMethod.
The quote also includes a price for each method, as determined by the configured ShippingCalculator of each eligible ShippingMethod.
(ctx: RequestContext, orderId: ID) => Promise<PaymentMethodQuote[]>Returns an array of quotes stating which PaymentMethods may be used on this Order.
(ctx: RequestContext, orderId: ID, shippingMethodIds: ID[]) => Promise<ErrorResultUnion<SetOrderShippingMethodResult, Order>>Sets the ShippingMethod to be used on this Order.
(ctx: RequestContext, orderId: ID, state: OrderState) => Promise<Order | OrderStateTransitionError>Transitions the Order to the given state.
(ctx: RequestContext, fulfillmentId: ID, state: FulfillmentState) => Promise<Fulfillment | FulfillmentStateTransitionError>Transitions a Fulfillment to the given state and then transitions the Order state based on whether all Fulfillments of the Order are shipped or delivered.
(ctx: RequestContext, refundId: ID, state: RefundState, transactionId?: string) => Promise<Refund | RefundStateTransitionError>Transitions a Refund to the given state
(ctx: RequestContext, input: ModifyOrderInput) => Promise<ErrorResultUnion<ModifyOrderResult, Order>>Allows the Order to be modified, which allows several aspects of the Order to be changed:
Setting the dryRun input property to true will apply all changes, including updating the price of the
Order, except history entry and additional payment actions.
Using dryRun option, you must wrap function call in transaction manually.
(ctx: RequestContext, paymentId: ID, state: PaymentState) => Promise<ErrorResultUnion<TransitionPaymentToStateResult, Payment>>Transitions the given Payment to a new state.
(ctx: RequestContext, orderId: ID, input: PaymentInput) => Promise<ErrorResultUnion<AddPaymentToOrderResult, Order>>Adds a new Payment to the Order. If the Order totalWithTax is covered by Payments, then the Order
state will get automatically transitioned to the PaymentSettled or PaymentAuthorized state.
(ctx: RequestContext, input: ManualPaymentInput) => Promise<ErrorResultUnion<AddManualPaymentToOrderResult, Order>>This method is used after modifying an existing completed order using the modifyOrder() method. If the modifications
cause the order total to increase (such as when adding a new OrderLine), then there will be an outstanding charge to
pay.
This method allows you to add a new Payment and assumes the actual processing has been done manually, e.g. in the dashboard of your payment provider.
(ctx: RequestContext, paymentId: ID) => Promise<ErrorResultUnion<SettlePaymentResult, Payment>>Settles a payment by invoking the PaymentMethodHandler's settlePayment() method. Automatically
transitions the Order state if all Payments are settled.
(ctx: RequestContext, paymentId: ID) => Promise<ErrorResultUnion<CancelPaymentResult, Payment>>Cancels a payment by invoking the PaymentMethodHandler's cancelPayment() method (if defined), and transitions the Payment to
the Cancelled state.
(ctx: RequestContext, input: FulfillOrderInput) => Promise<ErrorResultUnion<AddFulfillmentToOrderResult, Fulfillment>>Creates a new Fulfillment associated with the given Order and OrderItems.
(ctx: RequestContext, order: Order) => Promise<Fulfillment[]>Returns an array of all Fulfillments associated with the Order.
(ctx: RequestContext, orderId: ID) => Promise<Surcharge[]>Returns an array of all Surcharges associated with the Order.
(ctx: RequestContext, input: CancelOrderInput) => Promise<ErrorResultUnion<CancelOrderResult, Order>>Cancels an Order by transitioning it to the Cancelled state. If stock is being tracked for the ProductVariants
in the Order, then new StockMovements will be created to correct the stock levels.
(ctx: RequestContext, input: RefundOrderInput) => Promise<ErrorResultUnion<RefundOrderResult, Refund>>Creates a Refund against the order and in doing so invokes the createRefund() method of the
PaymentMethodHandler.
(ctx: RequestContext, orderId: ID) => Promise<Array<{ code: string; description: string; availableForPaymentIds: ID[] }>>Returns the available refund destinations for the given order. Includes the default destination (original payment method) plus any custom destinations registered via RefundDestinationStrategy.
(ctx: RequestContext, input: SettleRefundInput) => Promise<Refund>Settles a Refund by transitioning it to the Settled state.
(ctx: RequestContext, orderIdOrOrder: ID | Order, customer: Customer) => Promise<Order>Associates a Customer with the Order.
(ctx: RequestContext, input: AddNoteToOrderInput) => Promise<Order>Creates a new "ORDER_NOTE" type OrderHistoryEntry in the Order's history timeline.
(ctx: RequestContext, input: UpdateOrderNoteInput) => Promise<HistoryEntry>(ctx: RequestContext, id: ID) => Promise<DeletionResponse>Deletes an Order, ensuring that any Sessions that reference this Order are dereferenced before deletion.
(ctx: RequestContext, user: User, guestOrder?: Order, existingOrder?: Order) => Promise<Order | undefined>When a guest user with an anonymous Order signs in and has an existing Order associated with that Customer, we need to reconcile the contents of the two orders.
The logic used to do the merging is specified in the OrderOptions mergeStrategy config setting.
(ctx: RequestContext, order: Order, updatedOrderLines?: OrderLine[], relations?: RelationPaths<Order>, options?: ApplyPriceAdjustmentsOptions) => Promise<Order>Applies promotions, taxes and shipping to the Order. If the updatedOrderLines argument is passed in,
then all of those OrderLines will have their prices re-calculated using the configured OrderItemPriceCalculationStrategy.
Pass options.recalculateShipping: false to leave the Order's existing ShippingLine prices
untouched. This is needed when the Order's ShippingMethods cannot be resolved in the current
Channel, e.g. for a seller Order whose ShippingLines were already calculated on the aggregate
Order. The existing shipping Promotion adjustments are then left in place too, unless
options.recalculateShippingPromotions: true is also passed, which revalidates them against
the Promotions of the current Channel.
Note that recalculateShipping: false also leaves the ShippingLine's taxLines and
listPriceIncludesTax as they were, since both are produced by the ShippingMethod's
ShippingCalculator and that is only run when the prices are recalculated. The
OrderLine taxes are still recalculated for the current Channel's tax zone, so an Order priced
this way in a Channel which resolves to a different tax zone, or which has a different
pricesIncludeTax setting, ends up with its lines and its shipping taxed on different bases.
The built-in defaultShippingCalculator takes its tax rate from a ShippingMethod arg
rather than from the tax zone, so this only affects the includesTax: 'auto' setting and
custom ShippingCalculators which derive their tax rate from the RequestContext.
Recalculates the given active Order's prices, promotions, taxes and shipping promotions if the
configured OrderRecalculationStrategy reports it as stale. The shipping method and
rate are deliberately NOT re-evaluated on this read path — the customer's chosen method is
never silently swapped; those are re-evaluated when the Order transitions to ArrangingPayment.
Only Orders in the AddingItems state are eligible; no-ops (returning the Order unchanged)
otherwise. Invoked on the active-order read path.
Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.
Talk to the team