Create Order

To create an order into Geins you need a cart and the checkout options.

⚠️ Important

Don't use this if you are using an external checkout flow. This is only for custom checkout flows. Geins backend handles with hooks from payment gateway if checkout is an iframe or alike.

Overview

• Before order is created the checkout will be validated.
• Validation will only ceckl
• If the checkout is valid the order will be created.
• A successful order creation will return the CreateOrderResponseType which contains all the necessary information next steps of the checkout process.

⚠️ Important

The validation performed before creating the order is not the same as the validation performed by the validate method.

Options

The create order options are required to create an order. The options are as follows:

@geins/types

type CreateOrderOptions = {
  cartId: string;
  checkoutOptions: CheckoutInputType;
};

Return Object

The return object is of type a CreateOrderResponseType:

@geins/types

export type CreateOrderResponseType = {
  created?: boolean;
  orderId?: string;
  publicId?: string;
  message?: string;  
};

• created - A boolean value indicating if the order was created successfully or not.
• orderId - The order ID that is created in Geins. This is not preset if the order was not created.
• publicId - Might be empty depending on flow of the payment gateway. This is not preset if the order was not created.
• message - Only present if the order was not created. This will contain a message indicating why the order was not created.

Example

const myCheckoutOptions = getCheckoutOptions();
const createOrderResult = await geinsOMS.checkout.createOrder({ 
  cartId: 'cart-id', 
  checkoutOptions: myCheckoutOptions
});

if(createOrderResult.created) {
    console.log("Order created successfully:", createOrderResult);
} else {
    console.log("Order creation failed:", createOrderResult.message);
}