*** title: "OrderService" generated: true --------------- Contains methods relating to [Order](/current/core/reference/typescript-api/entities/order#order) entities. ```ts title="Signature" class OrderService { constructor(connection: TransactionalConnection, configService: ConfigService, productVariantService: ProductVariantService, customerService: CustomerService, countryService: CountryService, orderCalculator: OrderCalculator, shippingCalculator: ShippingCalculator, orderStateMachine: OrderStateMachine, orderMerger: OrderMerger, paymentService: PaymentService, paymentMethodService: PaymentMethodService, fulfillmentService: FulfillmentService, listQueryBuilder: ListQueryBuilder, refundStateMachine: RefundStateMachine, historyService: HistoryService, promotionService: PromotionService, eventBus: EventBus, channelService: ChannelService, orderModifier: OrderModifier, customFieldRelationService: CustomFieldRelationService, requestCache: RequestContextCacheService, translator: TranslatorService, stockLevelService: StockLevelService) getOrderProcessStates() => OrderProcessState[]; findAll(ctx: RequestContext, options?: OrderListOptions, relations?: RelationPaths) => Promise>; findOne(ctx: RequestContext, orderId: ID, relations?: RelationPaths) => Promise; findOneByCode(ctx: RequestContext, orderCode: string, relations?: RelationPaths) => Promise; findOneByOrderLineId(ctx: RequestContext, orderLineId: ID, relations?: RelationPaths) => Promise; findByCustomerId(ctx: RequestContext, customerId: ID, options?: ListQueryOptions, relations?: RelationPaths) => Promise>; getOrderPayments(ctx: RequestContext, orderId: ID) => Promise; getOrderModifications(ctx: RequestContext, orderId: ID) => Promise; getPaymentRefunds(ctx: RequestContext, paymentId: ID) => Promise; getSellerOrders(ctx: RequestContext, order: Order) => Promise; getAggregateOrder(ctx: RequestContext, order: Order) => Promise; getOrderChannels(ctx: RequestContext, order: Order) => Promise; getActiveOrderForUser(ctx: RequestContext, userId: ID) => Promise; create(ctx: RequestContext, userId?: ID) => Promise; createDraft(ctx: RequestContext) => ; updateCustomFields(ctx: RequestContext, orderId: ID, customFields: any) => ; updateOrderCustomer(ctx: RequestContext, { customerId, orderId, note }: SetOrderCustomerInput) => ; updateOrderCurrency(ctx: RequestContext, orderId: ID, currencyCode: CurrencyCode, relations?: RelationPaths) => Promise>; addItemToOrder(ctx: RequestContext, orderId: ID, productVariantId: ID, quantity: number, customFields?: { [key: string]: any }, relations?: RelationPaths) => Promise>; addItemsToOrder(ctx: RequestContext, orderId: ID, items: Array<{ productVariantId: ID; quantity: number; customFields?: { [key: string]: any }; }>, relations?: RelationPaths) => Promise<{ order: Order; errorResults: Array> }>; adjustOrderLine(ctx: RequestContext, orderId: ID, orderLineId: ID, quantity: number, customFields?: { [key: string]: any }, relations?: RelationPaths) => Promise>; adjustOrderLines(ctx: RequestContext, orderId: ID, lines: Array<{ orderLineId: ID; quantity: number; customFields?: { [key: string]: any } }>, relations?: RelationPaths) => Promise<{ order: Order; errorResults: Array> }>; removeItemFromOrder(ctx: RequestContext, orderId: ID, orderLineId: ID) => Promise>; removeItemsFromOrder(ctx: RequestContext, orderId: ID, orderLineIds: ID[]) => Promise>; removeAllItemsFromOrder(ctx: RequestContext, orderId: ID) => Promise>; addSurchargeToOrder(ctx: RequestContext, orderId: ID, surchargeInput: Partial>) => Promise; removeSurchargeFromOrder(ctx: RequestContext, orderId: ID, surchargeId: ID) => Promise; applyCouponCode(ctx: RequestContext, orderId: ID, couponCode: string) => Promise>; removeCouponCode(ctx: RequestContext, orderId: ID, couponCode: string) => ; getOrderPromotions(ctx: RequestContext, orderId: ID) => Promise; getNextOrderStates(order: Order) => readonly OrderState[]; setShippingAddress(ctx: RequestContext, orderId: ID, input: CreateAddressInput) => Promise; setBillingAddress(ctx: RequestContext, orderId: ID, input: CreateAddressInput) => Promise; unsetShippingAddress(ctx: RequestContext, orderId: ID) => Promise; unsetBillingAddress(ctx: RequestContext, orderId: ID) => Promise; getEligibleShippingMethods(ctx: RequestContext, orderId: ID) => Promise; getEligiblePaymentMethods(ctx: RequestContext, orderId: ID) => Promise; setShippingMethod(ctx: RequestContext, orderId: ID, shippingMethodIds: ID[]) => Promise>; transitionToState(ctx: RequestContext, orderId: ID, state: OrderState) => Promise; transitionFulfillmentToState(ctx: RequestContext, fulfillmentId: ID, state: FulfillmentState) => Promise; transitionRefundToState(ctx: RequestContext, refundId: ID, state: RefundState, transactionId?: string) => Promise; modifyOrder(ctx: RequestContext, input: ModifyOrderInput) => Promise>; transitionPaymentToState(ctx: RequestContext, paymentId: ID, state: PaymentState) => Promise>; addPaymentToOrder(ctx: RequestContext, orderId: ID, input: PaymentInput) => Promise>; addManualPaymentToOrder(ctx: RequestContext, input: ManualPaymentInput) => Promise>; settlePayment(ctx: RequestContext, paymentId: ID) => Promise>; cancelPayment(ctx: RequestContext, paymentId: ID) => Promise>; createFulfillment(ctx: RequestContext, input: FulfillOrderInput) => Promise>; getOrderFulfillments(ctx: RequestContext, order: Order) => Promise; getOrderSurcharges(ctx: RequestContext, orderId: ID) => Promise; cancelOrder(ctx: RequestContext, input: CancelOrderInput) => Promise>; refundOrder(ctx: RequestContext, input: RefundOrderInput) => Promise>; settleRefund(ctx: RequestContext, input: SettleRefundInput) => Promise; addCustomerToOrder(ctx: RequestContext, orderIdOrOrder: ID | Order, customer: Customer) => Promise; addNoteToOrder(ctx: RequestContext, input: AddNoteToOrderInput) => Promise; updateOrderNote(ctx: RequestContext, input: UpdateOrderNoteInput) => Promise; deleteOrderNote(ctx: RequestContext, id: ID) => Promise; deleteOrder(ctx: RequestContext, orderOrId: ID | Order) => ; mergeOrders(ctx: RequestContext, user: User, guestOrder?: Order, existingOrder?: Order) => Promise; applyPriceAdjustments(ctx: RequestContext, order: Order, updatedOrderLines?: OrderLine[], relations?: RelationPaths) => Promise; } ```
### getOrderProcessStates \ 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](/current/core/reference/typescript-api/orders/order-process#orderprocess) objects defined in the [OrderOptions](/current/core/reference/typescript-api/orders/order-options#orderoptions) `process` array. ### findAll \RequestContext, options?: OrderListOptions, relations?: RelationPaths<Order>) => Promise<PaginatedList<Order>>`} /> ### findOne \RequestContext, orderId: ID, relations?: RelationPaths<Order>) => Promise<Order | undefined>`} /> ### findOneByCode \RequestContext, orderCode: string, relations?: RelationPaths<Order>) => Promise<Order | undefined>`} /> ### findOneByOrderLineId \RequestContext, orderLineId: ID, relations?: RelationPaths<Order>) => Promise<Order | undefined>`} /> ### findByCustomerId \RequestContext, customerId: ID, options?: ListQueryOptions<Order>, relations?: RelationPaths<Order>) => Promise<PaginatedList<Order>>`} /> ### getOrderPayments \RequestContext, orderId: ID) => Promise<Payment[]>`} /> Returns all [Payment](/current/core/reference/typescript-api/entities/payment#payment) entities associated with the Order. ### getOrderModifications \RequestContext, orderId: ID) => Promise<OrderModification[]>`} /> Returns an array of any [OrderModification](/current/core/reference/typescript-api/entities/order-modification#ordermodification) entities associated with the Order. ### getPaymentRefunds \RequestContext, paymentId: ID) => Promise<Refund[]>`} /> Returns any [Refund](/current/core/reference/typescript-api/entities/refund#refund)s associated with a [Payment](/current/core/reference/typescript-api/entities/payment#payment). ### getSellerOrders \RequestContext, order: Order) => Promise<Order[]>`} /> ### getAggregateOrder \RequestContext, order: Order) => Promise<Order | undefined>`} /> ### getOrderChannels \RequestContext, order: Order) => Promise<Channel[]>`} /> ### getActiveOrderForUser \RequestContext, userId: ID) => Promise<Order | undefined>`} /> Returns any Order associated with the specified User's Customer account that is still in the `active` state. ### create \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. ### createDraft \RequestContext) => `} /> ### updateCustomFields \RequestContext, orderId: ID, customFields: any) => `} /> Updates the custom fields of an Order. ### updateOrderCustomer \RequestContext, { customerId, orderId, note }: SetOrderCustomerInput) => `} since="2.2.0" /> 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. ### updateOrderCurrency \RequestContext, orderId: ID, currencyCode: CurrencyCode, relations?: RelationPaths<Order>) => Promise<ErrorResultUnionOrder>>`} since="3.3.0" /> Updates the currency code of an Order. This will recalculate all prices in the new currency using `applyPriceAdjustments`. ### addItemToOrder \RequestContext, orderId: ID, productVariantId: ID, quantity: number, customFields?: { [key: string]: any }, relations?: RelationPaths<Order>) => Promise<ErrorResultUnionOrder>>`} /> 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. ### addItemsToOrder \RequestContext, orderId: ID, items: Array<{ productVariantId: ID; quantity: number; customFields?: { [key: string]: any }; }>, relations?: RelationPaths<Order>) => Promise<{ order: Order; errorResults: Array> }>`} since="3.1.0" /> Adds 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. ### adjustOrderLine \RequestContext, orderId: ID, orderLineId: ID, quantity: number, customFields?: { [key: string]: any }, relations?: RelationPaths<Order>) => Promise<ErrorResultUnionOrder>>`} /> Adjusts the quantity and/or custom field values of an existing OrderLine. If you need to adjust multiple OrderLines, use `adjustOrderLines()` instead. ### adjustOrderLines \RequestContext, orderId: ID, lines: Array<{ orderLineId: ID; quantity: number; customFields?: { [key: string]: any } }>, relations?: RelationPaths<Order>) => Promise<{ order: Order; errorResults: Array> }>`} since="3.1.0" /> Adjusts 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. ### removeItemFromOrder \RequestContext, orderId: ID, orderLineId: ID) => Promise<ErrorResultUnionOrder>>`} /> Removes the specified OrderLine from the Order. If you need to remove multiple OrderLines, use `removeItemsFromOrder()` instead. ### removeItemsFromOrder \RequestContext, orderId: ID, orderLineIds: ID[]) => Promise<ErrorResultUnionOrder>>`} since="3.1.0" /> Removes 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. ### removeAllItemsFromOrder \RequestContext, orderId: ID) => Promise<ErrorResultUnionOrder>>`} /> Removes all OrderLines from the Order. ### addSurchargeToOrder \RequestContext, orderId: ID, surchargeInput: PartialSurcharge, 'id' | 'createdAt' | 'updatedAt' | 'order'>>) => Promise<Order>`} /> Adds a [Surcharge](/current/core/reference/typescript-api/entities/surcharge#surcharge) to the Order. ### removeSurchargeFromOrder \RequestContext, orderId: ID, surchargeId: ID) => Promise<Order>`} /> Removes a [Surcharge](/current/core/reference/typescript-api/entities/surcharge#surcharge) from the Order. ### applyCouponCode \RequestContext, orderId: ID, couponCode: string) => Promise<ErrorResultUnionOrder>>`} /> Applies a coupon code to the Order, which should be a valid coupon code as specified in the configuration of an active [Promotion](/current/core/reference/typescript-api/entities/promotion#promotion). ### removeCouponCode \RequestContext, orderId: ID, couponCode: string) => `} /> Removes a coupon code from the Order. ### getOrderPromotions \RequestContext, orderId: ID) => Promise<Promotion[]>`} /> Returns all [Promotion](/current/core/reference/typescript-api/entities/promotion#promotion)s associated with an Order. ### getNextOrderStates \Order) => readonly OrderState[]`} /> Returns the next possible states that the Order may transition to. ### setShippingAddress \RequestContext, orderId: ID, input: CreateAddressInput) => Promise<Order>`} /> Sets the shipping address for the Order. ### setBillingAddress \RequestContext, orderId: ID, input: CreateAddressInput) => Promise<Order>`} /> Sets the billing address for the Order. ### unsetShippingAddress \RequestContext, orderId: ID) => Promise<Order>`} since="3.1.0" /> Unsets the shipping address for the Order. ### unsetBillingAddress \RequestContext, orderId: ID) => Promise<Order>`} since="3.1.0" /> Unsets the billing address for the Order. ### getEligibleShippingMethods \RequestContext, orderId: ID) => Promise`} /> Returns an array of quotes stating which [ShippingMethod](/current/core/reference/typescript-api/entities/shipping-method#shippingmethod)s may be applied to this Order. This is determined by the configured [ShippingEligibilityChecker](/current/core/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker) of each ShippingMethod. The quote also includes a price for each method, as determined by the configured [ShippingCalculator](/current/core/reference/typescript-api/shipping/shipping-calculator#shippingcalculator) of each eligible ShippingMethod. ### getEligiblePaymentMethods \RequestContext, orderId: ID) => Promise`} /> Returns an array of quotes stating which [PaymentMethod](/current/core/reference/typescript-api/entities/payment-method#paymentmethod)s may be used on this Order. ### setShippingMethod \RequestContext, orderId: ID, shippingMethodIds: ID[]) => Promise<ErrorResultUnionOrder>>`} /> Sets the ShippingMethod to be used on this Order. ### transitionToState \RequestContext, orderId: ID, state: OrderState) => Promise<Order | OrderStateTransitionError>`} /> Transitions the Order to the given state. ### transitionFulfillmentToState \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. ### transitionRefundToState \RequestContext, refundId: ID, state: RefundState, transactionId?: string) => Promise<Refund | RefundStateTransitionError>`} /> Transitions a Refund to the given state ### modifyOrder \RequestContext, input: ModifyOrderInput) => Promise<ErrorResultUnionOrder>>`} /> Allows the Order to be modified, which allows several aspects of the Order to be changed: * Changes to OrderLine quantities * New OrderLines being added * Arbitrary [Surcharge](/current/core/reference/typescript-api/entities/surcharge#surcharge)s being added * Shipping or billing address changes 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.** ### transitionPaymentToState \RequestContext, paymentId: ID, state: PaymentState) => Promise<ErrorResultUnionPayment>>`} /> Transitions the given [Payment](/current/core/reference/typescript-api/entities/payment#payment) to a new state. ### addPaymentToOrder \RequestContext, orderId: ID, input: PaymentInput) => Promise<ErrorResultUnionOrder>>`} /> 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. ### addManualPaymentToOrder \RequestContext, input: ManualPaymentInput) => Promise<ErrorResultUnionOrder>>`} /> 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. ### settlePayment \RequestContext, paymentId: ID) => Promise<ErrorResultUnion<SettlePaymentResult, Payment>>`} /> Settles a payment by invoking the [PaymentMethodHandler](/current/core/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler)'s `settlePayment()` method. Automatically transitions the Order state if all Payments are settled. ### cancelPayment \RequestContext, paymentId: ID) => Promise<ErrorResultUnion<CancelPaymentResult, Payment>>`} /> Cancels a payment by invoking the [PaymentMethodHandler](/current/core/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler)'s `cancelPayment()` method (if defined), and transitions the Payment to the `Cancelled` state. ### createFulfillment \RequestContext, input: FulfillOrderInput) => Promise<ErrorResultUnionFulfillment>>`} /> Creates a new Fulfillment associated with the given Order and OrderItems. ### getOrderFulfillments \RequestContext, order: Order) => Promise<Fulfillment[]>`} /> Returns an array of all Fulfillments associated with the Order. ### getOrderSurcharges \RequestContext, orderId: ID) => Promise<Surcharge[]>`} /> Returns an array of all Surcharges associated with the Order. ### cancelOrder \RequestContext, input: CancelOrderInput) => Promise<ErrorResultUnionOrder>>`} /> Cancels an Order by transitioning it to the `Cancelled` state. If stock is being tracked for the ProductVariants in the Order, then new [StockMovement](/current/core/reference/typescript-api/entities/stock-movement#stockmovement)s will be created to correct the stock levels. ### refundOrder \RequestContext, input: RefundOrderInput) => Promise<ErrorResultUnionRefund>>`} /> Creates a [Refund](/current/core/reference/typescript-api/entities/refund#refund) against the order and in doing so invokes the `createRefund()` method of the [PaymentMethodHandler](/current/core/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler). ### settleRefund \RequestContext, input: SettleRefundInput) => Promise<Refund>`} /> Settles a Refund by transitioning it to the `Settled` state. ### addCustomerToOrder \RequestContext, orderIdOrOrder: ID | Order, customer: Customer) => Promise<Order>`} /> Associates a Customer with the Order. ### addNoteToOrder \RequestContext, input: AddNoteToOrderInput) => Promise<Order>`} /> Creates a new "ORDER\_NOTE" type [OrderHistoryEntry](/current/core/reference/typescript-api/entities/order-history-entry#orderhistoryentry) in the Order's history timeline. ### updateOrderNote \RequestContext, input: UpdateOrderNoteInput) => Promise<HistoryEntry>`} /> ### deleteOrderNote \RequestContext, id: ID) => Promise`} /> ### deleteOrder \RequestContext, orderOrId: ID | Order) => `} since="1.5.0" /> Deletes an Order, ensuring that any Sessions that reference this Order are dereferenced before deletion. ### mergeOrders \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](/current/core/reference/typescript-api/orders/order-options#orderoptions) `mergeStrategy` config setting. ### applyPriceAdjustments \RequestContext, order: Order, updatedOrderLines?: OrderLine[], relations?: RelationPaths<Order>) => 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](/current/core/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy).