Skip to content

OrderModule

Module in @evolve-framework/commercetools

Placed orders on commercetools, including orderByPublicId and orderBySignedLink for an order page reached without signing in.

import { OrderModule } from "@evolve-framework/commercetools";

Serves the Order part of the GraphQL API: orderByPublicId, orderBySignedLink.

new OrderModule(options: OrderModuleOptions)
OptionTypeDescription
clientFactoryClientFactory

The commercetools client its requests to the project go through, built with ClientFactory.create.

payments?PaymentRegistry

The payment providers checkout can use. Required for the availablePaymentMethods resolver to return anything.

trackingUrls?Record<string, string>

Track & trace URLs by carrier name, each with a {trackingId} placeholder, such as { PostNL: "https://jouw.postnl.nl/track-and-trace/{trackingId}" }. A delivery by a carrier without one has no trackingUrl.

orderLinkSecret?string

The secret order links are signed with, the same one passed to createOrderLinkToken from @evolve-framework/core/order-link where the link is made. Without it orderBySignedLink answers null.

Extends AbstractModule<CommercetoolsLoaderContext>.

The same module on medusa and sfcc.