Type Alias: GetCartSubmissionFormAction()

GetCartSubmissionFormAction = (cartId) => Promise<CartCustomField[]>

Function

Retrieves the custom fields and form structure required for cart submission.

This method fetches the collection of form fields needed to complete a cart submission, including both standard fields (name, email, etc.) and any custom fields defined for the cart submission process. The returned fields contain all necessary validation rules, display properties, and ordering information.

The form structure is typically used to build a dynamic checkout form that collects the required customer information before finalizing an order. Field types can include text inputs, dropdowns, checkboxes, and more complex components like rich text areas.

Parameters

cartId

string

The unique identifier for the cart

Returns

Promise<CartCustomField[]>

A promise that resolves to an array of form field definitions

Example

// Fetch the submission form structure and build a dynamic form
const formFields = await window.mimeeqApp.actions.getCartSubmissionForm('cart_123456');

// Sort fields by their ordinal position
formFields.sort((a, b) => a.ordinal - b.ordinal);

// Create form elements for each field
const formContainer = document.getElementById('checkout-form');
formFields.forEach(field => {
  const formControl = createFormControl(field);
  formContainer.appendChild(formControl);
});

Throws

Will throw an error if the cart ID is missing or if form retrieval fails